Merge pull request #391 from crazy-max/buildkit-git

buildkit: git parseURL and parseRef funcs

src/buildkit/git.ts

@@ -0,0 +1,113 @@
+/**
+ * Copyright 2024 actions-toolkit authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {GitRef, GitURL, GitURLFragment, URLUserInfo} from '../types/buildkit/git';
+
+export class Git {
+  private static protoRegexp = new RegExp('^[a-zA-Z0-9]+://');
+  private static supportedProtos = {
+    http: {},
+    https: {},
+    ssh: {},
+    git: {}
+  };
+
+  // https://github.com/moby/buildkit/blob/2ec1338fc13f73b43f0b1b4f4678d7cd654bc86c/util/gitutil/git_url.go#L79
+  public static parseURL(remote: string): GitURL {
+    const match = remote.match(Git.protoRegexp);
+    if (match && match.length > 0) {
+      let proto = match[0].toLowerCase();
+      proto = proto.slice(0, proto.lastIndexOf('://'));
+      if (!(proto in Git.supportedProtos)) {
+        throw new Error(`Invalid protocol: ${proto}`);
+      }
+      return Git.fromURL(new URL(remote));
+    }
+
+    throw new Error('Unknown protocol');
+  }
+
+  // https://github.com/moby/buildkit/blob/2ec1338fc13f73b43f0b1b4f4678d7cd654bc86c/util/gitutil/git_url.go#L108
+  private static fromURL(url: URL): GitURL {
+    const withoutFragment = new URL(url.toString());
+    withoutFragment.hash = '';
+
+    let user: URLUserInfo | undefined;
+    if (url.username || url.password) {
+      user = {
+        username: url.username,
+        password: url.password,
+        passwordSet: url.password !== ''
+      };
+    }
+
+    // TODO: handle SCP-style URLs
+
+    return {
+      scheme: url.protocol.slice(0, -1),
+      user: user,
+      host: `${url.hostname}${url.port ? ':' + url.port : ''}`,
+      path: url.pathname,
+      fragment: Git.splitGitFragment(url.hash),
+      remote: withoutFragment.toString()
+    };
+  }
+
+  // https://github.com/moby/buildkit/blob/2ec1338fc13f73b43f0b1b4f4678d7cd654bc86c/util/gitutil/git_url.go#L69
+  private static splitGitFragment(fragment: string): GitURLFragment | undefined {
+    if (fragment === '') {
+      return undefined;
+    }
+    const [ref, subdir] = fragment.slice(1).split(':');
+    return {
+      ref: ref,
+      subdir: subdir
+    };
+  }
+
+  // https://github.com/moby/buildkit/blob/2ec1338fc13f73b43f0b1b4f4678d7cd654bc86c/util/gitutil/git_ref.go#L52
+  public static parseRef(ref: string): GitRef | undefined {
+    const res: GitRef = {};
+    let remote: GitURL;
+    if (ref.startsWith('./') || ref.startsWith('../')) {
+      throw new Error('Invalid argument');
+    } else if (ref.startsWith('github.com/')) {
+      res.indistinguishableFromLocal = true; // Deprecated
+      remote = Git.fromURL(new URL('https://' + ref));
+    } else {
+      remote = Git.parseURL(ref);
+      if (['http', 'git'].includes(remote.scheme)) {
+        res.unencryptedTCP = true; // Discouraged, but not deprecated
+      }
+      if (['http', 'https'].includes(remote.scheme) && !remote.path.endsWith('.git')) {
+        throw new Error('Invalid argument');
+      }
+    }
+    res.remote = remote.remote;
+
+    if (res.indistinguishableFromLocal) {
+      res.remote = res.remote.split('://')[1];
+    }
+    if (remote.fragment) {
+      res.commit = remote.fragment.ref;
+      res.subDir = remote.fragment.subdir;
+    }
+
+    const repoSplitBySlash = res.remote.split('/');
+    res.shortName = repoSplitBySlash[repoSplitBySlash.length - 1].replace('.git', '');
+    return res;
+  }
+}

src/types/buildkit/git.ts

@@ -0,0 +1,44 @@
+/**
+ * Copyright 2024 actions-toolkit authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface GitURL {
+  scheme: string;
+  host: string;
+  path: string;
+  user?: URLUserInfo;
+  fragment?: GitURLFragment;
+  remote: string;
+}
+
+export interface GitURLFragment {
+  ref: string;
+  subdir: string;
+}
+
+export interface GitRef {
+  remote?: string;
+  shortName?: string;
+  commit?: string;
+  subDir?: string;
+  indistinguishableFromLocal?: boolean;
+  unencryptedTCP?: boolean;
+}
+
+export interface URLUserInfo {
+  username: string;
+  password: string;
+  passwordSet: boolean;
+}