Removed the alias for chartNameForACR and chartPathForACR and added unit tests. (#13116)

sonayak · web-flow · commit 376a6b4a8ee7 · 2020-06-13T12:41:15.000+05:30
* removing aliases for help chart save command

* added unit tests for helm chart save command

* addressing PR comments
diff --git a/Tasks/HelmDeployV0/Tests/L0.ts b/Tasks/HelmDeployV0/Tests/L0.ts
@@ -191,5 +191,45 @@ describe("HelmDeployV0 Suite", function () {
         assert(tr.stdout.indexOf(`Successfully packaged chart and saved it to: ${shared.testDestinationPath}/testChartName.tgz`) !=-1 , "Chart should have been successfully packaged");
         assert(tr.succeeded, "task should have succeeded");
         done();
-    });    
+    });
+    
+    it("Run successfully with Helm save command (version 3)", function (done: MochaDone) {
+        const tp = path.join(__dirname, "TestSetup.js");
+        const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
+        process.env[shared.TestEnvVars.command] = shared.Commands.save;
+        process.env[shared.TestEnvVars.connectionType] = shared.ConnectionTypes.None;
+        process.env[shared.TestEnvVars.chartPathForACR] = shared.testChartPathForACR;
+        process.env[shared.TestEnvVars.chartNameForACR] = shared.testChartNameForACR;
+        process.env[shared.TestEnvVars.azureSubscriptionEndpointForACR] = shared.testAzureSubscriptionEndpointForACR;
+        process.env[shared.TestEnvVars.azureResourceGroupForACR] = shared.testAzureResourceGroupForACR;
+        process.env[shared.TestEnvVars.azureContainerRegistry] = shared.testAzureContainerRegistry;
+        process.env[shared.TestEnvVars.failOnStderr] = "false";
+        process.env[shared.isHelmV3] = "true";
+
+        tr.run();
+        assert(tr.stdout.indexOf("Successfully saved the helm chart to local registry cache.") != -1, "Chart should have been successfully saved to local registry cache.");
+        assert(tr.stdout.indexOf(`Successfully logged in to  ${process.env[shared.TestEnvVars.azureContainerRegistry]}.`) != -1, "Azure container registry login should have been successful.");
+        assert(tr.stdout.indexOf("Successfully pushed to the chart to container registry.") != -1, "Chart should have been successfully pushed to container registry.");
+        assert(tr.stdout.indexOf("Successfully removed the chart from local cache.") != -1, "Chart should have been successfully removed from local cache.");
+        assert(tr.succeeded, "task should have succeeded");
+        done();
+    });
+
+    it("Helm same should fail (version 2)", function (done: MochaDone) {
+        const tp = path.join(__dirname, "TestSetup.js");
+        const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
+        process.env[shared.TestEnvVars.command] = shared.Commands.save;
+        process.env[shared.TestEnvVars.connectionType] = shared.ConnectionTypes.None;
+        process.env[shared.TestEnvVars.chartPathForACR] = shared.testChartPathForACR;
+        process.env[shared.TestEnvVars.chartNameForACR] = shared.testChartNameForACR;
+        process.env[shared.TestEnvVars.azureSubscriptionEndpointForACR] = shared.testAzureSubscriptionEndpointForACR;
+        process.env[shared.TestEnvVars.azureResourceGroupForACR] = shared.testAzureResourceGroupForACR;
+        process.env[shared.TestEnvVars.azureContainerRegistry] = shared.testAzureContainerRegistry;
+        process.env[shared.TestEnvVars.failOnStderr] = "false";
+
+        tr.run();
+        assert(tr.failed, "task should have failed");
+        assert(tr.stdout.indexOf("loc_mock_SaveSupportedInHelmsV3Only") != -1, "Chart save should have failed when helm version is not 3.");
+        done();
+    })
 });
diff --git a/Tasks/HelmDeployV0/Tests/TestSetup.ts b/Tasks/HelmDeployV0/Tests/TestSetup.ts
@@ -268,6 +268,30 @@ a.exec[kubectlClusterInfo] = {
     "stdout": `Kubernetes master is running at https://shigupt-cluster-dns-7489360e.hcp.southindia.azmk8s.io:443 \nhealthmodel-replicaset-service is running at https://shigupt-cluster-dns-7489360e.hcp.southindia.azmk8s.io:443/api/v1/namespaces/kube-system/services/healthmodel-replicaset-service/proxy \nCoreDNS is running at https://shigupt-cluster-dns-7489360e.hcp.southindia.azmk8s.io:443/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy \nkubernetes-dashboard is running at https://shigupt-cluster-dns-7489360e.hcp.southindia.azmk8s.io:443/api/v1/namespaces/kube-system/services/kubernetes-dashboard/proxy \nMetrics-server is running at https://shigupt-cluster-dns-7489360e.hcp.southindia.azmk8s.io:443/api/v1/namespaces/kube-system/services/https:metrics-server:/proxy\n\nTo further debug and diagnose cluster problems, use "kubectl cluster-info dump".\n`
 }
 
