add onedeploy endpoint (#294)

Author: v-mohithgc

common-npm-packages/azure-arm-rest/azure-arm-app-service-kudu.ts

@@ -528,6 +528,41 @@ export class Kudu {
         }
     }
 
+    public async oneDeploy(webPackage: string, queryParameters?: Array<string>): Promise<any> {
+        let httpRequest = new webClient.WebRequest();
+        httpRequest.method = 'POST';
+        httpRequest.uri = this.client.getRequestUri(`/api/publish`, queryParameters);
+        httpRequest.body = fs.createReadStream(webPackage);
+        let requestOptions = new webClient.WebRequestOptions();
+        //Bydefault webclient.sendRequest retries for  [500, 502, 503, 504]
+        requestOptions.retriableStatusCodes = [500, 502, 503, 504];
+        requestOptions.retryIntervalInSeconds = 5;
+        try {
+            let response = await this.client.beginRequest(httpRequest, requestOptions, 'application/octet-stream');
+            tl.debug(`OneDeploy response: ${JSON.stringify(response)}`);
+            if (response.statusCode == 200) {
+                tl.debug('Deployment passed');
+                return null;
+            }
+            else if (response.statusCode == 202) {
+                let pollableURL: string = response.headers.location;
+                if (!!pollableURL) {
+                    tl.debug(`Polling for OneDeploy URL: ${pollableURL}`);
+                    return await this._getDeploymentDetailsFromPollURL(pollableURL);
+                }
+                else {
+                    tl.debug('OneDeploy returned 202 without pollable URL.');
+                    return null;
+                }
+            }
+            else {
+                throw response;
+            }
+        }
+        catch (error) {
+            throw new Error(tl.loc('PackageDeploymentFailed', this._getFormattedError(error)));
+        }
+    }
 
     public async getDeploymentDetails(deploymentID: string): Promise<any> {
         try {

common-npm-packages/azurermdeploycommon/azure-arm-rest/azure-arm-app-service-kudu.ts

@@ -522,6 +522,41 @@ export class Kudu {
         }
     }
 
+        public async oneDeploy(webPackage: string, queryParameters?: Array<string>): Promise<any> {
+        let httpRequest = new webClient.WebRequest();
+        httpRequest.method = 'POST';
+        httpRequest.uri = this._client.getRequestUri(`/api/publish`, queryParameters);
+        httpRequest.body = fs.createReadStream(webPackage);
+        let requestOptions = new webClient.WebRequestOptions();
+        //Bydefault webclient.sendRequest retries for  [500, 502, 503, 504]
+        requestOptions.retriableStatusCodes = [500, 502, 503, 504];
+        requestOptions.retryIntervalInSeconds = 5;
+        try {
+            let response = await this._client.beginRequest(httpRequest, requestOptions, 'application/octet-stream');
+            tl.debug(`OneDeploy response: ${JSON.stringify(response)}`);
+            if (response.statusCode == 200) {
+                tl.debug('Deployment passed');
+                return null;
+            }
+            else if (response.statusCode == 202) {
+                let pollableURL: string = response.headers.location;
+                if (!!pollableURL) {
+                    tl.debug(`Polling for OneDeploy URL: ${pollableURL}`);
+                    return await this._getDeploymentDetailsFromPollURL(pollableURL);
+                }
+                else {
+                    tl.debug('OneDeploy returned 202 without pollable URL.');
+                    return null;
+                }
+            }
+            else {
+                throw response;
+            }
+        }
+        catch (error) {
+            throw new Error(tl.loc('PackageDeploymentFailed', this._getFormattedError(error)));
+        }
+    }
 
     public async getDeploymentDetails(deploymentID: string): Promise<any> {
         try {
@@ -648,4 +683,4 @@ export class Kudu {
         }
         return error;
     }
-}
+}

common-npm-packages/azurermdeploycommon/operations/KuduServiceUtility.ts

@@ -14,6 +14,7 @@ const physicalRootPath: string = '/site/wwwroot';
 const deploymentFolder: string = 'site/deployments';
 const manifestFileName: string = 'manifest';
 const VSTS_ZIP_DEPLOY: string = 'VSTS_ZIP_DEPLOY';
+const VSTS_ONE_DEPLOY: string = 'VSTS_ONE_DEPLOY';
 const VSTS_DEPLOY: string = 'VSTS';
 
 export class KuduServiceUtility {
@@ -196,6 +197,45 @@ export class KuduServiceUtility {
         }
     }
 
+    public async deployUsingOneDeploy(packagePath: string, customMessage?: any, targetPath?: any, type?: any, clean?: any, restart?: any): Promise<string> {
+        try {
+            console.log(tl.loc('Package deployment using OneDeploy initiated.'));
+            let queryParameters: Array<string> = [
+                'async=true',
+                'deployer=' + VSTS_ONE_DEPLOY
+            ];
+
+            if (type) {
+                queryParameters.push('type=' + encodeURIComponent(type));
+            }
+
+            if (targetPath) {
+                queryParameters.push('path=' + encodeURIComponent(targetPath));
+            }
+
+            if (clean) {
+                queryParameters.push('clean=' + encodeURIComponent(clean));
+            }
+
+            if (restart) {
+                queryParameters.push('restart=' + encodeURIComponent(restart));
+            }
+
+            var deploymentMessage = this._getUpdateHistoryRequest(null, null, customMessage).message;
+            queryParameters.push('message=' + encodeURIComponent(deploymentMessage));
+            let deploymentDetails = await this._appServiceKuduService.oneDeploy(packagePath, queryParameters);
+            console.log(tl.loc(deploymentDetails));
+            await this._processDeploymentResponse(deploymentDetails);
+            console.log(tl.loc('Successfully deployed web package to App Service.'));
+
+            return deploymentDetails.id;
+        }
+        catch (error) {
+            tl.error(tl.loc('PackageDeploymentFailed'));
+            throw error;
+        }
+    }
+
     private async _processDeploymentResponse(deploymentDetails: any): Promise<void> {
         try {
             var kuduDeploymentDetails = await this._appServiceKuduService.getDeploymentDetails(deploymentDetails.id);
@@ -456,4 +496,4 @@ export class KuduServiceUtility {
             deployer : 'VSTS'
         };
     }
-}
+}

common-npm-packages/azurermdeploycommon/package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "azure-pipelines-tasks-azurermdeploycommon",
-    "version": "3.236.0",
+    "version": "3.237.0",
     "description": "Common Lib for Azure ARM REST apis",
     "repository": {
         "type": "git",