feat: Determine SCM and parse clone url in GitProvenance for more accurate path/origin/organiation/groups

rewrite-core/src/main/java/org/openrewrite/marker/GitProvenance.java

@@ -16,6 +16,7 @@
 package org.openrewrite.marker;
 
 
+import lombok.AllArgsConstructor;
 import lombok.Value;
 import lombok.With;
 import org.openrewrite.Incubating;
@@ -30,6 +31,8 @@
 import org.openrewrite.marker.ci.BuildEnvironment;
 import org.openrewrite.marker.ci.IncompleteGitConfigException;
 import org.openrewrite.marker.ci.JenkinsBuildEnvironment;
+import org.openrewrite.scm.CloneUrl;
+import org.openrewrite.scm.Scm;
 
 import java.io.File;
 import java.io.IOException;
@@ -45,9 +48,14 @@
 
 @Value
 @With
+@AllArgsConstructor
 public class GitProvenance implements Marker {
     UUID id;
 
+    /**
+     * The URL of the origin remote, not to be confused with the SCM origin
+     * which can be found under scmUrlComponents.getOrigin() which contains the base url to the SCM server
+     */
     @Nullable
     String origin;
 
@@ -67,14 +75,34 @@ public class GitProvenance implements Marker {
     @Incubating(since = "8.9.0")
     List<Committer> committers;
 
+    @Incubating(since = "8.33.0")
+    @Nullable
+    CloneUrl cloneUrl;
+
+    public GitProvenance(UUID id, @Nullable String origin, @Nullable String branch, @Nullable String change, @Nullable AutoCRLF autocrlf, @Nullable EOL eol, @Nullable List<Committer> committers) {
+        this.id = id;
+        this.origin = origin;
+        this.branch = branch;
+        this.change = change;
+        this.autocrlf = autocrlf;
+        this.eol = eol;
+        this.committers = committers;
+        cloneUrl = parseCloneUrl(origin);
+    }
+
     /**
      * Extract the organization name, including sub-organizations for git hosting services which support such a concept,
      * from the origin URL. Needs to be supplied with the
      *
      * @param baseUrl the portion of the URL which precedes the organization
      * @return the portion of the git origin URL which corresponds to the organization the git repository is organized under
+     * @deprecated use {@link #getCloneUrl().getOrganization()} instead }
      */
+    @Deprecated
     public @Nullable String getOrganizationName(String baseUrl) {
+        if (cloneUrl != null) {
+            return cloneUrl.getOrganization();
+        }
         if (origin == null) {
             return null;
         }
@@ -102,6 +130,9 @@ public class GitProvenance implements Marker {
      */
     @Deprecated
     public @Nullable String getOrganizationName() {
+        if (cloneUrl != null) {
+            return cloneUrl.getOrganization();
+        }
         if (origin == null) {
             return null;
         }
@@ -206,9 +237,10 @@ private static GitProvenance fromGitConfig(Repository repository, @Nullable Stri
         if (branch == null) {
             branch = resolveBranchFromGitConfig(repository);
         }
-        return new GitProvenance(randomId(), getOrigin(repository), branch, changeset,
+        String remoteOriginUrl = getRemoteOriginUrl(repository);
+        return new GitProvenance(randomId(), remoteOriginUrl, branch, changeset,
                 getAutocrlf(repository), getEOF(repository),
-                getCommitters(repository));
+                getCommitters(repository), parseCloneUrl(remoteOriginUrl));
     }
 
     static @Nullable String resolveBranchFromGitConfig(Repository repository) {
@@ -268,7 +300,7 @@ private static GitProvenance fromGitConfig(Repository repository, @Nullable Stri
         return branch;
     }
 
-    private static @Nullable String getOrigin(Repository repository) {
+    private static @Nullable String getRemoteOriginUrl(Repository repository) {
         Config storedConfig = repository.getConfig();
         String url = storedConfig.getString("remote", "origin", "url");
         if (url == null) {
@@ -354,6 +386,15 @@ private static String hideSensitiveInformation(String url) {
         return url;
     }
 
+    @Nullable
+    public static CloneUrl parseCloneUrl(@Nullable String cloneUrl) {
+        if (cloneUrl == null) {
+            return null;
+        }
+        Scm scm = Scm.findMatchingScm(cloneUrl);
+        return scm.parseCloneUrl(cloneUrl);
+    }
+
     public enum AutoCRLF {
         False,
         True,
@@ -373,4 +414,5 @@ public static class Committer {
         String email;
         NavigableMap<LocalDate, Integer> commitsByDay;
     }
+
 }

rewrite-core/src/main/java/org/openrewrite/scm/AzureDevOpsScm.java

@@ -0,0 +1,46 @@
+/*
+ * 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.scm;
+
+public class AzureDevOpsScm implements Scm {
+
+    @Override
+    public String getOrigin() {
+        return "dev.azure.com";
+    }
+
+    @Override
+    public String cleanHostAndPath(String url) {
+        UrlComponents uri = UrlComponents.parse(url);
+        String host = uri.getHost();
+        String path = uri.getPath();
+        if (uri.isSsh() && host.startsWith("ssh.")) {
+            host = host.substring(4);
+            path = path.replaceFirst("v3/", "");
+        } else {
+            path = path.replaceFirst("_git/", "");
+        }
+        String hostAndPath = host + "/" + path
+                .replaceFirst("\\.git$", "");
+        return hostAndPath.replaceFirst("/$", "");
+    }
+
+    @Override
+    public CloneUrl parseCloneUrl(String cloneUrl) {
+        CloneUrl parsed = Scm.super.parseCloneUrl(cloneUrl);
+        return new AzureDevopsCloneUrl(cloneUrl, getOrigin(), parsed.getPath());
+    }
+}

rewrite-core/src/main/java/org/openrewrite/scm/AzureDevopsCloneUrl.java

@@ -0,0 +1,40 @@
+/*
+ * 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.scm;
+
+import lombok.Value;
+
+@Value
+public class AzureDevopsCloneUrl implements CloneUrl {
+    String cloneUrl;
+    String origin;
+    String path;
+    String organization;
+    String project;
+    String repositoryName;
+
+    public AzureDevopsCloneUrl(String cloneUrl, String origin, String path) {
+        this.cloneUrl = cloneUrl;
+        this.origin = origin;
+        this.path = path;
+        if (!path.contains("/")) {
+            throw new IllegalArgumentException("Azure DevOps clone url path must contain organization, project and repository");
+        }
+        this.organization = path.substring(0, path.indexOf("/"));
+        this.project = path.substring(path.indexOf("/") + 1, path.lastIndexOf("/"));
+        this.repositoryName = path.substring(path.lastIndexOf("/") + 1);
+    }
+}

rewrite-core/src/main/java/org/openrewrite/scm/BitbucketServerScm.java

@@ -0,0 +1,40 @@
+/*
+ * 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.scm;
+
+import lombok.Getter;
+
+@Getter
+public class BitbucketServerScm implements Scm {
+    private final String origin;
+
+    public BitbucketServerScm(String origin) {
+        if (origin.startsWith("ssh://") || origin.startsWith("http://") || origin.startsWith("https://")) {
+            origin = cleanHostAndPath(origin);
+        }
+        this.origin = origin;
+    }
+
+    @Override
+    public String cleanHostAndPath(String url) {
+        UrlComponents uri = UrlComponents.parse(url);
+        String hostAndPath = uri.getHost() + uri.maybePort() + "/" + uri.getPath()
+                .replaceFirst("^/", "")
+                .replaceFirst("scm/", "")
+                .replaceFirst("\\.git$", "");
+        return hostAndPath.replaceFirst("/$", "");
+    }
+}

rewrite-core/src/main/java/org/openrewrite/scm/CloneUrl.java

@@ -0,0 +1,30 @@
+/*
+ * 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.scm;
+
+public interface CloneUrl {
+
+    String getCloneUrl();
+
+    String getOrigin();
+
+    String getPath();
+
+    String getOrganization();
+
+    String getRepositoryName();
+
+}

rewrite-core/src/main/java/org/openrewrite/scm/GitLabCloneUrl.java

@@ -0,0 +1,44 @@
+/*
+ * 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.scm;
+
+import lombok.Value;
+
+import java.util.Arrays;
+import java.util.List;
+
+@Value
+public class GitLabCloneUrl implements CloneUrl {
+    String cloneUrl;
+    String origin;
+    String path;
+    List<String> groups;
+    String organization;
+    String repositoryName;
+
+    public GitLabCloneUrl(String cloneUrl, String origin, String path) {
+        this.cloneUrl = cloneUrl;
+        this.origin = origin;
+        this.path = path;
+        if (!this.path.contains("/")) {
+            throw new IllegalArgumentException("GitLab path must contain 1 or more groups and a repository name");
+        }
+        String[] parts = this.path.split("/");
+        groups = Arrays.asList(parts).subList(0, parts.length - 1);
+        organization = String.join("/", groups);
+        repositoryName = parts[parts.length - 1];
+    }
+}

rewrite-core/src/main/java/org/openrewrite/scm/GitLabScm.java

@@ -0,0 +1,57 @@
+/*
+ * 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.scm;
+
+import lombok.Getter;
+
+@Getter
+public class GitLabScm implements Scm {
+    private final String origin;
+
+    /**
+     * Configure a GitLab SaaS SCM instance
+     */
+    public GitLabScm() {
+        this.origin = "gitlab.com";
+    }
+
+    /**
+     * Configure a self-hosted gitlab SCM and register with GitProvenance.registerScm(new GitLabScm(origin));
+     *
+     * @param origin the url and path pointing to your GitLab instance.
+     */
+    public GitLabScm(String origin) {
+        if (origin.startsWith("ssh://") || origin.startsWith("http://") || origin.startsWith("https://")) {
+            origin = cleanHostAndPath(origin);
+        }
+        this.origin = origin.replaceFirst("/$", "");
+    }
+
+    @Override
+    public String cleanHostAndPath(String url) {
+        UrlComponents uri = UrlComponents.parse(url);
+        String hostAndPath = uri.getHost() + uri.maybePort() + "/" + uri.getPath()
+                .replaceFirst("^/", "")
+                .replaceFirst("\\.git$", "");
+        return hostAndPath.replaceFirst("/$", "");
+    }
+
+    @Override
+    public CloneUrl parseCloneUrl(String cloneUrl) {
+        CloneUrl parsed = Scm.super.parseCloneUrl(cloneUrl);
+        return new GitLabCloneUrl(cloneUrl, getOrigin(), parsed.getPath());
+    }
+}