Transforming git url to http url while downloading commits from Jenki…

Tasks/JenkinsDownloadArtifactsV1/ArtifactDetails/CommitsDownloader.ts

@@ -53,12 +53,6 @@ export class CommitsDownloader extends ArtifactDetailsDownloaderBase {
     public static GetCommitMessagesFromCommits(commits: string): string[] {
         console.log(tl.loc("GetCommitMessages"));
 
-        // remove the extra comma at the end of the commit item
-        let index: number = commits.lastIndexOf(",");
-        if (index > -1) {
-            commits = commits.substring(0, index) + commits.substring(index + 1);
-        }
-
         let template = handlebars.compile(GetCommitMessagesTemplate);
         try {
             var result = template(JSON.parse(commits));
@@ -111,7 +105,9 @@ export class CommitsDownloader extends ArtifactDetailsDownloaderBase {
 
         this.jenkinsClient.DownloadJsonContent(commitsUrl, CommitTemplate, null).then((commitsResult) => {
             tl.debug(`Downloaded commits: ${commitsResult}`);
-            defer.resolve(commitsResult);
+
+            var commits: string = this.TransformCommits(commitsResult);
+            defer.resolve(commits);
         }, (error) => {
             defer.reject(error);
         });
@@ -128,7 +124,9 @@ export class CommitsDownloader extends ArtifactDetailsDownloaderBase {
         tl.debug(`Downloading commits from startIndex ${startIndex} and endIndex ${endIndex}`);
         this.jenkinsClient.DownloadJsonContent(commitsUrl, CommitsTemplate, {'buildParameter': buildParameter}).then((commitsResult) => {
             tl.debug(`Downloaded commits: ${commitsResult}`);
-            defer.resolve(commitsResult);
+
+            var commits: string = this.TransformCommits(commitsResult);
+            defer.resolve(commits);
         }, (error) => {
             defer.reject(error);
         });
@@ -161,4 +159,55 @@ export class CommitsDownloader extends ArtifactDetailsDownloaderBase {
 
         return fileName;
     }
+
+    private TransformCommits(commits: string): string {
+        if (!!commits) {
+
+            // remove the extra comma at the end of the commit item
+            let index: number = commits.lastIndexOf(",");
+            if (index > -1) {
+                commits = commits.substring(0, index) + commits.substring(index + 1);
+            }
+
+            try {
+                var commitMessages = JSON.parse(commits);
+
+                commitMessages.forEach((commit) => {
+                    tl.debug('Normalizing url' + commit.DisplayUri);
+                    commit.DisplayUri = this.ConvertGitProtocolUrlToHttpProtocol(commit.DisplayUri);
+                });
+
+                return JSON.stringify(commitMessages);
+
+            } catch (error) {
+                console.log(tl.loc("CannotParseCommits", commits, error));
+                throw error;
+            }
+        }
+
+        return '';
+    };
+
+    private ConvertGitProtocolUrlToHttpProtocol(commitUrl: string): string {
+        var result: string = '';
+        if (!!commitUrl) {
+            if (commitUrl.startsWith('git@')) {
+                tl.debug('repo url is a git protocol url');
+
+                if (commitUrl.startsWith('[email protected]')) {
+                    result= commitUrl.replace('[email protected]:', 'https://gitlab.com/').replace('.git/', '/');
+                }
+                else if (commitUrl.startsWith('[email protected]')) {
+                    result = commitUrl.replace('[email protected]:', 'https://github.com/').replace('.git/', '/');
+                }                
+            }
+            else if (commitUrl.startsWith('http')) {
+                // if its http return the url as is.
+                result = commitUrl;
+            }
+        }
+
+        tl.debug(`Translated url ${commitUrl} to ${result}`);
+        return result;
+    }
 }

Tasks/JenkinsDownloadArtifactsV1/Strings/resources.resjson/en-US/resources.resjson

@@ -66,6 +66,7 @@
   "loc.messages.SuccessfullyDownloadedCommitsAndWorkItems": "Commits and work items downloaded successfully",
   "loc.messages.CommitsAndWorkItemsDownloadFailed": "Downloading commits and work items from Jenkins failed with an error: %s",
   "loc.messages.CannotFindBuilds": "Cannot find builds",
+  "loc.messages.CannotParseCommits": "Cannot parse commit objects %s. Error: %s",
   "loc.messages.JenkinsNoCommitsToFetch": "Start and end build Ids are same. Commits and work items will not be downloaded.",
   "loc.messages.InvalidJenkinsBuildNumber": "Cannot parse the Jenkins Build number.",
   "loc.messages.InvalidJenkinsStartBuildNumber": "The specified Jenkins start build number %s is not valid.",

Tasks/JenkinsDownloadArtifactsV1/Tests/L0.ts

@@ -103,6 +103,82 @@ describe('JenkinsDownloadArtifacts L0 Suite', function () {
         }
     });
 
+    it('Validate github commit url', (done) => {
+
+        const tp: string = path.join(__dirname, 'L0ValidateGitHubCommitUrl.js');
+        const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
+
+        try {
+            tr.run();
+
+            assert(tr.stdout.indexOf('Translated url [email protected]:user/TestRepo.git/commit/3cbfc14e3f482a25e5122323f3273b89677d9875 to https://github.com/user/TestRepo/commit/3cbfc14e3f482a25e5122323f3273b89677d9875') !== -1, tr.stdout);
+
+            done();
+        } catch(err) {
+            console.log(tr.stdout);
+            console.log(tr.stderr);
+            console.log(err);
+            done(err);
+        }
+    });
+
+    it('Validate gitlab commit url', (done) => {
+
+        const tp: string = path.join(__dirname, 'L0ValidateGitLabCommitUrl.js');
+        const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
+
+        try {
+            tr.run();
+
+            assert(tr.stdout.indexOf('Translated url [email protected]:admin/projectk.git/commit/3cbfc14e3f482a25e5122323f3273b89677d9875 to https://gitlab.com/admin/projectk/commit/3cbfc14e3f482a25e5122323f3273b89677d9875') !== -1, tr.stdout);
+
+            done();
+        } catch(err) {
+            console.log(tr.stdout);
+            console.log(tr.stderr);
+            console.log(err);
+            done(err);
+        }
+    });
+
+    it('Validate http commit url', (done) => {
+
+        const tp: string = path.join(__dirname, 'L0ValidateHttpCommitUrl.js');
+        const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
+
+        try {
+            tr.run();
+
+            assert(tr.stdout.indexOf('Translated url https://github.com/user/TestRepo/commit/3cbfc14e3f482a25e5122323f3273b89677d9875 to https://github.com/user/TestRepo/commit/3cbfc14e3f482a25e5122323f3273b89677d9875') !== -1, tr.stdout);
+
+            done();
+        } catch(err) {
+            console.log(tr.stdout);
+            console.log(tr.stderr);
+            console.log(err);
+            done(err);
+        }
+    });
+
+    it('Validate invalid commit url', (done) => {
+
+        const tp: string = path.join(__dirname, 'L0ValidateInvalidCommitUrl.js');
+        const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
+
+        try {
+            tr.run();
+
+            assert(tr.stdout.indexOf('Translated url ssh://user@server/project.git/commit/3cbfc14e3f482a25e5122323f3273b89677d9875 to') !== -1, tr.stdout);
+
+            done();
+        } catch(err) {
+            console.log(tr.stdout);
+            console.log(tr.stderr);
+            console.log(err);
+            done(err);
+        }
+    });
+
     it('Should download commits from build range', (done) => {
         const tp: string = path.join(__dirname, 'L0DownloadCommitsFromBuildRange.js');
         const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);

Tasks/JenkinsDownloadArtifactsV1/Tests/L0ValidateGitHubCommitUrl.ts

@@ -0,0 +1,41 @@
+import ma = require('vsts-task-lib/mock-answer');
+import tmrm = require('vsts-task-lib/mock-run');
+import path = require('path');
+import mockTask = require('vsts-task-lib/mock-task');
+import helper = require("./JenkinsTestHelper");
+
+const taskPath = path.join(__dirname, '..', 'jenkinsdownloadartifacts.js');
+const tr: tmrm.TaskMockRunner = new tmrm.TaskMockRunner(taskPath);
+
+tr.setInput("serverEndpoint", "ID1");
+tr.setInput("jobName", "myfreestyleproject")
+tr.setInput("saveTo", "jenkinsArtifacts");
+tr.setInput("filePath", "/");
+tr.setInput("jenkinsBuild", "BuildNumber");
+tr.setInput("jenkinsBuildNumber", "20");
+tr.setInput("itemPattern", "archive/**");
+tr.setInput("downloadCommitsAndWorkItems", "true");
+tr.setInput("artifactDetailsFileNameSuffix", "alias_v1.json");
+
+process.env['ENDPOINT_URL_ID1'] = 'http://url';
+process.env['ENDPOINT_AUTH_PARAMETER_connection1_username'] = 'dummyusername';
+process.env['ENDPOINT_AUTH_PARAMETER_connection1_password'] = 'dummypassword';
+process.env['ENDPOINT_DATA_ID1_acceptUntrustedCerts'] = 'true';
+
+helper.RegisterArtifactEngineMock(tr);
+helper.RegisterHttpClientMock(tr, (url: string) => {
+    if (url === "http://url/job/myfreestyleproject//api/json") {
+        return helper.GetSuccessExpectedResult('{}');
+    }
+
+    if (url === "http://url//job/myfreestyleproject//20/api/json?tree=artifacts[*]") {
+        return helper.GetSuccessExpectedResult('{ "_class": "hudson.model.FreeStyleBuild", "artifacts": [ "abc" ] }');
+    }
+
+    var commitResult = '{"actions":[{"remoteUrls":["[email protected]:user/TestRepo.git"]}],"changeSet":{"items": [{"commitId": "3cbfc14e3f482a25e5122323f3273b89677d9875", "author": { "fullName": "user" }, "msg": "test3", "date": "2018-07-07 12:18:48 +0530" }], "kind": "git"}}'
+    if (url == "http://url/job/myfreestyleproject//20/api/json?tree=number,result,actions[remoteUrls],changeSet[kind,items[commitId,date,msg,author[fullName]]]") {
+        return helper.GetSuccessExpectedResult(commitResult);
+    }
+});
+
+tr.run();

Tasks/JenkinsDownloadArtifactsV1/Tests/L0ValidateGitLabCommitUrl.ts

@@ -0,0 +1,41 @@
+import ma = require('vsts-task-lib/mock-answer');
+import tmrm = require('vsts-task-lib/mock-run');
+import path = require('path');
+import mockTask = require('vsts-task-lib/mock-task');
+import helper = require("./JenkinsTestHelper");
+
+const taskPath = path.join(__dirname, '..', 'jenkinsdownloadartifacts.js');
+const tr: tmrm.TaskMockRunner = new tmrm.TaskMockRunner(taskPath);
+
+tr.setInput("serverEndpoint", "ID1");
+tr.setInput("jobName", "myfreestyleproject")
+tr.setInput("saveTo", "jenkinsArtifacts");
+tr.setInput("filePath", "/");
+tr.setInput("jenkinsBuild", "BuildNumber");
+tr.setInput("jenkinsBuildNumber", "20");
+tr.setInput("itemPattern", "archive/**");
+tr.setInput("downloadCommitsAndWorkItems", "true");
+tr.setInput("artifactDetailsFileNameSuffix", "alias_v1.json");
+
+process.env['ENDPOINT_URL_ID1'] = 'http://url';
+process.env['ENDPOINT_AUTH_PARAMETER_connection1_username'] = 'dummyusername';
+process.env['ENDPOINT_AUTH_PARAMETER_connection1_password'] = 'dummypassword';
+process.env['ENDPOINT_DATA_ID1_acceptUntrustedCerts'] = 'true';
+
+helper.RegisterArtifactEngineMock(tr);
+helper.RegisterHttpClientMock(tr, (url: string) => {
+    if (url === "http://url/job/myfreestyleproject//api/json") {
+        return helper.GetSuccessExpectedResult('{}');
+    }
+
+    if (url === "http://url//job/myfreestyleproject//20/api/json?tree=artifacts[*]") {
+        return helper.GetSuccessExpectedResult('{ "_class": "hudson.model.FreeStyleBuild", "artifacts": [ "abc" ] }');
+    }
+
+    var commitResult = '{"actions":[{"remoteUrls":["[email protected]:admin/projectk.git"]}],"changeSet":{"items": [{"commitId": "3cbfc14e3f482a25e5122323f3273b89677d9875", "author": { "fullName": "user" }, "msg": "test3", "date": "2018-07-07 12:18:48 +0530" }], "kind": "git"}}'
+    if (url == "http://url/job/myfreestyleproject//20/api/json?tree=number,result,actions[remoteUrls],changeSet[kind,items[commitId,date,msg,author[fullName]]]") {
+        return helper.GetSuccessExpectedResult(commitResult);
+    }
+});
+
+tr.run();

Tasks/JenkinsDownloadArtifactsV1/Tests/L0ValidateHttpCommitUrl.ts

@@ -0,0 +1,41 @@
+import ma = require('vsts-task-lib/mock-answer');
+import tmrm = require('vsts-task-lib/mock-run');
+import path = require('path');
+import mockTask = require('vsts-task-lib/mock-task');
+import helper = require("./JenkinsTestHelper");
+
+const taskPath = path.join(__dirname, '..', 'jenkinsdownloadartifacts.js');
+const tr: tmrm.TaskMockRunner = new tmrm.TaskMockRunner(taskPath);
+
+tr.setInput("serverEndpoint", "ID1");
+tr.setInput("jobName", "myfreestyleproject")
+tr.setInput("saveTo", "jenkinsArtifacts");
+tr.setInput("filePath", "/");
+tr.setInput("jenkinsBuild", "BuildNumber");
+tr.setInput("jenkinsBuildNumber", "20");
+tr.setInput("itemPattern", "archive/**");
+tr.setInput("downloadCommitsAndWorkItems", "true");
+tr.setInput("artifactDetailsFileNameSuffix", "alias_v1.json");
+
+process.env['ENDPOINT_URL_ID1'] = 'http://url';
+process.env['ENDPOINT_AUTH_PARAMETER_connection1_username'] = 'dummyusername';
+process.env['ENDPOINT_AUTH_PARAMETER_connection1_password'] = 'dummypassword';
+process.env['ENDPOINT_DATA_ID1_acceptUntrustedCerts'] = 'true';
+
+helper.RegisterArtifactEngineMock(tr);
+helper.RegisterHttpClientMock(tr, (url: string) => {
+    if (url === "http://url/job/myfreestyleproject//api/json") {
+        return helper.GetSuccessExpectedResult('{}');
+    }
+
+    if (url === "http://url//job/myfreestyleproject//20/api/json?tree=artifacts[*]") {
+        return helper.GetSuccessExpectedResult('{ "_class": "hudson.model.FreeStyleBuild", "artifacts": [ "abc" ] }');
+    }
+
+    var commitResult = '{"actions":[{"remoteUrls":["https://github.com/user/TestRepo"]}],"changeSet":{"items": [{"commitId": "3cbfc14e3f482a25e5122323f3273b89677d9875", "author": { "fullName": "user" }, "msg": "test3", "date": "2018-07-07 12:18:48 +0530" }], "kind": "git"}}'
+    if (url == "http://url/job/myfreestyleproject//20/api/json?tree=number,result,actions[remoteUrls],changeSet[kind,items[commitId,date,msg,author[fullName]]]") {
+        return helper.GetSuccessExpectedResult(commitResult);
+    }
+});
+
+tr.run();

Tasks/JenkinsDownloadArtifactsV1/Tests/L0ValidateInvalidCommitUrl.ts

@@ -0,0 +1,41 @@
+import ma = require('vsts-task-lib/mock-answer');
+import tmrm = require('vsts-task-lib/mock-run');
+import path = require('path');
+import mockTask = require('vsts-task-lib/mock-task');
+import helper = require("./JenkinsTestHelper");
+
+const taskPath = path.join(__dirname, '..', 'jenkinsdownloadartifacts.js');
+const tr: tmrm.TaskMockRunner = new tmrm.TaskMockRunner(taskPath);
+
+tr.setInput("serverEndpoint", "ID1");
+tr.setInput("jobName", "myfreestyleproject")
+tr.setInput("saveTo", "jenkinsArtifacts");
+tr.setInput("filePath", "/");
+tr.setInput("jenkinsBuild", "BuildNumber");
+tr.setInput("jenkinsBuildNumber", "20");
+tr.setInput("itemPattern", "archive/**");
+tr.setInput("downloadCommitsAndWorkItems", "true");
+tr.setInput("artifactDetailsFileNameSuffix", "alias_v1.json");
+
+process.env['ENDPOINT_URL_ID1'] = 'http://url';
+process.env['ENDPOINT_AUTH_PARAMETER_connection1_username'] = 'dummyusername';
+process.env['ENDPOINT_AUTH_PARAMETER_connection1_password'] = 'dummypassword';
+process.env['ENDPOINT_DATA_ID1_acceptUntrustedCerts'] = 'true';
+
+helper.RegisterArtifactEngineMock(tr);
+helper.RegisterHttpClientMock(tr, (url: string) => {
+    if (url === "http://url/job/myfreestyleproject//api/json") {
+        return helper.GetSuccessExpectedResult('{}');
+    }
+
+    if (url === "http://url//job/myfreestyleproject//20/api/json?tree=artifacts[*]") {
+        return helper.GetSuccessExpectedResult('{ "_class": "hudson.model.FreeStyleBuild", "artifacts": [ "abc" ] }');
+    }
+
+    var commitResult = '{"actions":[{"remoteUrls":["ssh://user@server/project.git"]}],"changeSet":{"items": [{"commitId": "3cbfc14e3f482a25e5122323f3273b89677d9875", "author": { "fullName": "user" }, "msg": "test3", "date": "2018-07-07 12:18:48 +0530" }], "kind": "git"}}'
+    if (url == "http://url/job/myfreestyleproject//20/api/json?tree=number,result,actions[remoteUrls],changeSet[kind,items[commitId,date,msg,author[fullName]]]") {
+        return helper.GetSuccessExpectedResult(commitResult);
+    }
+});
+
+tr.run();

Tasks/JenkinsDownloadArtifactsV1/task.json

@@ -17,7 +17,7 @@
     "demands": [],
     "version": {
         "Major": 1,
-        "Minor": 137,
+        "Minor": 138,
         "Patch": 0
     },
     "groups": [
@@ -304,6 +304,7 @@
         "SuccessfullyDownloadedCommitsAndWorkItems": "Commits and work items downloaded successfully",
         "CommitsAndWorkItemsDownloadFailed": "Downloading commits and work items from Jenkins failed with an error: %s",
         "CannotFindBuilds": "Cannot find builds",
+        "CannotParseCommits": "Cannot parse commit objects %s. Error: %s",
         "JenkinsNoCommitsToFetch": "Start and end build Ids are same. Commits and work items will not be downloaded.",
         "InvalidJenkinsBuildNumber": "Cannot parse the Jenkins Build number.",
         "InvalidJenkinsStartBuildNumber": "The specified Jenkins start build number %s is not valid.",

Tasks/JenkinsDownloadArtifactsV1/task.loc.json

@@ -17,7 +17,7 @@
   "demands": [],
   "version": {
     "Major": 1,
-    "Minor": 137,
+    "Minor": 138,
     "Patch": 0
   },
   "groups": [
@@ -304,6 +304,7 @@
     "SuccessfullyDownloadedCommitsAndWorkItems": "ms-resource:loc.messages.SuccessfullyDownloadedCommitsAndWorkItems",
     "CommitsAndWorkItemsDownloadFailed": "ms-resource:loc.messages.CommitsAndWorkItemsDownloadFailed",
     "CannotFindBuilds": "ms-resource:loc.messages.CannotFindBuilds",
+    "CannotParseCommits": "ms-resource:loc.messages.CannotParseCommits",
     "JenkinsNoCommitsToFetch": "ms-resource:loc.messages.JenkinsNoCommitsToFetch",
     "InvalidJenkinsBuildNumber": "ms-resource:loc.messages.InvalidJenkinsBuildNumber",
     "InvalidJenkinsStartBuildNumber": "ms-resource:loc.messages.InvalidJenkinsStartBuildNumber",