Added Version Installer and for Kubernetes Task (#6058) (#6078)

jikuma · web-flow · commit 8f4fe0189bfa · 2017-12-20T19:37:30.000+05:30
* Added Version Installer and for Kubernetes Task (#6058) * Added Version Installer and for Kubernetes Task * kubectl changes * fix invalid version * handle back compat * update task version
diff --git a/Tasks/Common/utility-common/downloadutility.ts b/Tasks/Common/utility-common/downloadutility.ts
@@ -6,14 +6,21 @@ import * as tl from "vsts-task-lib/task";
 
 export async function download(url: string, downloadPath: string): Promise<void> {
     var file = fs.createWriteStream(downloadPath);
-    await new Promise((resolve, reject) => {
+    return new Promise<void>((resolve, reject) => {
         var req = https.request(url, res => {
             tl.debug("statusCode: " + res.statusCode);
             res.pipe(file);
             res.on("error", err => reject(err));
             res.on("end", () => {
-                tl.debug("File download completed");
-                resolve();
+                file.end(null, null, file.close);
+                if(res.statusCode < 200 || res.statusCode >= 300) {
+                    tl.debug("File download failed");
+                    reject(new Error('Failed to download file status code: ' + res.statusCode));
+                }
+                else {
+                    tl.debug("File download completed");
+                    resolve();
+                }
             });
         });
 
@@ -24,6 +31,4 @@ export async function download(url: string, downloadPath: string): Promise<void>
 
         req.end();
     });
-    
-    file.end(null, null, file.close);    
 }
diff --git a/Tasks/Kubernetes/Strings/resources.resjson/en-US/resources.resjson b/Tasks/Kubernetes/Strings/resources.resjson/en-US/resources.resjson
@@ -31,11 +31,11 @@
   "loc.input.help.forceUpdate": "Delete the docker-registry secret if it exists and create a new one with updated values.",
   "loc.input.label.versionOrLocation": "Kubectl",
   "loc.input.label.versionSpec": "Version Spec",
-  "loc.input.help.versionSpec": "Version Spec of version to get.  Examples: 1.7, 1.x, 4.x, 6.10.0, >=6.10.0",
+  "loc.input.help.versionSpec": "Version Spec of version to get.  Examples: 1.7.0, 1.x.0, 4.x.0, 6.10.0, >=6.10.0",
   "loc.input.label.checkLatest": "Check for Latest Version",
   "loc.input.help.checkLatest": "Always checks online for the latest available version (stable.txt) that satisfies the version spec. This is typically false unless you have a specific scenario to always get latest. This will cause it to incur download costs when potentially not necessary, especially with the hosted build pool.",
   "loc.input.label.specifyLocation": "Path to Kubectl",
-  "loc.input.help.specifyLocation": "Path to the kubectl version to use",
+  "loc.input.help.specifyLocation": "Full path to the kubectl.exe",
   "loc.input.label.cwd": "Working directory",
   "loc.input.help.cwd": "Working directory for the Kubectl command.",
   "loc.input.label.outputFormat": "Output format",
@@ -48,5 +48,8 @@
   "loc.messages.DockerRegistryConnectionNotSpecified": "Docker Registry connection details not specified",
   "loc.messages.FileNotFoundException": "Can not find file at location: %s",
   "loc.messages.DownloadingKubeCtlFromUrl": "Downloading Kubectl from Url: %s",
-  "loc.messages.DownloadPathForStableTxt": "Download path for stable.txt: %s"
+  "loc.messages.DownloadPathForStableTxt": "Download path for stable.txt: %s",
+  "loc.messages.DownloadKubeCtlFailed": "Can not download the kubectl client of version %s. Check if the version is correct https://github.com/kubernetes/kubernetes/releases",
+  "loc.messages.DownloadStableVersionFailed": "Can not download kubernetes stable version file from %s. Falling back to %s",
+  "loc.messages.UsingLatestStableVersion": "Invalid version 1.7 specified in Version Spec input. Using latest stable version instead. Check for correct versions https://github.com/kubernetes/kubernetes/releases"
 }
diff --git a/Tasks/Kubernetes/make.json b/Tasks/Kubernetes/make.json
@@ -10,5 +10,14 @@
 		"type": "node",
 		"dest" : "./",
 		"compile" : true
-	}]
+	}],
+	"rm": [
+        {
+            "items": [
+                "node_modules/utility-common/node_modules/vsts-task-lib",
+                "node_modules/docker-common/node_modules/vsts-task-lib"
+            ],
+            "options": "-Rf"
+        }
+    ]
 }
