Remove trailing forward slash from store endpoint (#21475)

* Remove trailing forward slash from store endpoint

* Update title

---------

Co-authored-by: Maryanne Gichohi <mgichohi@microsoft.com>

Author: MaryanneNjeri

Tasks/AzureAppConfigurationExportV10/Tests/L0.ts

@@ -2,7 +2,7 @@ import * as assert from 'assert';
 import path = require('path');
 import { MockTestRunner } from 'azure-pipelines-task-lib/mock-test';
 
-describe("Pull configuration settings test", function(){
+describe("Export task configuration settings test", function(){
     this.timeout(30000);
 
     before(async ()=> {
@@ -248,4 +248,18 @@ describe("Pull configuration settings test", function(){
             assert.strictEqual(tr.errorIssues[0], "loc_mock_InvalidSecretUrl");
         },tr);
     });
+
+    it("Trim any trailing forward slash in a store endpoint", async()=> {
+        const taskPath = path.join(__dirname, "downloadKVWithInvalidStoreEndpoint.js");
+        const tr = new MockTestRunner(taskPath);
+
+        await tr.runAsync();
+
+        runValidations(()=>{ 
+            assert.strictEqual(tr.succeeded, true, "should have succeeded");
+            assert.strictEqual(tr.warningIssues.length, 0, "should have no warnings");
+            assert.strictEqual(tr.errorIssues.length, 0, "should have no errors");
+            assert.ok(tr.stdout.indexOf("loc_mock_AppConfigurationEndpointTitle https://Test.azconfig.io") >= 0, "App Configuration Endpoint: https://Test.azconfig.io");
+        },tr);
+    });
 })

Tasks/AzureAppConfigurationExportV10/Tests/downloadKVWithInvalidStoreEndpoint.ts

@@ -0,0 +1,16 @@
+import { TaskMockRunner } from "azure-pipelines-task-lib/mock-run";
+import * as path from "path";
+
+let taskPath = path.join(__dirname, "..", "index.js");
+let taskRunner:TaskMockRunner = new TaskMockRunner(taskPath);
+
+taskRunner.setInput("AppConfigurationEndpoint", "https://Test.azconfig.io/");
+taskRunner.setInput("selectionMode", "Default");
+taskRunner.setInput("keyFilter", "*");
+taskRunner.setInput("ConnectedServiceName","AzureRMSpn");
+
+taskRunner.registerMock('azure-pipelines-task-lib/toolrunner', require('azure-pipelines-task-lib/mock-toolrunner'));
+taskRunner.registerMock('@azure/app-configuration', require('./mock_node_modules/app-configuration/appConfigurationClient'));
+taskRunner.registerMock('@azure/keyvault-secrets', require('./mock_node_modules/keyvault-secrets/secretClient'));
+
+taskRunner.run();

Tasks/AzureAppConfigurationExportV10/task.json

@@ -9,7 +9,7 @@
     "author": "Microsoft Corporation",
     "version": {
         "Major": 10,
-        "Minor": 264,
+        "Minor": 266,
         "Patch": 0
     },
     "instanceNameFormat": "Azure App Configuration",

Tasks/AzureAppConfigurationExportV10/task.loc.json

@@ -9,7 +9,7 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 10,
-    "Minor": 264,
+    "Minor": 266,
     "Patch": 0
   },
   "instanceNameFormat": "ms-resource:loc.instanceNameFormat",

Tasks/AzureAppConfigurationExportV10/taskParameter.ts

@@ -35,7 +35,7 @@ export class TaskParameters {
 
         taskParameters.selectionMode = selectionMode == Default ? SelectionMode.Default : SelectionMode.Snapshot;
         try {
-            taskParameters.configStoreUrl = tl.getInput("AppConfigurationEndpoint", true);
+            taskParameters.configStoreUrl = this.trimTrailingSlash(tl.getInput("AppConfigurationEndpoint", true));
             taskParameters.keyFilter = tl.getInput("KeyFilter", taskParameters.selectionMode == SelectionMode.Default);
             taskParameters.snapshotName = tl.getInput("SnapshotName", taskParameters.selectionMode == SelectionMode.Snapshot);
         }
@@ -75,4 +75,11 @@ export class TaskParameters {
 
         return taskParameters;
     }
+
+    private static trimTrailingSlash(endpoint: string): string {
+        if (endpoint.endsWith("/")) {
+            return endpoint.slice(0,-1);
+        }
+        return endpoint;
+    }
 }

Tasks/AzureAppConfigurationImportV10/Tests/L0.ts

@@ -2,7 +2,7 @@ import * as assert from 'assert';
 import * as path from "path";
 import { MockTestRunner } from 'azure-pipelines-task-lib/mock-test';
 
-describe("Push task test", function () {
+describe("Import task test", function () {
     this.timeout(30000);
 
     before(async () => {
@@ -191,4 +191,18 @@ describe("Push task test", function () {
             assert.strictEqual(testRunner.errorIssues[0], "loc_mock_InvalidTypeInTags");
         }, testRunner);
     });
+
+    it("Trim any trailing forward slash in store endpoint", async ()=> {
+        const taskPath = path.join(__dirname, "setKeyValueWithInvalidEndpoint.js");
+        const testRunner = new MockTestRunner(taskPath);
+
+        await testRunner.runAsync();
+
+        runValidations(() => {
+            assert.strictEqual(testRunner.succeeded, true, "should have succeeded");
+            assert.strictEqual(testRunner.errorIssues.length, 0, "should have no errors");
+            assert.strictEqual(testRunner.warningIssues.length, 0, "should have no warnings");
+            assert.ok(testRunner.stdout.indexOf("loc_mock_AppConfigurationEndpointTitle https://Test.azconfig.io") > 0, "should successfully trim any trailing forward slash");
+        }, testRunner);
+    })
 });

Tasks/AzureAppConfigurationImportV10/Tests/setKeyValueWithInvalidEndpoint.ts

@@ -0,0 +1,19 @@
+import * as path from "path";
+import { TaskMockRunner } from "azure-pipelines-task-lib/mock-run";
+
+const taskPath = path.join(__dirname, "..", "index.js");
+const taskRunner:TaskMockRunner = new TaskMockRunner(taskPath);
+
+const configurationFile: string = path.join(__dirname, 'sourceFiles/validConfigFile.json');
+
+taskRunner.setInput("AppConfigurationEndpoint", "https://Test.azconfig.io/");
+taskRunner.setInput("ConfigurationFile", `${configurationFile}`);
+taskRunner.setInput("UseFilePathExtension", "true");
+taskRunner.setInput("Strict", "false");
+taskRunner.setInput("Separator", ":");
+taskRunner.setInput("ConnectedServiceName","AzureRMSpn");
+
+taskRunner.registerMock('azure-pipelines-task-lib/toolrunner', require('azure-pipelines-task-lib/mock-toolrunner'));
+taskRunner.registerMock('@azure/app-configuration', require('./mock_node_modules/app-configuration/appConfigurationClient'));
+
+taskRunner.run();

Tasks/AzureAppConfigurationImportV10/task.json

@@ -9,7 +9,7 @@
     "author": "Microsoft Corporation",
     "version": {
         "Major": 10,
-        "Minor": 265,
+        "Minor": 266,
         "Patch": 0
     },
     "instanceNameFormat": "Azure App Configuration",

Tasks/AzureAppConfigurationImportV10/task.loc.json

@@ -9,7 +9,7 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 10,
-    "Minor": 265,
+    "Minor": 266,
     "Patch": 0
   },
   "instanceNameFormat": "ms-resource:loc.instanceNameFormat",

Tasks/AzureAppConfigurationImportV10/taskParameters.ts

@@ -43,7 +43,7 @@ export class TaskParameters {
         taskParameters.profile = profile;
         taskParameters.useFilePathExtension = tl.getBoolInput("UseFilePathExtension", false);
         try {
-            taskParameters.configStoreUrl = tl.getInput("AppConfigurationEndpoint", true);
+            taskParameters.configStoreUrl = this.trimTrailingSlash(tl.getInput("AppConfigurationEndpoint", true));
             taskParameters.strict = tl.getBoolInput("Strict", true);
             connectedService = tl.getInput("ConnectedServiceName", true);
             taskParameters.filePath = tl.getPathInput("ConfigurationFile", true);
@@ -116,4 +116,11 @@ export class TaskParameters {
 
         return taskParameters;
     }
+
+    private static trimTrailingSlash(endpoint: string): string {
+        if (endpoint.endsWith("/")) {
+            return endpoint.slice(0,-1)
+        }
+        return endpoint;
+    }
 }