feat: Add GitRemote detection logic (#4381)

* feat: Determine SCM in GitProvenance for more accurate path estimation Determine the SCM from a list of known urls and any manually registered SCMs. The SCM is then used to determine ScmUrlComponents which in turn give information about a repository. * Apply suggestions from code review Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * rename gitlab scm * Comments * fix tests * fix boolean * fix git provenance tests * Rename to `ScmUrlComponents` to `CloneUrl` and move logic into that * Add full cloneUrl * fully parse on construction * Update rewrite-core/src/test/java/org/openrewrite/scm/GitLabScmTest.java Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update rewrite-core/src/main/java/org/openrewrite/scm/AzureDevopsCloneUrl.java Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Add missing newlines at the end of files * Add missing newline at the end of GitLabScmTest * refactor: Azure devops refactoring (#4378) * refactor: Azure DevOps refactoring. * review changes * review changes --------- Co-authored-by: Peter Streef <[email protected]> * new line? * Lazy initialization * Lombok compiler issue * Update rewrite-core/src/main/java/org/openrewrite/internal/Lazy.java Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Replace Lazy with `@NonFinal` field * fix message, use getters * feat: Add `GitRemote` detection logic * Cleanup and add new tests * update comment * Don't try to fix the `getOrganizationName(String baseUrl)` to avoid unexpected results (not using the baseUrl) * replace `Optional` * Simplify * Simplify * remove deprecation and fix whitespace * pass null and let `#fromProjectDirectory(Path, BuildEnvironment, GitRemote.Parser)` init instead * add `getRepositoryPath()` instance method * do not update to unknown * no nullable * extract `GitRemote` * license * review comments * add url to message --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Tim te Beek <[email protected]> Co-authored-by: bryceatmoderne <[email protected]>
openrewrite · Aug 5, 2024 · a0314ce · a0314ce
1 parent 6ce62f1
commit a0314ce
Show file tree

Hide file tree

Showing 5 changed files with 393 additions and 64 deletions.
diff --git a/rewrite-core/src/main/java/org/openrewrite/GitRemote.java b/rewrite-core/src/main/java/org/openrewrite/GitRemote.java
@@ -0,0 +1,177 @@
+/*
+ * Copyright 2024 the original author or authors.
+ * <p>
+ * 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
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.
+ */
+package org.openrewrite;
+
+import lombok.Value;
+import org.openrewrite.internal.lang.Nullable;
+import org.openrewrite.jgit.transport.URIish;
+
+import java.net.URISyntaxException;
+import java.util.Arrays;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+@Value
+public class GitRemote {
+    Service service;
+    String url;
+    String origin;
+    String path;
+
+    @Nullable
+    String organization;
+
+    String repositoryName;
+
+    public enum Service {
+        GitHub,
+        GitLab,
+        Bitbucket,
+        BitbucketCloud,
+        AzureDevOps,
+        Unknown
+    }
+
+    public static class Parser {
+        private final Map<String, Service> origins;
+
+        public Parser() {
+            origins = new LinkedHashMap<>();
+            origins.put("github.com", Service.GitHub);
+            origins.put("gitlab.com", Service.GitLab);
+            origins.put("bitbucket.org", Service.BitbucketCloud);
+            origins.put("dev.azure.com", Service.AzureDevOps);
+            origins.put("ssh.dev.azure.com", Service.AzureDevOps);
+        }
+
+        public Parser registerRemote(Service service, String origin) {
+            if (origin.startsWith("https://") || origin.startsWith("http://") || origin.startsWith("ssh://")) {
+                origin = new Parser.HostAndPath(origin).concat();
+            }
+            if (origin.contains("@")) {
+                origin = new Parser.HostAndPath("https://" + origin).concat();
+            }
+            if (service == Service.Unknown) {
+                // Do not override a known with an unknown service
+                origins.putIfAbsent(origin, service);
+            } else {
+                origins.put(origin, service);
+            }
+            return this;
+        }
+
+        public GitRemote parse(String url) {
+            Parser.HostAndPath hostAndPath = new Parser.HostAndPath(url);
+
+            String origin = hostAndPath.host;
+            Service service = origins.get(origin);
+            if (service == null) {
+                for (String maybeOrigin : origins.keySet()) {
+                    if (hostAndPath.concat().startsWith(maybeOrigin)) {
+                        service = origins.get(maybeOrigin);
+                        origin = maybeOrigin;
+                        break;
+                    }
+                }
+            }
+
+            if (service == null) {
+                // If we cannot find a service, we assume the last 2 path segments are the organization and repository name
+                service = Service.Unknown;
+                String hostPath = hostAndPath.concat();
+                String[] segments = hostPath.split("/");
+                if (segments.length <= 2) {
+                    origin = null;
+                } else {
+                    origin = Arrays.stream(segments, 0, segments.length - 2).collect(Collectors.joining("/"));
+                }
+            }
+
+            String repositoryPath = hostAndPath.repositoryPath(origin);
+
+            switch (service) {
+                case AzureDevOps:
+                    if (origin.equals("ssh.dev.azure.com")) {
+                        origin = "dev.azure.com";
+                        repositoryPath = repositoryPath.replaceFirst("v3/", "");
+                    } else {
+                        repositoryPath = repositoryPath.replaceFirst("/_git/", "/");
+                    }
+                    break;
+                case Bitbucket:
+                    if (url.startsWith("http")) {
+                        repositoryPath = repositoryPath.replaceFirst("scm/", "");
+                    }
+                    break;
+            }
+            String organization = null;
+            String repositoryName;
+            if (repositoryPath.contains("/")) {
+                organization = repositoryPath.substring(0, repositoryPath.lastIndexOf("/"));
+                repositoryName = repositoryPath.substring(repositoryPath.lastIndexOf("/") + 1);
+            } else {
+                repositoryName = repositoryPath;
+            }
+            return new GitRemote(service, url, origin, repositoryPath, organization, repositoryName);
+        }
+
+        private static class HostAndPath {
+            String scheme;
+            String host;
+            String path;
+
+            public HostAndPath(String url) {
+                try {
+                    URIish uri = new URIish(url);
+                    scheme = uri.getScheme();
+                    host = uri.getHost();
+                    if (host == null && !"file".equals(scheme)) {
+                        throw new IllegalStateException("No host in url: " + url);
+                    }
+                    path = uri.getPath().replaceFirst("/$", "")
+                            .replaceFirst(".git$", "")
+                            .replaceFirst("^/", "");
+                } catch (URISyntaxException e) {
+                    throw new IllegalStateException("Unable to parse origin from: " + url, e);
+                }
+            }
+
+            private String concat() {
+                String hostAndPath = host == null ? "" : host;
+                if (!path.isEmpty()) {
+                    if (!hostAndPath.isEmpty()) {
+                        hostAndPath += "/";
+                    }
+                    hostAndPath += path;
+                }
+                return hostAndPath;
+            }
+
+            private String repositoryPath(@Nullable String origin) {
+                if (origin == null) {
+                    origin = "";
+                }
+                String hostAndPath = concat();
+                if (!hostAndPath.startsWith(origin)) {
+                    throw new IllegalArgumentException("Unable to find origin '" + origin + "' in '" + hostAndPath + "'");
+                }
+                return hostAndPath.substring(origin.length())
+                        .replaceFirst("^/", "");
+            }
+        }
+    }
+}