diff --git a/Tasks/Kubernetes/package.json b/Tasks/Kubernetes/package.json
@@ -1,6 +1,7 @@
 {
   "dependencies": {
     "del": "2.2.0",
-    "js-yaml": "3.6.1"
+    "js-yaml": "3.6.1",
+    "vsts-task-tool-lib": "0.4.0"
   }
 }
diff --git a/Tasks/Kubernetes/src/clusterconnection.ts b/Tasks/Kubernetes/src/clusterconnection.ts
@@ -19,13 +19,12 @@ export default class ClusterConnection {
         this.userDir = utils.getNewUserDirPath();
     }
 
-    private async initialize() {
+    private async initialize(): Promise<void> {
         if(!this.kubectlPath || !fs.existsSync(this.kubectlPath))
         {
-            tl.debug(tl.loc("DownloadingClient"));
-            this.kubectlPath = path.join(this.userDir, "kubectl") + this.getExecutableExtention();
-            var version = await utils.getStableKubectlVersion();
-            await utils.downloadKubectl(version, this.kubectlPath);
+            return this.getKubectl().then((kubectlpath)=> {
+                this.kubectlPath = kubectlpath;
+            });
         }
     }
 
@@ -41,10 +40,11 @@ export default class ClusterConnection {
 
     // open kubernetes connection
     public async open(kubernetesEndpoint?: string){
-         await this.initialize();
-         if (kubernetesEndpoint) {
-            this.downloadKubeconfigFileFromEndpoint(kubernetesEndpoint);
-         }
+         return this.initialize().then(() => {
+            if (kubernetesEndpoint) {
+                this.downloadKubeconfigFileFromEndpoint(kubernetesEndpoint);
+            }
+         });
     }
 
     // close kubernetes connection
@@ -78,4 +78,22 @@ export default class ClusterConnection {
 
         return "";
     }
+
+    private async getKubectl() : Promise<string> {
+        let versionOrLocation = tl.getInput("versionOrLocation");
+        if( versionOrLocation === "location") {
+            let pathToKubectl = tl.getPathInput("specifyLocation", true, true);
+            fs.chmod(pathToKubectl, "777");
+            return pathToKubectl;
+        }
+        else if(versionOrLocation === "version") {
+            tl.debug(tl.loc("DownloadingClient"));
+            var kubectlPath = path.join(this.userDir, "kubectl") + this.getExecutableExtention();
+            let versionSpec = tl.getInput("versionSpec");
+            let checkLatest: boolean = tl.getBoolInput('checkLatest', false);
+            return utils.getKubectlVersion(versionSpec, checkLatest).then((version) => {
+                return utils.downloadKubectl(version, kubectlPath);
+            })
+        }
+    }
 }
diff --git a/Tasks/Kubernetes/src/utilities.ts b/Tasks/Kubernetes/src/utilities.ts
@@ -34,28 +34,62 @@ function ensureDirExists(dirPath : string) : void
     }
 }
 
