Notify Commit: Ignore ssh subdomain to allow matching azure devops git ssh urls for notify (#1758)

* Loosely match host, ignoring ssh. subdomain to make notifiy commit hook work with azure devops

* Remove import reformatting

https://github.com/jenkinsci/git-plugin/blob/master/CONTRIBUTING.adoc says:

> Code formatting in the git plugin varies between files. Try to maintain
> reasonable consistency with the existing files where feasible. Please
> don’t perform wholesale reformatting of a file without discussing
> with the current maintainers. New code should follow the SCM API code
> style guidelines.

The SCM API code style guidelines say:

https://github.com/jenkinsci/scm-api-plugin/blob/master/CONTRIBUTING.md#imports

For code in src/test:

> * imports of anything other than JUnit classes and Hamcrest matchers are banned.
> * static imports of anything other than JUnit classes and Hamcrest
>   matchers are strongly discouraged.
> * import static org.hamcrest.Matchers.*, import static org.junit.Assert.*
>   are expressly permitted. Any other static * imports are discouraged
>   unless code readability is significantly enhanced and the import is
>   restricted to a single class.

* Ignore /_git/ meta path of https url when matching

* Ignore versioning (as used in azure devops) in ssh path

---------

Co-authored-by: Christof Schöll <[email protected]>
Co-authored-by: Mark Waite <[email protected]>

Author: 3 people

src/main/java/hudson/plugins/git/GitStatus.java

@@ -208,14 +208,28 @@ public void generateResponse(StaplerRequest2 req, StaplerResponse2 rsp, Object n
      * @return true if left-hand side loosely matches right-hand side
      */
     public static boolean looselyMatches(URIish lhs, URIish rhs) {
-        return Objects.equals(lhs.getHost(),rhs.getHost())
+        return looselyMatchHost(lhs, rhs)
             && Objects.equals(normalizePath(lhs.getPath()), normalizePath(rhs.getPath()));
     }
 
+    /**
+     * Match hosts removing any "ssh." at the start of the subdomain.
+     * Some cloud providers prepend "ssh." in the host for ssh urls - while only allowing to send the https url (without ssh.) to the notify commit endpoint.
+     *
+     * Ignoring the "ssh" subdomain allows keeping loosely matching the url.
+     */
+    private static boolean looselyMatchHost(URIish lhs, URIish rhs) {
+        String lhsHost = StringUtils.removeStart(lhs.getHost(), "ssh.");
+        String rhsHost = StringUtils.removeStart(rhs.getHost(), "ssh.");
+        return Objects.equals(lhsHost, rhsHost);
+    }
+
     private static String normalizePath(String path) {
         if (path.startsWith("/"))   path=path.substring(1);
         if (path.endsWith("/"))     path=path.substring(0,path.length()-1);
         if (path.endsWith(".git"))  path=path.substring(0,path.length()-4);
+        if (path.matches("v\\d/.*"))   path=path.substring(3); //remove leading versioning used in azure devops (e.g. v3/...)
+        path = path.replace("/_git/", "/"); //ignore _git meta path in http urls as they are usually not in ssh urls
         return path;
     }
 

src/test/java/hudson/plugins/git/GitStatusTest.java

@@ -596,4 +596,20 @@ void testDoNotifyCommitWithAllowModeSha1() throws Exception {
         assertNotNull(lastBuild);
         assertEquals(1, lastBuild.getNumber());
     }
+
+    @Test
+    public void testDoNotifyCommitWithSshAzureDevopsPath() throws Exception { /* No parameters */
+        this.repoURL = "[email protected]:v3/myorg/PROJECT/reponame";
+        FreeStyleProject project = setupNotifyProject();
+        final String differingUrl = "https://[email protected]/myorg/PROJECT/_git/reponame";
+        this.gitStatus.doNotifyCommit(requestWithNoParameter, differingUrl, branch, sha1, notifyCommitApiToken);
+        assertEquals("URL: " + differingUrl
+                + " SHA1: " + sha1
+                + " Branches: " + branch, this.gitStatus.toString());
+
+        r.waitUntilNoActivity();
+        FreeStyleBuild lastBuild = project.getLastBuild();
+        assertNotNull(lastBuild);
+    }
+
 }