+const helmSaveCommand = `helm chart save ${process.env[shared.TestEnvVars.chartPathForACR]} ${process.env[shared.TestEnvVars.azureContainerRegistry]}/helm/${process.env[shared.TestEnvVars.chartNameForACR]}`;
+a.exec[helmSaveCommand] = {
+    "code": 0,
+    "stdout": `ref:    ${process.env[shared.TestEnvVars.azureContainerRegistry]}/helm/${process.env[shared.TestEnvVars.chartNameForACR]}:0.1.0 \n Successfully saved the helm chart to local registry cache.`
+}
+
+const helmRegistryLoginCommand = `helm registry login ${process.env[shared.TestEnvVars.azureContainerRegistry]} --username --password`;
+a.exec[helmRegistryLoginCommand] = {
+    "code": 0,
+    "stdout": `Successfully logged in to  ${process.env[shared.TestEnvVars.azureContainerRegistry]}.`
+};
+
+const helmChartPushCommand = `helm chart push ${process.env[shared.TestEnvVars.azureContainerRegistry]}/helm/${process.env[shared.TestEnvVars.chartNameForACR]}:0.1.0`;
+a.exec[helmChartPushCommand] = {
+    "code": 0,
+    "stdout": "Successfully pushed to the chart to container registry."
+}
+
+const helmChartRemoveCommand = `helm chart remove ${process.env[shared.TestEnvVars.azureContainerRegistry]}/helm/${process.env[shared.TestEnvVars.chartNameForACR]}:0.1.0`;
+a.exec[helmChartRemoveCommand] = {
+    "code": 0,
+    "stdout": "Successfully removed the chart from local cache."
+}
+
 tr.setAnswers(<any>a);
 tr.registerMock("azure-pipelines-task-lib/toolrunner", require("azure-pipelines-task-lib/mock-toolrunner"));
 
diff --git a/Tasks/HelmDeployV0/Tests/TestShared.ts b/Tasks/HelmDeployV0/Tests/TestShared.ts
@@ -66,6 +66,12 @@ export const testReleaseName = "testReleaseName";
 export const isHelmV3 = "__isHelmV3__";
 export const testNamespace = "testNamespace";
 export const testDestinationPath = "testDestinationPath";
+export const testChartNameForACR = "testChartNameForACR";
+export const testChartPathForACR = "test/testChartPathForACR";
+export const testAzureResourceGroupForACR = "test-rg";
+export const testAzureSubscriptionEndpointForACR = "RMTest";
+export const testAzureContainerRegistry = "sonayak.azurecr.io";
+
 /**
  * Formats the given path to be appropriate for the operating system.
  * @param canonicalPath A non-rooted path using a forward slash (/) as a directory separator.
diff --git a/Tasks/HelmDeployV0/task.json b/Tasks/HelmDeployV0/task.json
@@ -14,7 +14,7 @@
     "version": {
         "Major": 0,
         "Minor": 171,
-        "Patch": 2
+        "Patch": 3
     },
     "demands": [],
     "groups": [
@@ -436,9 +436,6 @@
         },
         {
             "name": "chartNameForACR",
-            "aliases": [
-                "chartName"
-            ],
             "label": "Chart Name For Azure Container Registry",
             "type": "string",
             "helpMarkDown": "Chart name with which the chart will be stored in Azure Container Registry.",
@@ -449,9 +446,6 @@
         },
         {
             "name": "chartPathForACR",
-            "aliases": [
-                "chartPath"
-            ],
             "label": "Chart Path for Azure Container Registry",
             "type": "filePath",
             "helpMarkDown": "Path to the chart directory.",
diff --git a/Tasks/HelmDeployV0/task.loc.json b/Tasks/HelmDeployV0/task.loc.json
@@ -14,7 +14,7 @@
   "version": {
     "Major": 0,
     "Minor": 171,
-    "Patch": 2
+    "Patch": 3
   },
   "demands": [],
   "groups": [
@@ -436,9 +436,6 @@
     },
     {
       "name": "chartNameForACR",
-      "aliases": [
-        "chartName"
-      ],
       "label": "ms-resource:loc.input.label.chartNameForACR",
       "type": "string",
       "helpMarkDown": "ms-resource:loc.input.help.chartNameForACR",
@@ -449,9 +446,6 @@
     },
     {
       "name": "chartPathForACR",
-      "aliases": [
-        "chartPath"
-      ],
       "label": "ms-resource:loc.input.label.chartPathForACR",
       "type": "filePath",
       "helpMarkDown": "ms-resource:loc.input.help.chartPathForACR",