+export async function getKubectlVersion(versionSpec: string, checkLatest: boolean) : Promise<string> {
+   let version: string = "v1.6.6";   
+
+   if(checkLatest) {
+        return getStableKubectlVersion();
+   }
+   else if (versionSpec) {
+       if(versionSpec === "1.7") {
+           // Backward compat handle
+           tl.warning(tl.loc("UsingLatestStableVersion"));
+           return getStableKubectlVersion();
+       } 
+       else if(!versionSpec.startsWith("v")) {
+           version = "v".concat(versionSpec);
+       }
+       else {
+            version = versionSpec;
+       } 
+    }
+
+	return version;
+}
+
 export async function getStableKubectlVersion() : Promise<string> {
     var stableVersion = "v1.6.6";
     var version;
     var stableVersionUrl = "https://storage.googleapis.com/kubernetes-release/release/stable.txt";
     var downloadPath = path.join(getTempDirectory(), getCurrentTime().toString()+".txt");
-    await downloadutility.download(stableVersionUrl, downloadPath);
-    tl.debug(tl.loc('DownloadPathForStableTxt', downloadPath));
-    version = fs.readFileSync(downloadPath, "utf8").toString().trim();
-    if(!version){
-        version = stableVersion;
-    }
-    return version;
+    return downloadutility.download(stableVersionUrl, downloadPath).then((resolve) => {
+        version = fs.readFileSync(downloadPath, "utf8").toString().trim();
+        if(!version){
+            version = stableVersion;
+        }
+        return version;
+    },
+    (reject) => {
+        tl.debug(reject);
+        tl.warning(tl.loc('DownloadStableVersionFailed', stableVersionUrl, stableVersion));
+        return stableVersion;
+    })
 }
 
-export async function downloadKubectl(version: string, kubectlPath: string): Promise<void> {
+export async function downloadKubectl(version: string, kubectlPath: string): Promise<string> {
     var kubectlURL = getkubectlDownloadURL(version);
     tl.debug(tl.loc('DownloadingKubeCtlFromUrl', kubectlURL));
     var kubectlPathTmp = kubectlPath+".tmp";
-    await downloadutility.download(kubectlURL, kubectlPathTmp);
-    tl.cp(kubectlPathTmp, kubectlPath, "-f");
-    fs.chmod(kubectlPath, "777");
-    assertFileExists(kubectlPath);
+    return downloadutility.download(kubectlURL, kubectlPathTmp).then( (res) => {
+            tl.cp(kubectlPathTmp, kubectlPath, "-f");
+            fs.chmod(kubectlPath, "777");
+            assertFileExists(kubectlPath);
+            return kubectlPath;
+    },
+    (reason) => {
+        //Download kubectl client failed.
+        throw new Error(tl.loc('DownloadKubeCtlFailed', version));
+    }); 
 }
 
 function getkubectlDownloadURL(version: string) : string {
@@ -74,7 +108,7 @@ function getkubectlDownloadURL(version: string) : string {
     }
 }
 
-function assertFileExists(path: string) {
+export function assertFileExists(path: string) {
     if(!fs.existsSync(path)) {
         tl.error(tl.loc('FileNotFoundException', path));
         throw new Error(tl.loc('FileNotFoundException', path));
diff --git a/Tasks/Kubernetes/task.json b/Tasks/Kubernetes/task.json
@@ -13,7 +13,7 @@
     "version": {
         "Major": 0,
         "Minor": 1,
-        "Patch": 6
+        "Patch": 7
     },
     "demands": [],
     "preview": "false",
@@ -161,7 +161,7 @@
             "type": "radio",
             "label": "Kubectl",
             "defaultValue": "version",
-            "required": "true",
+            "required": false,
             "options": {
                 "version": "Version",
                 "location": "Specify Location"
@@ -172,9 +172,8 @@
             "name": "versionSpec",
             "type": "string",
             "label": "Version Spec",
-            "defaultValue": "1.7",
-            "helpMarkDown": "Version Spec of version to get.  Examples: 1.7, 1.x, 4.x, 6.10.0, >=6.10.0",
-            "required": "false",
+            "defaultValue": "1.7.0",
+            "helpMarkDown": "Version Spec of version to get.  Examples: 1.7.0, 1.x.0, 4.x.0, 6.10.0, >=6.10.0",
             "groupName": "advanced",
             "visibleRule": "versionOrLocation = version"
         },
@@ -193,8 +192,8 @@
             "type": "filePath",
             "label": "Path to Kubectl",
             "defaultValue": "",
-            "helpMarkDown": "Path to the kubectl version to use",
-            "required": "false",
+            "helpMarkDown": "Full path to the kubectl.exe",
+            "required": true,
             "groupName": "advanced",
             "visibleRule": "versionOrLocation = location"
         },
@@ -244,12 +243,15 @@
         }
     },
     "messages": {
-        "DownloadingClient":"Downloading kubernetes client.",
-        "CreatingSecret":"Executing create docker-registry %s secret.",
+        "DownloadingClient": "Downloading kubernetes client.",
+        "CreatingSecret": "Executing create docker-registry %s secret.",
         "DeleteSecret": "Executing delete docker-registry %s secret",
         "DockerRegistryConnectionNotSpecified": "Docker Registry connection details not specified",
         "FileNotFoundException": "Can not find file at location: %s",
         "DownloadingKubeCtlFromUrl": "Downloading Kubectl from Url: %s",
-        "DownloadPathForStableTxt": "Download path for stable.txt: %s"
+        "DownloadPathForStableTxt": "Download path for stable.txt: %s",
+        "DownloadKubeCtlFailed": "Can not download the kubectl client of version %s. Check if the version is correct https://github.com/kubernetes/kubernetes/releases",
+        "DownloadStableVersionFailed": "Can not download kubernetes stable version file from %s. Falling back to %s",
+        "UsingLatestStableVersion": "Invalid version 1.7 specified in Version Spec input. Using latest stable version instead. Check for correct versions https://github.com/kubernetes/kubernetes/releases"
     }
 }
diff --git a/Tasks/Kubernetes/task.loc.json b/Tasks/Kubernetes/task.loc.json
@@ -13,7 +13,7 @@
   "version": {
     "Major": 0,
     "Minor": 1,
-    "Patch": 6
+    "Patch": 7
   },
   "demands": [],
   "preview": "false",
@@ -161,7 +161,7 @@
       "type": "radio",
       "label": "ms-resource:loc.input.label.versionOrLocation",
       "defaultValue": "version",
-      "required": "true",
+      "required": false,
       "options": {
         "version": "Version",
         "location": "Specify Location"
@@ -172,9 +172,8 @@
       "name": "versionSpec",
       "type": "string",
       "label": "ms-resource:loc.input.label.versionSpec",
-      "defaultValue": "1.7",
+      "defaultValue": "1.7.0",
       "helpMarkDown": "ms-resource:loc.input.help.versionSpec",
-      "required": "false",
       "groupName": "advanced",
       "visibleRule": "versionOrLocation = version"
     },
@@ -194,7 +193,7 @@
       "label": "ms-resource:loc.input.label.specifyLocation",
       "defaultValue": "",
       "helpMarkDown": "ms-resource:loc.input.help.specifyLocation",
-      "required": "false",
+      "required": true,
       "groupName": "advanced",
       "visibleRule": "versionOrLocation = location"
     },
@@ -250,6 +249,9 @@
     "DockerRegistryConnectionNotSpecified": "ms-resource:loc.messages.DockerRegistryConnectionNotSpecified",
     "FileNotFoundException": "ms-resource:loc.messages.FileNotFoundException",
     "DownloadingKubeCtlFromUrl": "ms-resource:loc.messages.DownloadingKubeCtlFromUrl",
-    "DownloadPathForStableTxt": "ms-resource:loc.messages.DownloadPathForStableTxt"
+    "DownloadPathForStableTxt": "ms-resource:loc.messages.DownloadPathForStableTxt",
+    "DownloadKubeCtlFailed": "ms-resource:loc.messages.DownloadKubeCtlFailed",
+    "DownloadStableVersionFailed": "ms-resource:loc.messages.DownloadStableVersionFailed",
+    "UsingLatestStableVersion": "ms-resource:loc.messages.UsingLatestStableVersion"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"dependencies": {`
`3`	`3`	`"del": "2.2.0",`
`4`		`- "js-yaml": "3.6.1"`
	`4`	`+ "js-yaml": "3.6.1",`
	`5`	`+ "vsts-task-tool-lib": "0.4.0"`
`5`	`6`	`}`
`6`	`7`	`}`