From 3d01307a8a1367bad103f0349d76f8cb43f7ef44 Mon Sep 17 00:00:00 2001 From: "Vincent A (vinca)" Date: Thu, 18 Jan 2018 18:04:46 +0530 Subject: [PATCH] App Service Deploy - Reliability fixes (#6182) * raw changes push * added final changes * fixed few bugs * updated task.loc * removed azurerest-common module * retry msDeploy * Fixed few bugs * Fixed bugs #2 * Fixed bugs #3 * addressed review comments * added help messages * fixed few bugs * linux kudu file path updated * added basic Tests * changed rm fn * Fix L0 Tests * Test added for common-kudu * added Tests for common-AzureAppService * Fix App Service issue * added debug statements * Addressed review comments * addressed review comments * addressed review comments * addressed review comments * Package error message updated * addressed Ajay & Ayantika comments --- .../operations/ContinuousMonitoringUtils.ts | 2 +- .../resources.resjson/en-US/resources.resjson | 47 +- Tasks/AzureRmWebAppDeployment/Tests/L0.ts | 522 +-- .../azurermwebappcontainerdeployment.ts | 202 - .../azurermwebappdeployment.ts | 449 +-- Tasks/AzureRmWebAppDeployment/kuduutility.ts | 536 --- Tasks/AzureRmWebAppDeployment/make.json | 12 +- .../operations/AzureAppServiceUtility.ts | 235 ++ .../operations/AzureResourceFilterUtility.ts | 22 + .../ContainerBasedDeploymentUtility.ts | 216 ++ .../operations/FileTransformsUtility.ts | 35 + .../operations/KuduServiceUtility.ts | 329 ++ .../operations/ParameterParserUtility.ts | 127 + .../operations/ReleaseAnnotationUtility.ts | 78 + .../operations/TaskParameters.ts | 95 + Tasks/AzureRmWebAppDeployment/package.json | 4 +- Tasks/AzureRmWebAppDeployment/task.json | 71 +- Tasks/AzureRmWebAppDeployment/task.loc.json | 55 +- .../resources.resjson/en-US/resources.resjson | 17 +- .../L0-azure-arm-app-service-kudu-tests.ts | 92 +- .../Tests/L0-azure-arm-app-service.ts | 44 +- .../Tests/azure-arm-app-service-kudu-tests.ts | 213 +- .../Tests/azure-arm-app-service-tests.ts | 250 +- .../Common/azure-arm-rest/Tests/mock_utils.ts | 115 +- .../azure-arm-app-service-kudu.ts | 217 +- .../azure-arm-rest/azure-arm-app-service.ts | 136 +- .../azure-arm-rest/azure-arm-appinsights.ts | 68 +- Tasks/Common/azure-arm-rest/constants.ts | 11 +- Tasks/Common/azure-arm-rest/module.json | 17 +- Tasks/Common/azure-arm-rest/webClient.ts | 3 +- .../azurerest-common/azurerestutility.ts | 1057 ------ .../azurerest-common/globals/mocha/index.d.ts | 202 - .../globals/mocha/typings.json | 8 - .../azurerest-common/globals/node/index.d.ts | 3350 ----------------- .../globals/node/typings.json | 8 - .../azurerest-common/globals/q/index.d.ts | 357 -- .../azurerest-common/globals/q/typings.json | 8 - Tasks/Common/azurerest-common/index.d.ts | 3 - .../kududeploymentstatusutility.ts | 98 - .../azurerest-common/npm-shrinkwrap.json | 91 - Tasks/Common/azurerest-common/package.json | 22 - Tasks/Common/azurerest-common/tsconfig.json | 9 - Tasks/Common/azurerest-common/typings.json | 7 - Tasks/Common/azurerest-common/utility.ts | 37 - .../deployusingmsdeploy.ts | 18 +- .../webdeployment-common/msdeployutility.ts | 23 +- .../webdeployment-common/packageUtility.ts | 18 + Tasks/Common/webdeployment-common/utility.ts | 2 +- .../webdeployment-common/webconfigutil.ts | 2 +- .../Tests/L0.ts | 6 +- .../Tests/L0WindowsFailDefault.ts | 1 - .../Tests/L0WindowsManyPackage.ts | 4 +- 52 files changed, 2442 insertions(+), 7109 deletions(-) delete mode 100644 Tasks/AzureRmWebAppDeployment/azurermwebappcontainerdeployment.ts delete mode 100644 Tasks/AzureRmWebAppDeployment/kuduutility.ts create mode 100644 Tasks/AzureRmWebAppDeployment/operations/AzureAppServiceUtility.ts create mode 100644 Tasks/AzureRmWebAppDeployment/operations/AzureResourceFilterUtility.ts create mode 100644 Tasks/AzureRmWebAppDeployment/operations/ContainerBasedDeploymentUtility.ts create mode 100644 Tasks/AzureRmWebAppDeployment/operations/FileTransformsUtility.ts create mode 100644 Tasks/AzureRmWebAppDeployment/operations/KuduServiceUtility.ts create mode 100644 Tasks/AzureRmWebAppDeployment/operations/ParameterParserUtility.ts create mode 100644 Tasks/AzureRmWebAppDeployment/operations/ReleaseAnnotationUtility.ts create mode 100644 Tasks/AzureRmWebAppDeployment/operations/TaskParameters.ts delete mode 100644 Tasks/Common/azurerest-common/azurerestutility.ts delete mode 100644 Tasks/Common/azurerest-common/globals/mocha/index.d.ts delete mode 100644 Tasks/Common/azurerest-common/globals/mocha/typings.json delete mode 100644 Tasks/Common/azurerest-common/globals/node/index.d.ts delete mode 100644 Tasks/Common/azurerest-common/globals/node/typings.json delete mode 100644 Tasks/Common/azurerest-common/globals/q/index.d.ts delete mode 100644 Tasks/Common/azurerest-common/globals/q/typings.json delete mode 100644 Tasks/Common/azurerest-common/index.d.ts delete mode 100644 Tasks/Common/azurerest-common/kududeploymentstatusutility.ts delete mode 100644 Tasks/Common/azurerest-common/npm-shrinkwrap.json delete mode 100644 Tasks/Common/azurerest-common/package.json delete mode 100644 Tasks/Common/azurerest-common/tsconfig.json delete mode 100644 Tasks/Common/azurerest-common/typings.json delete mode 100644 Tasks/Common/azurerest-common/utility.ts create mode 100644 Tasks/Common/webdeployment-common/packageUtility.ts diff --git a/Tasks/AzureAppServiceManage/operations/ContinuousMonitoringUtils.ts b/Tasks/AzureAppServiceManage/operations/ContinuousMonitoringUtils.ts index e0b543501758..a4ea284ce98e 100644 --- a/Tasks/AzureAppServiceManage/operations/ContinuousMonitoringUtils.ts +++ b/Tasks/AzureAppServiceManage/operations/ContinuousMonitoringUtils.ts @@ -33,7 +33,7 @@ export async function enableContinuousMonitoring(endpoint: AzureEndpoint, appSer try { tl.debug('Enable alwaysOn property for app service.'); - await appService.patchConfiguration({"alwaysOn": true}); + await appService.patchConfiguration({ "properties" :{"alwaysOn": true}}); } catch(error) { tl.warning(error); diff --git a/Tasks/AzureRmWebAppDeployment/Strings/resources.resjson/en-US/resources.resjson b/Tasks/AzureRmWebAppDeployment/Strings/resources.resjson/en-US/resources.resjson index 3cf23d8b991c..5fa2ee009283 100644 --- a/Tasks/AzureRmWebAppDeployment/Strings/resources.resjson/en-US/resources.resjson +++ b/Tasks/AzureRmWebAppDeployment/Strings/resources.resjson/en-US/resources.resjson @@ -7,8 +7,8 @@ "loc.group.displayName.FileTransformsAndVariableSubstitution": "File Transforms & Variable Substitution Options", "loc.group.displayName.AdditionalDeploymentOptions": "Additional Deployment Options", "loc.group.displayName.PostDeploymentAction": "Post Deployment Action", + "loc.group.displayName.ApplicationAndConfigurationSettings": "Application and Configuration Settings", "loc.group.displayName.output": "Output", - "loc.group.displayName.ApplicationSettings": "Application Settings", "loc.input.label.ConnectedServiceName": "Azure subscription", "loc.input.help.ConnectedServiceName": "Select the Azure Resource Manager subscription for the deployment.", "loc.input.label.WebAppKind": "App type", @@ -48,9 +48,9 @@ "loc.input.label.VirtualApplication": "Virtual application", "loc.input.help.VirtualApplication": "Specify the name of the Virtual application that has been configured in the Azure portal. The option is not required for deployments to the App Service root.", "loc.input.label.Package": "Package or folder", - "loc.input.help.Package": "File path to the package or a folder containing app service contents generated by MSBuild or a compressed archive file.
Variables ( [Build](https://www.visualstudio.com/docs/build/define/variables) | [Release](https://www.visualstudio.com/docs/release/author-release-definition/understanding-tasks#predefvariables)), wild cards are supported.
For example, $(System.DefaultWorkingDirectory)/\\*\\*/\\*.zip.", + "loc.input.help.Package": "File path to the package or a folder containing app service contents generated by MSBuild or a compressed zip or war file.
Variables ( [Build](https://www.visualstudio.com/docs/build/define/variables) | [Release](https://www.visualstudio.com/docs/release/author-release-definition/understanding-tasks#predefvariables)), wild cards are supported.
For example, $(System.DefaultWorkingDirectory)/\\*\\*/\\*.zip or $(System.DefaultWorkingDirectory)/\\*\\*/\\*.war.", "loc.input.label.BuiltinLinuxPackage": "Package or folder", - "loc.input.help.BuiltinLinuxPackage": "File path to the package or a folder containing app service contents generated by MSBuild or a compressed archive file.
Variables ( [Build](https://www.visualstudio.com/docs/build/define/variables) | [Release](https://www.visualstudio.com/docs/release/author-release-definition/understanding-tasks#predefvariables)), wild cards are supported.
For example, $(System.DefaultWorkingDirectory)/\\*\\*/\\*.zip.", + "loc.input.help.BuiltinLinuxPackage": "File path to the package or a folder containing app service contents generated by MSBuild or a compressed zip or war file.
Variables ( [Build](https://www.visualstudio.com/docs/build/define/variables) | [Release](https://www.visualstudio.com/docs/release/author-release-definition/understanding-tasks#predefvariables)), wild cards are supported.
For example, $(System.DefaultWorkingDirectory)/\\*\\*/\\*.zip or $(System.DefaultWorkingDirectory)/\\*\\*/\\*.war.", "loc.input.label.RuntimeStack": "Runtime Stack", "loc.input.help.RuntimeStack": "Select the framework and version.", "loc.input.label.StartupCommand": "Startup command ", @@ -67,6 +67,8 @@ "loc.input.help.WebConfigParameters": "Edit values like startup file in the generated web.config file. This edit feature is only for the generated web.config. [Learn more](https://go.microsoft.com/fwlink/?linkid=843469).", "loc.input.label.AppSettings": "App settings", "loc.input.help.AppSettings": "Edit web app application settings following the syntax -key value .
Example : -Port 5000 -RequestTimeout 5000", + "loc.input.label.ConfigurationSettings": "Configuration settings", + "loc.input.help.ConfigurationSettings": "Edit web app configuration settings following the syntax -key value.
Example : -phpVersion 5.6 -linuxFxVersion: node|6.11", "loc.input.label.TakeAppOfflineFlag": "Take App Offline", "loc.input.help.TakeAppOfflineFlag": "Select the option to take the Azure App Service offline by placing an app_offline.htm file in the root directory of the App Service before the sync operation begins. The file will be removed after the sync operation completes successfully.", "loc.input.label.UseWebDeploy": "Publish using Web Deploy", @@ -96,7 +98,7 @@ "loc.messages.UnabletoretrieveResourceID": "Unable to retrieve connection details for Azure Resource:'%s'. Status Code: %s", "loc.messages.CouldnotfetchaccesstokenforAzureStatusCode": "Could not fetch access token for Azure. Status Code: %s (%s)", "loc.messages.Successfullyupdateddeploymenthistory": "Successfully updated deployment History at %s", - "loc.messages.Failedtoupdatedeploymenthistory": "Failed to update deployment history.", + "loc.messages.Failedtoupdatedeploymenthistory": "Failed to update deployment history. Error: %s", "loc.messages.WARNINGCannotupdatedeploymentstatusSCMendpointisnotenabledforthiswebsite": "WARNING : Cannot update deployment status : SCM endpoint is not enabled for this website", "loc.messages.Unabletoretrievewebconfigdetails": "Unable to retrieve App Service configuration details. Status Code: '%s'", "loc.messages.Unabletoretrievewebappsettings": "Unable to retrieve App Service application settings. [Status Code: '%s', Error Message: '%s']", @@ -112,8 +114,8 @@ "loc.messages.MSDeploygeneratedpackageareonlysupportedforWindowsplatform": "MSDeploy generated packages are only supported for Windows platform.", "loc.messages.UnsupportedinstalledversionfoundforMSDeployversionshouldbeatleast3orabove": "Unsupported installed version: %s found for MSDeploy. version should be at least 3 or above", "loc.messages.UnabletofindthelocationofMSDeployfromregistryonmachineError": "Unable to find the location of MS Deploy from registry on machine (Error : %s)", - "loc.messages.Nopackagefoundwithspecifiedpattern": "No package found with specified pattern", - "loc.messages.MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern": "More than one package matched with specified pattern. Please restrain the search pattern.", + "loc.messages.Nopackagefoundwithspecifiedpattern": "No package found with specified pattern: %s", + "loc.messages.MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern": "More than one package matched with specified pattern: %s. Please restrain the search pattern.", "loc.messages.Trytodeploywebappagainwithappofflineoptionselected": "Try to deploy app service again with Take application offline option selected.", "loc.messages.Trytodeploywebappagainwithrenamefileoptionselected": "Try to deploy app service again with Rename locked files option selected.", "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", @@ -135,7 +137,7 @@ "loc.messages.RequestedURLforkuduphysicalpath": "Requested URL for kudu physical path : %s", "loc.messages.Physicalpathalreadyexists": "Physical path '%s' already exists", "loc.messages.KuduPhysicalpathCreatedSuccessfully": "Kudu physical path created successfully : %s", - "loc.messages.FailedtocreateKuduPhysicalPath": "Failed to create kudu physical path. Error Code: %s", + "loc.messages.FailedtocreateKuduPhysicalPath": "Failed to create kudu physical path. Error : %s", "loc.messages.FailedtocheckphysicalPath": "Failed to check kudu physical path. Error Code: %s", "loc.messages.VirtualApplicationDoesNotExist": "Virtual application doesn't exists : %s", "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", @@ -143,8 +145,8 @@ "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", "loc.messages.failedtoUploadFileToKudu": "Unable to upload file: %s to Kudu (%s). Status Code: %s", "loc.messages.failedtoUploadFileToKuduError": "Unable to upload file: %s to Kudu (%s). Error: %s", - "loc.messages.ExecuteScriptOnKudu": "Executing given script on Kudu: %s", - "loc.messages.FailedToRunScriptOnKuduError": "Unable to run the script on Kudu: %s. Error: %s", + "loc.messages.ExecuteScriptOnKudu": "Executing given script on Kudu service.", + "loc.messages.FailedToRunScriptOnKuduError": "Unable to run the script on Kudu Service. Error: %s", "loc.messages.FailedToRunScriptOnKudu": "Unable to run the script on Kudu: %s. Status Code: %s", "loc.messages.ScriptExecutionOnKuduSuccess": "Successfully executed script on Kudu.", "loc.messages.ScriptExecutionOnKuduFailed": "Executed script returned '%s' as return code. Error: %s", @@ -183,5 +185,30 @@ "loc.messages.UnableToUpdateWebAppConfigDetails": "Unable to update WebApp config details. StatusCode: '%s'", "loc.messages.AddingReleaseAnnotation": "Adding release annotation for the Application Insights resource '%s'", "loc.messages.SuccessfullyAddedReleaseAnnotation": "Successfully added release annotation to the Application Insight : %s", - "loc.messages.FailedAddingReleaseAnnotation": "Failed to add release annotation. %s" + "loc.messages.FailedAddingReleaseAnnotation": "Failed to add release annotation. %s", + "loc.messages.RenameLockedFilesEnabled": "Rename locked files enabled for App Service.", + "loc.messages.FailedToEnableRenameLockedFiles": "Failed to enable rename locked files. Error: %s", + "loc.messages.WebJobsInProgressIssue": "Few WebJobs in running state prevents the deployment from removing the files. You can disable 'Remove additional files at destinaton' option or Stop continuous Jobs before deployment.", + "loc.messages.FailedToFetchKuduAppSettings": "Failed to fetch Kudu App Settings. Error: %s", + "loc.messages.FailedToCreatePath": "Failed to create path '%s' from Kudu. Error: %s", + "loc.messages.FailedToDeleteFile": "Failed to delete file '%s/%s' from Kudu. Error: %s", + "loc.messages.FailedToUploadFile": "Failed to upload file '%s/%s' from Kudu. Error: %s", + "loc.messages.FailedToGetFileContent": "Failed to get file content '%s/%s' from Kudu. Error: %s", + "loc.messages.FailedToListPath": "Failed to list path '%s' from Kudu. Error: %s", + "loc.messages.RetryToDeploy": "Retrying to deploy the package.", + "loc.messages.FailedToGetAppServiceDetails": "Failed to fetch App Service '%s' details. Error: %s", + "loc.messages.FailedToGetAppServicePublishingProfile": "Failed to fetch App Service '%s' publishing profile. Error: %s", + "loc.messages.FailedToUpdateAppServiceMetadata": "Failed to update App service '%s' Meta data. Error: %s", + "loc.messages.FailedToGetAppServiceMetadata": "Failed to get App service '%s' Meta data. Error: %s", + "loc.messages.FailedToPatchAppServiceConfiguration": "Failed to patch App Service '%s' configuration. Error: %s", + "loc.messages.FailedToUpdateAppServiceConfiguration": "Failed to update App service '%s' configuration. Error: %s", + "loc.messages.FailedToGetAppServiceConfiguration": "Failed to get App service '%s' configuration. Error: %s", + "loc.messages.FailedToGetAppServicePublishingCredentials": "Failed to fetch App Service '%s' publishing credentials. Error: %s", + "loc.messages.FailedToGetAppServiceApplicationSettings": "Failed to get App service '%s' application settings. Error: %s", + "loc.messages.FailedToUpdateAppServiceApplicationSettings": "Failed to update App service '%s' application settings. Error: %s", + "loc.messages.UpdatingAppServiceConfigurationSettings": "Updating App Service Configuration settings. Data: %s", + "loc.messages.UpdatedAppServiceConfigurationSettings": "Updated App Service Configuration settings.", + "loc.messages.UpdatingAppServiceApplicationSettings": "Updating App Service Application settings. Data: %s", + "loc.messages.UpdatedAppServiceApplicationSettings": "Updated App Service Application settings and Kudu Application settings.", + "loc.messages.MultipleResourceGroupFoundForAppService": "Multiple resource group found for App Service '%s'." } \ No newline at end of file diff --git a/Tasks/AzureRmWebAppDeployment/Tests/L0.ts b/Tasks/AzureRmWebAppDeployment/Tests/L0.ts index bac05db41607..fbd8098745f3 100644 --- a/Tasks/AzureRmWebAppDeployment/Tests/L0.ts +++ b/Tasks/AzureRmWebAppDeployment/Tests/L0.ts @@ -5,8 +5,20 @@ import tl = require('vsts-task-lib'); var ltx = require('ltx'); import fs = require('fs'); +var AppServiceTests = require("../node_modules/azure-arm-rest/Tests/L0-azure-arm-app-service.js"); +var KuduServiceTests = require("../node_modules/azure-arm-rest/Tests/L0-azure-arm-app-service-kudu-tests.js"); +var ApplicationInsightsTests = require("../node_modules/azure-arm-rest/Tests/L0-azure-arm-appinsights-tests.js"); + + describe('AzureRmWebAppDeployment Suite', function() { + + this.timeout(60000); + before((done) => { + if(!tl.exist(path.join(__dirname, '..', 'node_modules/azure-arm-rest/Tests/node_modules'))) { + tl.cp(path.join( __dirname, 'node_modules'), path.join(__dirname, '..', 'node_modules/azure-arm-rest/Tests'), '-rf', true); + } + tl.cp(path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub', 'Web.config'), path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub', 'Web_test.config'), '-f', false); tl.cp(path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub', 'Web.Debug.config'), path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub', 'Web_test.Debug.config'), '-f', false); tl.cp(path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub', 'parameters.xml'), path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub', 'parameters_test.xml'), '-f', false); @@ -14,271 +26,19 @@ describe('AzureRmWebAppDeployment Suite', function() { done(); }); after(function() { - tl.rmRF(path.join(__dirname, "..", "node_modules","webdeployment-common","Tests", 'L1XdtTransform', 'Web_test.config'), true); - tl.rmRF(path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub', 'Web_test.config'), true); - tl.rmRF(path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub', 'Web_Test.Debug.config'), true); - tl.rmRF(path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub', 'parameters_test.xml'), true); + try { + tl.rmRF(path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub', 'parameters_test.xml')); + } + catch(error) { + tl.debug(error); + } }); - if (tl.osType().match(/^Win/)) { - - it('Runs successfully with default inputs and application insights is configured for the app service', (done:MochaDone) => { - let tp = path.join(__dirname, 'L0WindowsDefault.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); - assert(tr.stderr.length == 0 || tr.errorIssues.length, 'should not have written to stderr'); - var expectedOut = 'Updated history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = "loc_mock_AddingReleaseAnnotation ApplicationInsights"; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = "loc_mock_SuccessfullyAddedReleaseAnnotation ApplicationInsights"; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - assert(tr.succeeded, 'task should have succeeded'); - done(); - }); - - it('Runs successfully with default inputs even when adding release annotation step fails', (done: MochaDone) => { - let tp = path.join(__dirname, 'L0WindowsDefaultReleaseAnnotationFail.js'); - let tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); - assert(tr.stderr.length == 0 || tr.errorIssues.length, 'should not have written to stderr'); - var expectedOut = 'Updated history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = "loc_mock_AddingReleaseAnnotation ApplicationInsights"; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = "loc_mock_FailedAddingReleaseAnnotation Random error"; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - - assert(tr.succeeded, 'task should have succeeded'); - done(); - }); - - it('Runs successfully with default inputs and add web.config for node is selected', (done:MochaDone) => { - let tp = path.join(__dirname, 'L0GenerateWebConfigForNode.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); - assert(tr.stderr.length == 0 || tr.errorIssues.length, 'should not have written to stderr'); - var expectedOut = "loc_mock_SuccessfullyGeneratedWebConfig"; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'Updated history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - assert(tr.succeeded, 'task should have succeeded'); - done(); - }); - - it('Verify logs pushed to Kudu when task runs successfully with default inputs and env variables found', (done) => { - this.timeout(1000); - let tp = path.join(__dirname, 'L0WindowsDefault.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - var expectedOut = 'Updated history to kudu'; - var expectedMessage = JSON.stringify({ - type : 'Deployment', - commitId : '46da24f35850f455185b9188b4742359b537076f', - buildId : '1', - releaseId : '1', - buildNumber : '1', - releaseName : 'Release-1', - repoProvider : 'TfsGit', - repoName : 'MyFirstProject', - collectionUrl : 'https://abc.visualstudio.com/', - teamProject : '1', - slotName : 'Production' - }); - var expectedRequestBody = JSON.stringify({ - active : true, - status : 4, - status_text : 'success', - message : expectedMessage, - author : 'author', - deployer : 'VSTS', - details : 'https://abc.visualstudio.com/1/_apps/hub/ms.vss-releaseManagement-web.hub-explorer?releaseId=1&_a=release-summary' - }); - expectedRequestBody = 'kudu log requestBody is:' + expectedRequestBody; - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); - assert(tr.stderr.length == 0 && tr.errorIssues.length == 0, 'should not have written to stderr'); - assert(tr.succeeded, 'task should have succeeded'); - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - assert(tr.stdout.indexOf(expectedRequestBody) != -1, 'should have said: ' + expectedRequestBody); - done(); - }); - - - it('Runs successfully with all other inputs and application insights is not configured for the app service.', (done) => { - let tp = path.join(__dirname, 'L0WindowsAllInput.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - var expectedOut = 'Updated history to kudu'; - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); - assert(tr.stderr.length == 0 && tr.errorIssues.length == 0, 'should not have written to stderr'); - assert(tr.stdout.search(expectedOut) >= 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = "Application Insights is not configured for the App Service mytestapp. Skipping adding release annotation."; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - assert(tr.succeeded, 'task should have succeeded'); - done(); - }); - - - it('Runs successfully with default inputs for deployment to specific slot and invalid application insights key is present in the app settings.', (done) => { - let tp = path.join(__dirname, 'L0WindowsSpecificSlot.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - var expectedOut = 'Updated history to kudu'; - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); - assert(tr.stderr.length == 0 && tr.errorIssues.length == 0, 'should not have written to stderr'); - assert(tr.stdout.search(expectedOut) >= 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = "Unable to find Application Insights resource with Instrumentation key 00000000-0000-0000-0000-000000000000. Skipping adding release annotation." - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - assert(tr.succeeded, 'task should have succeeded'); - done(); - }); - - it('Fails if msdeploy cmd fails to execute', (done) => { - let tp = path.join(__dirname, 'L0WindowsFailDefault.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - var expectedErr = 'Error: msdeploy failed with return code: 1'; - var expectedOut = 'Failed to update history to kudu'; - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); - assert(tr.errorIssues.length > 0 || tr.stderr.length > 0, 'should have written to stderr'); - assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'E should have said: ' + expectedErr); - assert(tr.stdout.search(expectedOut) >= 0, 'should have said: ' + expectedOut); - var sampleOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(sampleOut) < 0, 'should not have updated web app config details'); - assert(tr.failed, 'task should have failed'); - done(); - }); - - it('Verify logs pushed to kudu when task fails if msdeploy cmd fails to execute and some env variables not found', (done) => { - this.timeout(1000); - let tp = path.join(__dirname, 'L0WindowsFailDefault.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - var expectedErr = 'Error: msdeploy failed with return code: 1'; - var expectedOut = 'Failed to update history to kudu'; - var expectedMessage = JSON.stringify({ - type: "Deployment", - commitId : '46da24f35850f455185b9188b4742359b537076f', - buildId : '1', - releaseId : '1', - buildNumber : '1', - releaseName : 'Release-1', - repoProvider : 'TfsGit', - repoName : 'MyFirstProject', - collectionUrl : 'https://abc.visualstudio.com/', - teamProject : '1', - slotName : 'Production' - }); - var expectedRequestBody = JSON.stringify({ - active : false, - status : 3, - status_text : 'failed', - message : expectedMessage, - author : 'author', - deployer : 'VSTS', - details : 'https://abc.visualstudio.com/1/_apps/hub/ms.vss-releaseManagement-web.hub-explorer?releaseId=1&_a=release-summary' - }); - - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); - assert(tr.errorIssues.length > 0 || tr.stderr.length > 0, 'should have written to stderr'); - - assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'should have said: ' + expectedErr); - assert(tr.stdout.search(expectedOut) >= 0, 'should have said: ' + expectedOut); - assert(tr.failed, 'task should have failed'); - expectedRequestBody = 'kudu log requestBody is:' + expectedRequestBody; - assert(tr.stdout.indexOf(expectedRequestBody) != -1, 'should have said: ' + expectedRequestBody); - var sampleOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(sampleOut) < 0, 'should not have updated web app config details'); - done(); - }); - - it('Runs successfully with parameter file present in package', (done) => { - let tp = path.join(__dirname, 'L0WindowsParamFileinPkg.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - var expectedOut = 'Updated history to kudu'; - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); - assert(tr.stderr.length == 0 && tr.errorIssues.length == 0, 'should not have written to stderr'); - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - assert(tr.succeeded, 'task should have succeeded'); - done(); - - }); - - it('Runs successfully with parameter file present in package on non-windows', (done) => { - let tp = path.join(__dirname, 'L0NonWindowsParamFileinPkg.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - var expectedOut = 'Deployed using KuduDeploy'; - assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); - assert(tr.stderr.length == 0, 'should not have written to stderr'); - assert(tr.succeeded, 'task should have succeeded'); - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'Updated history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - done(); - }); - - it('Fails if parameters file provided by user is not present', (done) => { - let tp = path.join(__dirname, 'L0WindowsFailSetParamFile.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.invokedToolCount == 0, 'should not have invoked tool'); - assert(tr.stderr.length > 0 || tr.errorIssues.length > 0, 'should have written to stderr'); - var expectedErr = 'Error: loc_mock_SetParamFilenotfound0 invalidparameterFile.xml'; - assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'should have said: ' + expectedErr); - var expectedOut = 'Failed to update history to kudu'; - assert(tr.stdout.search(expectedOut) >= 0, 'should have said: ' + expectedOut); - var sampleOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(sampleOut) < 0, 'should not have updated web app config details'); - assert(tr.failed, 'task should have failed'); - done(); - }); - - it('Runs successfully with Folder Deployment', (done) => { - let tp = path.join(__dirname, 'L0WindowsFolderPkg.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); - assert(tr.stderr.length == 0 && tr.errorIssues.length == 0, 'should not have written to stderr'); - assert(tr.succeeded, 'task should have succeeded'); - var expectedOut = 'Updated history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - done(); - }); + ApplicationInsightsTests.ApplicationInsightsTests(); + AppServiceTests.AzureAppServiceMockTests(); + KuduServiceTests.KuduServiceTests(); + if (tl.osType().match(/^Win/)) { it('Runs successfully with XML Transformation (L1)', (done:MochaDone) => { let tp = path.join(__dirname, "..", "node_modules","webdeployment-common","Tests","L1XdtTransform.js"); let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); @@ -289,175 +49,10 @@ describe('AzureRmWebAppDeployment Suite', function() { assert(ltx.equal(resultFile, expectFile) , 'Should Transform attributes on Web.config'); done(); }); - - it('Runs Successfully with XML Transformation (Mock)', (done) => { - this.timeout(1000); - let tp = path.join(__dirname, 'L0WindowsXdtTransformation.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - var expectedOut = 'Updated history to kudu'; - assert(tr.invokedToolCount == 2, 'should have invoked tool twice'); - assert(tr.stderr.length == 0 && tr.errorIssues.length == 0, 'should not have written to stderr'); - assert(tr.stdout.search(expectedOut) >= 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - assert(tr.succeeded, 'task should have succeeded'); - assert(tr.stdout.search('loc_mock_AutoParameterizationMessage'), 'Should have provided message for MSBuild package'); - done(); - }); - - it('Fails if XML Transformation throws error (Mock)', (done) => { - let tp = path.join(__dirname, 'L0WindowsXdtTransformationFail.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - var expectedErr = 'Error: loc_mock_XdtTransformationErrorWhileTransforming C:\\tempFolder\\web.config C:\\tempFolder\\web.Release.config'; - assert(tr.invokedToolCount == 1, 'should have invoked tool only once'); - assert(tr.stderr.length > 0 || tr.errorIssues.length > 0, 'should have written to stderr'); - assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'Should have said: ' + expectedErr); - var expectedOut = 'Failed to update history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - var sampleOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(sampleOut) < 0, 'should not have updated web app config details'); - assert(tr.failed, 'task should have failed'); - done(); - }); - - it('Fails if XML Transformation throws error (Mock) for MSBuild package', (done) => { - this.timeout(1000); - let tp = path.join(__dirname, 'L0XdtTransformationFailMSBuildPackage.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.failed, 'task should have failed'); - assert(tr.stderr.search('loc_mock_FailedToApplyTransformation'), 'Should have provided proper errror message for MSBuild package'); - assert(tr.stdout.search('loc_mock_AutoParameterizationMessage'), 'Should have provided message for MSBuild package'); - done(); - }); } else { - it('Runs KuduDeploy successfully with default inputs on non-windows agent', (done) => { - let tp = path.join(__dirname, 'L0NonWindowsDefault.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - var expectedOut = 'Deployed using KuduDeploy'; - assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); - assert(tr.stderr.length == 0 && tr.errorIssues.length == 0, 'should not have written to stderr'); - assert(tr.succeeded, 'task should have succeeded'); - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'Updated history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - done(); - }); - - it('Runs KuduDeploy successfully with folder archiving on non-windows agent', (done) => { - let tp = path.join(__dirname, 'L0NonWindowsFolderPkg.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); - assert(tr.stderr.length == 0 && tr.errorIssues.length == 0, 'should not have written to stderr'); - var expectedOut = 'Compressed folder '; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'Deployed using KuduDeploy'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'Updated history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - assert(tr.succeeded, 'task should have succeeded'); - done(); - }); - - it('Fails KuduDeploy if parameter file is present in package', (done) => { - let tp = path.join(__dirname, 'L0NonWindowsFailParamPkg.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); - assert(tr.stderr.length > 0 || tr.errorIssues.length > 0, 'should have written to stderr'); - var expectedErr = 'Error: Error: loc_mock_MSDeploygeneratedpackageareonlysupportedforWindowsplatform' - assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'should have said: ' + expectedErr); - var expectedOut = 'Failed to update history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - var sampleOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(sampleOut) < 0, 'should not have updated web app config details'); - assert(tr.failed, 'task should have failed'); - done(); - }); - - it('Fails KuduDeploy if folder archiving fails', (done) => { - let tp = path.join(__dirname, 'L0NonWindowsFailArchive.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); - assert(tr.stderr.length > 0 || tr.errorIssues.length > 0, 'should have written to stderr'); - var expectedErr = 'Error: Error: Folder Archiving Failed'; - assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'should have said: ' + expectedErr); - var expectedOut = 'Failed to update history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - var sampleOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(sampleOut) < 0, 'should not have updated web app config details'); - assert(tr.failed, 'task should have failed'); - done(); - }); - - it('Fails if XDT Transformation is run on non-windows platform', (done) => { - let tp = path.join(__dirname, 'L0NonWindowsXdtTransformationFail.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - var expectedErr = "Error: loc_mock_CannotPerformXdtTransformationOnNonWindowsPlatform"; - assert(tr.invokedToolCount == 0, 'should not have invoked tool any tool'); - assert(tr.stderr.length > 0 || tr.errorIssues.length > 0, 'should have written to stderr'); - assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'E should have said: ' + expectedErr); - var expectedOut = 'Failed to update history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - var sampleOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(sampleOut) < 0, 'should not have updated web app config details'); - assert(tr.failed, 'task should have failed'); - done(); - }); } - - it('Fails if more than one package matched with specified pattern', (done) => { - let tp = path.join(__dirname, 'L0WindowsManyPackage.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); - assert(tr.stderr.length > 0 || tr.errorIssues.length > 0, 'should have written to stderr'); - var expectedErr = 'Error: loc_mock_MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern'; - assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'should have said: ' + expectedErr); - var expectedOut = 'Failed to update history to kudu'; - assert(tr.stdout.search(expectedOut) >= 0, 'should have said: ' + expectedOut); - var sampleOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(sampleOut) < 0, 'should not have updated web app config details'); - assert(tr.failed, 'task should have failed'); - done(); - }); - - it('Fails if package or folder name is invalid', (done) => { - let tp = path.join(__dirname, 'L0WindowsNoPackage.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); - assert(tr.stderr.length > 0 || tr.errorIssues.length > 0, 'should have written to stderr'); - var expectedErr = 'Error: loc_mock_Nopackagefoundwithspecifiedpattern'; - assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'should have said: ' + expectedErr); - var expectedOut = 'Failed to update history to kudu'; - assert(tr.stdout.search(expectedOut) >= 0, 'should have said: ' + expectedOut); - var sampleOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(sampleOut) < 0, 'should not have updated web app config details'); - assert(tr.failed, 'task should have failed'); - done(); - }); it('Runs successfully with XML variable substitution', (done:MochaDone) => { let tp = path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L1XmlVarSub.js'); @@ -516,7 +111,7 @@ describe('AzureRmWebAppDeployment Suite', function() { done(); }); - it('Validate webdeployment-common.utility.copyDirectory()', (done:MochaDone) => { + it('Validate webdeployment-common.utility.copyDirectory()', (done:MochaDone) => { let tp = path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L0CopyDirectory.js'); let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); tr.run(); @@ -525,75 +120,4 @@ describe('AzureRmWebAppDeployment Suite', function() { assert(tr.stdout.search('## mkdir Successful ##') >= 0, 'should have created dir including dest folder'); done(); }); - - it('Validate webdepoyment-common.utility.runPostDeploymentScript()', (done:MochaDone) => { - let tp = path.join(__dirname, 'L0RunPostDeploymentScript.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - assert(tr.succeeded, 'task should have succeeded'); - assert(tr.stdout.search('PUT:https://mytestappKuduUrl/api/vfs/site/wwwroot/kuduPostDeploymentScript.cmd') >= 0, 'should have uploaded file: kuduPostDeploymentScript.cmd'); - assert(tr.stdout.search('PUT:https://mytestappKuduUrl/api/vfs/site/wwwroot/mainCmdFile.cmd') >= 0, 'should have uploaded file: mainCmdFile.cmd'); - assert(tr.stdout.search('POST:https://mytestappKuduUrl/api/command') >= 0, 'should have executed script'); - assert(tr.stdout.search('GET:https://mytestappKuduUrl/api/vfs/site/wwwroot/stdout.txt') >= 0, 'should have retrieved file content: stdout.txt'); - assert(tr.stdout.search('GET:https://mytestappKuduUrl/api/vfs/site/wwwroot/stderr.txt') >= 0, 'should have retrieved file content: stderr.txt'); - assert(tr.stdout.search('GET:https://mytestappKuduUrl/api/vfs/site/wwwroot/script_result.txt') >= 0, 'should have retrieved file content: script_result.txt'); - done(); - }); - - it('Validate webdepoyment-common.utility.runPostDeploymentScriptForLinux()', (done:MochaDone) => { - let tp = path.join(__dirname, 'L0RunPostDeploymentScriptForLinux.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - assert(tr.succeeded, 'task should have succeeded'); - assert(tr.stdout.search('PUT:https://mytestappKuduUrl/api/vfs/site/wwwroot/kuduPostDeploymentScript.sh') >= 0, 'should have uploaded file: kuduPostDeploymentScript.sh'); - assert(tr.stdout.search('PUT:https://mytestappKuduUrl/api/vfs/site/wwwroot/mainCmdFile.sh') >= 0, 'should have uploaded file: mainCmdFile.sh'); - assert(tr.stdout.search('POST:https://mytestappKuduUrl/api/command') >= 0, 'should have executed script'); - assert(tr.stdout.search('GET:https://mytestappKuduUrl/api/vfs/site/wwwroot/stdout.txt') >= 0, 'should have retrieved file content: stdout.txt'); - assert(tr.stdout.search('GET:https://mytestappKuduUrl/api/vfs/site/wwwroot/stderr.txt') >= 0, 'should have retrieved file content: stderr.txt'); - assert(tr.stdout.search('GET:https://mytestappKuduUrl/api/vfs/site/wwwroot/script_result.txt') >= 0, 'should have retrieved file content: script_result.txt'); - done(); - }); - - it('Validate webdeployment-common.generatewebconfig.generateWebConfigFile()', (done:MochaDone) => { - let tp = path.join(__dirname, "..", "node_modules", "webdeployment-common", "Tests", 'L0GenerateWebConfig.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - assert(tr.stdout.search('web.config contents: server.js;iisnode') >=0, 'should have replaced web config parameters'); - done(); - }); - - it('Validate success azurerestutility-common.testAzureWebAppAvailability()', (done:MochaDone) => { - let tp = path.join(__dirname, 'WebAppAvailabilitySuccessTest.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - assert(tr.stdout.search('Azure web app is available.') >=0, 'Failed while checking azure web app avilability.'); - done(); - }); - - it('validate failure azurerestutility-common.testAzureWebAppAvailability()', (done:MochaDone) => { - let tp = path.join(__dirname, 'WebAppAvailabilityFailureTest.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - assert(tr.stdout.search('Azure web app in wrong state. Action: testAzureWebAppAvailability') >=0, 'Failed while checking azure web app avilability.'); - done(); - }); - - it('Runs successfully for Builtin Images', (done:MochaDone) => { - let tp = path.join(__dirname, 'L0LinuxBuiltinImage.js'); - let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); - - var expectedOut = 'Successfully updated web app config details'; - assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); - assert(tr.succeeded, 'task should have succeeded'); - assert(tr.stdout.search(expectedOut) > 1, 'should have said: ' + expectedOut + 'twice.'); - expectedOut = 'Deployed using KuduDeploy'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'Updated history to kudu'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - expectedOut = 'loc_mock_SuccessfullyUpdatedAzureRMWebAppConfigDetails'; - assert(tr.stdout.search(expectedOut) > 0, 'should have said: ' + expectedOut); - done(); - }); }); diff --git a/Tasks/AzureRmWebAppDeployment/azurermwebappcontainerdeployment.ts b/Tasks/AzureRmWebAppDeployment/azurermwebappcontainerdeployment.ts deleted file mode 100644 index b924c3eaaf1c..000000000000 --- a/Tasks/AzureRmWebAppDeployment/azurermwebappcontainerdeployment.ts +++ /dev/null @@ -1,202 +0,0 @@ -import tl = require('vsts-task-lib/task'); -import util = require('util'); -import url = require('url'); - -var azureRESTUtility = require ('azurerest-common/azurerestutility.js'); -var parameterParser = require("./parameterparser.js").parse; - -enum registryTypes { - "AzureContainerRegistry", - "Registry", // TODO: Rename it to DockerHub while supporting all the registry types. Also add all these registry types in Task.json in ImageSource pick list. - "PrivateRegistry" -} - -export async function deployWebAppImage(endPoint, resourceGroupName, webAppName, deployToSlotFlag, slotName) { - var startupCommand = tl.getInput('StartupCommand', false); - - var imageName = getImageName(); - var appName = deployToSlotFlag ? webAppName + "-" + slotName : webAppName; - tl.debug("Deploying an image " + imageName + " to the webapp " + appName); - - // Update webapp configuration - tl.debug("Updating the webapp configuration."); - var updatedConfigDetails = JSON.stringify({ - "properties": { - "appCommandLine": startupCommand, - "linuxFxVersion": "DOCKER|" + imageName - } - }); - - await azureRESTUtility.updateAzureRMWebAppConfigDetails(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName, updatedConfigDetails); - - // Update webapp settings - tl.debug("Updating the webapp application settings."); - var webAppSettings = await getWebAppSettings(imageName, endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName); - await azureRESTUtility.updateWebAppAppSettings(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName, webAppSettings); -} - -function getImageName() { - var registryType = tl.getInput('ImageSource', true); - var imageName = null; - - switch(registryType) { - case registryTypes[registryTypes.AzureContainerRegistry]: - imageName = getAzureContainerImageName(); - break; - - case registryTypes[registryTypes.Registry]: - imageName = getDockerHubImageName(); - break; - - case registryTypes[registryTypes.PrivateRegistry]: - imageName = getPrivateRegistryImageName(); - break; - } - - return imageName; -} - -function getAzureContainerImageName() { - var registry = tl.getInput('AzureContainerRegistryLoginServer', true) + ".azurecr.io"; - var image = tl.getInput('AzureContainerRegistryImage', true); - var tag = tl.getInput('AzureContainerRegistryTag', false); - - return constructImageName(registry, image, tag); -} - -function getDockerHubImageName() { - var namespace = tl.getInput('DockerNamespace', true); - var image = tl.getInput('DockerRepository', true); - var tag = tl.getInput('DockerImageTag', false); - - return constructImageName(namespace, image, tag); -} - -function getPrivateRegistryImageName() { - var registryConnectedServiceName = tl.getInput('RegistryConnectedServiceName', true); - var loginServer = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'url', true); - - var registry = url.parse(loginServer).hostname; - var image = tl.getInput('PrivateRegistryImage', true); - var tag = tl.getInput('PrivateRegistryTag', false); - - return constructImageName(registry, image, tag); -} - -function constructImageName(namespace, repository, tag) { - var imageName = null; - /* - Special Case : If release definition is not linked to build artifacts - then $(Build.BuildId) variable don't expand in release. So clearing state - of dockerImageTag if $(Build.BuildId) not expanded in value of dockerImageTag. - */ - if(tag && (tag.trim() == "$(Build.BuildId)")) { - tag = null; - } - - if(tag) { - imageName = namespace + "/" + repository + ":" + tag; - } else { - imageName = namespace + "/" + repository; - } - - return imageName; -} - -export async function getWebAppSettings(imageName, endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName) { - // Get new appsettings specified in the task - var appSettingsParameters = tl.getInput('AppSettings', false); - appSettingsParameters = appSettingsParameters ? appSettingsParameters.trim() : ""; - appSettingsParameters = await getContainerRegistrySettings(imageName, endPoint) + " " + appSettingsParameters; - - // Get current appsettings of webapp - var webAppSettings = await azureRESTUtility.getWebAppAppSettings(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName); - - // Update the current webapp settings with new appsetting details - updateWebAppSettings(appSettingsParameters, webAppSettings); - - return webAppSettings; -} - -async function getContainerRegistrySettings(imageName,endPoint) { - var containerRegistryType = tl.getInput('ImageSource', true); - var containerRegistrySettings = "-DOCKER_CUSTOM_IMAGE_NAME " + imageName; - var containerRegistryAuthParamsFormatString = "-DOCKER_REGISTRY_SERVER_URL %s -DOCKER_REGISTRY_SERVER_USERNAME %s -DOCKER_REGISTRY_SERVER_PASSWORD %s"; - - switch(containerRegistryType) { - case registryTypes[registryTypes.AzureContainerRegistry]: - containerRegistrySettings = await getAzureContainerRegistrySettings(endPoint, containerRegistrySettings, containerRegistryAuthParamsFormatString); - break; - - case registryTypes[registryTypes.Registry]: - var dockerRespositoryAccess = tl.getInput('DockerRepositoryAccess', true); - if(dockerRespositoryAccess === "private") - { - containerRegistrySettings = getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString); - } - break; - - case registryTypes[registryTypes.PrivateRegistry]: - containerRegistrySettings = getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString); - break; - } - - return containerRegistrySettings; - } - -async function getAzureContainerRegistrySettings(endPoint, containerRegistrySettings, containerRegistryAuthParamsFormatString) { - var registryServerName = tl.getInput('AzureContainerRegistryLoginServer', true); - var registryUrl = "https://" + registryServerName + ".azurecr.io"; - tl.debug("Azure Container Registry Url: " + registryUrl); - - var registryName = tl.getInput('AzureContainerRegistry', true); - var resourceGroupName = await azureRESTUtility.getResourceGroupName(endPoint, registryName, "Microsoft.ContainerRegistry/registries"); - tl.debug("Resource group name of a registry: " + resourceGroupName); - - var creds = await azureRESTUtility.getAzureContainerRegistryCredentials(endPoint, registryName, resourceGroupName); - tl.debug("Successfully retrieved the registry credentials"); - - var username = creds.username; - var password = creds["passwords"][0].value; - - return containerRegistrySettings + " " + util.format(containerRegistryAuthParamsFormatString, registryUrl, username, password); - } - -function getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString) { - var registryConnectedServiceName = tl.getInput('RegistryConnectedServiceName', true); - var username = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'username', true); - var password = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'password', true); - var registryUrl = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'registry', true); - - tl.debug("Docker or Private Container Registry Url: " + registryUrl); - - return containerRegistrySettings + " " + util.format(containerRegistryAuthParamsFormatString, registryUrl, username, password); -} - -function updateWebAppSettings(appSettingsParameters, webAppSettings) { - // In case of public repo, clear the connection details of a registry - var dockerRespositoryAccess = tl.getInput('DockerRepositoryAccess', true); - - // Uncomment the below lines while supprting all registry types. - // if(dockerRespositoryAccess === "public") - // { - // deleteRegistryConnectionSettings(webAppSettings); - // } - - var parsedAppSettings = parameterParser(appSettingsParameters); - for (var settingName in parsedAppSettings) { - var setting = settingName.trim(); - var settingVal = parsedAppSettings[settingName].value; - settingVal = settingVal ? settingVal.trim() : ""; - - if(setting) { - webAppSettings["properties"][setting] = settingVal; - } - } -} - -function deleteRegistryConnectionSettings(webAppSettings) { - delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_URL"]; - delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_USERNAME"]; - delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_PASSWORD"]; -} diff --git a/Tasks/AzureRmWebAppDeployment/azurermwebappdeployment.ts b/Tasks/AzureRmWebAppDeployment/azurermwebappdeployment.ts index 315bd2dab5d3..460e7360ceb1 100644 --- a/Tasks/AzureRmWebAppDeployment/azurermwebappdeployment.ts +++ b/Tasks/AzureRmWebAppDeployment/azurermwebappdeployment.ts @@ -1,409 +1,132 @@ import tl = require('vsts-task-lib/task'); import path = require('path'); import fs = require('fs'); +import { AzureRMEndpoint } from 'azure-arm-rest/azure-arm-endpoint'; +import { AzureEndpoint } from 'azure-arm-rest/azureModels'; +import { AzureResourceFilterUtility } from './operations/AzureResourceFilterUtility'; +import { KuduServiceUtility } from './operations/KuduServiceUtility'; +import { AzureAppService } from 'azure-arm-rest/azure-arm-app-service'; +import { Kudu } from 'azure-arm-rest/azure-arm-app-service-kudu'; +import { AzureAppServiceUtility } from './operations/AzureAppServiceUtility'; +import { ContainerBasedDeploymentUtility } from './operations/ContainerBasedDeploymentUtility'; +import { TaskParameters, TaskParametersUtility } from './operations/TaskParameters'; +import { FileTransformsUtility } from './operations/FileTransformsUtility'; import * as ParameterParser from './parameterparser' +import { addReleaseAnnotation } from './operations/ReleaseAnnotationUtility'; + +var packageUtility = require('webdeployment-common/packageUtility.js'); -var azureRESTUtility = require ('azurerest-common/azurerestutility.js'); -var msDeployUtility = require('webdeployment-common/msdeployutility.js'); var zipUtility = require('webdeployment-common/ziputility.js'); var deployUtility = require('webdeployment-common/utility.js'); var msDeploy = require('webdeployment-common/deployusingmsdeploy.js'); -var fileTransformationsUtility = require('webdeployment-common/fileTransformationsUtility.js'); -var kuduUtility = require('./kuduutility.js'); -var generateWebConfigUtil = require('webdeployment-common/webconfigutil.js'); -var deployWebAppImage = require("./azurermwebappcontainerdeployment").deployWebAppImage; -var azureStackUtility = require ('azurestack-common/azurestackrestutility.js'); -var updateAppSettings = require("./azurermwebappcontainerdeployment").updateAppSettings; -async function run() { - try { - tl.setResourcePath(path.join( __dirname, 'task.json')); - var connectedServiceName = tl.getInput('ConnectedServiceName', true); - var webAppName: string = tl.getInput('WebAppName', true); - var deployToSlotFlag: boolean = tl.getBoolInput('DeployToSlotFlag', false); - var resourceGroupName: string = tl.getInput('ResourceGroupName', false); - var slotName: string = tl.getInput('SlotName', false); - var webDeployPkg: string = tl.getPathInput('Package', true); - var virtualApplication: string = tl.getInput('VirtualApplication', false); - var useWebDeploy: boolean = tl.getBoolInput('UseWebDeploy', false); - var setParametersFile: string = tl.getPathInput('SetParametersFile', false); - var removeAdditionalFilesFlag: boolean = tl.getBoolInput('RemoveAdditionalFilesFlag', false); - var excludeFilesFromAppDataFlag: boolean = tl.getBoolInput('ExcludeFilesFromAppDataFlag', false); - var takeAppOfflineFlag: boolean = tl.getBoolInput('TakeAppOfflineFlag', false); - var renameFilesFlag: boolean = tl.getBoolInput('RenameFilesFlag', false); - var additionalArguments: string = tl.getInput('AdditionalArguments', false); - var webAppUri:string = tl.getInput('WebAppUri', false); - var xmlTransformation: boolean = tl.getBoolInput('XmlTransformation', false); - var JSONFiles = tl.getDelimitedInput('JSONFiles', '\n', false); - var xmlVariableSubstitution: boolean = tl.getBoolInput('XmlVariableSubstitution', false); - var scriptType: string = tl.getInput('ScriptType', false); - var inlineScript: string = tl.getInput('InlineScript', false); - var scriptPath: string = tl.getPathInput('ScriptPath', false); - var generateWebConfig = tl.getBoolInput('GenerateWebConfig', false); - var webConfigParametersStr = tl.getInput('WebConfigParameters', false); - var webAppKind = tl.getInput('WebAppKind', false); - var dockerNamespace = tl.getInput('DockerNamespace', false); +async function main() { + try { var isDeploymentSuccess: boolean = true; - var tempPackagePath = null; - var inputAppSettings = tl.getInput('AppSettings', false); - var imageSource = tl.getInput('ImageSource', false); - var startupCommand = tl.getInput('StartupCommand', false); - var isLinuxWebApp: boolean = webAppKind && webAppKind.indexOf("linux") >= 0; - var runtimeStack = ""; - var linuxWebDeployPkg = ""; - - var isBuiltinLinuxWebApp: boolean = imageSource && imageSource.indexOf("Builtin") >=0; + var kuduServiceUtility: KuduServiceUtility; + tl.setResourcePath(path.join( __dirname, 'task.json')); + var taskParams: TaskParameters = TaskParametersUtility.getParameters(); + var azureEndpoint: AzureEndpoint = await new AzureRMEndpoint(taskParams.connectedServiceName).getEndpoint(); - if (isLinuxWebApp && isBuiltinLinuxWebApp) { - linuxWebDeployPkg = tl.getInput('BuiltinLinuxPackage', true); - runtimeStack = tl.getInput('RuntimeStack', true); + console.log(tl.loc('GotconnectiondetailsforazureRMWebApp0', taskParams.WebAppName)); + if(!taskParams.DeployToSlotFlag) { + taskParams.ResourceGroupName = await AzureResourceFilterUtility.getResourceGroupName(azureEndpoint, taskParams.WebAppName); } - var endPoint = await azureStackUtility.initializeAzureRMEndpointData(connectedServiceName); + tl.debug(`Resource Group: ${taskParams.ResourceGroupName}`); + var appService: AzureAppService = new AzureAppService(azureEndpoint, taskParams.ResourceGroupName, taskParams.WebAppName, taskParams.SlotName, taskParams.WebAppKind); + let appServiceUtility: AzureAppServiceUtility = new AzureAppServiceUtility(appService); - if(deployToSlotFlag) { - if (slotName.toLowerCase() === "production") { - deployToSlotFlag = false; - } + await appServiceUtility.pingApplication(); + let kuduService: Kudu = await appServiceUtility.getKuduService(); + kuduServiceUtility = new KuduServiceUtility(kuduService); + if(taskParams.WebAppUri) { + tl.setVariable(taskParams.WebAppUri, await appServiceUtility.getApplicationURL()); } - else { - resourceGroupName = await azureRESTUtility.getResourceGroupName(endPoint, webAppName); - } - - var publishingProfile = await azureRESTUtility.getAzureRMWebAppPublishProfile(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName); - var webAppSettings = await azureRESTUtility.getWebAppAppSettings(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName); - console.log(tl.loc('GotconnectiondetailsforazureRMWebApp0', webAppName)); - - // For container based linux deployment - if(isLinuxWebApp && !isBuiltinLinuxWebApp && dockerNamespace) { - tl.debug("Performing container based deployment."); - - if (webAppUri) { - tl.setVariable(webAppUri, publishingProfile.destinationAppUrl); - } - await deployWebAppImage(endPoint, resourceGroupName, webAppName, deployToSlotFlag, slotName); - } - else { - tl.debug("Performing the deployment of webapp."); - if(isLinuxWebApp) { - webDeployPkg = linuxWebDeployPkg; - } - var availableWebPackages = deployUtility.findfiles(webDeployPkg); - if(availableWebPackages.length == 0) { - throw new Error(tl.loc('Nopackagefoundwithspecifiedpattern')); - } - - if(availableWebPackages.length > 1) { - throw new Error(tl.loc('MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern')); - } - webDeployPkg = availableWebPackages[0]; - - var azureWebAppDetails = null; - var virtualApplicationPhysicalPath = null; - - if (!isLinuxWebApp) { - if (virtualApplication) { - virtualApplication = (virtualApplication.startsWith("/")) ? virtualApplication.substr(1) : virtualApplication; - azureWebAppDetails = await azureRESTUtility.getAzureRMWebAppConfigDetails(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName); - var virtualApplicationMappings = azureWebAppDetails.properties.virtualApplications; - var pathMappings = kuduUtility.getVirtualAndPhysicalPaths(virtualApplication, virtualApplicationMappings); - if (pathMappings[1] != null) { - virtualApplicationPhysicalPath = pathMappings[1]; - await kuduUtility.ensurePhysicalPathExists(publishingProfile, pathMappings[1]); - } - else { - throw Error(tl.loc("VirtualApplicationDoesNotExist", virtualApplication)); - } + if(taskParams.isLinuxApp) { + switch(taskParams.ImageSource) { + case 'Builtin': { + var webPackage = packageUtility.PackageUtility.getPackagePath(taskParams.Package); + tl.debug('Performing Linux built-in package deployment'); + await kuduServiceUtility.deployWebPackage(webPackage, null , '/', taskParams.TakeAppOfflineFlag); + await appServiceUtility.updateStartupCommandAndRuntimeStack(taskParams.RuntimeStack, taskParams.StartupCommand); + break; } - var isFolderBasedDeployment = deployUtility.isInputPkgIsFolder(webDeployPkg); - var applyFileTransformFlag = JSONFiles.length != 0 || xmlTransformation || xmlVariableSubstitution; - - if (applyFileTransformFlag || generateWebConfig) { - var folderPath = await deployUtility.generateTemporaryFolderForDeployment(isFolderBasedDeployment, webDeployPkg); - - if (generateWebConfig) { - tl.debug('parsing web.config parameters'); - var webConfigParameters = ParameterParser.parse(webConfigParametersStr); - generateWebConfigUtil.addWebConfigFile(folderPath, webConfigParameters, virtualApplicationPhysicalPath); - } - if (applyFileTransformFlag) { - var isMSBuildPackage = !isFolderBasedDeployment && (await deployUtility.isMSDeployPackage(webDeployPkg)); - fileTransformationsUtility.fileTransformations(isFolderBasedDeployment, JSONFiles, xmlTransformation, xmlVariableSubstitution, folderPath, isMSBuildPackage); - } - - var output = await deployUtility.archiveFolderForDeployment(isFolderBasedDeployment, folderPath); - tempPackagePath = output.tempPackagePath; - webDeployPkg = output.webDeployPkg; + case 'Registry': { + tl.debug("Performing container based deployment."); + let containerDeploymentUtility: ContainerBasedDeploymentUtility = new ContainerBasedDeploymentUtility(appService); + await containerDeploymentUtility.deployWebAppImage(taskParams); + break; } - - if (virtualApplication) { - publishingProfile.destinationAppUrl += "/" + virtualApplication; + default: { + throw new Error('Invalid Image source Type'); } } - if(webAppUri) { - tl.setVariable(webAppUri, publishingProfile.destinationAppUrl); + } + else { + var webPackage = packageUtility.PackageUtility.getPackagePath(taskParams.Package); + var isFolderBasedDeployment = deployUtility.isInputPkgIsFolder(webPackage); + var physicalPath: string = '/site/wwwroot'; + if(taskParams.VirtualApplication) { + physicalPath = await appServiceUtility.getPhysicalPath(taskParams.VirtualApplication); + await kuduServiceUtility.createPathIfRequired(physicalPath); } - if(publishingProfile && publishingProfile.destinationAppUrl) { - try{ - await azureRESTUtility.testAzureWebAppAvailability(publishingProfile.destinationAppUrl, 3000); - } catch (error) { - tl.debug("Failed to check availability of azure web app, error : " + error.message); - } - } + webPackage = await FileTransformsUtility.applyTransformations(webPackage, taskParams); - if(!isLinuxWebApp && deployUtility.canUseWebDeploy(useWebDeploy)) { + if(deployUtility.canUseWebDeploy(taskParams.UseWebDeploy)) { + tl.debug("Performing the deployment of webapp."); if(!tl.osType().match(/^Win/)){ throw Error(tl.loc("PublishusingwebdeployoptionsaresupportedonlywhenusingWindowsagent")); } - if(renameFilesFlag) { - if (webAppSettings.properties.MSDEPLOY_RENAME_LOCKED_FILES == undefined || webAppSettings.properties.MSDEPLOY_RENAME_LOCKED_FILES == '0'){ - webAppSettings.properties.MSDEPLOY_RENAME_LOCKED_FILES = '1'; - await azureRESTUtility.updateWebAppAppSettings(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName, webAppSettings); - } - } - else { - if (webAppSettings.properties.MSDEPLOY_RENAME_LOCKED_FILES != undefined && webAppSettings.properties.MSDEPLOY_RENAME_LOCKED_FILES != '0'){ - delete webAppSettings.properties.MSDEPLOY_RENAME_LOCKED_FILES; - await azureRESTUtility.updateWebAppAppSettings(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName, webAppSettings); - } - } - - console.log("##vso[task.setvariable variable=websiteUserName;issecret=true;]" + publishingProfile.userName); - console.log("##vso[task.setvariable variable=websitePassword;issecret=true;]" + publishingProfile.userPWD); - await msDeploy.DeployUsingMSDeploy(webDeployPkg, webAppName, publishingProfile, removeAdditionalFilesFlag, - excludeFilesFromAppDataFlag, takeAppOfflineFlag, virtualApplication, setParametersFile, - additionalArguments, isFolderBasedDeployment, useWebDeploy); - } else { - tl.debug("Initiated deployment via kudu service for webapp package : " + webDeployPkg); - if(azureWebAppDetails == null) { - azureWebAppDetails = await azureRESTUtility.getAzureRMWebAppConfigDetails(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName); + if(taskParams.RenameFilesFlag) { + await appServiceUtility.enableRenameLockedFiles(); } - await DeployUsingKuduDeploy(webDeployPkg, azureWebAppDetails, publishingProfile, virtualApplication, isFolderBasedDeployment, takeAppOfflineFlag); - - if(isLinuxWebApp) { - await updateAppSetting(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName, inputAppSettings); - await updateStartupCommandAndRuntimeStack(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName, runtimeStack, startupCommand); - } + var msDeployPublishingProfile = await appServiceUtility.getWebDeployPublishingProfile(); + await msDeploy.DeployUsingMSDeploy(webPackage, taskParams.WebAppName, msDeployPublishingProfile, taskParams.RemoveAdditionalFilesFlag, + taskParams.ExcludeFilesFromAppDataFlag, taskParams.TakeAppOfflineFlag, taskParams.VirtualApplication, taskParams.SetParametersFile, + taskParams.AdditionalArguments, isFolderBasedDeployment, taskParams.UseWebDeploy); } - if(scriptType) { - var kuduWorkingDirectory = virtualApplication ? virtualApplicationPhysicalPath : 'site/wwwroot'; - await kuduUtility.runPostDeploymentScript(publishingProfile, kuduWorkingDirectory, scriptType, inlineScript, scriptPath, takeAppOfflineFlag, isLinuxWebApp); + else { + tl.debug("Initiated deployment via kudu service for webapp package : "); + await kuduServiceUtility.deployWebPackage(webPackage, physicalPath, taskParams.VirtualApplication, taskParams.TakeAppOfflineFlag); } } - await updateWebAppConfigDetails(endPoint, webAppName, resourceGroupName, deployToSlotFlag, slotName); - } - catch (error) { - isDeploymentSuccess = false; - tl.setResult(tl.TaskResult.Failed, error); - } - - try { - // Add release annotation for App Services which has an Application Insights resource configured to it. - await addReleaseAnnotation(endPoint, webAppName, webAppSettings, isDeploymentSuccess); - } - catch (error) { - // let the task silently continue if adding release annotation fails - console.log(tl.loc("FailedAddingReleaseAnnotation", error)); - } - - if(publishingProfile != null) { - var customMessage = { - type: "Deployment", - slotName: (deployToSlotFlag ? slotName : "Production") - }; - - try { - console.log(await azureRESTUtility.updateDeploymentStatus(publishingProfile, isDeploymentSuccess, customMessage)); - } - catch(error) { - tl.warning(error); - } - } - if(tempPackagePath) { - tl.rmRF(tempPackagePath); - } -} - - -/** - * Deploys website using Kudu REST API - * - * @param webDeployPkg Web deploy package - * @param webAppName Web App Name - * @param publishingProfile Azure RM Connection Details - * @param virtualApplication Virtual Application Name - * @param isFolderBasedDeployment Input is folder or not - * - */ -async function DeployUsingKuduDeploy(webDeployPkg, azureWebAppDetails, publishingProfile, virtualApplication, isFolderBasedDeployment, takeAppOfflineFlag) { - var tempPackagePath = null; - try { - var virtualApplicationMappings = azureWebAppDetails.properties.virtualApplications; - var webAppZipFile = webDeployPkg; - if(isFolderBasedDeployment) { - tempPackagePath = deployUtility.generateTemporaryFolderOrZipPath(tl.getVariable('System.DefaultWorkingDirectory'), false); - webAppZipFile = await zipUtility.archiveFolder(webDeployPkg, "", tempPackagePath); - tl.debug("Compressed folder " + webDeployPkg + " into zip : " + webAppZipFile); - } else { - if (await deployUtility.isMSDeployPackage(webAppZipFile)) { - throw new Error(tl.loc("MSDeploygeneratedpackageareonlysupportedforWindowsplatform")); + if(!taskParams.isContainerWebApp) { + if(taskParams.AppSettings) { + var customApplicationSettings = ParameterParser.parse(taskParams.AppSettings); + await appServiceUtility.updateAndMonitorAppSettings(customApplicationSettings); } - } - var physicalPath = "/site/wwwroot"; - var virtualPath = "/"; - - if (webDeployPkg && webDeployPkg.toLowerCase().endsWith('.war')) { - tl.debug('WAR: webAppPackage = ' + webDeployPkg); - let warFile = path.basename(webDeployPkg.slice(0, webDeployPkg.length - '.war'.length)); - let warExt = webDeployPkg.slice(webDeployPkg.length - '.war'.length) - tl.debug('WAR: warFile = ' + warFile); - warFile = warFile + ((virtualApplication) ? "/" + virtualApplication : ""); - tl.debug('WAR: warFile = ' + warFile); - physicalPath = physicalPath + "/webapps/" + warFile; - await kuduUtility.ensurePhysicalPathExists(publishingProfile, physicalPath); - } else { - if(virtualApplication) { - var pathMappings = kuduUtility.getVirtualAndPhysicalPaths(virtualApplication, virtualApplicationMappings); - if(pathMappings[1] != null) { - virtualPath = pathMappings[0]; - physicalPath = pathMappings[1]; - } else { - throw Error(tl.loc("VirtualApplicationDoesNotExist", virtualApplication)); - } + + if(taskParams.ConfigurationSettings) { + var customApplicationSettings = ParameterParser.parse(taskParams.ConfigurationSettings); + await appServiceUtility.updateConfigurationSettings(customApplicationSettings); } } - - await kuduUtility.deployWebAppPackage(webAppZipFile, publishingProfile, virtualPath, physicalPath, takeAppOfflineFlag); - console.log(tl.loc('PackageDeploymentSuccess')); - } - catch(error) { - tl.error(tl.loc('PackageDeploymentFailed')); - throw Error(error); - } - finally { - if(tempPackagePath) { - tl.rmRF(tempPackagePath, true); + else { + tl.debug('App Settings and config settings are already updated during container based deployment.') } - } -} -async function updateWebAppConfigDetails(SPN, webAppName: string, resourceGroupName: string, deployToSlotFlag: boolean, slotName: string) { - try { - var configDetails = await azureRESTUtility.getAzureRMWebAppConfigDetails(SPN, webAppName, resourceGroupName, deployToSlotFlag, slotName); - var scmType: string = configDetails.properties.scmType; - if (scmType && scmType.toLowerCase() === "none") { - var updatedConfigDetails = JSON.stringify( - { - "properties": { - "scmType": "VSTSRM" - } - }); - - await azureRESTUtility.updateAzureRMWebAppConfigDetails(SPN, webAppName, resourceGroupName, deployToSlotFlag, slotName, updatedConfigDetails); - - await updateArmMetadata(SPN, webAppName, resourceGroupName, deployToSlotFlag, slotName); - - console.log(tl.loc("SuccessfullyUpdatedAzureRMWebAppConfigDetails")); + if(taskParams.ScriptType) { + await kuduServiceUtility.runPostDeploymentScript(taskParams); } - } - catch (error) { - tl.warning(tl.loc("FailedToUpdateAzureRMWebAppConfigDetails", error)); - } -} - -async function updateArmMetadata(SPN, webAppName: string, resourceGroupName: string, deployToSlotFlag: boolean, slotName: string) { - var collectionUri = tl.getVariable("system.teamfoundationCollectionUri"); - var projectId = tl.getVariable("system.teamprojectId"); - var buildDefintionId = tl.getVariable("build.definitionId") - var releaseDefinitionId = tl.getVariable("release.definitionId"); - - let newPoperties = { - VSTSRM_BuildDefinitionId: buildDefintionId, - VSTSRM_ReleaseDefinitionId: releaseDefinitionId, - VSTSRM_ProjectId: projectId, - VSTSRM_AccountId: tl.getVariable("system.collectionId"), - VSTSRM_BuildDefinitionWebAccessUrl: collectionUri + projectId + "/_build?_a=simple-process&definitionId=" + buildDefintionId, - VSTSRM_ConfiguredCDEndPoint: collectionUri + projectId + "/_apps/hub/ms.vss-releaseManagement-web.hub-explorer?definitionId=" + releaseDefinitionId - } - - var metadata = await azureRESTUtility.getAzureRMWebAppMetadata(SPN, webAppName, resourceGroupName, deployToSlotFlag, slotName); - var properties = metadata.properties; - - Object.keys(newPoperties).forEach((key) => { - properties[key] = newPoperties[key]; - }); - - metadata.properties = properties; - await azureRESTUtility.updateAzureRMWebAppMetadata(SPN, webAppName, resourceGroupName, deployToSlotFlag, slotName, metadata); -} - -async function updateStartupCommandAndRuntimeStack(SPN, webAppName: string, resourceGroupName: string, deployToSlotFlag: boolean, slotName: string, runtimeStack: string, startupCommand: string) { - try { - var configDetails = await azureRESTUtility.getAzureRMWebAppConfigDetails(SPN, webAppName, resourceGroupName, deployToSlotFlag, slotName); - var linuxFxVersion: string = configDetails.properties.linuxFxVersion; - var appCommandLine: string = configDetails.properties.appCommandLine; - - var updatedConfigDetails: string = ""; - - if (!(!!appCommandLine == !!startupCommand && appCommandLine == startupCommand) - || runtimeStack != linuxFxVersion) { - updatedConfigDetails = JSON.stringify({ - "properties": { - "linuxFxVersion": runtimeStack, - "appCommandLine": startupCommand - } - }); - - tl.debug("Updating webConfig with the details: " + updatedConfigDetails); - await azureRESTUtility.updateAzureRMWebAppConfigDetails(SPN, webAppName, resourceGroupName, deployToSlotFlag, slotName, updatedConfigDetails); - - console.log(tl.loc("SuccessfullyUpdatedRuntimeStackAndStartupCommand")); - } - } - catch (error) { - throw new Error(tl.loc("FailedToUpdateRuntimeStackAndStartupCommand", error)); + await appServiceUtility.updateScmTypeAndConfigurationDetails(); } -} - -async function updateAppSetting(SPN, webAppName: string, resourceGroupName: string, deployToSlotFlag: boolean, slotName: string, appSettings: any) { - if (appSettings) { - try { - tl.debug("Updating app settings for builtin images"); - - await updateAppSettings(SPN, webAppName, resourceGroupName, deployToSlotFlag, slotName, appSettings); - - console.log(tl.loc("SuccessfullyUpdatedWebAppSettings")); - } - catch (error) { - throw new Error(tl.loc("FailedToUpdateAppSettingsInConfigDetails", error)); - } + catch(error) { + isDeploymentSuccess = false; + tl.setResult(tl.TaskResult.Failed, error); } -} - -async function addReleaseAnnotation(SPN, webAppName: string, webAppSettings: any, isDeploymentSuccess: boolean) { - let appInsightsInstrumentationKey: string = webAppSettings && webAppSettings.properties && webAppSettings.properties[azureRESTUtility.appInsightsInstrumentationKeyAppSetting]; - - if (!!appInsightsInstrumentationKey) { - let appInsightsResource = await azureRESTUtility.getApplicationInsightsResources(SPN, null, `InstrumentationKey eq '${appInsightsInstrumentationKey}'`); - if (appInsightsResource && appInsightsResource.length > 0) { - console.log(tl.loc("AddingReleaseAnnotation", appInsightsResource[0].name)); - let releaseAnnotationResponse = await azureRESTUtility.addReleaseAnnotation(SPN, appInsightsResource[0].id, isDeploymentSuccess); - tl.debug(JSON.stringify(releaseAnnotationResponse, null, 2)); - console.log(tl.loc("SuccessfullyAddedReleaseAnnotation", appInsightsResource[0].name)); - } - else { - tl.debug(`Unable to find Application Insights resource with Instrumentation key ${appInsightsInstrumentationKey}. Skipping adding release annotation.`); + finally { + if(kuduServiceUtility) { + await addReleaseAnnotation(azureEndpoint, appService, isDeploymentSuccess); + await kuduServiceUtility.updateDeploymentStatus(isDeploymentSuccess, null, {'type': 'Deployment', slotName: appService.getSlot()}); } } - else { - tl.debug(`Application Insights is not configured for the App Service ${webAppName}. Skipping adding release annotation.`); - } } -run(); +main(); diff --git a/Tasks/AzureRmWebAppDeployment/kuduutility.ts b/Tasks/AzureRmWebAppDeployment/kuduutility.ts deleted file mode 100644 index 5b7c11e8df60..000000000000 --- a/Tasks/AzureRmWebAppDeployment/kuduutility.ts +++ /dev/null @@ -1,536 +0,0 @@ -import Q = require('q'); -import tl = require('vsts-task-lib/task'); -import path = require("path"); -import fs = require("fs"); -import * as rm from "typed-rest-client/RestClient"; -import * as hm from "typed-rest-client/HttpClient"; -import httpInterfaces = require("typed-rest-client/Interfaces"); - -let proxyUrl: string = tl.getVariable("agent.proxyurl"); -var requestOptions: httpInterfaces.IRequestOptions = proxyUrl ? { - proxy: { - proxyUrl: proxyUrl, - proxyUsername: tl.getVariable("agent.proxyusername"), - proxyPassword: tl.getVariable("agent.proxypassword"), - proxyBypassHosts: tl.getVariable("agent.proxybypasslist") ? JSON.parse(tl.getVariable("agent.proxybypasslist")) : null - } -} : {}; - -let ignoreSslErrors: string = tl.getVariable("VSTS_ARM_REST_IGNORE_SSL_ERRORS"); -requestOptions.ignoreSslError = ignoreSslErrors && ignoreSslErrors.toLowerCase() == "true"; -let hc = new hm.HttpClient(tl.getVariable("AZURE_HTTP_USER_AGENT"), null, requestOptions); -let rc = new rm.RestClient(tl.getVariable("AZURE_HTTP_USER_AGENT"), null, null, requestOptions); - -var fileEncoding = require('webdeployment-common/fileencoding.js'); -var azureUtility = require('azurerest-common/utility.js'); - -/** - * Finds out virtual path and corresponding physical path mapping. - * - * @param virtualApplication Virtual Application details - * @param virtualApplicationMappings - */ -export function getVirtualAndPhysicalPaths(virtualApplication: string, virtualApplicationMappings) { - // construct URL depending on virtualApplication or root of webapplication - var physicalPath = null; - var virtualPath = "/" + virtualApplication; - - for( var index in virtualApplicationMappings ) { - var mapping = virtualApplicationMappings[index]; - if( mapping.virtualPath.toLowerCase() == virtualPath.toLowerCase()){ - physicalPath = mapping.physicalPath; - break; - } - } - - return [virtualPath, physicalPath]; -} - -export async function appOfflineKuduService(publishingProfile, physicalPath: string, enableFeature: boolean) { - if(enableFeature) { - tl.debug('Trying to enable app offline mode.'); - var appOfflineFilePath = path.join(tl.getVariable('system.DefaultWorkingDirectory'), 'app_offline_temp.htm'); - tl.writeFile(appOfflineFilePath, '

App Service is offline.

'); - await uploadFiletoKudu(publishingProfile, '/site/wwwroot', 'app_offline.htm', appOfflineFilePath); - tl.debug('App Offline mode enabled.'); - } - else { - tl.debug('Trying to disable app offline mode.'); - await deleteFileFromKudu(publishingProfile, 'site/wwwroot', 'app_offline.htm', false); - tl.debug('App Offline mode disabled.'); - } -} - -/** - * Deploys a zip based webapp package. - * - * @param webAppPackage Zip file or folder for deployment - * @param publishingProfile publish profile provides destination details for deployment - * @param virtualApplication (Optional) Virtual application name - * @param virtualApplicationMappings Mapping to get physical path for deployment - */ -export async function deployWebAppPackage(webAppPackage: string, publishingProfile, virtualPath: string, physicalPath: string, takeAppOfflineFlag: boolean) { - - var deferred = Q.defer(); - var kuduDeploymentURL = "https://" + publishingProfile.publishUrl + "/api/zip/" + physicalPath; - var basicAuthToken = 'Basic ' + new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64'); - var headers = { - 'Authorization': basicAuthToken, - 'content-type': 'multipart/form-data', - 'If-Match': '*' - }; - if(takeAppOfflineFlag) { - await appOfflineKuduService(publishingProfile, physicalPath, true); - } - console.log(tl.loc("Deployingwebapplicationatvirtualpathandphysicalpath", webAppPackage, virtualPath, physicalPath)); - var webAppReadStream = fs.createReadStream(webAppPackage); - - let options: rm.IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = rc.uploadStream('PUT', kuduDeploymentURL, webAppReadStream, options); - promise.then(async (response) => { - if(response.statusCode === 200) { - console.log(tl.loc("Successfullydeployedpackageusingkuduserviceat", webAppPackage, publishingProfile.publishUrl)); - if(takeAppOfflineFlag) { - tl.debug('Trying to disable app offline mode.'); - try { - await appOfflineKuduService(publishingProfile, physicalPath, false); - tl.debug('App Offline mode disabled.'); - } - catch(error) { - deferred.reject(error); - } - } - deferred.resolve(tl.loc("Successfullydeployedpackageusingkuduserviceat", webAppPackage, publishingProfile.publishUrl)); - } - else { - tl.debug("Action: deployWebAppPackage, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc('Unabletodeploywebappresponsecode', response.statusCode)); - } - }, - (error) => { - deferred.reject(tl.loc("Failedtodeploywebapppackageusingkuduservice", error)); - }); - - return deferred.promise; -} - -export async function ensurePhysicalPathExists(publishingProfile, physicalPath: string) { - var defer = Q.defer(); - physicalPath = physicalPath.replace(/[\\]/g, "/"); - var kuduPhysicalpathUrl = "https://" + publishingProfile.publishUrl + "/api/vfs/" + physicalPath + "/"; - var basicAuthToken = 'Basic ' + new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64'); - var headers = { - 'Authorization': basicAuthToken, - 'If-Match': "*" - }; - tl.debug("Requested URL for kudu physical path : " + kuduPhysicalpathUrl); - let options: rm.IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = rc.get(kuduPhysicalpathUrl, options); - promise.then(async (response) => { - if (response.statusCode === 200 || response.statusCode === 201 || response.statusCode === 204) { - tl.debug("Physical path '" + physicalPath + "' already exists "); - defer.resolve(tl.loc('Physicalpathalreadyexists')); - } - else if(response.statusCode === 404) { - tl.debug("Physical path doesn't exists. Creating physical path.") - defer.resolve(await createPhysicalPath(publishingProfile, physicalPath)); - } else { - tl.debug("Action: ensurePhysicalPathExists, Response: " + JSON.stringify(response)); - defer.reject(tl.loc('FailedtocheckphysicalPath', response.statusCode)); - } - }, - (error) => { - defer.reject(error); - }); - - return defer.promise; -} - -export async function runPostDeploymentScript(publishingProfile, physicalPath, scriptType, inlineScript, scriptPath, appOfflineFlag, isLinux) { - var scriptFile = getPostDeploymentScript(scriptType, inlineScript, scriptPath, isLinux); - var uniqueID = azureUtility.generateDeploymentId(); - tl.debug('Deployment ID : ' + uniqueID); - var deleteLogFiles = false; - var fileExtension : string = isLinux ? '.sh' : '.cmd'; - - if(appOfflineFlag) { - await appOfflineKuduService(publishingProfile, physicalPath, true); - } - try { - var mainCmdFilePath = path.join(__dirname, 'postDeploymentScript', 'mainCmdFile' + fileExtension); - await uploadFiletoKudu(publishingProfile, physicalPath, 'mainCmdFile_' + uniqueID + fileExtension, mainCmdFilePath); - await uploadFiletoKudu(publishingProfile, physicalPath, 'kuduPostDeploymentScript_' + uniqueID + fileExtension, scriptFile.filePath); - console.log(tl.loc('ExecuteScriptOnKudu', publishingProfile.publishUrl)); - if(isLinux){ - await runCommandOnKudu(publishingProfile, physicalPath, 'sh ' + 'mainCmdFile_' + uniqueID + fileExtension + ' ' + uniqueID, 30, 'script_result_' + uniqueID + '.txt'); - } else { - await runCommandOnKudu(publishingProfile, physicalPath, 'mainCmdFile_' + uniqueID + fileExtension + ' ' + uniqueID, 30, 'script_result_' + uniqueID + '.txt'); - } - console.log(tl.loc('ScriptExecutionOnKuduSuccess')); - deleteLogFiles = true; - await getPostDeploymentScriptLogs(publishingProfile, physicalPath, uniqueID); - } - catch(Exception) { - throw Error(Exception); - } - finally { - if(scriptFile.isCreated) { - tl.rmRF(scriptFile.filePath, true); - } - try { - await uploadFiletoKudu(publishingProfile, physicalPath, 'delete_log_file_' + uniqueID + fileExtension, path.join(__dirname, 'postDeploymentScript', 'deleteLogFile' + fileExtension)); - var commandResult; - if(isLinux){ - commandResult = await runCommandOnKudu(publishingProfile, physicalPath, 'sh ' + 'delete_log_file_' + uniqueID + fileExtension + ' ' + uniqueID, 0, null); - } else { - commandResult = await runCommandOnKudu(publishingProfile, physicalPath, 'delete_log_file_' + uniqueID + fileExtension + ' ' + uniqueID, 0, null); - } - tl.debug(JSON.stringify(commandResult)); - } - catch(error) { - tl.debug('Unable to delete log files : ' + error); - } - if(appOfflineFlag) { - await appOfflineKuduService(publishingProfile, physicalPath, false); - } - } -} - -function getPostDeploymentScript(scriptType, inlineScript, scriptPath, isLinux) { - if(scriptType === 'Inline Script') { - tl.debug('creating kuduPostDeploymentScript_local file'); - var scriptFilePath = path.join(tl.getVariable('System.DefaultWorkingDirectory'), isLinux ? 'kuduPostDeploymentScript_local.sh' : 'kuduPostDeploymentScript_local.cmd'); - tl.writeFile(scriptFilePath, inlineScript); - tl.debug('Created temporary script file : ' + scriptFilePath); - return { - filePath: scriptFilePath, - isCreated: true - }; - } - if(!tl.exist(scriptPath)) { - throw Error(tl.loc('ScriptFileNotFound', scriptPath)); - } - var scriptExtension = path.extname(scriptPath); - if(isLinux){ - if(scriptExtension != '.sh'){ - throw Error(tl.loc('InvalidScriptFile', scriptPath)); - } - } else { - if(scriptExtension != '.bat' && scriptExtension != '.cmd') { - throw Error(tl.loc('InvalidScriptFile', scriptPath)); - } - } - tl.debug('postDeployment script path to execute : ' + scriptPath); - return { - filePath: scriptPath, - isCreated: false - } -} - -async function createPhysicalPath(publishingProfile, physicalPath: string) { - var defer = Q.defer(); - var kuduPhysicalpathUrl = "https://" + publishingProfile.publishUrl + "/api/vfs/" + physicalPath + "/"; - var basicAuthToken = 'Basic ' + new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64'); - var headers = { - 'Authorization': basicAuthToken, - 'If-Match': "*" - }; - tl.debug("Requested URL for kudu physical path : " + kuduPhysicalpathUrl); - let options: rm.IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = rc.replace(kuduPhysicalpathUrl, null, options); - promise.then((response) => { - if (response.statusCode === 200 || response.statusCode === 201 || response.statusCode === 204) { - tl.debug("Kudu physical path : '" + physicalPath + "' created successfully "); - defer.resolve(tl.loc('KuduPhysicalpathCreatedSuccessfully', physicalPath)); - } - else { - tl.debug("Action: createPhysicalPath, Response: " + JSON.stringify(response)); - defer.reject(tl.loc('FailedtocreateKuduPhysicalPath', response.statusCode)); - } - }, - (error) => { - defer.reject(error); - }); - - return defer.promise; -} - -async function uploadFiletoKudu(publishingProfile, physicalPath: string, fileName: string, filePath: string) { - var defer = Q.defer(); - var basicAuthToken = 'Basic ' + new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64'); - var headers = { - 'Authorization': basicAuthToken, - 'If-Match': '*' - }; - var readStream = fs.createReadStream(filePath); - var kuduDeploymentURL = "https://" + publishingProfile.publishUrl + "/api/vfs/" + physicalPath + '/' + fileName; - - tl.debug('Uploading file: ' + fileName + ' using publishUrl: ' + kuduDeploymentURL); - let options: rm.IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = rc.uploadStream('PUT', kuduDeploymentURL, readStream, options); - promise.then((response) => { - if (response.statusCode === 200 || response.statusCode === 201 || response.statusCode === 204) { - tl.debug('Uploaded file: ' + fileName + ' at path: ' + physicalPath); - defer.resolve('file uploaded to Kudu'); - } - else { - tl.debug("Action: uploadFiletoKudu, Response: " + JSON.stringify(response)); - defer.reject(tl.loc('failedtoUploadFileToKudu', fileName, kuduDeploymentURL, response.statusCode)); - } - }, - (error) => { - defer.reject(tl.loc('failedtoUploadFileToKuduError', fileName, kuduDeploymentURL)); - }); - - return defer.promise; -} - -async function deleteFileFromKudu(publishingProfile, physicalPath: string, fileName: string, continueOnError: boolean) { - var defer = Q.defer(); - var basicAuthToken = 'Basic ' + new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64'); - var headers = { - 'Authorization': basicAuthToken, - 'If-Match': '*', - 'Content-Length': 0 - }; - var kuduDeploymentURL = "https://" + publishingProfile.publishUrl + "/api/vfs/" + physicalPath + '/' + fileName; - - tl.debug('Removing file: ' + fileName + ' using publishUrl: ' + kuduDeploymentURL); - let options: rm.IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = rc.del(kuduDeploymentURL, options); - promise.then((response) => { - if(response.statusCode === 200 || response.statusCode === 204 || response.statusCode === 404) { - tl.debug('Removed file: ' + fileName + ' from path: ' + physicalPath); - defer.resolve('file removed from kudu'); - } else { - if(continueOnError) { - tl.debug('Unable to delete file: ' + fileName + ' using publishURL : ' + kuduDeploymentURL + '. statusCode: ' + response.statusCode); - defer.resolve(' '); - } - defer.reject(tl.loc('FailedtoDeleteFileFromKudu', fileName, kuduDeploymentURL, response.statusCode)); - } - }, - (error) => { - if(continueOnError) { - tl.debug('Unable to delete file: ' + fileName + ' using publishURL : ' + kuduDeploymentURL + '. Error: ' + error); - defer.resolve(' '); - } - defer.reject(tl.loc('FailedtoDeleteFileFromKuduError', fileName, error)); - }); - - return defer.promise; -} - -async function getFileContentUtility(publishingProfile, physicalPath, fileName) { - try { - var fileContent: string = (await getFileContent(publishingProfile, physicalPath, fileName))['content']; - return fileContent; - } - catch(error) { - if(error.error) { - throw Error(tl.loc('FailedToGetKuduFileContentError', fileName, error.error)); - } - else { - throw Error(tl.loc('FailedToGetKuduFileContent', fileName, error.statusCode, error.statusMessage)); - } - } -} - -async function getFileContent(publishingProfile, physicalPath, fileName) { - var defer = Q.defer(); - var basicAuthToken = 'Basic ' + new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64'); - var headers = { - 'Authorization': basicAuthToken, - 'If-Match': '*' - }; - var kuduGetFileUrl = "https://" + publishingProfile.publishUrl + "/api/vfs/" + physicalPath + "/" + fileName; - tl.debug('Getting content of file: ' + fileName + ' using publishUrl: ' + kuduGetFileUrl); - let promise: Promise = hc.get(kuduGetFileUrl, headers); - promise.then(async (response) => { - let contents: string = ""; - try { - contents = await response.readBody(); - } catch (error) { - defer.reject(tl.loc("UnableToReadResponseBody", error)); - } - if(response.message.statusCode === 200) { - tl.debug('retrieved file content : ' + fileName); - defer.resolve({ - content: contents - }); - } else { - defer.reject({ - statusCode: response.message.statusCode, - statusMessage: response.message.statusMessage - }); - } - }, - (error) => { - defer.reject({ error: error + ''}); - }); - - return defer.promise; -} - -/** - * Poll for a file in Kudu - * @param publishingProfile publishing profile of App Service (contains credentials for web deploy) - * @param physicalPath Path where to look for file - * @param fileName File name - * @param noOfRetry max. no. of retry. - * @param checkForFileExists If set, then poll until the file exists else poll until the file is removed by other process - */ -async function pollForFile(publishingProfile, physicalPath: string, fileName: string, noOfRetry: number, fileAction: string) { - var defer = Q.defer(); - var attempts: number = 0; - if(tl.getVariable('appservicedeploy.retrytimeout')) { - noOfRetry = Number(tl.getVariable('appservicedeploy.retrytimeout')) * 6; - tl.debug('Retry timeout provided by user: ' + noOfRetry); - } - tl.debug('Polling started for file: ' + fileName + ' to ' + fileAction); - var poll = async function () { - if (attempts < noOfRetry) { - attempts += 1; - try { - var fileContent = (await getFileContent(publishingProfile, physicalPath, fileName))['content']; - if(fileAction === 'CheckFileExists') { - tl.debug('Found file: ' + fileName); - defer.resolve(fileContent); - } - else if(fileAction === 'CheckFileNotExists') { - tl.debug('File: ' + fileName + 'found. retry after 10 seconds. Attempt: ' + attempts); - setTimeout(poll, 10000); - } - else { - defer.reject(tl.loc('InvalidPollOption', fileAction)); - } - } - catch(error) { - if(error.statusCode === 404) { - if(fileAction === 'CheckFileExists') { - tl.debug('File ' + fileName + ' not found. retry after 10 seconds. Attempt : ' + attempts); - setTimeout(poll, 10000); - } - else if(fileAction === 'CheckFileNotExists') { - tl.debug('File: ' + fileName + 'not found.'); - defer.resolve(); - } - else { - defer.reject(tl.loc('InvalidPollOption', fileAction)); - } - } - else { - if(error.error) { - defer.reject(tl.loc('FailedToGetKuduFileContentError', fileName, error.error)); - } - else { - defer.reject(tl.loc('FailedToGetKuduFileContent', fileName, error.statusCode, error.statusMessage)); - } - } - } - } - else { - tl.warning(tl.loc('PollingForFileTimeOut')); - defer.reject(tl.loc('ScriptStatusTimeout')); - } - } - poll(); - return defer.promise; -} - -async function getPostDeploymentScriptLogs(publishingProfile, physicalPath, uniqueID) { - - try { - var stdoutLog = (await getFileContentUtility(publishingProfile, physicalPath, 'stdout_' + uniqueID + '.txt')); - var stderrLog = (await getFileContentUtility(publishingProfile, physicalPath, 'stderr_' + uniqueID + '.txt')); - var scriptReturnCode = ((await getFileContentUtility(publishingProfile, physicalPath, 'script_result_' + uniqueID + '.txt')).trim()); - } - catch(error) { - throw Error(error); - } - if(stdoutLog) { - console.log(tl.loc('stdoutFromScript')); - console.log(stdoutLog); - } - if(stderrLog) { - console.log(tl.loc('stderrFromScript')); - if(scriptReturnCode != '0') { - tl.error(stderrLog); - throw Error(tl.loc('ScriptExecutionOnKuduFailed', scriptReturnCode, stderrLog)); - } - else { - console.log(stderrLog); - } - } -} - -/** - * Run given command on Kudu - * @param publishingProfile Publishing profile - * @param physicalPath Path where to run the command - * @param command command to run - * @param timeout if timeOut is 0, then runs command synchronously, else run command async and polls for given file [within the time limit (in Minutes)] - * @param pollFile poll for file if command runs async - * @returns {ExitCode, Stdout, Stderr} for sync and {pollFileContent} for async call - */ -async function runCommandOnKudu(publishingProfile, physicalPath: string, command: string, timeOut: number, pollFile: string) { - var defer = Q.defer(); - var kuduDeploymentURL = "https://" + publishingProfile.publishUrl + "/api/command"; - var basicAuthToken = 'Basic ' + new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64'); - var headers = { - 'Authorization': basicAuthToken, - 'If-Match': '*', - 'Content-Type': 'application/json' - }; - var jsonData = { - 'command': command, - 'dir': physicalPath - }; - - tl.debug('Executing Script on Kudu: ' + kuduDeploymentURL + '. Command: ' + command + '. runAsync : ' + (timeOut > 0)); - let options: rm.IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = rc.create(kuduDeploymentURL, jsonData, options); - promise.then(async (response) => { - if(response.statusCode === 200) { - tl.debug('successfully executed script on kudu'); - tl.debug('Response from Kudu: ' + JSON.stringify(response.result)); - if(timeOut > 0) { - tl.debug('Async command execution completed. polling for file: ' + pollFile); - try { - defer.resolve( { - 'pollFileContent': await pollForFile(publishingProfile, physicalPath, pollFile, timeOut * 6, 'CheckFileExists') - }); - } - catch(pollError) { - defer.reject(pollError); - } - } - defer.resolve(response.result); - } - else { - defer.reject(tl.loc('FailedToRunScriptOnKudu', kuduDeploymentURL, response.statusCode)); - } - }, - async (error) => { - if(timeOut > 0 && error.toString().indexOf('Request timeout: /api/command') != -1) { - tl.debug('Request timeout occurs. Trying to poll for file: ' + pollFile); - try { - defer.resolve( { - 'pollFileContent': await pollForFile(publishingProfile, physicalPath, pollFile, timeOut * 6, 'CheckFileExists') - }); - } - catch(pollError) { - defer.reject(pollError); - } - } - defer.reject(tl.loc('FailedToRunScriptOnKuduError', kuduDeploymentURL, error)); - }); - - return defer.promise; -} diff --git a/Tasks/AzureRmWebAppDeployment/make.json b/Tasks/AzureRmWebAppDeployment/make.json index 257406625645..e64b05884e39 100644 --- a/Tasks/AzureRmWebAppDeployment/make.json +++ b/Tasks/AzureRmWebAppDeployment/make.json @@ -1,7 +1,7 @@ { "common": [ { - "module": "../Common/azurerest-common", + "module": "../Common/azure-arm-rest", "type": "node", "dest": "./", "compile" : true @@ -11,12 +11,6 @@ "type": "node", "dest": "./", "compile" : true - }, - { - "module": "../Common/azurestack-common", - "type": "node", - "dest": "./", - "compile" : true } ], "externals": { @@ -42,8 +36,8 @@ "rm": [ { "items": [ - "node_modules/azurestack-common/node_modules/vsts-task-lib", - "node_modules/azurestack-common/node_modules/vso-node-api" + "node_modules/azure-arm-rest/node_modules/vsts-task-lib", + "node_modules/webdeployment-common/node_modules/vsts-task-lib" ], "options": "-Rf" } diff --git a/Tasks/AzureRmWebAppDeployment/operations/AzureAppServiceUtility.ts b/Tasks/AzureRmWebAppDeployment/operations/AzureAppServiceUtility.ts new file mode 100644 index 000000000000..8333439bb994 --- /dev/null +++ b/Tasks/AzureRmWebAppDeployment/operations/AzureAppServiceUtility.ts @@ -0,0 +1,235 @@ +import tl = require('vsts-task-lib/task'); +import { AzureAppService } from 'azure-arm-rest/azure-arm-app-service'; +import webClient = require('azure-arm-rest/webClient'); +var parseString = require('xml2js').parseString; +import Q = require('q'); +import { Kudu } from 'azure-arm-rest/azure-arm-app-service-kudu'; +import { AzureAppServiceConfigurationDetails } from 'azure-arm-rest/azureModels'; + +export class AzureAppServiceUtility { + private _appService: AzureAppService; + constructor(appService: AzureAppService) { + this._appService = appService; + } + + public async updateScmTypeAndConfigurationDetails() : Promise{ + try { + var configDetails = await this._appService.getConfiguration(); + var scmType: string = configDetails.properties.scmType; + if (scmType && scmType.toLowerCase() === "none") { + configDetails.properties.scmType = 'VSTSRM'; + tl.debug('updating SCM Type to VSTS-RM'); + await this._appService.updateConfiguration(configDetails); + tl.debug('updated SCM Type to VSTS-RM'); + tl.debug('Updating metadata with latest release details'); + await this._appService.patchMetadata(this._getNewMetadata()); + tl.debug('Updated metadata with latest release details'); + console.log(tl.loc("SuccessfullyUpdatedAzureRMWebAppConfigDetails")); + } + else { + tl.debug(`Skipped updating the SCM value. Value: ${scmType}`); + } + } + catch(error) { + tl.warning(tl.loc("FailedToUpdateAzureRMWebAppConfigDetails", error)); + } + } + + public async getWebDeployPublishingProfile(): Promise { + var publishingProfile = await this._appService.getPublishingProfileWithSecrets(); + var defer = Q.defer(); + parseString(publishingProfile, (error, result) => { + if(!!error) { + defer.reject(error); + } + var publishProfile = result && result.publishData && result.publishData.publishProfile ? result.publishData.publishProfile : null; + if(publishProfile) { + for (var index in publishProfile) { + if (publishProfile[index].$ && publishProfile[index].$.publishMethod === "MSDeploy") { + defer.resolve(result.publishData.publishProfile[index].$); + } + } + } + + defer.reject(tl.loc('ErrorNoSuchDeployingMethodExists')); + }); + + return defer.promise; + } + + public async getApplicationURL(): Promise { + let webDeployProfile: any = await this.getWebDeployPublishingProfile(); + return await webDeployProfile.destinationAppUrl; + } + + public async pingApplication(): Promise { + try { + var applicationUrl: string = await this.getApplicationURL(); + + if(!applicationUrl) { + tl.debug('Application Url not found.'); + return; + } + var webRequest = new webClient.WebRequest(); + webRequest.method = 'GET'; + webRequest.uri = applicationUrl; + tl.debug('pausing for 5 seconds before request'); + await webClient.sleepFor(5); + var response = await webClient.sendRequest(webRequest); + tl.debug(`App Service status Code: '${response.statusCode}'. Status Message: '${response.statusMessage}'`); + } + catch(error) { + tl.debug(`Unable to ping App Service. Error: ${error}`); + } + } + + public async getKuduService(): Promise { + var publishingCredentials = await this._appService.getPublishingCredentials(); + if(publishingCredentials.properties["scmUri"]) { + tl.setVariable(`AZURE_APP_SERVICE_KUDU_${this._appService.getSlot()}_PASSWORD`, publishingCredentials.properties["publishingPassword"], true); + return new Kudu(publishingCredentials.properties["scmUri"], publishingCredentials.properties["publishingUserName"], publishingCredentials.properties["publishingPassword"]); + } + + throw Error(tl.loc('KuduSCMDetailsAreEmpty')); + } + + public async getPhysicalPath(virtualApplication: string): Promise { + + if(!virtualApplication) { + return '/site/wwwroot'; + } + + virtualApplication = (virtualApplication.startsWith("/")) ? virtualApplication.substr(1) : virtualApplication; + + var physicalToVirtualPathMap = await this._getPhysicalToVirtualPathMap(virtualApplication); + + if(!physicalToVirtualPathMap) { + throw Error(tl.loc("VirtualApplicationDoesNotExist", virtualApplication)); + } + + tl.debug(`Virtual Application Map: Physical path: '${physicalToVirtualPathMap.physicalPath}'. Virtual path: '${physicalToVirtualPathMap.virtualPath}'.`); + return physicalToVirtualPathMap.physicalPath; + } + + public async updateConfigurationSettings(properties: any) : Promise { + for(var property in properties) { + if(properties[property].value !== undefined) { + properties[property] = properties[property].value; + } + } + + console.log(tl.loc('UpdatingAppServiceConfigurationSettings', JSON.stringify(properties))); + await this._appService.patchConfiguration({'properties': properties}); + console.log(tl.loc('UpdatedAppServiceConfigurationSettings')); + } + + public async updateAndMonitorAppSettings(properties: any): Promise { + for(var property in properties) { + if(properties[property].value !== undefined) { + properties[property] = properties[property].value; + } + } + + console.log(tl.loc('UpdatingAppServiceApplicationSettings', JSON.stringify(properties))); + await this._appService.patchApplicationSettings(properties); + var kuduService = await this.getKuduService(); + var noOftimesToIterate: number = 6; + tl.debug('retrieving values from Kudu service to check if new values are updated'); + while(noOftimesToIterate > 0) { + var kuduServiceAppSettings = await kuduService.getAppSettings(); + var propertiesChanged: boolean = true; + for(var property in properties) { + if(kuduServiceAppSettings[property] != properties[property]) { + tl.debug('New properties are not updated in Kudu service :('); + propertiesChanged = false; + break; + } + } + + if(propertiesChanged) { + tl.debug('New properties are updated in Kudu service.'); + console.log(tl.loc('UpdatedAppServiceApplicationSettings')); + return; + } + + noOftimesToIterate -= 1; + await webClient.sleepFor(10); + } + + tl.debug('Timing out from app settings check'); + } + + public async enableRenameLockedFiles(): Promise { + try { + var webAppSettings = await this._appService.getApplicationSettings(); + if(webAppSettings && webAppSettings.properties) { + if(webAppSettings.properties.MSDEPLOY_RENAME_LOCKED_FILES !== '1') { + tl.debug(`Rename locked files value found to be ${webAppSettings.properties.MSDEPLOY_RENAME_LOCKED_FILES}. Updating the value to 1`); + await this.updateAndMonitorAppSettings({ 'MSDEPLOY_RENAME_LOCKED_FILES' : '1' }); + console.log(tl.loc('RenameLockedFilesEnabled')); + } + else { + tl.debug('Rename locked files is already enabled in App Service'); + } + } + } + catch(error) { + throw new Error(tl.loc('FailedToEnableRenameLockedFiles', error)); + } + } + + public async updateStartupCommandAndRuntimeStack(runtimeStack: string, startupCommand?: string): Promise { + var configDetails = await this._appService.getConfiguration(); + var linuxFxVersion: string = configDetails.properties.linuxFxVersion; + var appCommandLine: string = configDetails.properties.appCommandLine; + + if (!(!!appCommandLine == !!startupCommand && appCommandLine == startupCommand) + || runtimeStack != linuxFxVersion) { + await this.updateConfigurationSettings({linuxFxVersion: runtimeStack, appCommandLine: startupCommand}); + } + else { + tl.debug(`Skipped updating the values. linuxFxVersion: ${linuxFxVersion} : appCommandLine: ${appCommandLine}`) + } + } + + private async _getPhysicalToVirtualPathMap(virtualApplication: string): Promise { + // construct URL depending on virtualApplication or root of webapplication + var physicalPath = null; + var virtualPath = "/" + virtualApplication; + var appConfigSettings = await this._appService.getConfiguration(); + var virtualApplicationMappings = appConfigSettings.properties && appConfigSettings.properties.virtualApplications; + + if(virtualApplicationMappings) { + for( var mapping of virtualApplicationMappings ) { + if(mapping.virtualPath.toLowerCase() == virtualPath.toLowerCase()) { + physicalPath = mapping.physicalPath; + break; + } + } + } + + return physicalPath ? { + 'virtualPath': virtualPath, + 'physicalPath': physicalPath + }: null; + } + + private _getNewMetadata(): any { + var collectionUri = tl.getVariable("system.teamfoundationCollectionUri"); + var projectId = tl.getVariable("system.teamprojectId"); + var buildDefintionId = tl.getVariable("build.definitionId") + var releaseDefinitionId = tl.getVariable("release.definitionId"); + + let newProperties = { + VSTSRM_BuildDefinitionId: buildDefintionId, + VSTSRM_ReleaseDefinitionId: releaseDefinitionId, + VSTSRM_ProjectId: projectId, + VSTSRM_AccountId: tl.getVariable("system.collectionId"), + VSTSRM_BuildDefinitionWebAccessUrl: collectionUri + projectId + "/_build?_a=simple-process&definitionId=" + buildDefintionId, + VSTSRM_ConfiguredCDEndPoint: collectionUri + projectId + "/_apps/hub/ms.vss-releaseManagement-web.hub-explorer?definitionId=" + releaseDefinitionId + } + + return newProperties; + } + +} \ No newline at end of file diff --git a/Tasks/AzureRmWebAppDeployment/operations/AzureResourceFilterUtility.ts b/Tasks/AzureRmWebAppDeployment/operations/AzureResourceFilterUtility.ts new file mode 100644 index 000000000000..4c5cd68cc3e0 --- /dev/null +++ b/Tasks/AzureRmWebAppDeployment/operations/AzureResourceFilterUtility.ts @@ -0,0 +1,22 @@ +import tl = require('vsts-task-lib/task'); +import { AzureEndpoint } from 'azure-arm-rest/azureModels'; +import { Resources } from 'azure-arm-rest/azure-arm-resource'; + +export class AzureResourceFilterUtility { + public static async getResourceGroupName(endpoint: AzureEndpoint, resourceName: string): Promise { + var azureResources: Resources = new Resources(endpoint); + var filteredResources: Array = await azureResources.getResources('Microsoft.Web/Sites', resourceName); + let resourceGroupName: string; + if(!filteredResources || filteredResources.length == 0) { + throw new Error(tl.loc('ResourceDoesntExist', resourceName)); + } + else if(filteredResources.length == 1) { + resourceGroupName = filteredResources[0].id.split("/")[4]; + } + else { + throw new Error(tl.loc('MultipleResourceGroupFoundForAppService', resourceName)); + } + + return resourceGroupName; + } +} \ No newline at end of file diff --git a/Tasks/AzureRmWebAppDeployment/operations/ContainerBasedDeploymentUtility.ts b/Tasks/AzureRmWebAppDeployment/operations/ContainerBasedDeploymentUtility.ts new file mode 100644 index 000000000000..dedb4f9b9ef0 --- /dev/null +++ b/Tasks/AzureRmWebAppDeployment/operations/ContainerBasedDeploymentUtility.ts @@ -0,0 +1,216 @@ +import tl = require('vsts-task-lib/task'); +import url = require('url'); +import util = require('util'); +import { AzureAppService } from 'azure-arm-rest/azure-arm-app-service'; +import { TaskParameters } from './TaskParameters'; +import { parse } from './ParameterParserUtility'; +import { AzureAppServiceUtility } from './AzureAppServiceUtility'; + +enum registryTypes { + "AzureContainerRegistry", + "Registry", // TODO: Rename it to DockerHub while supporting all the registry types. Also add all these registry types in Task.json in ImageSource pick list. + "PrivateRegistry" +} + +export class ContainerBasedDeploymentUtility { + private _appService: AzureAppService; + private _appServiceUtility: AzureAppServiceUtility; + + constructor(appService: AzureAppService) { + this._appService = appService; + this._appServiceUtility = new AzureAppServiceUtility(appService); + } + + public async deployWebAppImage(taskParameters: TaskParameters): Promise { + var imageName = this._getImageName(); + tl.debug("Deploying an image " + imageName + " to the webapp " + this._appService.getName()); + + tl.debug("Updating the webapp configuration."); + await this._updateConfigurationDetails(taskParameters, imageName); + + tl.debug('Updating web app settings'); + await this._updateApplicationSettings(taskParameters, imageName); + } + + private async _updateApplicationSettings(taskParameters: TaskParameters, imageName: string): Promise { + var appSettingsParameters = taskParameters.AppSettings; + appSettingsParameters = appSettingsParameters ? appSettingsParameters.trim() : ""; + appSettingsParameters = await this._getContainerRegistrySettings(imageName, null) + ' ' + appSettingsParameters; + var appSettingsNewProperties = parse(appSettingsParameters); + await this._appServiceUtility.updateAndMonitorAppSettings(appSettingsNewProperties); + } + + private async _updateConfigurationDetails(taskParameters: TaskParameters, imageName: string): Promise { + var startupCommand: string = taskParameters.StartupCommand; + var configSettingsParameters = taskParameters.ConfigurationSettings; + var appSettingsNewProperties = !!configSettingsParameters ? parse(configSettingsParameters.trim()): { }; + appSettingsNewProperties.appCommandLine = { + 'value': startupCommand + } + + appSettingsNewProperties.linuxFxVersion = { + 'value': "DOCKER|" + imageName + } + tl.debug(`CONATINER UPDATE CONFIG VALUES : ${appSettingsNewProperties}`); + await this._appServiceUtility.updateConfigurationSettings(appSettingsNewProperties); + } + + private getDockerHubImageName(): string { + var namespace = tl.getInput('DockerNamespace', true); + var image = tl.getInput('DockerRepository', true); + var tag = tl.getInput('DockerImageTag', false); + + return this._constructImageName(namespace, image, tag); + } + + private _getAzureContainerImageName(): string { + var registry = tl.getInput('AzureContainerRegistryLoginServer', true) + ".azurecr.io"; + var image = tl.getInput('AzureContainerRegistryImage', true); + var tag = tl.getInput('AzureContainerRegistryTag', false); + + return this._constructImageName(registry, image, tag); + } + + private _getDockerHubImageName(): string { + var namespace = tl.getInput('DockerNamespace', true); + var image = tl.getInput('DockerRepository', true); + var tag = tl.getInput('DockerImageTag', false); + + return this._constructImageName(namespace, image, tag); + } + + private _constructImageName(namespace, repository, tag): string { + var imageName = null; + /* + Special Case : If release definition is not linked to build artifacts + then $(Build.BuildId) variable don't expand in release. So clearing state + of dockerImageTag if $(Build.BuildId) not expanded in value of dockerImageTag. + */ + if(tag && (tag.trim() == "$(Build.BuildId)")) { + tag = null; + } + + if(tag) { + imageName = namespace + "/" + repository + ":" + tag; + } else { + imageName = namespace + "/" + repository; + } + + return imageName; + } + + private _getPrivateRegistryImageName(): string { + var registryConnectedServiceName = tl.getInput('RegistryConnectedServiceName', true); + var loginServer = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'url', true); + + var registry = url.parse(loginServer).hostname; + var image = tl.getInput('PrivateRegistryImage', true); + var tag = tl.getInput('PrivateRegistryTag', false); + + return this._constructImageName(registry, image, tag); + } + + private _updateWebAppSettings(appSettingsParameters, webAppSettings): void { + // In case of public repo, clear the connection details of a registry + var dockerRespositoryAccess = tl.getInput('DockerRepositoryAccess', true); + + // Uncomment the below lines while supprting all registry types. + // if(dockerRespositoryAccess === "public") + // { + // deleteRegistryConnectionSettings(webAppSettings); + // } + + var parsedAppSettings = parse(appSettingsParameters); + for (var settingName in parsedAppSettings) { + var setting = settingName.trim(); + var settingVal = parsedAppSettings[settingName].value; + settingVal = settingVal ? settingVal.trim() : ""; + + if(setting) { + webAppSettings["properties"][setting] = settingVal; + } + } + } + + private _getImageName(): string { + var registryType = tl.getInput('ImageSource', true); + var imageName = null; + + switch(registryType) { + case registryTypes[registryTypes.AzureContainerRegistry]: + imageName = this._getAzureContainerImageName(); + break; + + case registryTypes[registryTypes.Registry]: + imageName = this._getDockerHubImageName(); + break; + + case registryTypes[registryTypes.PrivateRegistry]: + imageName = this._getPrivateRegistryImageName(); + break; + } + + return imageName; + } + + private async _getContainerRegistrySettings(imageName, endPoint): Promise { + var containerRegistryType: string = tl.getInput('ImageSource', true); + var containerRegistrySettings: string = "-DOCKER_CUSTOM_IMAGE_NAME " + imageName; + var containerRegistryAuthParamsFormatString: string = "-DOCKER_REGISTRY_SERVER_URL %s -DOCKER_REGISTRY_SERVER_USERNAME %s -DOCKER_REGISTRY_SERVER_PASSWORD %s"; + + switch(containerRegistryType) { + case registryTypes[registryTypes.AzureContainerRegistry]: + containerRegistrySettings = await this._getAzureContainerRegistrySettings(endPoint, containerRegistrySettings, containerRegistryAuthParamsFormatString); + break; + + case registryTypes[registryTypes.Registry]: + var dockerRespositoryAccess = tl.getInput('DockerRepositoryAccess', false); + if(dockerRespositoryAccess === "private") + { + containerRegistrySettings = this._getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString); + } + break; + + case registryTypes[registryTypes.PrivateRegistry]: + containerRegistrySettings = this._getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString); + break; + } + + return containerRegistrySettings; + } + + private async _getAzureContainerRegistrySettings(endPoint, containerRegistrySettings, containerRegistryAuthParamsFormatString): Promise { + var registryServerName = tl.getInput('AzureContainerRegistryLoginServer', true); + var registryUrl = "https://" + registryServerName + ".azurecr.io"; + tl.debug("Azure Container Registry Url: " + registryUrl); + + var registryName = tl.getInput('AzureContainerRegistry', true); + var resourceGroupName = '';// await azureRESTUtility.getResourceGroupName(endPoint, registryName, "Microsoft.ContainerRegistry/registries"); + tl.debug("Resource group name of a registry: " + resourceGroupName); + + var creds = null //await azureRESTUtility.getAzureContainerRegistryCredentials(endPoint, registryName, resourceGroupName); + tl.debug("Successfully retrieved the registry credentials"); + + var username = creds.username; + var password = creds["passwords"][0].value; + + return containerRegistrySettings + " " + util.format(containerRegistryAuthParamsFormatString, registryUrl, username, password); + } + + private _getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString): string { + var registryConnectedServiceName = tl.getInput('RegistryConnectedServiceName', true); + var username = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'username', true); + var password = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'password', true); + var registryUrl = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'registry', true); + + tl.debug("Docker or Private Container Registry Url: " + registryUrl); + + return containerRegistrySettings + " " + util.format(containerRegistryAuthParamsFormatString, registryUrl, username, password); + } + + private _deleteRegistryConnectionSettings(webAppSettings): void { + delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_URL"]; + delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_USERNAME"]; + delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_PASSWORD"]; + } +} \ No newline at end of file diff --git a/Tasks/AzureRmWebAppDeployment/operations/FileTransformsUtility.ts b/Tasks/AzureRmWebAppDeployment/operations/FileTransformsUtility.ts new file mode 100644 index 000000000000..886b3b794239 --- /dev/null +++ b/Tasks/AzureRmWebAppDeployment/operations/FileTransformsUtility.ts @@ -0,0 +1,35 @@ +import tl = require('vsts-task-lib/task'); +import { TaskParameters } from './TaskParameters'; +import { parse } from './ParameterParserUtility'; +var zipUtility = require('webdeployment-common/ziputility.js'); +var deployUtility = require('webdeployment-common/utility.js'); +var fileTransformationsUtility = require('webdeployment-common/fileTransformationsUtility.js'); +var generateWebConfigUtil = require('webdeployment-common/webconfigutil.js'); + +export class FileTransformsUtility { + public static async applyTransformations(webPackage: string, taskParams: TaskParameters): Promise { + var applyFileTransformFlag = taskParams.JSONFiles.length != 0 || taskParams.XmlTransformation || taskParams.XmlVariableSubstitution; + if (applyFileTransformFlag || taskParams.GenerateWebConfig) { + var isFolderBasedDeployment: boolean = tl.stats(webPackage).isDirectory(); + var folderPath = await deployUtility.generateTemporaryFolderForDeployment(isFolderBasedDeployment, webPackage); + if (taskParams.GenerateWebConfig) { + tl.debug('parsing web.config parameters'); + var webConfigParameters = parse(taskParams.WebConfigParameters); + generateWebConfigUtil.addWebConfigFile(folderPath, webConfigParameters); + } + + if (applyFileTransformFlag) { + var isMSBuildPackage = !isFolderBasedDeployment && (await deployUtility.isMSDeployPackage(webPackage)); + fileTransformationsUtility.fileTransformations(isFolderBasedDeployment, taskParams.JSONFiles, taskParams.XmlTransformation, taskParams.XmlVariableSubstitution, folderPath, isMSBuildPackage); + } + + var output = await deployUtility.archiveFolderForDeployment(isFolderBasedDeployment, folderPath); + webPackage = output.webDeployPkg; + } + else { + tl.debug('File Tranformation not enabled'); + } + + return webPackage; + } +} \ No newline at end of file diff --git a/Tasks/AzureRmWebAppDeployment/operations/KuduServiceUtility.ts b/Tasks/AzureRmWebAppDeployment/operations/KuduServiceUtility.ts new file mode 100644 index 000000000000..62ea06eeba72 --- /dev/null +++ b/Tasks/AzureRmWebAppDeployment/operations/KuduServiceUtility.ts @@ -0,0 +1,329 @@ +import tl = require('vsts-task-lib/task'); +import Q = require('q'); +import path = require('path'); +import { Kudu } from 'azure-arm-rest/azure-arm-app-service-kudu'; +import { KUDU_DEPLOYMENT_CONSTANTS } from 'azure-arm-rest/constants'; +import webClient = require('azure-arm-rest/webClient'); +import { TaskParameters } from './TaskParameters'; +var deployUtility = require('webdeployment-common/utility.js'); +var zipUtility = require('webdeployment-common/ziputility.js'); +const physicalRootPath: string = '/site/wwwroot'; + +export class KuduServiceUtility { + private _appServiceKuduService: Kudu; + private _deploymentID: string; + + constructor(kuduService: Kudu) { + this._appServiceKuduService = kuduService; + } + + public async createPathIfRequired(phsyicalPath: string): Promise { + var listDir = await this._appServiceKuduService.listDir(phsyicalPath); + if(listDir == null) { + await this._appServiceKuduService.createPath(phsyicalPath); + } + } + + public async updateDeploymentStatus(taskResult: boolean, DeploymentID: string, customMessage: any): Promise { + try { + var requestBody = this._getUpdateHistoryRequest(taskResult, DeploymentID, customMessage); + await this._appServiceKuduService.updateDeployment(requestBody); + } + catch(error) { + tl.warning(error); + } + } + + public async runPostDeploymentScript(taskParams: TaskParameters): Promise { + try { + if(taskParams.TakeAppOfflineFlag) { + await this._appOfflineKuduService(physicalRootPath, true); + } + + var scriptFile = this._getPostDeploymentScript(taskParams.ScriptType, taskParams.InlineScript, taskParams.ScriptPath, taskParams.isLinuxApp); + var uniqueID = this.getDeploymentID(); + var fileExtension : string = taskParams.isLinuxApp ? '.sh' : '.cmd'; + var mainCmdFilePath = path.join(__dirname, '..', 'postDeploymentScript', 'mainCmdFile' + fileExtension); + await this._appServiceKuduService.uploadFile(physicalRootPath, 'mainCmdFile_' + uniqueID + fileExtension, mainCmdFilePath); + await this._appServiceKuduService.uploadFile(physicalRootPath, 'kuduPostDeploymentScript_' + uniqueID + fileExtension, scriptFile.filePath); + console.log(tl.loc('ExecuteScriptOnKudu')); + await this.runCommand('site\\wwwroot', + 'mainCmdFile_' + uniqueID + fileExtension + ' ' + uniqueID, + 30, 'script_result_' + uniqueID + '.txt'); + await this._printPostDeploymentLogs(physicalRootPath, uniqueID); + + } + catch(error) { + throw Error(tl.loc('FailedToRunScriptOnKuduError', error)); + } + finally { + try { + await this._appServiceKuduService.uploadFile(physicalRootPath, 'delete_log_file_' + uniqueID + fileExtension, path.join(__dirname, '..', 'postDeploymentScript', 'deleteLogFile' + fileExtension)); + await this.runCommand('site\\wwwroot', 'delete_log_file_' + uniqueID + fileExtension + ' ' + uniqueID, 0, null); + } + catch(error) { + tl.debug('Unable to delete log files : ' + error); + } + if(taskParams.TakeAppOfflineFlag) { + await this._appOfflineKuduService(physicalRootPath, false); + } + } + } + + public getDeploymentID(): string { + if(this._deploymentID) { + return this._deploymentID; + } + + var buildUrl = tl.getVariable('build.buildUri'); + var releaseUrl = tl.getVariable('release.releaseUri'); + + var buildId = tl.getVariable('build.buildId'); + var releaseId = tl.getVariable('release.releaseId'); + + var buildNumber = tl.getVariable('build.buildNumber'); + var releaseName = tl.getVariable('release.releaseName'); + + var collectionUrl = tl.getVariable('system.TeamFoundationCollectionUri'); + var teamProject = tl.getVariable('system.teamProjectId'); + + var commitId = tl.getVariable('build.sourceVersion'); + var repoName = tl.getVariable('build.repository.name'); + var repoProvider = tl.getVariable('build.repository.provider'); + + var buildOrReleaseUrl = "" ; + var deploymentID: string = (releaseId ? releaseId : buildId) + Date.now().toString(); + return deploymentID; + } + + public async deployWebPackage(packagePath: string, physicalPath: string, virtualPath: string, appOffline: boolean): Promise { + physicalPath = physicalPath ? physicalPath : physicalRootPath; + try { + if(appOffline) { + await this._appOfflineKuduService(physicalPath, true); + tl.debug('Wait for 10 seconds for app_offline to take effect'); + await webClient.sleepFor(10); + } + + if(tl.stats(packagePath).isDirectory()) { + let tempPackagePath = deployUtility.generateTemporaryFolderOrZipPath(tl.getVariable('AGENT.TEMPDIRECTORY'), false); + packagePath = await zipUtility.archiveFolder(packagePath, "", tempPackagePath); + tl.debug("Compressed folder " + packagePath + " into zip : " + packagePath); + } + else if(packagePath.toLowerCase().endsWith('.war')) { + physicalPath = await this._warFileDeployment(packagePath, physicalPath, virtualPath); + } + + await this._appServiceKuduService.extractZIP(packagePath, physicalPath); + if(appOffline) { + await this._appOfflineKuduService(physicalPath, false); + } + + console.log(tl.loc("Successfullydeployedpackageusingkuduserviceat", packagePath, physicalPath)); + } + catch(error) { + tl.error(tl.loc('PackageDeploymentFailed')); + throw Error(error); + } + } + + private async _printPostDeploymentLogs(physicalPath: string, uniqueID: string) : Promise { + var stdoutLog = await this._appServiceKuduService.getFileContent(physicalPath, 'stdout_' + uniqueID + '.txt'); + var stderrLog = await this._appServiceKuduService.getFileContent(physicalPath, 'stderr_' + uniqueID + '.txt'); + var scriptReturnCode = await this._appServiceKuduService.getFileContent(physicalPath, 'script_result_' + uniqueID + '.txt'); + + if(scriptReturnCode == null) { + throw new Error('File not found in Kudu Service. ' + 'script_result_' + uniqueID + '.txt'); + } + + if(stdoutLog) { + console.log(tl.loc('stdoutFromScript')); + console.log(stdoutLog); + } + if(stderrLog) { + console.log(tl.loc('stderrFromScript')); + if(scriptReturnCode != '0') { + tl.error(stderrLog); + throw Error(tl.loc('ScriptExecutionOnKuduFailed', scriptReturnCode, stderrLog)); + } + else { + console.log(stderrLog); + } + } + } + + private async runCommand(physicalPath: string, command: string, timeOutInMinutes: number, pollFile: string): Promise { + try { + await this._appServiceKuduService.runCommand(physicalPath, command); + } + catch(error) { + if(timeOutInMinutes > 0 && error.toString().indexOf('Request timeout: /api/command') != -1) { + tl.debug('Request timeout occurs. Trying to poll for file: ' + pollFile); + await this._pollForFile(physicalPath, pollFile, timeOutInMinutes); + } + else { + if(typeof error.valueOf() == 'string') { + throw error; + } + + throw `${error.statusCode} - ${error.statusMessage}`; + } + } + } + + private _getPostDeploymentScript(scriptType, inlineScript, scriptPath, isLinux): any { + if(scriptType === 'Inline Script') { + tl.debug('creating kuduPostDeploymentScript_local file'); + var scriptFilePath = path.join(tl.getVariable('AGENT.TEMPDIRECTORY'), isLinux ? 'kuduPostDeploymentScript_local.sh' : 'kuduPostDeploymentScript_local.cmd'); + tl.writeFile(scriptFilePath, inlineScript); + tl.debug('Created temporary script file : ' + scriptFilePath); + return { + "filePath": scriptFilePath, + "isCreated": true + }; + } + if(!tl.exist(scriptPath)) { + throw Error(tl.loc('ScriptFileNotFound', scriptPath)); + } + var scriptExtension = path.extname(scriptPath); + if(isLinux){ + if(scriptExtension != '.sh'){ + throw Error(tl.loc('InvalidScriptFile', scriptPath)); + } + } else { + if(scriptExtension != '.bat' && scriptExtension != '.cmd') { + throw Error(tl.loc('InvalidScriptFile', scriptPath)); + } + } + tl.debug('postDeployment script path to execute : ' + scriptPath); + return { + filePath: scriptPath, + isCreated: false + } + } + + private async _warFileDeployment(packagePath: string, physicalPath: string, virtualPath?: string): Promise { + tl.debug('WAR: webAppPackage = ' + packagePath); + let warFile = path.basename(packagePath.slice(0, packagePath.length - '.war'.length)); + let warExt = packagePath.slice(packagePath.length - '.war'.length) + tl.debug('WAR: warFile = ' + warFile); + warFile = warFile + ((virtualPath) ? "/" + virtualPath : ""); + tl.debug('WAR: warFile = ' + warFile); + physicalPath = physicalPath + "/webapps/" + warFile; + await this.createPathIfRequired(physicalPath); + return physicalPath; + + } + + private async _appOfflineKuduService(physicalPath: string, enableFeature: boolean): Promise { + if(enableFeature) { + tl.debug('Trying to enable app offline mode.'); + var appOfflineFilePath = path.join(tl.getVariable('AGENT.TEMPDIRECTORY'), 'app_offline_temp.htm'); + tl.writeFile(appOfflineFilePath, '

App Service is offline.

'); + await this._appServiceKuduService.uploadFile(physicalPath, 'app_offline.htm', appOfflineFilePath); + tl.debug('App Offline mode enabled.'); + } + else { + tl.debug('Trying to disable app offline mode.'); + await this._appServiceKuduService.deleteFile(physicalPath, 'app_offline.htm'); + tl.debug('App Offline mode disabled.'); + } + } + + private async _pollForFile(physicalPath: string, fileName: string, timeOutInMinutes: number): Promise { + var attempts: number = 0; + const retryInterval: number = 10; + if(tl.getVariable('appservicedeploy.retrytimeout')) { + timeOutInMinutes = Number(tl.getVariable('appservicedeploy.retrytimeout')); + tl.debug('Retry timeout in minutes provided by user: ' + timeOutInMinutes); + } + + var timeOutInSeconds = timeOutInMinutes * 60; + var noOfRetry = timeOutInSeconds / retryInterval; + + tl.debug(`Polling started for file: ${fileName} with retry count: ${noOfRetry}`); + + while (attempts < noOfRetry) { + attempts += 1; + var fileContent: string = await this._appServiceKuduService.getFileContent(physicalPath, fileName); + if(fileContent == null) { + tl.debug('File: ' + fileName + ' not found. retry after 10 seconds. Attempt: ' + attempts); + await webClient.sleepFor(10); + } + else { + tl.debug('Found file: ' + fileName); + return ; + } + } + + if(attempts == noOfRetry) { + throw new Error(tl.loc('ScriptStatusTimeout')); + } + } + + private _getUpdateHistoryRequest(isDeploymentSuccess: boolean, deploymentID?: string, customMessage?: any): any { + + var status = isDeploymentSuccess ? KUDU_DEPLOYMENT_CONSTANTS.SUCCESS : KUDU_DEPLOYMENT_CONSTANTS.FAILED; + var author = tl.getVariable('build.sourceVersionAuthor') || tl.getVariable('build.requestedfor') || + tl.getVariable('release.requestedfor') || tl.getVariable('agent.name') + + var buildUrl = tl.getVariable('build.buildUri'); + var releaseUrl = tl.getVariable('release.releaseUri'); + + var buildId = tl.getVariable('build.buildId'); + var releaseId = tl.getVariable('release.releaseId'); + + var buildNumber = tl.getVariable('build.buildNumber'); + var releaseName = tl.getVariable('release.releaseName'); + + var collectionUrl = tl.getVariable('system.TeamFoundationCollectionUri'); + var teamProject = tl.getVariable('system.teamProjectId'); + + var commitId = tl.getVariable('build.sourceVersion'); + var repoName = tl.getVariable('build.repository.name'); + var repoProvider = tl.getVariable('build.repository.provider'); + + var buildOrReleaseUrl = "" ; + deploymentID = !!deploymentID ? deploymentID : this.getDeploymentID(); + + if(releaseUrl !== undefined) { + buildOrReleaseUrl = collectionUrl + teamProject + "/_apps/hub/ms.vss-releaseManagement-web.hub-explorer?releaseId=" + releaseId + "&_a=release-summary"; + } + else if(buildUrl !== undefined) { + buildOrReleaseUrl = collectionUrl + teamProject + "/_build?buildId=" + buildId + "&_a=summary"; + } + + var message = { + type : customMessage? customMessage.type : "", + commitId : commitId, + buildId : buildId, + releaseId : releaseId, + buildNumber : buildNumber, + releaseName : releaseName, + repoProvider : repoProvider, + repoName : repoName, + collectionUrl : collectionUrl, + teamProject : teamProject + }; + // Append Custom Messages to original message + for(var attribute in customMessage) { + message[attribute] = customMessage[attribute]; + } + + var deploymentLogType: string = message['type']; + var active: boolean = false; + if(deploymentLogType.toLowerCase() === "deployment" && isDeploymentSuccess) { + active = true; + } + + return { + id: deploymentID, + active : active, + status : status, + message : JSON.stringify(message), + author : author, + deployer : 'VSTS', + details : buildOrReleaseUrl + }; + } +} \ No newline at end of file diff --git a/Tasks/AzureRmWebAppDeployment/operations/ParameterParserUtility.ts b/Tasks/AzureRmWebAppDeployment/operations/ParameterParserUtility.ts new file mode 100644 index 000000000000..8933f643c6c3 --- /dev/null +++ b/Tasks/AzureRmWebAppDeployment/operations/ParameterParserUtility.ts @@ -0,0 +1,127 @@ +// TODO: This whole file is copied from AzureResourceGroupDeployment task. Move this parser to common lib +// Similar parser is used in Grid UI extension. Try to move the code to some place where all can use it. + +export function parse(input: string): {[key: string]: any} { + var result = {}; + var index = 0; + var obj = { name: "", value: "" }; + while (index < input.length) { + var literalData = findLiteral(input, index); + var nextIndex = literalData.currentPosition; + var specialCharacterFlag = literalData.specialCharacterFlag + var literal = input.substr(index, nextIndex - index).trim(); + if (isName(literal, specialCharacterFlag)) { + if (obj.name) { + result[obj.name] = { value: obj.value }; + obj = { name: "", value: "" }; + } + obj.name = literal.substr(1, literal.length); + } + else { + obj.value = literal; + result[obj.name] = { value: obj.value }; + obj = { name: "", value: "" }; + } + index = nextIndex + 1; + } + if (obj.name) { + result[obj.name] = { value: obj.value }; + } + for (var name in result) { + result[name].value = result[name].value.replace(/^"(.*)"$/, '$1'); + } + return result; +} + +function isName(literal: string, specialCharacterFlag: boolean): boolean { + return literal[0] === '-' && !specialCharacterFlag && isNaN(Number(literal)); +} + +function findLiteral(input, currentPosition): {[key: string]: any} { + var specialCharacterFlag = false; + for (; currentPosition < input.length; currentPosition++) { + if (input[currentPosition] == " " || input[currentPosition] == "\t") { + for (; currentPosition < input.length; currentPosition++) { + if (input[currentPosition + 1] != " " || input[currentPosition + 1] != "\t") { + break; + } + } + break; + } + else if (input[currentPosition] == "(") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, ")"); + specialCharacterFlag = true; + } + else if (input[currentPosition] == "[") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, "]"); + specialCharacterFlag = true; + } + else if (input[currentPosition] == "{") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, "}"); + specialCharacterFlag = true; + } + else if (input[currentPosition] == "\"") { + //keep going till this one closes + currentPosition = findClosingQuoteIndex(input, currentPosition + 1, "\""); + specialCharacterFlag = true; + } + else if (input[currentPosition] == "'") { + //keep going till this one closes + currentPosition = findClosingQuoteIndex(input, currentPosition + 1, "'"); + specialCharacterFlag = true; + } + else if (input[currentPosition] == "`") { + currentPosition++; + specialCharacterFlag = true; + if (currentPosition >= input.length) { + break; + } + } + } + return { currentPosition: currentPosition, specialCharacterFlag: specialCharacterFlag }; +} + +function findClosingBracketIndex(input, currentPosition, closingBracket): number { + for (; currentPosition < input.length; currentPosition++) { + if (input[currentPosition] == closingBracket) { + break; + } + else if (input[currentPosition] == "(") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, ")"); + } + else if (input[currentPosition] == "[") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, "]"); + } + else if (input[currentPosition] == "{") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, "}"); + } + else if (input[currentPosition] == "\"") { + currentPosition = findClosingQuoteIndex(input, currentPosition + 1, "\""); + } + else if (input[currentPosition] == "'") { + currentPosition = findClosingQuoteIndex(input, currentPosition + 1, "'"); + } + else if (input[currentPosition] == "`") { + currentPosition++; + if (currentPosition >= input.length) { + break; + } + } + } + return currentPosition; +} + +function findClosingQuoteIndex(input, currentPosition, closingQuote) { + for (; currentPosition < input.length; currentPosition++) { + if (input[currentPosition] == closingQuote) { + break; + } + else if (input[currentPosition] == "`") { + currentPosition++; + if (currentPosition >= input.length) { + break; + } + } + } + return currentPosition; +} diff --git a/Tasks/AzureRmWebAppDeployment/operations/ReleaseAnnotationUtility.ts b/Tasks/AzureRmWebAppDeployment/operations/ReleaseAnnotationUtility.ts new file mode 100644 index 000000000000..bdd343509b1e --- /dev/null +++ b/Tasks/AzureRmWebAppDeployment/operations/ReleaseAnnotationUtility.ts @@ -0,0 +1,78 @@ +import tl = require('vsts-task-lib/task'); +import { AzureAppService } from 'azure-arm-rest/azure-arm-app-service'; +import { AzureApplicationInsights, ApplicationInsightsResources} from 'azure-arm-rest/azure-arm-appinsights'; +import { AzureEndpoint } from 'azure-arm-rest/azureModels'; + +var uuidV4 = require("uuid/v4"); + +export async function addReleaseAnnotation(endpoint: AzureEndpoint, azureAppService: AzureAppService, isDeploymentSuccess: boolean): Promise { + try { + var appSettings = await azureAppService.getApplicationSettings(); + var instrumentationKey = appSettings && appSettings.properties && appSettings.properties.APPINSIGHTS_INSTRUMENTATIONKEY; + if(instrumentationKey) { + let appinsightsResources: ApplicationInsightsResources = new ApplicationInsightsResources(endpoint); + var appInsightsResources = await appinsightsResources.list(null, [`$filter=InstrumentationKey eq '${instrumentationKey}'`]); + if(appInsightsResources.length > 0) { + var appInsights: AzureApplicationInsights = new AzureApplicationInsights(endpoint, appInsightsResources[0].id.split('/')[4], appInsightsResources[0].name); + var releaseAnnotationData = getReleaseAnnotation(isDeploymentSuccess); + await appInsights.addReleaseAnnotation(releaseAnnotationData); + console.log(tl.loc("SuccessfullyAddedReleaseAnnotation", appInsightsResources[0].name)); + } + else { + tl.debug(`Unable to find Application Insights resource with Instrumentation key ${instrumentationKey}. Skipping adding release annotation.`); + } + } + else { + tl.debug(`Application Insights is not configured for the App Service. Skipping adding release annotation.`); + } + } + catch(error) { + console.log(tl.loc("FailedAddingReleaseAnnotation", error)); + } +} + +function getReleaseAnnotation(isDeploymentSuccess: boolean): {[key: string]: any} { + let annotationName = "Release Annotation"; + let releaseUri = tl.getVariable("Release.ReleaseUri"); + let buildUri = tl.getVariable("Build.BuildUri"); + + if (!!releaseUri) { + annotationName = `${tl.getVariable("Release.DefinitionName")} - ${tl.getVariable("Release.ReleaseName")}`; + } + else if (!!buildUri) { + annotationName = `${tl.getVariable("Build.DefinitionName")} - ${tl.getVariable("Build.BuildNumber")}`; + } + + let releaseAnnotationProperties = { + "Label": isDeploymentSuccess ? "Success" : "Error", // Label decides the icon for release annotation + "Deployment Uri": getDeploymentUri() + }; + + let releaseAnnotation = { + "AnnotationName": annotationName, + "Category": "Text", + "EventTime": new Date(), + "Id": uuidV4(), + "Properties": JSON.stringify(releaseAnnotationProperties) + }; + + return releaseAnnotation; +} + +function getDeploymentUri(): string { + let buildUri = tl.getVariable("Build.BuildUri"); + let releaseWebUrl = tl.getVariable("Release.ReleaseWebUrl"); + let collectionUrl = tl.getVariable('System.TeamFoundationCollectionUri'); + let teamProject = tl.getVariable('System.TeamProjectId'); + let buildId = tl.getVariable('build.buildId'); + + if (!!releaseWebUrl) { + return releaseWebUrl; + } + + if (!!buildUri) { + return `${collectionUrl}${teamProject}/_build?buildId=${buildId}&_a=summary`; + } + + return ""; +} \ No newline at end of file diff --git a/Tasks/AzureRmWebAppDeployment/operations/TaskParameters.ts b/Tasks/AzureRmWebAppDeployment/operations/TaskParameters.ts new file mode 100644 index 000000000000..de09c16eba2c --- /dev/null +++ b/Tasks/AzureRmWebAppDeployment/operations/TaskParameters.ts @@ -0,0 +1,95 @@ +import tl = require('vsts-task-lib/task'); + +export class TaskParametersUtility { + public static getParameters(): TaskParameters { + var taskParameters: TaskParameters = { + connectedServiceName: tl.getInput('ConnectedServiceName', true), + WebAppName: tl.getInput('WebAppName', true), + WebAppKind: tl.getInput('WebAppKind', false), + DeployToSlotFlag: tl.getBoolInput('DeployToSlotFlag', false), + ResourceGroupName: tl.getInput('ResourceGroupName', false), + SlotName: tl.getInput('SlotName', false), + VirtualApplication: tl.getInput('VirtualApplication', false), + Package: tl.getPathInput('Package', true), + GenerateWebConfig: tl.getBoolInput('GenerateWebConfig', false), + WebConfigParameters: tl.getInput('WebConfigParameters', false), + XmlTransformation: tl.getBoolInput('XmlTransformation', false), + JSONFiles: tl.getDelimitedInput('JSONFiles', '\n', false), + XmlVariableSubstitution: tl.getBoolInput('XmlVariableSubstitution', false), + UseWebDeploy: tl.getBoolInput('UseWebDeploy', false), + TakeAppOfflineFlag: tl.getBoolInput('TakeAppOfflineFlag', false), + RenameFilesFlag: tl.getBoolInput('RenameFilesFlag', false), + AdditionalArguments: tl.getInput('AdditionalArguments', false), + ScriptType: tl.getInput('ScriptType', false), + InlineScript: tl.getInput('InlineScript', false), + ScriptPath : tl.getPathInput('ScriptPath', false), + DockerNamespace: tl.getInput('DockerNamespace', false), + AppSettings: tl.getInput('AppSettings', false), + ImageSource: tl.getInput('ImageSource', false), + StartupCommand: tl.getInput('StartupCommand', false), + WebAppUri: tl.getInput('WebAppUri', false), + ConfigurationSettings: tl.getInput('ConfigurationSettings', false) + } + + taskParameters.isLinuxApp = taskParameters.WebAppKind && taskParameters.WebAppKind.indexOf("linux") >= 0; + taskParameters.isBuiltinLinuxWebApp = taskParameters.ImageSource && taskParameters.ImageSource.indexOf("Builtin") >= 0; + taskParameters.isContainerWebApp = taskParameters.isLinuxApp && taskParameters.ImageSource.indexOf("Registry") >= 0; + + if(taskParameters.isLinuxApp && taskParameters.isBuiltinLinuxWebApp) { + taskParameters.BuiltinLinuxPackage = tl.getInput('BuiltinLinuxPackage', true); + taskParameters.RuntimeStack = tl.getInput('RuntimeStack', true); + tl.debug('Change package path to Linux package path'); + taskParameters.Package = tl.getInput('BuiltinLinuxPackage', true); + } + + taskParameters.VirtualApplication = taskParameters.VirtualApplication && taskParameters.VirtualApplication.startsWith('/') ? + taskParameters.VirtualApplication.substr(1) : taskParameters.VirtualApplication; + + if(taskParameters.UseWebDeploy) { + taskParameters.RemoveAdditionalFilesFlag = tl.getBoolInput('RemoveAdditionalFilesFlag', false); + taskParameters.SetParametersFile = tl.getPathInput('SetParametersFile', false); + taskParameters.ExcludeFilesFromAppDataFlag = tl.getBoolInput('ExcludeFilesFromAppDataFlag', false) + taskParameters.AdditionalArguments = tl.getInput('AdditionalArguments', false); + } + + return taskParameters; + } +} + +export interface TaskParameters { + connectedServiceName: string; + WebAppName: string; + WebAppKind?: string; + DeployToSlotFlag?: boolean; + ResourceGroupName?: string; + SlotName?: string; + VirtualApplication?: string; + Package: string; + GenerateWebConfig?: boolean; + WebConfigParameters?: string; + XmlTransformation?: boolean; + JSONFiles?: string[]; + XmlVariableSubstitution?: boolean; + UseWebDeploy?: boolean; + RemoveAdditionalFilesFlag?: boolean; + SetParametersFile?: string; + ExcludeFilesFromAppDataFlag?: boolean; + TakeAppOfflineFlag?: boolean; + RenameFilesFlag?: boolean; + AdditionalArguments?: string; + ScriptType?: string; + InlineScript?: string; + ScriptPath ?: string; + DockerNamespace?: string; + AppSettings?: string; + ImageSource?: string; + StartupCommand?: string; + BuiltinLinuxPackage?: string; + RuntimeStack?: string; + WebAppUri?: string; + ConfigurationSettings?: string; + /** Additional parameters */ + isLinuxApp?: boolean; + isBuiltinLinuxWebApp?: boolean; + isContainerWebApp?: boolean; +} \ No newline at end of file diff --git a/Tasks/AzureRmWebAppDeployment/package.json b/Tasks/AzureRmWebAppDeployment/package.json index 9eb61fca6eb1..dbca31f62a30 100644 --- a/Tasks/AzureRmWebAppDeployment/package.json +++ b/Tasks/AzureRmWebAppDeployment/package.json @@ -17,6 +17,8 @@ }, "homepage": "https://github.com/Microsoft/vsts-tasks#readme", "dependencies": { - "q": "1.4.1" + "q": "1.4.1", + "xml2js": "0.4.13", + "uuid": "3.1.0" } } diff --git a/Tasks/AzureRmWebAppDeployment/task.json b/Tasks/AzureRmWebAppDeployment/task.json index bb6288ffd187..bb35ced16af5 100644 --- a/Tasks/AzureRmWebAppDeployment/task.json +++ b/Tasks/AzureRmWebAppDeployment/task.json @@ -16,7 +16,7 @@ "version": { "Major": 3, "Minor": 3, - "Patch": 35 + "Patch": 36 }, "releaseNotes": "What's new in Version 3.0:
  Supports File Transformations (XDT)
  Supports Variable Substitutions(XML, JSON)
Click [here](https://aka.ms/azurermwebdeployreadme) for more Information.", "minimumAgentVersion": "2.104.1", @@ -39,17 +39,16 @@ "isExpanded": false, "visibleRule": "WebAppKind != \"\"" }, + { + "name": "ApplicationAndConfigurationSettings", + "displayName": "Application and Configuration Settings", + "isExpanded": false + }, { "name": "output", "displayName": "Output", "isExpanded": true, "visibleRule": "WebAppKind != \"\"" - }, - { - "name": "ApplicationSettings", - "displayName": "Application Settings", - "isExpanded": true, - "visibleRule": "WebAppKind = applinux" } ], "inputs": [ @@ -281,7 +280,7 @@ "defaultValue": "$(System.DefaultWorkingDirectory)/**/*.zip", "required": true, "visibleRule": "WebAppKind != applinux && WebAppKind != \"\"", - "helpMarkDown": "File path to the package or a folder containing app service contents generated by MSBuild or a compressed archive file.
Variables ( [Build](https://www.visualstudio.com/docs/build/define/variables) | [Release](https://www.visualstudio.com/docs/release/author-release-definition/understanding-tasks#predefvariables)), wild cards are supported.
For example, $(System.DefaultWorkingDirectory)/\\*\\*/\\*.zip." + "helpMarkDown": "File path to the package or a folder containing app service contents generated by MSBuild or a compressed zip or war file.
Variables ( [Build](https://www.visualstudio.com/docs/build/define/variables) | [Release](https://www.visualstudio.com/docs/release/author-release-definition/understanding-tasks#predefvariables)), wild cards are supported.
For example, $(System.DefaultWorkingDirectory)/\\*\\*/\\*.zip or $(System.DefaultWorkingDirectory)/\\*\\*/\\*.war." }, { "name": "BuiltinLinuxPackage", @@ -291,7 +290,7 @@ "defaultValue": "$(System.DefaultWorkingDirectory)/**/*.zip", "required": true, "visibleRule": "WebAppKind = applinux && ImageSource = Builtin", - "helpMarkDown": "File path to the package or a folder containing app service contents generated by MSBuild or a compressed archive file.
Variables ( [Build](https://www.visualstudio.com/docs/build/define/variables) | [Release](https://www.visualstudio.com/docs/release/author-release-definition/understanding-tasks#predefvariables)), wild cards are supported.
For example, $(System.DefaultWorkingDirectory)/\\*\\*/\\*.zip." + "helpMarkDown": "File path to the package or a folder containing app service contents generated by MSBuild or a compressed zip or war file.
Variables ( [Build](https://www.visualstudio.com/docs/build/define/variables) | [Release](https://www.visualstudio.com/docs/release/author-release-definition/understanding-tasks#predefvariables)), wild cards are supported.
For example, $(System.DefaultWorkingDirectory)/\\*\\*/\\*.zip or $(System.DefaultWorkingDirectory)/\\*\\*/\\*.war." }, { "name": "RuntimeStack", @@ -355,6 +354,7 @@ "label": "Inline Script", "defaultValue": ":: You can provide your deployment commands here. One command per line.", "groupName": "PostDeploymentAction", + "required": true, "visibleRule": "ScriptType == Inline Script", "properties": { "resizable": "true", @@ -398,12 +398,24 @@ "label": "App settings", "defaultValue": "", "required": false, - "groupName": "ApplicationSettings", + "groupName": "ApplicationAndConfigurationSettings", "helpMarkDown": "Edit web app application settings following the syntax -key value .
Example : -Port 5000 -RequestTimeout 5000", "properties": { "editorExtension": "ms.vss-services-azure.parameters-grid" } }, + { + "name": "ConfigurationSettings", + "type": "multiLine", + "label": "Configuration settings", + "defaultValue": "", + "required": false, + "groupName": "ApplicationAndConfigurationSettings", + "helpMarkDown": "Edit web app configuration settings following the syntax -key value.
Example : -phpVersion 5.6 -linuxFxVersion: node|6.11", + "properties": { + "editorExtension": "ms.vss-services-azure.parameters-grid" + } + }, { "name": "TakeAppOfflineFlag", "type": "boolean", @@ -614,7 +626,7 @@ "UnabletoretrieveResourceID": "Unable to retrieve connection details for Azure Resource:'%s'. Status Code: %s", "CouldnotfetchaccesstokenforAzureStatusCode": "Could not fetch access token for Azure. Status Code: %s (%s)", "Successfullyupdateddeploymenthistory": "Successfully updated deployment History at %s", - "Failedtoupdatedeploymenthistory": "Failed to update deployment history.", + "Failedtoupdatedeploymenthistory": "Failed to update deployment history. Error: %s", "WARNINGCannotupdatedeploymentstatusSCMendpointisnotenabledforthiswebsite": "WARNING : Cannot update deployment status : SCM endpoint is not enabled for this website", "Unabletoretrievewebconfigdetails": "Unable to retrieve App Service configuration details. Status Code: '%s'", "Unabletoretrievewebappsettings": "Unable to retrieve App Service application settings. [Status Code: '%s', Error Message: '%s']", @@ -630,8 +642,8 @@ "MSDeploygeneratedpackageareonlysupportedforWindowsplatform": "MSDeploy generated packages are only supported for Windows platform.", "UnsupportedinstalledversionfoundforMSDeployversionshouldbeatleast3orabove": "Unsupported installed version: %s found for MSDeploy. version should be at least 3 or above", "UnabletofindthelocationofMSDeployfromregistryonmachineError": "Unable to find the location of MS Deploy from registry on machine (Error : %s)", - "Nopackagefoundwithspecifiedpattern": "No package found with specified pattern", - "MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern": "More than one package matched with specified pattern. Please restrain the search pattern.", + "Nopackagefoundwithspecifiedpattern": "No package found with specified pattern: %s", + "MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern": "More than one package matched with specified pattern: %s. Please restrain the search pattern.", "Trytodeploywebappagainwithappofflineoptionselected": "Try to deploy app service again with Take application offline option selected.", "Trytodeploywebappagainwithrenamefileoptionselected": "Try to deploy app service again with Rename locked files option selected.", "NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", @@ -653,7 +665,7 @@ "RequestedURLforkuduphysicalpath": "Requested URL for kudu physical path : %s", "Physicalpathalreadyexists": "Physical path '%s' already exists", "KuduPhysicalpathCreatedSuccessfully": "Kudu physical path created successfully : %s", - "FailedtocreateKuduPhysicalPath": "Failed to create kudu physical path. Error Code: %s", + "FailedtocreateKuduPhysicalPath": "Failed to create kudu physical path. Error : %s", "FailedtocheckphysicalPath": "Failed to check kudu physical path. Error Code: %s", "VirtualApplicationDoesNotExist": "Virtual application doesn't exists : %s", "JSONParseError": "Unable to parse JSON file: %s. Error: %s", @@ -661,8 +673,8 @@ "XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", "failedtoUploadFileToKudu": "Unable to upload file: %s to Kudu (%s). Status Code: %s", "failedtoUploadFileToKuduError": "Unable to upload file: %s to Kudu (%s). Error: %s", - "ExecuteScriptOnKudu": "Executing given script on Kudu: %s", - "FailedToRunScriptOnKuduError": "Unable to run the script on Kudu: %s. Error: %s", + "ExecuteScriptOnKudu": "Executing given script on Kudu service.", + "FailedToRunScriptOnKuduError": "Unable to run the script on Kudu Service. Error: %s", "FailedToRunScriptOnKudu": "Unable to run the script on Kudu: %s. Status Code: %s", "ScriptExecutionOnKuduSuccess": "Successfully executed script on Kudu.", "ScriptExecutionOnKuduFailed": "Executed script returned '%s' as return code. Error: %s", @@ -701,6 +713,31 @@ "UnableToUpdateWebAppConfigDetails": "Unable to update WebApp config details. StatusCode: '%s'", "AddingReleaseAnnotation": "Adding release annotation for the Application Insights resource '%s'", "SuccessfullyAddedReleaseAnnotation": "Successfully added release annotation to the Application Insight : %s", - "FailedAddingReleaseAnnotation": "Failed to add release annotation. %s" + "FailedAddingReleaseAnnotation": "Failed to add release annotation. %s", + "RenameLockedFilesEnabled": "Rename locked files enabled for App Service.", + "FailedToEnableRenameLockedFiles": "Failed to enable rename locked files. Error: %s", + "WebJobsInProgressIssue": "Few WebJobs in running state prevents the deployment from removing the files. You can disable 'Remove additional files at destinaton' option or Stop continuous Jobs before deployment.", + "FailedToFetchKuduAppSettings": "Failed to fetch Kudu App Settings. Error: %s", + "FailedToCreatePath": "Failed to create path '%s' from Kudu. Error: %s", + "FailedToDeleteFile": "Failed to delete file '%s/%s' from Kudu. Error: %s", + "FailedToUploadFile": "Failed to upload file '%s/%s' from Kudu. Error: %s", + "FailedToGetFileContent": "Failed to get file content '%s/%s' from Kudu. Error: %s", + "FailedToListPath": "Failed to list path '%s' from Kudu. Error: %s", + "RetryToDeploy": "Retrying to deploy the package.", + "FailedToGetAppServiceDetails": "Failed to fetch App Service '%s' details. Error: %s", + "FailedToGetAppServicePublishingProfile": "Failed to fetch App Service '%s' publishing profile. Error: %s", + "FailedToUpdateAppServiceMetadata": "Failed to update App service '%s' Meta data. Error: %s", + "FailedToGetAppServiceMetadata": "Failed to get App service '%s' Meta data. Error: %s", + "FailedToPatchAppServiceConfiguration": "Failed to patch App Service '%s' configuration. Error: %s", + "FailedToUpdateAppServiceConfiguration": "Failed to update App service '%s' configuration. Error: %s", + "FailedToGetAppServiceConfiguration": "Failed to get App service '%s' configuration. Error: %s", + "FailedToGetAppServicePublishingCredentials": "Failed to fetch App Service '%s' publishing credentials. Error: %s", + "FailedToGetAppServiceApplicationSettings": "Failed to get App service '%s' application settings. Error: %s", + "FailedToUpdateAppServiceApplicationSettings": "Failed to update App service '%s' application settings. Error: %s", + "UpdatingAppServiceConfigurationSettings": "Updating App Service Configuration settings. Data: %s", + "UpdatedAppServiceConfigurationSettings": "Updated App Service Configuration settings.", + "UpdatingAppServiceApplicationSettings": "Updating App Service Application settings. Data: %s", + "UpdatedAppServiceApplicationSettings": "Updated App Service Application settings and Kudu Application settings.", + "MultipleResourceGroupFoundForAppService": "Multiple resource group found for App Service '%s'." } } diff --git a/Tasks/AzureRmWebAppDeployment/task.loc.json b/Tasks/AzureRmWebAppDeployment/task.loc.json index 0ebc47cbfd90..2904bcd1fdbb 100644 --- a/Tasks/AzureRmWebAppDeployment/task.loc.json +++ b/Tasks/AzureRmWebAppDeployment/task.loc.json @@ -16,7 +16,7 @@ "version": { "Major": 3, "Minor": 3, - "Patch": 35 + "Patch": 36 }, "releaseNotes": "ms-resource:loc.releaseNotes", "minimumAgentVersion": "2.104.1", @@ -39,17 +39,16 @@ "isExpanded": false, "visibleRule": "WebAppKind != \"\"" }, + { + "name": "ApplicationAndConfigurationSettings", + "displayName": "ms-resource:loc.group.displayName.ApplicationAndConfigurationSettings", + "isExpanded": false + }, { "name": "output", "displayName": "ms-resource:loc.group.displayName.output", "isExpanded": true, "visibleRule": "WebAppKind != \"\"" - }, - { - "name": "ApplicationSettings", - "displayName": "ms-resource:loc.group.displayName.ApplicationSettings", - "isExpanded": true, - "visibleRule": "WebAppKind = applinux" } ], "inputs": [ @@ -363,6 +362,7 @@ "label": "ms-resource:loc.input.label.InlineScript", "defaultValue": ":: You can provide your deployment commands here. One command per line.", "groupName": "PostDeploymentAction", + "required": true, "visibleRule": "ScriptType == Inline Script", "properties": { "resizable": "true", @@ -406,12 +406,24 @@ "label": "ms-resource:loc.input.label.AppSettings", "defaultValue": "", "required": false, - "groupName": "ApplicationSettings", + "groupName": "ApplicationAndConfigurationSettings", "helpMarkDown": "ms-resource:loc.input.help.AppSettings", "properties": { "editorExtension": "ms.vss-services-azure.parameters-grid" } }, + { + "name": "ConfigurationSettings", + "type": "multiLine", + "label": "ms-resource:loc.input.label.ConfigurationSettings", + "defaultValue": "", + "required": false, + "groupName": "ApplicationAndConfigurationSettings", + "helpMarkDown": "ms-resource:loc.input.help.ConfigurationSettings", + "properties": { + "editorExtension": "ms.vss-services-azure.parameters-grid" + } + }, { "name": "TakeAppOfflineFlag", "type": "boolean", @@ -713,6 +725,31 @@ "UnableToUpdateWebAppConfigDetails": "ms-resource:loc.messages.UnableToUpdateWebAppConfigDetails", "AddingReleaseAnnotation": "ms-resource:loc.messages.AddingReleaseAnnotation", "SuccessfullyAddedReleaseAnnotation": "ms-resource:loc.messages.SuccessfullyAddedReleaseAnnotation", - "FailedAddingReleaseAnnotation": "ms-resource:loc.messages.FailedAddingReleaseAnnotation" + "FailedAddingReleaseAnnotation": "ms-resource:loc.messages.FailedAddingReleaseAnnotation", + "RenameLockedFilesEnabled": "ms-resource:loc.messages.RenameLockedFilesEnabled", + "FailedToEnableRenameLockedFiles": "ms-resource:loc.messages.FailedToEnableRenameLockedFiles", + "WebJobsInProgressIssue": "ms-resource:loc.messages.WebJobsInProgressIssue", + "FailedToFetchKuduAppSettings": "ms-resource:loc.messages.FailedToFetchKuduAppSettings", + "FailedToCreatePath": "ms-resource:loc.messages.FailedToCreatePath", + "FailedToDeleteFile": "ms-resource:loc.messages.FailedToDeleteFile", + "FailedToUploadFile": "ms-resource:loc.messages.FailedToUploadFile", + "FailedToGetFileContent": "ms-resource:loc.messages.FailedToGetFileContent", + "FailedToListPath": "ms-resource:loc.messages.FailedToListPath", + "RetryToDeploy": "ms-resource:loc.messages.RetryToDeploy", + "FailedToGetAppServiceDetails": "ms-resource:loc.messages.FailedToGetAppServiceDetails", + "FailedToGetAppServicePublishingProfile": "ms-resource:loc.messages.FailedToGetAppServicePublishingProfile", + "FailedToUpdateAppServiceMetadata": "ms-resource:loc.messages.FailedToUpdateAppServiceMetadata", + "FailedToGetAppServiceMetadata": "ms-resource:loc.messages.FailedToGetAppServiceMetadata", + "FailedToPatchAppServiceConfiguration": "ms-resource:loc.messages.FailedToPatchAppServiceConfiguration", + "FailedToUpdateAppServiceConfiguration": "ms-resource:loc.messages.FailedToUpdateAppServiceConfiguration", + "FailedToGetAppServiceConfiguration": "ms-resource:loc.messages.FailedToGetAppServiceConfiguration", + "FailedToGetAppServicePublishingCredentials": "ms-resource:loc.messages.FailedToGetAppServicePublishingCredentials", + "FailedToGetAppServiceApplicationSettings": "ms-resource:loc.messages.FailedToGetAppServiceApplicationSettings", + "FailedToUpdateAppServiceApplicationSettings": "ms-resource:loc.messages.FailedToUpdateAppServiceApplicationSettings", + "UpdatingAppServiceConfigurationSettings": "ms-resource:loc.messages.UpdatingAppServiceConfigurationSettings", + "UpdatedAppServiceConfigurationSettings": "ms-resource:loc.messages.UpdatedAppServiceConfigurationSettings", + "UpdatingAppServiceApplicationSettings": "ms-resource:loc.messages.UpdatingAppServiceApplicationSettings", + "UpdatedAppServiceApplicationSettings": "ms-resource:loc.messages.UpdatedAppServiceApplicationSettings", + "MultipleResourceGroupFoundForAppService": "ms-resource:loc.messages.MultipleResourceGroupFoundForAppService" } } \ No newline at end of file diff --git a/Tasks/Common/azure-arm-rest/Strings/resources.resjson/en-US/resources.resjson b/Tasks/Common/azure-arm-rest/Strings/resources.resjson/en-US/resources.resjson index ec8e4edca48b..375ebe95e88f 100644 --- a/Tasks/Common/azure-arm-rest/Strings/resources.resjson/en-US/resources.resjson +++ b/Tasks/Common/azure-arm-rest/Strings/resources.resjson/en-US/resources.resjson @@ -62,11 +62,9 @@ "loc.messages.FailedToRestartAppService": "Failed to restart App Service '%s'. Error: %s", "loc.messages.FailedToRestartAppServiceSlot": "Failed to restart App Service '%s-%s'. Error: %s", "loc.messages.FailedToGetAppServiceDetails": "Failed to fetch App Service '%s' details. Error: %s", - "loc.messages.FailedToGetAppServiceDetailsSlot": "Failed to fetch App Service '%s-%s' details. Error: %s", "loc.messages.AppServiceState": "App Service is in '%s' state.", "loc.messages.InvalidMonitorAppState": "Invalid state '%s' provided for monitoring app state", "loc.messages.FailedToGetAppServicePublishingProfile": "Failed to fetch App Service '%s' publishing profile. Error: %s", - "loc.messages.FailedToGetAppServicePublishingProfileSlot": "Failed to fetch App Service '%s-%s' publishing profile. Error: %s", "loc.messages.FailedToSwapAppServiceSlotWithProduction": "Failed to swap App Service '%s' slots - 'production' and '%s'. Error: %s", "loc.messages.FailedToSwapAppServiceSlotSlots": "Failed to swap App Service '%s' slots - '%s' and '%s'. Error: %s", "loc.messages.SwappingAppServiceSlotWithProduction": "Swapping App Service '%s' slots - 'production' and '%s'", @@ -74,7 +72,6 @@ "loc.messages.SwappedAppServiceSlotWithProduction": "Swapped App Service '%s' slots - 'production' and '%s'", "loc.messages.SwappedAppServiceSlotSlots": "Swapped App Service '%s' slots - '%s' and '%s'", "loc.messages.FailedToGetAppServicePublishingCredentials": "Failed to fetch App Service '%s' publishing credentials. Error: %s", - "loc.messages.FailedToGetAppServicePublishingCredentialsSlot": "Failed to fetch App Service '%s-%s' publishing credentials. Error: %s", "loc.messages.WarmingUpSlots": "Warming-up slots", "loc.messages.DeploymentIDCannotBeNull": "Deployment ID cannot be null or empty.", "loc.messages.DeploymentDataEntityCannotBeNull": "Deployment data entity cannot be null or undefined.", @@ -93,13 +90,9 @@ "loc.messages.FailedToCreateWebTests": "Failed to create Web Test. Error: %s", "loc.messages.WebTestAlreadyConfigured": "Web Test already configured for URL: %s", "loc.messages.FailedToGetAppServiceConfiguration": "Failed to get App service '%s' configuration. Error: %s", - "loc.messages.FailedToGetAppServiceConfigurationSlot": "Failed to get App service '%s-%s' configuration. Error: %s", "loc.messages.FailedToUpdateAppServiceConfiguration": "Failed to update App service '%s' configuration. Error: %s", - "loc.messages.FailedToUpdateAppServiceConfigurationSlot": "Failed to update App service '%s-%s' configuration. Error: %s", "loc.messages.FailedToGetAppServiceApplicationSettings": "Failed to get App service '%s' application settings. Error: %s", - "loc.messages.FailedToGetAppServiceApplicationSettingsSlot": "Failed to get App service '%s-%s' application settings. Error: %s", "loc.messages.FailedToUpdateAppServiceApplicationSettings": "Failed to update App service '%s' application settings. Error: %s", - "loc.messages.FailedToUpdateAppServiceApplicationSettingsSlot": "Failed to update App service '%s-%s' application settings. Error: %s", "loc.messages.KuduSCMDetailsAreEmpty": "KUDU SCM details are empty", "loc.messages.FailedToGetContinuousWebJobs": "Failed to get continuous WebJobs. Error: %s", "loc.messages.FailedToStartContinuousWebJob": "Failed to start continuous WebJob '%s'. Error: %s", @@ -125,5 +118,13 @@ "loc.messages.WebJobAlreadyInStoppedState": "WebJob '%s' is already in stopped state.", "loc.messages.RestartingKuduService": "Restarting Kudu Service.", "loc.messages.RestartedKuduService": "Kudu Service restarted", - "loc.messages.FailedToRestartKuduService": "Failed to restart kudu Service. %s." + "loc.messages.FailedToRestartKuduService": "Failed to restart kudu Service. %s.", + "loc.messages.FailedToFetchKuduAppSettings": "Failed to fetch Kudu App Settings. Error: %s", + "loc.messages.Successfullydeployedpackageusingkuduserviceat": "Successfully deployed package %s using kudu service at %s", + "loc.messages.Failedtodeploywebapppackageusingkuduservice": "Failed to deploy web package. Error: %s", + "loc.messages.FailedToCreatePath": "Failed to create path '%s' from Kudu. Error: %s", + "loc.messages.FailedToDeleteFile": "Failed to delete file '%s/%s' from Kudu. Error: %s", + "loc.messages.FailedToUploadFile": "Failed to upload file '%s/%s from Kudu. Error: %s", + "loc.messages.FailedToGetFileContent": "Failed to get file content '%s/%s' from Kudu. Error: %s", + "loc.messages.FailedToListPath": "Failed to list path '%s'. Error: %s" } \ No newline at end of file diff --git a/Tasks/Common/azure-arm-rest/Tests/L0-azure-arm-app-service-kudu-tests.ts b/Tasks/Common/azure-arm-rest/Tests/L0-azure-arm-app-service-kudu-tests.ts index 4dbc200933a6..8747ac260ad0 100644 --- a/Tasks/Common/azure-arm-rest/Tests/L0-azure-arm-app-service-kudu-tests.ts +++ b/Tasks/Common/azure-arm-rest/Tests/L0-azure-arm-app-service-kudu-tests.ts @@ -26,6 +26,23 @@ export function KuduServiceTests() { getProcess(tr); console.log("\tvalidating killProcess"); killProcess(tr); + console.log("\tvalidating getAppSettings"); + getAppSettings(tr); + console.log("\tvalidating listDir"); + listDir(tr); + console.log("\tvalidating getFileContent"); + getFileContent(tr); + console.log("\tvalidating uploadFile"); + uploadFile(tr); + console.log("\tvalidating createPath"); + createPath(tr); + console.log("\tvalidating runCommand"); + runCommand(tr); + console.log("\tvalidating extractZIP"); + extractZIP(tr); + console.log("\tvalidating deleteFile"); + deleteFile(tr); + } catch(error) { passed = false; @@ -44,8 +61,8 @@ function updateDeployment(tr) { assert(tr.stdOutContained('Successfullyupdateddeploymenthistory http://MOCK_SCM_WEBSITE/api/deployments/MOCK_DEPLOYMENT_ID'), 'Should have printed: Successfullyupdateddeploymenthistory http://MOCK_SCM_WEBSITE/api/deployments/MOCK_DEPLOYMENT_ID'); - assert(tr.stdOutContained('FailedToUpdateDeploymentHistory null (CODE: 504)'), - 'Should have printed: FailedToUpdateDeploymentHistory null (CODE: 504)'); + assert(tr.stdOutContained('FailedToUpdateDeploymentHistory null (CODE: 501)'), + 'Should have printed: FailedToUpdateDeploymentHistory null (CODE: 501)'); } function getContinuousJobs(tr) { @@ -93,9 +110,78 @@ function getProcess(tr) { 'Should have printed: MOCK KUDU PROCESS ID: 1'); } - function killProcess(tr) { assert(tr.stdOutContained('KILLED PROCESS 0'), 'Should have printed: KILLED PROCESS 0'); } +function getAppSettings(tr) { + assert(tr.stdOutContained('KUDU APP SETTINGS {"MSDEPLOY_RENAME_LOCKED_FILES":"1","ScmType":"VSTSRM"}'), + 'Should have printed: KUDU APP SETTINGS {"MSDEPLOY_RENAME_LOCKED_FILES":"1","ScmType":"VSTSRM"}'); + + assert(tr.stdOutContained('FailedToFetchKuduAppSettings null (CODE: 501)'), + 'Should have printed: FailedToFetchKuduAppSettings null (CODE: 501)'); +} + +function listDir(tr) { + assert(tr.stdOutContained('KUDU LIST DIR [{"name":"web.config"},{"name":"content","size":777}]'), + 'Should have printed: KUDU LIST DIR [{"name":"web.config"},{"name":"content","size":777}]'); + + assert(tr.stdOutContained('FailedToListPath site/wwwroot null (CODE: 501)'), + 'Should have printed: FailedToListPath site/wwwroot null (CODE: 501)'); +} + +function getFileContent(tr) { + assert(tr.stdOutContained('KUDU FILE CONTENT HELLO.TXT FILE CONTENT'), + 'Should have printed: KUDU FILE CONTENT HELLO.TXT FILE CONTENT'); + + assert(tr.stdOutContained('KUDU FILE CONTENT 404 - PASSED'), + 'Should have printed: KUDU FILE CONTENT 404 - PASSED'); + + assert(tr.stdOutContained('FailedToGetFileContent site/wwwroot web.config null (CODE: 501)'), + 'Should have printed: FailedToGetFileContent site/wwwroot web.config null (CODE: 501)'); +} + +function uploadFile(tr) { + assert(tr.stdOutContained('KUDU FILE UPLOAD HELLO.TXT PASSED'), + 'Should have printed: KUDU FILE UPLOAD HELLO.TXT PASSED'); + + assert(tr.stdOutContained('FailedToUploadFile site/wwwroot web.config null (CODE: 501)'), + 'Should have printed: FailedToUploadFile site/wwwroot web.config null (CODE: 501)'); +} + +function createPath(tr) { + assert(tr.stdOutContained('KUDU CREATE PATH SITE/WWWROOT PASSED'), + 'Should have printed: KUDU CREATE PATH SITE/WWWROOT PASSED'); + + assert(tr.stdOutContained('FailedToCreatePath site/wwwroot null (CODE: 501)'), + 'Should have printed: FailedToCreatePath site/wwwroot null (CODE: 501)'); +} + +function runCommand(tr) { + + assert(tr.stdOutContained('Executing Script on Kudu. Command: echo hello'), + 'Should have printed: Executing Script on Kudu. Command: echo hello'); + + assert(tr.stdOutContained('KUDU RUN COMMAND PASSED'), + 'Should have printed: KUDU RUN COMMAND PASSED'); + + assert(tr.stdOutContained('Executing Script on Kudu. Command: exit /b 1'), + 'Should have printed: Executing Script on Kudu. Command: exit /b 1'); +} + +function extractZIP(tr) { + assert(tr.stdOutContained('KUDU ZIP API PASSED'), + 'Should have printed: KUDU ZIP API PASSED'); + + assert(tr.stdOutContained('Failedtodeploywebapppackageusingkuduservice null (CODE: 501)'), + 'Should have printed: Failedtodeploywebapppackageusingkuduservice null (CODE: 501)'); +} + +function deleteFile(tr) { + assert(tr.stdOutContained('KUDU DELETE FILE PASSED'), + 'Should have printed: KUDU DELETE FILE PASSED'); + + assert(tr.stdOutContained('FailedToDeleteFile site/wwwroot web.config null (CODE: 501)'), + 'Should have printed: Error: FailedToDeleteFile site/wwwroot web.config null (CODE: 501)'); +} \ No newline at end of file diff --git a/Tasks/Common/azure-arm-rest/Tests/L0-azure-arm-app-service.ts b/Tasks/Common/azure-arm-rest/Tests/L0-azure-arm-app-service.ts index 2de56a487226..72791bec8673 100644 --- a/Tasks/Common/azure-arm-rest/Tests/L0-azure-arm-app-service.ts +++ b/Tasks/Common/azure-arm-rest/Tests/L0-azure-arm-app-service.ts @@ -1,6 +1,6 @@ import * as assert from 'assert'; import * as ttm from 'vsts-task-lib/mock-test'; -import tl = require('vsts-task-lib'); +import tl = require('vsts-task-lib/task'); import * as path from 'path'; export function AzureAppServiceMockTests() { @@ -21,12 +21,10 @@ export function AzureAppServiceMockTests() { swap(tr); console.log("\tvalidating get"); get(tr); - //console.log("\tvalidating monitorAppState"); - //monitorAppState(tr); console.log("\tvalidating getPublishingProfileWithSecrets"); getPublishingProfileWithSecrets(tr); - //console.log("\tvalidating getWebDeployPublishingProfile"); - //getWebDeployPublishingProfile(tr); + console.log("\tvalidating getPublishingCredentials"); + getPublishingCredentials(tr); console.log("\tvalidating getApplicationSettings"); getApplicationSettings(tr); console.log("\tvalidating updateApplicationSettings"); @@ -35,8 +33,12 @@ export function AzureAppServiceMockTests() { getConfiguration(tr); console.log("\tvalidating updateConfiguration"); updateConfiguration(tr); - //console.log("\tvalidating getKuduService"); - //getKuduService(tr); + console.log("\tvalidating patchConfiguration"); + patchConfiguration(tr); + console.log("\tvalidating getMetadata"); + getMetadata(tr); + console.log("\tvalidating updateMetadata"); + updateMetadata(tr); } catch(error) { passed = false; @@ -102,11 +104,6 @@ function getPublishingProfileWithSecrets(tr) { 'Should have printed: Error: FailedToGetAppServicePublishingProfile MOCK_APP_SERVICE_NAME-MOCK_SLOT_NAME internal_server_error (CODE: 500)'); } -function getWebDeployPublishingProfile(tr) { - assert(tr.stdOutContained('WEB DEPLOY PUBLISHING PROFILE: MOCK_APP_SERVICE_NAME - Web Deploy'), - 'Should have printed:WEB DEPLOY PUBLISHING PROFILE: MOCK_APP_SERVICE_NAME - Web Deploy'); -} - function getPublishingCredentials(tr) { assert(tr.stdOutContained('MOCK_APP_SERVICE_NAME PUBLISHINGCREDENTIALS ID: /subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/publishingcredentials/$MOCK_APP_SERVICE_NAME'), 'Should have printed: MOCK_APP_SERVICE_NAME PUBLISHINGCREDENTIALS ID: /subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/publishingcredentials/$MOCK_APP_SERVICE_NAME'); @@ -135,7 +132,6 @@ function getConfiguration(tr) { 'Should have printed: Error: FailedToUpdateAppServiceApplicationSettings MOCK_APP_SERVICE_NAME-MOCK_SLOT_NAME internal_server_error (CODE: 500)'); } - function updateConfiguration(tr) { assert(tr.stdOutContained('MOCK_APP_SERVICE_NAME CONFIG_WEB ID: /subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/web'), 'Should have printed: MOCK_APP_SERVICE_NAME CONFIG_WEB ID: /subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/web'); @@ -143,6 +139,22 @@ function updateConfiguration(tr) { 'Should have printed: Error: FailedToUpdateAppServiceConfiguration MOCK_APP_SERVICE_NAME-MOCK_SLOT_NAME internal_server_error (CODE: 500)'); } -function getKuduService(tr) { - assert(tr.stdOutContained('KUDU SERVICE FROM APP SERVICE', 'Should have printed: KUDU SERVICE FROM APP SERVICE')); -} \ No newline at end of file +function patchConfiguration(tr) { + assert(tr.stdOutContained('PATCH CONFIGURATION PASSED'), 'Should have printed: PATCH CONFIGURATION PASSED'); + assert(tr.stdOutContained(' FailedToPatchAppServiceConfiguration MOCK_APP_SERVICE_NAME-MOCK_SLOT_NAME internal_server_error (CODE: 500)'), + 'Should have printed: FailedToPatchAppServiceConfiguration MOCK_APP_SERVICE_NAME-MOCK_SLOT_NAME internal_server_error (CODE: 500)'); +} + +function getMetadata(tr) { + assert(tr.stdOutContained('MOCK_APP_SERVICE_NAME CONFIG_METADATA GET ID: /subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/metadata'), + 'Should have printed: MOCK_APP_SERVICE_NAME CONFIG_METADATA GET ID: /subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/metadata'); + assert(tr.stdOutContained(' FailedToGetAppServiceMetadata MOCK_APP_SERVICE_NAME-MOCK_SLOT_NAME internal_server_error (CODE: 500)'), + 'Should have printed: FailedToGetAppServiceMetadata MOCK_APP_SERVICE_NAME-MOCK_SLOT_NAME internal_server_error (CODE: 500)'); +} + +function updateMetadata(tr) { + assert(tr.stdOutContained('MOCK_APP_SERVICE_NAME CONFIG_METADATA UPDATE ID: /subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/metadata'), + 'Should have printed: MOCK_APP_SERVICE_NAME CONFIG_METADATA UPDATE ID: /subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/metadata'); + assert(tr.stdOutContained(' FailedToUpdateAppServiceMetadata MOCK_APP_SERVICE_NAME-MOCK_SLOT_NAME internal_server_error (CODE: 500)'), + 'Should have printed: FailedToUpdateAppServiceMetadata MOCK_APP_SERVICE_NAME-MOCK_SLOT_NAME internal_server_error (CODE: 500)'); +} diff --git a/Tasks/Common/azure-arm-rest/Tests/azure-arm-app-service-kudu-tests.ts b/Tasks/Common/azure-arm-rest/Tests/azure-arm-app-service-kudu-tests.ts index bbeb74a7ef49..9b9067807eb3 100644 --- a/Tasks/Common/azure-arm-rest/Tests/azure-arm-app-service-kudu-tests.ts +++ b/Tasks/Common/azure-arm-rest/Tests/azure-arm-app-service-kudu-tests.ts @@ -2,6 +2,7 @@ import { Kudu } from '../azure-arm-app-service-kudu'; import tl = require('vsts-task-lib'); import { getMockEndpoint, nock } from './mock_utils'; import { mockKuduServiceTests } from './mock_utils'; +import path = require('path'); mockKuduServiceTests(); @@ -28,7 +29,6 @@ export class KuduTests { } } - public static async getContinuousJobs() { try { var kudu = new Kudu('http://MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); @@ -152,15 +152,208 @@ export class KuduTests { } } + public static async getAppSettings() { + try { + var kudu = new Kudu('http://MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + var appSettings = await kudu.getAppSettings(); + console.log(`KUDU APP SETTINGS ${JSON.stringify(appSettings)}`); + } + catch(error) { + tl.error(error); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.getAppSettings() should have passed but failed'); + } + + try { + var kudu = new Kudu('http://FAIL_MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.getAppSettings(); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.getAppSettings() should have failed but passed'); + } + catch(error) { + tl.error(error); + } + } + + public static async listDir() { + try { + var kudu = new Kudu('http://MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + var listDir = await kudu.listDir('/site/wwwroot'); + console.log(`KUDU LIST DIR ${JSON.stringify(listDir)}`); + } + catch(error) { + tl.error(error); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.listDir() should have passed but failed'); + } + + try { + var kudu = new Kudu('http://FAIL_MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.listDir('/site/wwwroot'); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.listDir() should have failed but passed'); + } + catch(error) { + tl.error(error); + } + } + + public static async getFileContent() { + try { + var kudu = new Kudu('http://MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + var fileContent: string = await kudu.getFileContent('/site/wwwroot', 'hello.txt'); + console.log(`KUDU FILE CONTENT ${fileContent}`); + } + catch(error) { + tl.error(error); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.getFileContent() should have passed but failed'); + } + + try { + var kudu = new Kudu('http://MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + var fileContent: string = await kudu.getFileContent('/site/wwwroot', '404.txt'); + if(fileContent == null) { + console.log('KUDU FILE CONTENT 404 - PASSED'); + } + else { + console.log('KUDU FILE CONTENT 404 - FAILED'); + } + } + catch(error) { + tl.error(error); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.getFileContent() should have passed but failed'); + } + + try { + var kudu = new Kudu('http://FAIL_MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.getFileContent('/site/wwwroot', 'web.config'); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.getFileContent() should have failed but passed'); + } + catch(error) { + tl.error(error); + } + } + + public static async uploadFile() { + try { + var kudu = new Kudu('http://MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.uploadFile('/site/wwwroot', 'hello.txt', path.join(__dirname, 'package.json')); + console.log('KUDU FILE UPLOAD HELLO.TXT PASSED'); + } + catch(error) { + tl.error(error); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.uploadFile() should have passed but failed'); + } + + try { + var kudu = new Kudu('http://FAIL_MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.uploadFile('/site/wwwroot', 'web.config', path.join(__dirname, 'package.json')); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.uploadFile() should have failed but passed'); + } + catch(error) { + tl.error(error); + } + } + + public static async createPath() { + try { + var kudu = new Kudu('http://MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.createPath('/site/wwwroot'); + console.log('KUDU CREATE PATH SITE/WWWROOT PASSED'); + } + catch(error) { + tl.error(error); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.createPath() should have passed but failed'); + } + + try { + var kudu = new Kudu('http://FAIL_MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.createPath('/site/wwwroot'); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.createPath() should have failed but passed'); + } + catch(error) { + tl.error(error); + } + } + + public static async runCommand() { + try { + var kudu = new Kudu('http://MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.runCommand('site\\wwwroot', 'echo hello'); + console.log('KUDU RUN COMMAND PASSED'); + } + catch(error) { + tl.error(error); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.runCommand() should have passed but failed'); + } + + try { + var kudu = new Kudu('http://FAIL_MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.runCommand('site\\wwwroot', 'exit /b 1'); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.runCommand() should have failed but passed'); + } + catch(error) { + tl.error(error); + } + } + + public static async extractZIP() { + try { + var kudu = new Kudu('http://MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + var listDir = await kudu.extractZIP(path.join(__dirname, 'package.json'), '/site/wwwroot'); + console.log('KUDU ZIP API PASSED'); + } + catch(error) { + tl.error(error); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.extractZIP() should have passed but failed'); + } + + try { + var kudu = new Kudu('http://FAIL_MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.extractZIP(path.join(__dirname, 'package.json'), '/site/wwwroot'); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.extractZIP() should have failed but passed'); + } + catch(error) { + tl.error(error); + } + } + + public static async deleteFile() { + try { + var kudu = new Kudu('http://MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.deleteFile('/site/wwwroot', 'hello.txt'); + console.log(`KUDU DELETE FILE PASSED`); + } + catch(error) { + tl.error(error); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.deleteFile() should have passed but failed'); + } + + try { + var kudu = new Kudu('http://FAIL_MOCK_SCM_WEBSITE', 'MOCK_SCM_USERNAME', 'MOCK_SCM_PASSWORD'); + await kudu.deleteFile('/site/wwwroot', 'web.config'); + tl.setResult(tl.TaskResult.Failed, 'KuduTests.deleteFile() should have failed but passed'); + } + catch(error) { + tl.error(error); + } + } + } +async function RUNTESTS() { + await KuduTests.updateDeployment(); + await KuduTests.getContinuousJobs(); + await KuduTests.startContinuousWebJob(); + await KuduTests.stopContinuousWebJob(); + await KuduTests.installSiteExtension(); + await KuduTests.getSiteExtensions(); + await KuduTests.getProcess(); + await KuduTests.killProcess(); + await KuduTests.getAppSettings(); + await KuduTests.listDir(); + await KuduTests.getFileContent(); + await KuduTests.uploadFile(); + await KuduTests.createPath(); + await KuduTests.runCommand(); + await KuduTests.extractZIP(); + await KuduTests.deleteFile(); +} -// tl.setVariable('AZURE_HTTP_USER_AGENT','TEST_AGENT'); -KuduTests.updateDeployment(); -KuduTests.getContinuousJobs(); -KuduTests.startContinuousWebJob(); -KuduTests.stopContinuousWebJob(); -KuduTests.installSiteExtension(); -KuduTests.getSiteExtensions(); -KuduTests.getProcess(); -KuduTests.killProcess(); \ No newline at end of file +RUNTESTS(); \ No newline at end of file diff --git a/Tasks/Common/azure-arm-rest/Tests/azure-arm-app-service-tests.ts b/Tasks/Common/azure-arm-rest/Tests/azure-arm-app-service-tests.ts index 36584dd5ecaf..782c1be0f91f 100644 --- a/Tasks/Common/azure-arm-rest/Tests/azure-arm-app-service-tests.ts +++ b/Tasks/Common/azure-arm-rest/Tests/azure-arm-app-service-tests.ts @@ -2,7 +2,7 @@ import { AzureAppService } from '../azure-arm-app-service'; import { getMockEndpoint, mockAzureAppServiceTests } from './mock_utils'; import { AzureEndpoint } from '../azureModels'; import * as querystring from 'querystring'; -import tl = require('vsts-task-lib'); +import tl = require('vsts-task-lib/task'); var endpoint = getMockEndpoint(); mockAzureAppServiceTests(); @@ -79,93 +79,87 @@ class AzureAppServiceTests { public static async get() { var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); - appSerivce.get().then((value) => { + try { + var value = await appSerivce.get(); console.log('MOCK_APP_SERVICE_NAME ID: ' + value.id); - }).catch((error) => { + } + catch(error) { console.log(error); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.get() should have passed but failed'); - }); + } var appSerivceSlot: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME", "MOCK_SLOT_NAME"); - appSerivceSlot.get().then((value) => { + try { + await appSerivceSlot.get(); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.get() should have failed but passed'); - }).catch((error) => { + } + catch(error) { console.log(error); - }); - + } } - /* - public static async monitorAppState() { - var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); - appSerivce.monitorAppState("Running") - .catch((error) => { - console.log(error); - tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.monitorAppState() should have passed but failed'); - }); - } - */ public static async getPublishingProfileWithSecrets() { var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); - appSerivce.getPublishingProfileWithSecrets().then((value) => { + try { + var value = await appSerivce.getPublishingProfileWithSecrets(); console.log('MOCK_APP_SERVICE_NAME PUBLISHING_PROFILE : ' + value); - }).catch((error) => { + } + catch(error) { console.log(error); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getPublishingProfileWithSecrets() should have passed but failed'); - }); + } + var appSerivceSlot: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME", "MOCK_SLOT_NAME"); - appSerivceSlot.getPublishingProfileWithSecrets().then((value) => { + try { + await appSerivceSlot.getPublishingProfileWithSecrets(); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getPublishingProfileWithSecrets() should have failed but passed'); - }).catch((error) => { - console.log(error); - }); - } - - /* - public static async getWebDeployPublishingProfile() { - var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); - appSerivce.getWebDeployPublishingProfile().then((value) => { - console.log('WEB DEPLOY PUBLISHING PROFILE: ' + value.profileName); - }).catch((error) => { - tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getWebDeployPublishingProfile() should have passed but failed'); + } + catch(error) { console.log(error); - }); + } } - */ public static async getPublishingCredentials() { var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); - appSerivce.getPublishingCredentials().then((value) => { + try { + var value = await appSerivce.getPublishingCredentials(); console.log('MOCK_APP_SERVICE_NAME PUBLISHINGCREDENTIALS ID: ' + value.id); - }).catch((error) => { + } + catch(error) { console.log(error); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getPublishingCredentials() should have passed but failed'); - }); + } var appSerivceSlot: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME", "MOCK_SLOT_NAME"); - appSerivceSlot.getPublishingCredentials().then((value) => { + try { + await appSerivceSlot.getPublishingCredentials(); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getPublishingCredentials() should have failed but passed'); - }).catch((error) => { + } + catch(error) { console.log(error); - }); + } } public static async getApplicationSettings() { var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); - appSerivce.getApplicationSettings().then((value) => { + try { + var value = await appSerivce.getApplicationSettings(); console.log('MOCK_APP_SERVICE_NAME APPSETTINGS ID: ' + value.id); - }).catch((error) => { + } + catch(error) { console.log(error); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getApplicationSettings() should have passed but failed'); - }); + } var appSerivceSlot: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME", "MOCK_SLOT_NAME"); - appSerivceSlot.getApplicationSettings().then((value) => { + try { + await appSerivceSlot.getApplicationSettings(); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getApplicationSettings() should have failed but passed'); - }).catch((error) => { + } + catch(error) { console.log(error); - }); + } } public static async updateApplicationSettings() { @@ -182,36 +176,44 @@ class AzureAppServiceTests { }; var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); - appSerivce.updateApplicationSettings(appSettings).then((value) => { + try { + var value = await appSerivce.updateApplicationSettings(appSettings); console.log('MOCK_APP_SERVICE_NAME PUBLISHINGCREDENTIALS ID: ' + value.id); - }).catch((error) => { + } + catch(error) { console.log(error); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.updateApplicationSettings() should have passed but failed'); - }); + } var appSerivceSlot: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME", "MOCK_SLOT_NAME"); - appSerivceSlot.updateApplicationSettings(appSettings).then((value) => { + try { + await appSerivceSlot.updateApplicationSettings(appSettings); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.updateApplicationSettings() should have failed but passed'); - }).catch((error) => { + } + catch(error) { console.log(error); - }); + } } public static async getConfiguration() { var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); - appSerivce.getConfiguration().then((value) => { + try { + var value = await appSerivce.getConfiguration(); console.log('MOCK_APP_SERVICE_NAME CONFIG_WEB ID: ' + value.id); - }).catch((error) => { + } + catch(error) { console.log(error); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getConfiguration() should have passed but failed'); - }); + } var appSerivceSlot: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME", "MOCK_SLOT_NAME"); - appSerivceSlot.getApplicationSettings().then((value) => { + try { + await appSerivceSlot.getApplicationSettings(); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getConfiguration() should have failed but passed'); - }).catch((error) => { + } + catch(error) { console.log(error); - }); + } } public static async updateConfiguration() { @@ -227,45 +229,115 @@ class AzureAppServiceTests { }; var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); - appSerivce.updateConfiguration(appSettings).then((value) => { + try { + var value = await appSerivce.updateConfiguration(appSettings); console.log('MOCK_APP_SERVICE_NAME CONFIG_WEB ID: ' + value.id); - }).catch((error) => { + } + catch(error) { console.log(error); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.updateConfiguration() should have passed but failed'); - }); - + } var appSerivceSlot: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME", "MOCK_SLOT_NAME"); - appSerivceSlot.updateConfiguration(appSettings).then((value) => { + try { + await appSerivceSlot.updateConfiguration(appSettings); tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.updateConfiguration() should have failed but passed'); - }).catch((error) => { + } + catch(error) { console.log(error); - }); + } } - /* - public static async getKuduService() { + public static async patchConfiguration() { + try { + var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); + await appSerivce.patchConfiguration({'properties': {}}); + console.log('PATCH CONFIGURATION PASSED'); + } + catch(error) { + console.log(error); + tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.patchConfiguration() should have passed but failed'); + } + + try { + var appSerivceSlot: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME", "MOCK_SLOT_NAME"); + await appSerivceSlot.patchConfiguration({'properties': {}}); + tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.patchConfiguration() should have failed but passed'); + } + catch(error) { + console.log(error); + } + } + + public static async getMetadata() { var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); - appSerivce.getKuduService().then((value) => { - console.log('KUDU SERVICE FROM APP SERVICE'); - }).catch((error) => { + try { + var value = await appSerivce.getMetadata(); + console.log('MOCK_APP_SERVICE_NAME CONFIG_METADATA GET ID: ' + value.id); + } + catch(error) { console.log(error); - tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.updateConfiguration() should have passed but failed'); - }); + tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getMetadata() should have passed but failed'); + } + + var appSerivceSlot: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME", "MOCK_SLOT_NAME"); + try { + await appSerivceSlot.getMetadata(); + tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.getMetadata() should have failed but passed'); + } + catch(error) { + console.log(error); + } } - */ + + public static async updateMetadata() { + var appSettings = { + id: "/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/metadata", + name: "MOCK_APP_SERVICE_NAME", + type: "Microsoft.Web/sites", + kind: "app", + location: "South Central US", + properties: { + "alwaysOn": true + } + }; + + var appSerivce: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME"); + try { + var value = await appSerivce.updateMetadata(appSettings); + console.log('MOCK_APP_SERVICE_NAME CONFIG_METADATA UPDATE ID: ' + value.id); + } + catch(error) { + console.log(error); + tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.updateMetadata() should have passed but failed'); + } + + var appSerivceSlot: AzureAppService = new AzureAppService(endpoint, "MOCK_RESOURCE_GROUP_NAME", "MOCK_APP_SERVICE_NAME", "MOCK_SLOT_NAME"); + try { + await appSerivceSlot.updateMetadata(appSettings); + tl.setResult(tl.TaskResult.Failed, 'AzureAppServiceTests.updateMetadata() should have failed but passed'); + } + catch(error) { + console.log(error); + } + } + +} + +async function RUNTESTS() { + await AzureAppServiceTests.start(); + await AzureAppServiceTests.stop(); + await AzureAppServiceTests.restart(); + await AzureAppServiceTests.swap(); + await AzureAppServiceTests.get(); + await AzureAppServiceTests.getPublishingProfileWithSecrets(); + await AzureAppServiceTests.getPublishingCredentials(); + await AzureAppServiceTests.getApplicationSettings(); + await AzureAppServiceTests.updateApplicationSettings(); + await AzureAppServiceTests.getConfiguration(); + await AzureAppServiceTests.updateConfiguration(); + await AzureAppServiceTests.patchConfiguration(); + await AzureAppServiceTests.getMetadata(); + await AzureAppServiceTests.updateMetadata(); } -AzureAppServiceTests.start(); -AzureAppServiceTests.stop(); -AzureAppServiceTests.restart(); -AzureAppServiceTests.swap(); -AzureAppServiceTests.get(); -// AzureAppServiceTests.monitorAppState(); -AzureAppServiceTests.getPublishingProfileWithSecrets(); -// AzureAppServiceTests.getWebDeployPublishingProfile(); -AzureAppServiceTests.getPublishingCredentials(); -AzureAppServiceTests.getApplicationSettings(); -AzureAppServiceTests.updateApplicationSettings(); -AzureAppServiceTests.getConfiguration(); -AzureAppServiceTests.updateConfiguration(); -// AzureAppServiceTests.getKuduService(); +RUNTESTS(); \ No newline at end of file diff --git a/Tasks/Common/azure-arm-rest/Tests/mock_utils.ts b/Tasks/Common/azure-arm-rest/Tests/mock_utils.ts index a5a77e95ae92..de4860b39931 100644 --- a/Tasks/Common/azure-arm-rest/Tests/mock_utils.ts +++ b/Tasks/Common/azure-arm-rest/Tests/mock_utils.ts @@ -371,7 +371,70 @@ export function mockAzureAppServiceTests() { nock('https://management.azure.com', { "authorization": "Bearer DUMMY_ACCESS_TOKEN", "content-type": "application/json; charset=utf-8" - }).put("/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/MOCK_RESOURCE_GROUP_NAME/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/slots/MOCK_SLOT_NAME/config/web?api-version=2016-08-01", JSON.stringify(appSettings1)) + }).put("/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/MOCK_RESOURCE_GROUP_NAME/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/slots/MOCK_SLOT_NAME/config/web?api-version=2016-08-01") + .reply(500, 'internal_server_error').persist(); + + nock('https://management.azure.com', { + "authorization": "Bearer DUMMY_ACCESS_TOKEN", + "content-type": "application/json; charset=utf-8" + }).patch("/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/MOCK_RESOURCE_GROUP_NAME/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/web?api-version=2016-08-01") + .reply(200, { + id: "/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/web", + name: "MOCK_APP_SERVICE_NAME", + type: "Microsoft.Web/sites", + kind: "app", + location: "South Central US", + properties: { + "alwaysOn": true + } + }).persist(); + + nock('https://management.azure.com', { + "authorization": "Bearer DUMMY_ACCESS_TOKEN", + "content-type": "application/json; charset=utf-8" + }).patch("/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/MOCK_RESOURCE_GROUP_NAME/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/slots/MOCK_SLOT_NAME/config/web?api-version=2016-08-01") + .reply(500, 'internal_server_error').persist(); + + nock('https://management.azure.com', { + "authorization": "Bearer DUMMY_ACCESS_TOKEN", + "content-type": "application/json; charset=utf-8" + }).post("/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/MOCK_RESOURCE_GROUP_NAME/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/metadata/list?api-version=2016-08-01") + .reply(200, { + id: "/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/metadata", + name: "MOCK_APP_SERVICE_NAME", + type: "Microsoft.Web/sites", + kind: "app", + location: "South Central US", + properties: { + "VSTSRM_ReleaseDefinitionId": 1 + } + }).persist(); + + nock('https://management.azure.com', { + "authorization": "Bearer DUMMY_ACCESS_TOKEN", + "content-type": "application/json; charset=utf-8" + }).post("/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/MOCK_RESOURCE_GROUP_NAME/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/slots/MOCK_SLOT_NAME/config/metadata/list?api-version=2016-08-01") + .reply(500, 'internal_server_error').persist(); + + nock('https://management.azure.com', { + "authorization": "Bearer DUMMY_ACCESS_TOKEN", + "content-type": "application/json; charset=utf-8" + }).put("/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/MOCK_RESOURCE_GROUP_NAME/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/metadata?api-version=2016-08-01") + .reply(200, { + id: "/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/vincaAzureRG/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/config/metadata", + name: "MOCK_APP_SERVICE_NAME", + type: "Microsoft.Web/sites", + kind: "app", + location: "South Central US", + properties: { + "VSTSRM_ReleaseDefinitionId": 1 + } + }).persist(); + + nock('https://management.azure.com', { + "authorization": "Bearer DUMMY_ACCESS_TOKEN", + "content-type": "application/json; charset=utf-8" + }).put("/subscriptions/MOCK_SUBSCRIPTION_ID/resourceGroups/MOCK_RESOURCE_GROUP_NAME/providers/Microsoft.Web/sites/MOCK_APP_SERVICE_NAME/slots/MOCK_SLOT_NAME/config/metadata?api-version=2016-08-01") .reply(500, 'internal_server_error').persist(); } @@ -383,7 +446,7 @@ export function mockKuduServiceTests() { }); nock('http://FAIL_MOCK_SCM_WEBSITE'). - put('/api/deployments/MOCK_DEPLOYMENT_ID').reply(504,'Some server side issue').persist(); + put('/api/deployments/MOCK_DEPLOYMENT_ID').reply(501,'Some server side issue').persist(); nock('http://MOCK_SCM_WEBSITE'). get('/api/continuouswebjobs').reply(200, [ @@ -435,4 +498,52 @@ export function mockKuduServiceTests() { nock('http://MOCK_SCM_WEBSITE') .delete('/api/processes/0').reply(502, 'Bad Gaterway'); + nock('http://MOCK_SCM_WEBSITE'). + get('/api/settings').reply(200, { MSDEPLOY_RENAME_LOCKED_FILES : '1', ScmType: "VSTSRM" }); + + nock('http://FAIL_MOCK_SCM_WEBSITE'). + get('/api/settings').reply(501, 'Internal error occured'); + + nock('http://MOCK_SCM_WEBSITE'). + get('/api/vfs/site/wwwroot/').reply(200, [{name: 'web.config'}, { name: 'content', size: 777}]); + + nock('http://FAIL_MOCK_SCM_WEBSITE'). + get('/api/vfs/site/wwwroot/').reply(501, 'Internal error occured'); + + nock('http://MOCK_SCM_WEBSITE'). + get('/api/vfs/site/wwwroot/hello.txt').reply(200, 'HELLO.TXT FILE CONTENT'); + + nock('http://MOCK_SCM_WEBSITE'). + get('/api/vfs/site/wwwroot/404.txt').reply(404, null); + + nock('http://FAIL_MOCK_SCM_WEBSITE'). + get('/api/vfs/site/wwwroot/web.config').reply(501, 'Internal error occured'); + + nock('http://MOCK_SCM_WEBSITE'). + put('/api/vfs/site/wwwroot/hello.txt').reply(200); + + nock('http://FAIL_MOCK_SCM_WEBSITE'). + put('/api/vfs/site/wwwroot/web.config').reply(501, 'Internal error occured'); + + nock('http://MOCK_SCM_WEBSITE'). + put('/api/vfs/site/wwwroot/').reply(200); + + nock('http://FAIL_MOCK_SCM_WEBSITE'). + put('/api/vfs/site/wwwroot/').reply(501, 'Internal error occured'); + + nock('http://MOCK_SCM_WEBSITE'). + post('/api/command').reply(200); + + nock('http://FAIL_MOCK_SCM_WEBSITE'). + post('/api/command').reply(501, 'Internal error occured'); + + nock('http://MOCK_SCM_WEBSITE'). + put('/api/zip/site/wwwroot/').reply(200); + + nock('http://FAIL_MOCK_SCM_WEBSITE'). + put('/api/zip/site/wwwroot/').reply(501, 'Internal error occured'); + + nock('http://MOCK_SCM_WEBSITE').delete('/api/vfs/site/wwwroot/hello.txt').reply(200); + + nock('http://FAIL_MOCK_SCM_WEBSITE').delete('/api/vfs/site/wwwroot/web.config').reply(501, 'Internal error occured'); } \ No newline at end of file diff --git a/Tasks/Common/azure-arm-rest/azure-arm-app-service-kudu.ts b/Tasks/Common/azure-arm-rest/azure-arm-app-service-kudu.ts index 833b44c95fef..546212db3095 100644 --- a/Tasks/Common/azure-arm-rest/azure-arm-app-service-kudu.ts +++ b/Tasks/Common/azure-arm-rest/azure-arm-app-service-kudu.ts @@ -1,10 +1,12 @@ import msRestAzure = require('./azure-arm-common'); import tl = require('vsts-task-lib/task'); +import fs = require('fs'); import util = require('util'); import webClient = require('./webClient'); import Q = require('q'); import { ToError } from './AzureServiceClient'; import { WebJob, SiteExtension } from './azureModels'; + export class KuduServiceManagementClient { private _scmUri; private _accesssToken: string; @@ -68,7 +70,7 @@ export class Kudu { } } - public async getContinuousJobs(): Promise>{ + public async getContinuousJobs(): Promise> { var httpRequest = new webClient.WebRequest(); httpRequest.method = 'GET'; httpRequest.uri = this._client.getRequestUri(`/api/continuouswebjobs`); @@ -166,7 +168,7 @@ export class Kudu { } } - public async getProcess(processID: number) { + public async getProcess(processID: number): Promise { var httpRequest = new webClient.WebRequest(); httpRequest.method = 'GET'; httpRequest.uri = this._client.getRequestUri(`/api/processes/${processID}`); @@ -184,7 +186,7 @@ export class Kudu { } } - public async killProcess(processID: number) { + public async killProcess(processID: number): Promise { var httpRequest = new webClient.WebRequest(); httpRequest.method = 'DELETE'; httpRequest.uri = this._client.getRequestUri(`/api/processes/${processID}`); @@ -208,6 +210,215 @@ export class Kudu { } } + public async getAppSettings(): Promise> { + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'GET'; + httpRequest.uri = this._client.getRequestUri(`/api/settings`); + + try { + var response = await this._client.beginRequest(httpRequest); + tl.debug(`getAppSettings. Data: ${JSON.stringify(response)}`); + if(response.statusCode == 200) { + return response.body; + } + + throw response; + } + catch(error) { + throw Error(tl.loc('FailedToFetchKuduAppSettings', this._getFormattedError(error))); + } + } + + public async listDir(physicalPath: string): Promise { + physicalPath = physicalPath.replace(/[\\]/g, "/"); + physicalPath = physicalPath[0] == "/" ? physicalPath.slice(1): physicalPath; + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'GET'; + httpRequest.uri = this._client.getRequestUri(`/api/vfs/${physicalPath}/`); + httpRequest.headers = { + 'If-Match': '*' + }; + + try { + var response = await this._client.beginRequest(httpRequest); + tl.debug(`listFiles. Data: ${JSON.stringify(response)}`); + if([200, 201, 204].indexOf(response.statusCode) != -1) { + return response.body; + } + else if(response.statusCode === 404) { + return null; + } + else { + throw response; + } + } + catch(error) { + throw Error(tl.loc('FailedToListPath', physicalPath, this._getFormattedError(error))); + } + } + + public async getFileContent(physicalPath: string, fileName: string): Promise { + physicalPath = physicalPath.replace(/[\\]/g, "/"); + physicalPath = physicalPath[0] == "/" ? physicalPath.slice(1): physicalPath; + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'GET'; + httpRequest.uri = this._client.getRequestUri(`/api/vfs/${physicalPath}/${fileName}`); + httpRequest.headers = { + 'If-Match': '*' + }; + + try { + var response = await this._client.beginRequest(httpRequest); + tl.debug(`getFileContent. Data: ${JSON.stringify(response)}`); + if([200, 201, 204].indexOf(response.statusCode) != -1) { + return response.body; + } + else if(response.statusCode === 404) { + return null; + } + else { + throw response; + } + } + catch(error) { + throw Error(tl.loc('FailedToGetFileContent', physicalPath, fileName, this._getFormattedError(error))); + } + } + + public async uploadFile(physicalPath: string, fileName: string, filePath: string): Promise { + physicalPath = physicalPath.replace(/[\\]/g, "/"); + physicalPath = physicalPath[0] == "/" ? physicalPath.slice(1): physicalPath; + if(!tl.exist(filePath)) { + throw new Error(tl.loc('FilePathInvalid', filePath)); + } + + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'PUT'; + httpRequest.uri = this._client.getRequestUri(`/api/vfs/${physicalPath}/${fileName}`); + httpRequest.headers = { + 'If-Match': '*' + }; + httpRequest.body = fs.createReadStream(filePath); + + try { + var response = await this._client.beginRequest(httpRequest); + tl.debug(`uploadFile. Data: ${JSON.stringify(response)}`); + if([200, 201, 204].indexOf(response.statusCode) != -1) { + return response.body; + } + + throw response; + } + catch(error) { + throw Error(tl.loc('FailedToUploadFile', physicalPath, fileName, this._getFormattedError(error))); + } + } + + public async createPath(physicalPath: string): Promise { + physicalPath = physicalPath.replace(/[\\]/g, "/"); + physicalPath = physicalPath[0] == "/" ? physicalPath.slice(1): physicalPath; + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'PUT'; + httpRequest.uri = this._client.getRequestUri(`/api/vfs/${physicalPath}/`); + httpRequest.headers = { + 'If-Match': '*' + }; + + try { + var response = await this._client.beginRequest(httpRequest); + tl.debug(`createPath. Data: ${JSON.stringify(response)}`); + if([200, 201, 204].indexOf(response.statusCode) != -1) { + return response.body; + } + + throw response; + } + catch(error) { + throw Error(tl.loc('FailedToCreatePath', physicalPath, this._getFormattedError(error))); + } + } + + public async runCommand(physicalPath: string, command: string): Promise { + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'POST'; + httpRequest.uri = this._client.getRequestUri(`/api/command`); + httpRequest.headers = { + 'Content-Type': 'multipart/form-data', + 'If-Match': '*' + }; + httpRequest.body = JSON.stringify({ + 'command': command, + 'dir': physicalPath + }); + + try { + tl.debug('Executing Script on Kudu. Command: ' + command); + var response = await this._client.beginRequest(httpRequest); + tl.debug(`runCommand. Data: ${JSON.stringify(response)}`); + if(response.statusCode == 200) { + return ; + } + else { + throw response; + } + } + catch(error) { + throw Error(error.toString()); + } + } + + public async extractZIP(webPackage: string, physicalPath: string): Promise { + physicalPath = physicalPath.replace(/[\\]/g, "/"); + physicalPath = physicalPath[0] == "/" ? physicalPath.slice(1): physicalPath; + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'PUT'; + httpRequest.uri = this._client.getRequestUri(`/api/zip/${physicalPath}/`); + httpRequest.headers = { + 'Content-Type': 'multipart/form-data', + 'If-Match': '*' + }; + httpRequest.body = fs.createReadStream(webPackage); + + try { + var response = await this._client.beginRequest(httpRequest); + tl.debug(`extractZIP. Data: ${JSON.stringify(response)}`); + if(response.statusCode == 200) { + return ; + } + else { + throw response; + } + } + catch(error) { + throw Error(tl.loc('Failedtodeploywebapppackageusingkuduservice', this._getFormattedError(error))); + } + } + + public async deleteFile(physicalPath: string, fileName: string): Promise { + physicalPath = physicalPath.replace(/[\\]/g, "/"); + physicalPath = physicalPath[0] == "/" ? physicalPath.slice(1): physicalPath; + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'DELETE'; + httpRequest.uri = this._client.getRequestUri(`/api/vfs/${physicalPath}/${fileName}`); + httpRequest.headers = { + 'If-Match': '*' + }; + + try { + var response = await this._client.beginRequest(httpRequest); + tl.debug(`deleteFile. Data: ${JSON.stringify(response)}`); + if([200, 201, 204, 404].indexOf(response.statusCode) != -1) { + return ; + } + else { + throw response; + } + } + catch(error) { + throw Error(tl.loc('FailedToDeleteFile', physicalPath, fileName, this._getFormattedError(error))); + } + } + private _getFormattedError(error: any) { if(error && error.statusCode) { return `${error.statusMessage} (CODE: ${error.statusCode})`; diff --git a/Tasks/Common/azure-arm-rest/azure-arm-app-service.ts b/Tasks/Common/azure-arm-rest/azure-arm-app-service.ts index ec197cf7758a..1f59fcc908ad 100644 --- a/Tasks/Common/azure-arm-rest/azure-arm-app-service.ts +++ b/Tasks/Common/azure-arm-rest/azure-arm-app-service.ts @@ -24,6 +24,7 @@ export class AzureAppService { public _client: ServiceClient; private _appServiceConfigurationDetails: AzureAppServiceConfigurationDetails; private _appServicePublishingProfile: any; + private _appServiceApplicationSetings: AzureAppServiceConfigurationDetails; constructor(endpoint: AzureEndpoint, resourceGroup: string, name: string, slot?: string, appKind?: string) { this._client = new ServiceClient(endpoint.applicationTokenCredentials, endpoint.subscriptionID, 30); @@ -143,7 +144,7 @@ export class AzureAppService { return this._appServiceConfigurationDetails; } - public async getPublishingProfileWithSecrets(force?: boolean) { + public async getPublishingProfileWithSecrets(force?: boolean): Promise{ if(force || !this._appServicePublishingProfile) { this._appServicePublishingProfile = await this._getPublishingProfileWithSecrets(); } @@ -151,7 +152,7 @@ export class AzureAppService { return this._appServicePublishingProfile; } - public async getPublishingCredentials() { + public async getPublishingCredentials(): Promise { try { var httpRequest = new webClient.WebRequest(); httpRequest.method = 'POST'; @@ -174,27 +175,12 @@ export class AzureAppService { } } - public async getApplicationSettings(): Promise { - try { - var httpRequest = new webClient.WebRequest(); - httpRequest.method = 'POST'; - var slotUrl: string = !!this._slot ? `/slots/${this._slot}` : ''; - httpRequest.uri = this._client.getRequestUri(`//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/${slotUrl}/config/appsettings/list`, - { - '{resourceGroupName}': this._resourceGroup, - '{name}': this._name, - }, null, '2016-08-01'); - - var response = await this._client.beginRequest(httpRequest); - if(response.statusCode != 200) { - throw ToError(response); - } - - return response.body; - } - catch(error) { - throw Error(tl.loc('FailedToGetAppServiceApplicationSettings', this._getFormattedName(), this._client.getFormattedError(error))); + public async getApplicationSettings(force?: boolean): Promise { + if(force || !this._appServiceApplicationSetings) { + this._appServiceApplicationSetings = await this._getApplicationSettings(); } + + return this._appServiceApplicationSetings; } public async updateApplicationSettings(applicationSettings): Promise { @@ -278,21 +264,92 @@ export class AzureAppService { } } - public async patchConfiguration(properties): Promise { - var applicationSettings = await this.getConfiguration(); - for(var key in properties) { - applicationSettings.properties[key] = properties[key]; + public async patchConfiguration(properties: any): Promise { + try { + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'PATCH'; + httpRequest.body = JSON.stringify(properties); + var slotUrl: string = !!this._slot ? `/slots/${this._slot}` : ''; + httpRequest.uri = this._client.getRequestUri(`//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/${slotUrl}/config/web`, + { + '{resourceGroupName}': this._resourceGroup, + '{name}': this._name, + }, null, '2016-08-01'); + + var response = await this._client.beginRequest(httpRequest); + if(response.statusCode != 200) { + throw ToError(response); + } + + return response.body; } + catch(error) { + throw Error(tl.loc('FailedToPatchAppServiceConfiguration', this._getFormattedName(), this._client.getFormattedError(error))); + } + + } - await this.updateConfiguration(applicationSettings); + public async getMetadata(): Promise { + try { + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'POST'; + var slotUrl: string = !!this._slot ? `/slots/${this._slot}` : ''; + httpRequest.uri = this._client.getRequestUri(`//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/${slotUrl}/config/metadata/list`, + { + '{resourceGroupName}': this._resourceGroup, + '{name}': this._name, + }, null, '2016-08-01'); + + var response = await this._client.beginRequest(httpRequest); + if(response.statusCode != 200) { + throw ToError(response); + } + return response.body; + } + catch(error) { + throw Error(tl.loc('FailedToGetAppServiceMetadata', this._getFormattedName(), this._client.getFormattedError(error))); + } } + public async updateMetadata(applicationSettings): Promise { + try { + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'PUT'; + httpRequest.body = JSON.stringify(applicationSettings); + var slotUrl: string = !!this._slot ? `/slots/${this._slot}` : ''; + httpRequest.uri = this._client.getRequestUri(`//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/${slotUrl}/config/metadata`, + { + '{resourceGroupName}': this._resourceGroup, + '{name}': this._name, + }, null, '2016-08-01'); + + var response = await this._client.beginRequest(httpRequest); + if(response.statusCode != 200) { + throw ToError(response); + } + + return response.body; + } + catch(error) { + throw Error(tl.loc('FailedToUpdateAppServiceMetadata', this._getFormattedName(), this._client.getFormattedError(error))); + } + } + + public async patchMetadata(properties): Promise { + var applicationSettings = await this.getMetadata(); + for(var key in properties) { + applicationSettings.properties[key] = properties[key]; + } + + await this.updateMetadata(applicationSettings); + } + public getSlot(): string { return this._slot ? this._slot : "production"; } - private async _getPublishingProfileWithSecrets() { + private async _getPublishingProfileWithSecrets(): Promise { try { var httpRequest = new webClient.WebRequest(); httpRequest.method = 'POST'; @@ -316,6 +373,29 @@ export class AzureAppService { } } + private async _getApplicationSettings(): Promise { + try { + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'POST'; + var slotUrl: string = !!this._slot ? `/slots/${this._slot}` : ''; + httpRequest.uri = this._client.getRequestUri(`//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/${slotUrl}/config/appsettings/list`, + { + '{resourceGroupName}': this._resourceGroup, + '{name}': this._name, + }, null, '2016-08-01'); + + var response = await this._client.beginRequest(httpRequest); + if(response.statusCode != 200) { + throw ToError(response); + } + + return response.body; + } + catch(error) { + throw Error(tl.loc('FailedToGetAppServiceApplicationSettings', this._getFormattedName(), this._client.getFormattedError(error))); + } + } + private async _get(): Promise { try { var httpRequest = new webClient.WebRequest(); diff --git a/Tasks/Common/azure-arm-rest/azure-arm-appinsights.ts b/Tasks/Common/azure-arm-rest/azure-arm-appinsights.ts index 850deafba1c6..5f281ae5f220 100644 --- a/Tasks/Common/azure-arm-rest/azure-arm-appinsights.ts +++ b/Tasks/Common/azure-arm-rest/azure-arm-appinsights.ts @@ -6,6 +6,7 @@ import {ToError, ServiceClient } from './AzureServiceClient'; import Model = require('./azureModels'); import Q = require('q'); import { AzureEndpoint, ApplicationInsights } from './azureModels'; +import { APIVersions } from './constants'; export class AzureApplicationInsights { private _name: string; @@ -51,7 +52,7 @@ export class AzureApplicationInsights { { '{resourceGroupName}': this._resourceGroupName, '{resourceName}': this._name, - }, null, '2015-05-01'); + }, null, APIVersions.azure_arm_appinsights); try { var response = await this._client.beginRequest(httpRequest); @@ -66,7 +67,72 @@ export class AzureApplicationInsights { } } + public async addReleaseAnnotation(annotation: any): Promise { + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'PUT'; + httpRequest.body = JSON.stringify(annotation); + httpRequest.uri = this._client.getRequestUri(`//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/components/{resourceName}/Annotations`, + { + '{resourceGroupName}': this._resourceGroupName, + '{resourceName}': this._name, + }, null, APIVersions.azure_arm_appinsights); + + try { + var response = await this._client.beginRequest(httpRequest); + tl.debug(`addReleaseAnnotation. Data : ${JSON.stringify(response)}`); + if(response.statusCode == 200) { + return ; + } + + throw ToError(response); + } + catch(error) { + throw Error(tl.loc('FailedToUpdateApplicationInsightsResource', this._name, this._client.getFormattedError(error))) + } + } + public getResourceGroupName(): string { return this._resourceGroupName; } } + + +export class ApplicationInsightsResources { + private _endpoint: AzureEndpoint; + private _client: ServiceClient; + + constructor(endpoint: AzureEndpoint) { + this._client = new ServiceClient(endpoint.applicationTokenCredentials, endpoint.subscriptionID, 30); + this._endpoint = endpoint; + } + + public async list(resourceGroupName?: string, filter?: string[]): Promise { + var httpRequest = new webClient.WebRequest(); + httpRequest.method = 'GET'; + resourceGroupName = resourceGroupName ? `resourceGroups/${resourceGroupName}` : ''; + httpRequest.uri = this._client.getRequestUri(`//subscriptions/{subscriptionId}/${resourceGroupName}/providers/microsoft.insights/components`, + {}, filter, APIVersions.azure_arm_appinsights); + + try { + var response = await this._client.beginRequest(httpRequest); + if(response.statusCode == 200) { + var responseBody = response.body; + var applicationInsightsResources: ApplicationInsights[] = []; + if(responseBody.value && responseBody.value.length > 0) { + for(var value of responseBody.value) { + applicationInsightsResources.push(value as ApplicationInsights); + } + } + + return applicationInsightsResources; + + } + + throw ToError(response); + } + catch(error) { + throw Error(tl.loc('FailedToGetApplicationInsightsResource', this._client.getFormattedError(error))) + } + + } +} \ No newline at end of file diff --git a/Tasks/Common/azure-arm-rest/constants.ts b/Tasks/Common/azure-arm-rest/constants.ts index fc0f32226959..a66f3cccf5d6 100644 --- a/Tasks/Common/azure-arm-rest/constants.ts +++ b/Tasks/Common/azure-arm-rest/constants.ts @@ -4,4 +4,13 @@ export const AzureEnvironments = { export const APPLICATION_INSIGHTS_EXTENSION_NAME: string = "Microsoft.ApplicationInsights.AzureWebSites"; -export const productionSlot: string = "production"; \ No newline at end of file +export const productionSlot: string = "production"; + +export const APIVersions = { + azure_arm_appinsights: '2015-05-01' +} + +export const KUDU_DEPLOYMENT_CONSTANTS = { + SUCCESS: 4, + FAILED: 3 +} \ No newline at end of file diff --git a/Tasks/Common/azure-arm-rest/module.json b/Tasks/Common/azure-arm-rest/module.json index 75af8391c76b..b959fcfac1ec 100644 --- a/Tasks/Common/azure-arm-rest/module.json +++ b/Tasks/Common/azure-arm-rest/module.json @@ -63,11 +63,9 @@ "FailedToRestartAppService": "Failed to restart App Service '%s'. Error: %s", "FailedToRestartAppServiceSlot": "Failed to restart App Service '%s-%s'. Error: %s", "FailedToGetAppServiceDetails": "Failed to fetch App Service '%s' details. Error: %s", - "FailedToGetAppServiceDetailsSlot": "Failed to fetch App Service '%s-%s' details. Error: %s", "AppServiceState": "App Service is in '%s' state.", "InvalidMonitorAppState": "Invalid state '%s' provided for monitoring app state", "FailedToGetAppServicePublishingProfile": "Failed to fetch App Service '%s' publishing profile. Error: %s", - "FailedToGetAppServicePublishingProfileSlot": "Failed to fetch App Service '%s-%s' publishing profile. Error: %s", "FailedToSwapAppServiceSlotWithProduction": "Failed to swap App Service '%s' slots - 'production' and '%s'. Error: %s", "FailedToSwapAppServiceSlotSlots": "Failed to swap App Service '%s' slots - '%s' and '%s'. Error: %s", "SwappingAppServiceSlotWithProduction": "Swapping App Service '%s' slots - 'production' and '%s'", @@ -75,7 +73,6 @@ "SwappedAppServiceSlotWithProduction": "Swapped App Service '%s' slots - 'production' and '%s'", "SwappedAppServiceSlotSlots": "Swapped App Service '%s' slots - '%s' and '%s'", "FailedToGetAppServicePublishingCredentials": "Failed to fetch App Service '%s' publishing credentials. Error: %s", - "FailedToGetAppServicePublishingCredentialsSlot": "Failed to fetch App Service '%s-%s' publishing credentials. Error: %s", "WarmingUpSlots": "Warming-up slots", "DeploymentIDCannotBeNull": "Deployment ID cannot be null or empty.", "DeploymentDataEntityCannotBeNull": "Deployment data entity cannot be null or undefined.", @@ -94,13 +91,9 @@ "FailedToCreateWebTests": "Failed to create Web Test. Error: %s", "WebTestAlreadyConfigured": "Web Test already configured for URL: %s", "FailedToGetAppServiceConfiguration": "Failed to get App service '%s' configuration. Error: %s", - "FailedToGetAppServiceConfigurationSlot": "Failed to get App service '%s-%s' configuration. Error: %s", "FailedToUpdateAppServiceConfiguration": "Failed to update App service '%s' configuration. Error: %s", - "FailedToUpdateAppServiceConfigurationSlot": "Failed to update App service '%s-%s' configuration. Error: %s", "FailedToGetAppServiceApplicationSettings": "Failed to get App service '%s' application settings. Error: %s", - "FailedToGetAppServiceApplicationSettingsSlot": "Failed to get App service '%s-%s' application settings. Error: %s", "FailedToUpdateAppServiceApplicationSettings": "Failed to update App service '%s' application settings. Error: %s", - "FailedToUpdateAppServiceApplicationSettingsSlot": "Failed to update App service '%s-%s' application settings. Error: %s", "KuduSCMDetailsAreEmpty": "KUDU SCM details are empty", "FailedToGetContinuousWebJobs": "Failed to get continuous WebJobs. Error: %s", "FailedToStartContinuousWebJob": "Failed to start continuous WebJob '%s'. Error: %s", @@ -126,6 +119,14 @@ "WebJobAlreadyInStoppedState": "WebJob '%s' is already in stopped state.", "RestartingKuduService": "Restarting Kudu Service.", "RestartedKuduService": "Kudu Service restarted", - "FailedToRestartKuduService": "Failed to restart kudu Service. %s." + "FailedToRestartKuduService": "Failed to restart kudu Service. %s.", + "FailedToFetchKuduAppSettings": "Failed to fetch Kudu App Settings. Error: %s", + "Successfullydeployedpackageusingkuduserviceat": "Successfully deployed package %s using kudu service at %s", + "Failedtodeploywebapppackageusingkuduservice": "Failed to deploy web package. Error: %s", + "FailedToCreatePath": "Failed to create path '%s' from Kudu. Error: %s", + "FailedToDeleteFile": "Failed to delete file '%s/%s' from Kudu. Error: %s", + "FailedToUploadFile": "Failed to upload file '%s/%s from Kudu. Error: %s", + "FailedToGetFileContent": "Failed to get file content '%s/%s' from Kudu. Error: %s", + "FailedToListPath": "Failed to list path '%s'. Error: %s" } } \ No newline at end of file diff --git a/Tasks/Common/azure-arm-rest/webClient.ts b/Tasks/Common/azure-arm-rest/webClient.ts index 9f0e511f5d55..183574a16699 100644 --- a/Tasks/Common/azure-arm-rest/webClient.ts +++ b/Tasks/Common/azure-arm-rest/webClient.ts @@ -21,7 +21,8 @@ var httpCallbackClient = new httpClient.HttpClient(tl.getVariable("AZURE_HTTP_US export class WebRequest { public method: string; public uri: string; - public body: string; + // body can be string or ReadableStream + public body: string | NodeJS.ReadableStream; public headers: any; } diff --git a/Tasks/Common/azurerest-common/azurerestutility.ts b/Tasks/Common/azurerest-common/azurerestutility.ts deleted file mode 100644 index 1e2432c7da4d..000000000000 --- a/Tasks/Common/azurerest-common/azurerestutility.ts +++ /dev/null @@ -1,1057 +0,0 @@ -import * as tl from "vsts-task-lib/task"; -import * as Q from "q"; -import * as querystring from "querystring"; -import { HttpClient, HttpClientResponse } from "typed-rest-client/HttpClient"; -import { RestClient, IRequestOptions, IRestResponse } from "typed-rest-client/RestClient"; -import { IRequestOptions as IHttpRequestOptions } from "typed-rest-client/Interfaces"; -import * as Utils from "./utility"; - -var parseString = require('xml2js').parseString; -var uuidV4 = require("uuid/v4"); -var kuduDeploymentStatusUtility = require('./kududeploymentstatusutility.js'); - -let proxyUrl: string = tl.getVariable("agent.proxyurl"); -let requestOptions: IHttpRequestOptions = proxyUrl ? { - proxy: { - proxyUrl: proxyUrl, - proxyUsername: tl.getVariable("agent.proxyusername"), - proxyPassword: tl.getVariable("agent.proxypassword"), - proxyBypassHosts: tl.getVariable("agent.proxybypasslist") ? JSON.parse(tl.getVariable("agent.proxybypasslist")) : null - } -} : {}; - -let ignoreSslErrors: string = tl.getVariable("VSTS_ARM_REST_IGNORE_SSL_ERRORS"); -requestOptions.ignoreSslError = ignoreSslErrors && ignoreSslErrors.toLowerCase() == "true"; -let httpClient = new HttpClient(tl.getVariable("AZURE_HTTP_USER_AGENT"), null, requestOptions); -let restClient = new RestClient(tl.getVariable("AZURE_HTTP_USER_AGENT"), null, null, requestOptions); - -var defaultAuthUrl = 'https://login.windows.net/'; -var azureApiVersion = 'api-version=2016-08-01'; -var azureContainerRegistryApiVersion = "api-version=2017-03-01"; -var defaultWebAppAvailabilityTimeoutInMS = 3000; - -export const appInsightsInstrumentationKeyAppSetting = "APPINSIGHTS_INSTRUMENTATIONKEY"; - -export interface IDictionaryStringTo { - [key: string]: T; -} - -/** - * gets the name of the ResourceGroup that contains the resource - * - * @param endpoint Service Principal Name - * @param resourceName Name of the resource -*/ -export async function getResourceGroupName(endpoint, resourceName: string, resourceType) { - if (resourceType == null || resourceType == undefined) { - resourceType = "Microsoft.Web/Sites"; - } - - var requestURL = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resources?$filter=resourceType EQ \'' + resourceType + '\' AND name EQ \'' + resourceName + '\'&api-version=2016-07-01'; - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - authorization: 'Bearer ' + accessToken - }; - var resourceID = await getAzureRMResourceID(endpoint, resourceName, requestURL, headers); - - tl.debug('Web App details : ' + resourceID.id); - var resourceGroupName = resourceID.id.split('/')[4]; - tl.debug('Azure Resource Group Name : ' + resourceGroupName); - return resourceGroupName; -} - -/** - * updates the deployment status in kudu service - * - * @param publishingProfile Publish Profile details - * @param isDeploymentSuccess Status of Deployment - * - * @returns promise with string - */ -export function updateDeploymentStatus(publishingProfile, isDeploymentSuccess: boolean, customMessage, deploymentId): Q.Promise { - var deferred = Q.defer(); - var webAppPublishKuduUrl = publishingProfile.publishUrl; - tl.debug('Web App Publish Kudu URL: ' + webAppPublishKuduUrl); - if (webAppPublishKuduUrl) { - var requestDetails = kuduDeploymentStatusUtility.getUpdateHistoryRequest(webAppPublishKuduUrl, isDeploymentSuccess, customMessage, deploymentId); - var accessToken = 'Basic ' + (new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64')); - var headers = { - authorization: accessToken - }; - - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise> = restClient.replace(requestDetails['requestUrl'], requestDetails['requestBody'], options); - promise.then((response) => { - if (response.statusCode === 200) { - deferred.resolve(tl.loc("Successfullyupdateddeploymenthistory", response.result.url)); - } else { - tl.debug("Action: updateDeploymentStatus, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("Failedtoupdatedeploymenthistory")); - } - }, (error) => { - deferred.reject(error); - }); - } - else { - deferred.reject(tl.loc('WARNINGCannotupdatedeploymentstatusSCMendpointisnotenabledforthiswebsite')); - } - - return deferred.promise; -} - -/** - * Get all continious web jobs - * - * @param publishingProfile Publish Profile details - * - * @returns promise with string - */ -export function getAllContinuousWebJobs(publishingProfile): Q.Promise { - var deferred = Q.defer(); - - var webAppPublishKuduUrl = publishingProfile.publishUrl; - tl.debug('Web App Publish Kudu URL: ' + webAppPublishKuduUrl); - if (webAppPublishKuduUrl) { - var requestUrl = "https://" + webAppPublishKuduUrl + "/api/continuouswebjobs" - var accessToken = 'Basic ' + (new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64')); - var headers = { - authorization: accessToken - }; - - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - restClient.get(requestUrl, options).then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result); - } else { - tl.debug("Action: getAllContinuousWebJobs, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("UnableToFetchContinuousWebJobs")); - } - }, (error) => { - deferred.reject(error); - }); - } - else { - deferred.reject(tl.loc('UnableToFetchContinuousWebJobs')); - } - - return deferred.promise; -} - -export function startContinuousWebJob(publishingProfile, continuousWebJobName): Q.Promise { - var deferred = Q.defer(); - - var webAppPublishKuduUrl = publishingProfile.publishUrl; - tl.debug('Web App Publish Kudu URL: ' + webAppPublishKuduUrl); - if (webAppPublishKuduUrl) { - var requestUrl = "https://" + webAppPublishKuduUrl + "/api/continuouswebjobs/" + continuousWebJobName + "/start" - var accessToken = 'Basic ' + (new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64')); - var headers = { - authorization: accessToken - }; - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - restClient.create(requestUrl, null, options).then((response) => { - if (response.statusCode === 200) { - deferred.resolve(); - } else { - tl.debug("Action: startContinuousWebJob, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("UnableToStartContinuousWebJob", continuousWebJobName)); - } - }, (error) => { - deferred.reject(error); - }); - } - else { - deferred.reject(tl.loc('UnableToStartContinuousWebJob', continuousWebJobName)); - } - - return deferred.promise; -} - -export function stopContinuousWebJob(publishingProfile, continuousWebJobName): Q.Promise { - var deferred = Q.defer(); - - var webAppPublishKuduUrl = publishingProfile.publishUrl; - tl.debug('Web App Publish Kudu URL: ' + webAppPublishKuduUrl); - if (webAppPublishKuduUrl) { - var requestUrl = "https://" + webAppPublishKuduUrl + "/api/continuouswebjobs/" + continuousWebJobName + "/stop" - var accessToken = 'Basic ' + (new Buffer(publishingProfile.userName + ':' + publishingProfile.userPWD).toString('base64')); - var headers = { - authorization: accessToken - }; - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - restClient.create(requestUrl, null, options).then((response) => { - if (response.statusCode === 200) { - deferred.resolve(); - } else { - tl.debug("Action: stopContinuousWebJob, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("UnableToStopContinuousWebJob", continuousWebJobName)); - } - }, (error) => { - deferred.reject(error); - }); - } - else { - deferred.reject(tl.loc('UnableToStopContinuousWebJob', continuousWebJobName)); - } - - return deferred.promise; -} - -/** - * Gets the Azure RM Web App Connections details from endpoint - * - * @param endpoint Service Principal Name - * @param webAppName Name of the web App - * @param resourceGroupName Resource Group Name - * @param deployToSlotFlag Flag to check slot deployment - * @param slotName Name of the slot - * - * @returns (JSON) - */ -export async function getAzureRMWebAppPublishProfile(endPoint, webAppName: string, resourceGroupName: string, deployToSlotFlag: boolean, slotName: string) { - var accessToken = await getAuthorizationToken(endPoint); - var headers = { - authorization: 'Bearer ' + accessToken - }; - - var deferred = Q.defer(); - var slotUrl = deployToSlotFlag ? "/slots/" + slotName : ""; - - var url = endPoint.url + 'subscriptions/' + endPoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + '/publishxml?' + azureApiVersion; - - tl.debug('Requesting Azure Publish Profile: ' + url); - httpClient.post(url, null, headers).then(async (response) => { - let contents: string = ""; - try { - contents = await response.readBody(); - } catch (error) { - deferred.reject(tl.loc("UnableToReadResponseBody", error)); - } - - if (response.message.statusCode === 200) { - parseString(contents, (error, result) => { - for (var index in result.publishData.publishProfile) { - if (result.publishData.publishProfile[index].$.publishMethod === "MSDeploy") { - deferred.resolve(result.publishData.publishProfile[index].$); - } - } - deferred.reject(tl.loc('ErrorNoSuchDeployingMethodExists')); - }); - } else { - tl.debug("Action: getAzureRMWebAppPublishProfile, Response: " + contents); - tl.error(response.message.statusMessage); - deferred.reject(tl.loc('UnabletoretrieveconnectiondetailsforazureRMWebApp', webAppName, response.message.statusCode, response.message.statusMessage)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -function getAccessToken(endPoint) { - var deferred = Q.defer(); - var retryCounter = 0; - - var getAccessTokenInternal = async function () { - retryCounter++; - await getAuthorizationToken(endPoint).then((value) => { - return deferred.resolve(value); - }, (error) => { - if (error.code == "ETIMEDOUT") { - tl.debug("Request for Auth token failed with error ETIMEDOUT. Retry Attempt: " + retryCounter); - if (retryCounter <= 5) { - setTimeout(getAccessTokenInternal, 5000); - } - else { - deferred.reject(error); - } - } - else { - deferred.reject(error); - } - }); - } - getAccessTokenInternal(); - return deferred.promise; -} - -function getAuthorizationToken(endPoint): Q.Promise { - var deferred = Q.defer(); - var envAuthUrl = (endPoint.envAuthUrl) ? (endPoint.envAuthUrl) : defaultAuthUrl; - var authorityUrl = envAuthUrl + endPoint.tenantID + "/oauth2/token/"; - var requestData = querystring.stringify({ - resource: endPoint.activeDirectoryResourceId, - client_id: endPoint.servicePrincipalClientID, - grant_type: "client_credentials", - client_secret: endPoint.servicePrincipalKey - }); - - var requestHeader = { - "Content-Type": "application/x-www-form-urlencoded; charset=utf-8" - } - - tl.debug('Requesting for Auth Token: ' + authorityUrl); - httpClient.post(authorityUrl, requestData, requestHeader).then(async (response: HttpClientResponse) => { - if (response.message.statusCode === 200) { - let contents: string = ""; - try { - contents = await response.readBody(); - } catch (error) { - deferred.reject(tl.loc("UnableToReadResponseBody", error)); - } - if (contents && contents.length > 0) { - deferred.resolve(JSON.parse(contents).access_token); - } - } else { - deferred.reject(tl.loc('CouldnotfetchaccesstokenforAzureStatusCode', response.message.statusCode, response.message.statusMessage)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -async function getAzureRMResourceID(endpoint, resourceName: string, url: string, headers) { - var deferred = Q.defer(); - - tl.debug('Requesting Azure App Service ID: ' + url); - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.get(url, options); - promise.then(async (response) => { - if (response.statusCode === 200) { - let resourceIDDetails: any = response.result; - if (resourceIDDetails.value.length === 0) { - if (resourceIDDetails.nextLink) { - tl.debug("Requesting nextLink to accesss Id for resource " + resourceName); - try { - deferred.resolve(await getAzureRMResourceID(endpoint, resourceName, resourceIDDetails.nextLink, headers)); - } catch (error) { - deferred.reject(error); - } - } - deferred.reject(tl.loc("ResourceDoesntExist", resourceName)); - } - deferred.resolve(resourceIDDetails.value[0]); - } else { - tl.debug("Action: getAzureRMResourceID, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc('UnabletoretrieveWebAppID', resourceName, response.statusCode)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -/** - * REST request for azure webapp config details. Config details contains virtual application mappings. - * - * @param endpoint Subscription details - * @param webAppName Web application name - * @param deployToSlotFlag Should deploy to slot - * @param slotName Slot for deployment - */ -export async function getAzureRMWebAppConfigDetails(endpoint, webAppName: string, resourceGroupName: string, deployToSlotFlag: boolean, slotName: string) { - var deferred = Q.defer(); - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - authorization: 'Bearer ' + accessToken - }; - - var slotUrl = deployToSlotFlag ? "/slots/" + slotName : ""; - var configUrl = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + '/config/web?' + azureApiVersion; - - tl.debug('Requesting Azure App Service web config Details: ' + configUrl); - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.get(configUrl, options); - promise.then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result); - } else { - tl.debug("Action: getAzureRMWebAppConfigDetails, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc('Unabletoretrievewebconfigdetails', response.statusCode)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function updateAzureRMWebAppConfigDetails(endPoint, webAppName: string, resourceGroupName: string, deployToSlotFlag: boolean, slotName: string, configDetails: string) { - var deferred = Q.defer(); - var accessToken = await getAuthorizationToken(endPoint); - var headers = { - 'Authorization': 'Bearer ' + accessToken, - 'Content-Type': 'application/json' - }; - - var slotUrl = deployToSlotFlag ? "/slots/" + slotName : ""; - var configUrl = endPoint.url + 'subscriptions/' + endPoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + '/config/web?' + azureApiVersion; - - tl.debug('Updating web config details at: ' + configUrl); - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.update(configUrl, JSON.parse(configDetails), options); - promise.then((response) => { - if (response.statusCode === 200) { - deferred.resolve(); - } else { - tl.debug("Action: updateAzureRMWebAppConfigDetails, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("UnableToUpdateWebAppConfigDetails", response.statusCode)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function getWebAppAppSettings(endpoint, webAppName: string, resourceGroupName: string, deployToSlotFlag: boolean, slotName: string/*, appSettings: Object*/) { - var deferred = Q.defer(); - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - authorization: 'Bearer ' + accessToken - }; - - var slotUrl = deployToSlotFlag ? "/slots/" + slotName : ""; - var configUrl = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + '/config/appsettings/list?' + azureApiVersion; - - tl.debug('Requesting for the Current List of App Settings: ' + configUrl); - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.create(configUrl, null, options); - promise.then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result); - } else { - tl.debug("Action: getWebAppAppSettings, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc('Unabletoretrievewebconfigdetails', response.statusCode)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function updateWebAppAppSettings(endpoint, webAppName: string, resourceGroupName: string, deployToSlotFlag: boolean, slotName: string, appSettings: Object) { - var deferred = Q.defer(); - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - authorization: 'Bearer ' + accessToken - }; - - var slotUrl = deployToSlotFlag ? "/slots/" + slotName : ""; - var configUrl = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + '/config/appsettings?' + azureApiVersion; - - tl.debug('Updating the Current List of App Settings: ' + configUrl); - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise> = restClient.replace(configUrl, appSettings, options); - promise.then((response) => { - if (response.statusCode === 200) { - deferred.resolve(appSettings); - } else { - tl.debug("Action: updateWebAppAppSettings, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc('Unabletoupdatewebappsettings', response.statusCode)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -async function getOperationStatus(SPN, url: string) { - var deferred = Q.defer(); - var accessToken = await getAccessToken(SPN); - var headers = { - authorization: 'Bearer ' + accessToken - }; - - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise> = restClient.get(url, options); - promise.then((response) => { - deferred.resolve(response); - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -function monitorSlotSwap(SPN, url) { - tl.debug("Monitoring slot swap operation status from: " + url); - var deferred = Q.defer(); - var attempts = 0; - var poll = async function () { - if (attempts < 360) { - attempts++; - tl.debug("Slot swap operation is in progress. Attempt : " + attempts); - await getOperationStatus(SPN, url).then((response: IRestResponse) => { - if (response.statusCode === 200) { - deferred.resolve(); - } - else if (response.statusCode === 202) { - setTimeout(poll, 5000); - } - else { - tl.debug("Slot swap operation failed.StatusCode: " + response.statusCode + ", Response: " + JSON.stringify(response.result)); - deferred.reject(response.statusCode); - } - }).catch((error) => { - deferred.reject(error); - }); - } - else { - deferred.reject(""); - } - } - poll(); - return deferred.promise; -} - -export async function swapWebAppSlot(endpoint, resourceGroupName: string, webAppName: string, sourceSlot: string, targetSlot: string, preserveVnet: boolean) { - var deferred = Q.defer(); - var url = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + "/slots/" + sourceSlot + '/slotsswap?' + azureApiVersion; - - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - 'Authorization': 'Bearer ' + accessToken, - 'Content-Type': 'application/json' - }; - - var body = JSON.stringify( - { - targetSlot: targetSlot, - preserveVnet: preserveVnet - } - ); - - console.log(tl.loc('StartingSwapSlot', webAppName)); - httpClient.post(url, body, headers).then(async (response: HttpClientResponse) => { - if (response.message.statusCode === 200) { - deferred.resolve(); - } else if (response.message.statusCode === 202) { - await monitorSlotSwap(endpoint, response.message.headers.location).then(() => { - deferred.resolve(); - }).catch((error) => { - deferred.reject(error); - }); - } else { - let contents: string = ""; - try { - contents = await response.readBody(); - } catch (error) { - deferred.reject(tl.loc("UnableToReadResponseBody", error)); - } - tl.debug("Slot swap operation failed. Operation Response: " + contents); - deferred.reject(response.message.statusMessage); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function startAppService(endpoint, resourceGroupName: string, webAppName: string, specifySlotFlag: boolean, slotName: string) { - var deferred = Q.defer(); - var slotUrl = (specifySlotFlag) ? "/slots/" + slotName : ""; - var url = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + "/start?" + azureApiVersion; - - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - 'Authorization': 'Bearer ' + accessToken - }; - var webAppNameWithSlot = (specifySlotFlag) ? webAppName + '-' + slotName : webAppName; - tl.debug('Request to start App Service: ' + url); - console.log(tl.loc('StartingAppService', webAppNameWithSlot)); - - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.create(url, null, options); - promise.then((response) => { - if (response.statusCode === 200 || response.statusCode === 204) { - deferred.resolve(tl.loc('AppServicestartedsuccessfully', webAppNameWithSlot)); - } else { - tl.debug("Action: startAppService, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("FailedtoStartAppService", webAppNameWithSlot, response.statusCode)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function stopAppService(endpoint, resourceGroupName: string, webAppName: string, specifySlotFlag: boolean, slotName: string) { - var deferred = Q.defer(); - var slotUrl = (specifySlotFlag) ? "/slots/" + slotName : ""; - var url = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + "/stop?" + azureApiVersion; - - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - 'Authorization': 'Bearer ' + accessToken - }; - var webAppNameWithSlot = (specifySlotFlag) ? webAppName + '-' + slotName : webAppName; - tl.debug('Request to stop App Service: ' + url); - console.log(tl.loc('StoppingAppService', webAppNameWithSlot)); - - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.create(url, null, options); - promise.then((response) => { - if (response.statusCode === 200 || response.statusCode === 204) { - deferred.resolve(tl.loc('AppServicestoppedsuccessfully', webAppNameWithSlot)); - } else { - tl.debug("Action: stopAppService, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("FailedtoStopAppService", webAppNameWithSlot, response.statusCode, response.statusMessage)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function restartAppService(endpoint, resourceGroupName: string, webAppName: string, specifySlotFlag: boolean, slotName: string) { - var deferred = Q.defer(); - var slotUrl = (specifySlotFlag) ? "/slots/" + slotName : ""; - var url = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + "/restart?" + azureApiVersion + '&synchronous=true'; - - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - 'Authorization': 'Bearer ' + accessToken - }; - var webAppNameWithSlot = (specifySlotFlag) ? webAppName + '-' + slotName : webAppName; - tl.debug('Request to restart App Service: ' + url); - console.log(tl.loc('RestartingAppService', webAppNameWithSlot)); - - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.create(url, null, options); - promise.then((response) => { - if (response.statusCode === 200 || response.statusCode === 204) { - deferred.resolve(tl.loc('AppServiceRestartedSuccessfully', webAppNameWithSlot)); - } else if (response.statusCode === 202) { - tl.warning(tl.loc('RestartAppServiceAccepted')); - deferred.resolve(tl.loc('RestartAppServiceAccepted', webAppNameWithSlot)); - } - else { - tl.debug("Action: restartAppService, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("FailedtoRestartAppService", webAppNameWithSlot, response.statusCode)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function getAzureContainerRegistryCredentials(endpoint, azureContainerRegistry: string, resourceGroupName: string) { - var deferred = Q.defer(); - - var credsUrl = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.ContainerRegistry/registries/' + azureContainerRegistry + '/listCredentials?' + azureContainerRegistryApiVersion; - - tl.debug('Requesting Azure Contianer Registry Creds: ' + credsUrl); - - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - 'Authorization': 'Bearer ' + accessToken - }; - - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.create(credsUrl, null, options); - promise.then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result); - } else { - tl.debug("Action: getAzureContainerRegistryCredentials, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc('Unabletoretrieveazureregistrycredentials', response.statusCode)); - - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function testAzureWebAppAvailability(webAppUrl, availabilityTimeout) { - var deferred = Q.defer(); - var headers = {}; - - let promise: Promise = httpClient.get(webAppUrl, headers); - promise.then(async (response) => { - let contents: string = await response.readBody(); - if (response.message.statusCode === 200) { - tl.debug("Azure web app is available."); - var webAppAvailabilityTimeout = (availabilityTimeout && !(isNaN(Number(availabilityTimeout)))) ? Number(availabilityTimeout) : defaultWebAppAvailabilityTimeoutInMS; - setTimeout(() => { - deferred.resolve("SUCCESS"); - }, webAppAvailabilityTimeout); - } else { - tl.debug("Azure web app in wrong state. Action: testAzureWebAppAvailability, Response: " + contents); - deferred.reject("FAILED"); - } - }, (error) => { - tl.debug("Failed to check availability of azure web app, error : " + error); - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function getAppServiceDetails(endpoint, resourceGroupName: string, webAppName: string, specifySlotFlag: boolean, slotName: string) { - var deferred = Q.defer(); - var slotUrl = (specifySlotFlag) ? "/slots/" + slotName : ""; - var url = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + "?" + azureApiVersion; - - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - 'Authorization': 'Bearer ' + accessToken - }; - - var webAppNameWithSlot = (specifySlotFlag) ? webAppName + '-' + slotName : webAppName; - tl.debug('Request to get App State: ' + webAppNameWithSlot); - - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.get(url, options); - promise.then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result); - } else { - tl.debug("Action: getAppServiceDetails, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("FailedToFetchAppServiceState", webAppNameWithSlot, response.statusCode)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function getAzureRMWebAppMetadata( - endpoint, - webAppName: string, - resourceGroupName: string, - deployToSlotFlag: boolean, - slotName: string) { - - var deferred = Q.defer(); - var accessToken = await getAuthorizationToken(endpoint); - var headers = { - authorization: 'Bearer ' + accessToken - }; - - var slotUrl = deployToSlotFlag ? "/slots/" + slotName : ""; - var metadataUrl = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + '/config/metadata/list?' + azureApiVersion; - - tl.debug('Requesting Azure App Service Metadata: ' + metadataUrl); - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.create(metadataUrl, null, options); - promise.then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result); - } else { - tl.debug("Action: getAzureRMWebAppMetadata, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("UnableToGetAzureRMWebAppMetadata", response.statusCode)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function updateAzureRMWebAppMetadata( - endPoint, - webAppName: string, - resourceGroupName: string, - deployToSlotFlag: boolean, - slotName: string, - webAppMetadata: Object) { - - var deferred = Q.defer(); - var accessToken = await getAuthorizationToken(endPoint); - var headers = { - 'Authorization': 'Bearer ' + accessToken, - 'Content-Type': 'application/json' - }; - - var slotUrl = deployToSlotFlag ? "/slots/" + slotName : ""; - var metadataUrl = endPoint.url + 'subscriptions/' + endPoint.subscriptionId + '/resourceGroups/' + resourceGroupName + - '/providers/Microsoft.Web/sites/' + webAppName + slotUrl + '/config/metadata?' + azureApiVersion; - - tl.debug('Updating Azure App Service Metadata at: ' + metadataUrl); - - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - let promise: Promise = restClient.replace(metadataUrl, webAppMetadata, options); - promise.then((response) => { - if (response.statusCode === 200) { - deferred.resolve(); - } else { - tl.debug("Action: updateAzureRMWebAppMetadata, Response: " + JSON.stringify(response)); - deferred.reject(tl.loc("UnableToUpdateAzureRMWebAppMetadata", response.statusCode)); - } - }, (error) => { - deferred.reject(error); - }); - return deferred.promise; -} - -export async function getApplicationInsightsResources(endpoint, appInsightsResourceGroupName, filter: string) { - - var deferred = Q.defer(); - var accessToken = await getAuthorizationToken(endpoint); - - var headers = { - "Content-Type": "application/json", - authorization: 'Bearer ' + accessToken - }; - - var resourceGroupPath = (appInsightsResourceGroupName) ? "/resourceGroups/" + appInsightsResourceGroupName : ""; - var resultFilter = !!filter ? `$filter=${filter}&` : ""; - - var metadataUrl = `${endpoint.url}subscriptions/${endpoint.subscriptionId}${resourceGroupPath}/providers/microsoft.insights/components?${resultFilter}api-version=2015-05-01`; - - tl.debug('Requesting Application insights resources : ' + metadataUrl); - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - restClient.get(metadataUrl, options).then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result['value']); - } else { - tl.debug("Action: getApplicationInsightsResources, Response: " + JSON.stringify(response)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function updateApplicationInsightsResource(endpoint, appInsightsResourceGroupName, appInsightsResourceData) { - - var deferred = Q.defer(); - var accessToken = await getAuthorizationToken(endpoint); - - var headers = { - "Content-Type": "application/json", - authorization: 'Bearer ' + accessToken - }; - - var metadataUrl = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + appInsightsResourceGroupName + - '/providers/microsoft.insights/components/' + appInsightsResourceData.name + '?api-version=2015-05-01'; - - tl.debug('Updating Application insights resources : ' + metadataUrl); - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - restClient.replace(metadataUrl, appInsightsResourceData, options).then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result); - } else { - tl.debug("Action: updateApplicationInsightsResource, Response: " + JSON.stringify(response)); - deferred.reject(new Error(response.statusCode.toString())); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -function sleep(timeInMilliSecond) { - return new Promise(resolve => setTimeout(resolve, timeInMilliSecond)); -} - -export async function getAppInsightsWebTests(endpoint, appInsightsResourceGroupName) { - - var deferred = Q.defer(); - var accessToken = await getAuthorizationToken(endpoint); - - var headers = { - "Content-Type": "application/json", - authorization: 'Bearer ' + accessToken - }; - - var resourceGroupPath = (appInsightsResourceGroupName) ? "/resourceGroups/" + appInsightsResourceGroupName : ""; - - var metadataUrl = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + resourceGroupPath + - '/providers/microsoft.insights/webTests?api-version=2015-05-01'; - - tl.debug('Requesting App Insights web tests : ' + metadataUrl); - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - restClient.get(metadataUrl, options).then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result['value']); - } else { - tl.debug("Action: getAppInsightsWebTests, Response: " + JSON.stringify(response)); - deferred.reject(response.statusCode); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -export async function createAppInsightsWebTest(endpoint, appInsightsResourceGroupName, webTestName, appInsightsResourceData, appServiceUrl) { - - var deferred = Q.defer(); - var accessToken = await getAuthorizationToken(endpoint); - - var headers = { - "Content-Type": "application/json", - authorization: 'Bearer ' + accessToken - }; - - var webTestHiddenLink = "hidden-link:" + appInsightsResourceData.id; - webTestName = "webtest" + webTestName; - appServiceUrl = ((appServiceUrl.indexOf("http") != -1) ? "" : "http://") + appServiceUrl; - - var webTestData = { - "name": webTestName, - "location": appInsightsResourceData.location, - "tags": {}, - "properties": { - "SyntheticMonitorId": webTestName, - "Name": webTestName, - "Description": "", - "Enabled": true, - "Frequency": 300, - "Timeout": 120, - "Kind": "ping", - "RetryEnabled": true, - "Locations": [ - { - "Id": "us-tx-sn1-azr" - }, - { - "Id": "us-il-ch1-azr" - }, - { - "Id": "us-ca-sjc-azr" - }, - { - "Id": "us-va-ash-azr" - }, - { - "Id": "us-fl-mia-edge" - } - ], - "Configuration": { - "WebTest": " " - } - } - } - - webTestData.tags[webTestHiddenLink] = "Resource"; - - var metadataUrl = endpoint.url + 'subscriptions/' + endpoint.subscriptionId + '/resourceGroups/' + appInsightsResourceGroupName + - '/providers/microsoft.insights/webTests/' + webTestName + '?api-version=2015-05-01'; - - tl.debug('Updating Application insights resources : ' + metadataUrl); - let options: IRequestOptions = {}; - options.additionalHeaders = headers; - restClient.replace(metadataUrl, webTestData, options).then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result); - } else { - tl.debug("Action: createAppInsightsWebTest, Response: " + JSON.stringify(response)); - deferred.reject(response.statusCode); - } - }, - (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} - -/** - * Adds release annotation to an application insights resource - * - * @param endpoint Service Principal Endpoint - * @param appInsightsResourceId ResourceId of the application insights resource - * @param isDeploymentSuccess Add annotation for success or failed deployment - */ -export async function addReleaseAnnotation(endpoint, appInsightsResourceId: string, isDeploymentSuccess: string): Promise { - let deferred: Q.Deferred = Q.defer(); - - let accessToken = await getAuthorizationToken(endpoint); - let restOptions: IRequestOptions = { - additionalHeaders: { - "Authorization": `Bearer ${accessToken}` - } - }; - - let restUrl = `${endpoint.url}${appInsightsResourceId}/Annotations?api-version=2015-05-01`; - let releaseAnnotationProperties: IDictionaryStringTo = { - "Label": isDeploymentSuccess ? "Success" : "Error", // Label decides the icon for release annotation - "Deployment Uri": Utils.getDeploymentUri() - }; - - let annotationName = "Release Annotation"; - let releaseUri = tl.getVariable("Release.ReleaseUri"); - let buildUri = tl.getVariable("Build.BuildUri"); - - if (!!releaseUri) { - annotationName = `${tl.getVariable("Release.DefinitionName")} - ${tl.getVariable("Release.ReleaseName")}`; - } - else if (!!buildUri) { - annotationName = `${tl.getVariable("Build.DefinitionName")} - ${tl.getVariable("Build.BuildNumber")}`; - } - - let releaseAnnotation = { - "AnnotationName": annotationName, - "Category": "Text", - "EventTime": new Date(), - "Id": uuidV4(), - "Properties": JSON.stringify(releaseAnnotationProperties) - }; - - tl.debug(`Adding release annotation. Requesting: ${restUrl} \n${JSON.stringify(releaseAnnotation, null, 2)}`); - - restClient.replace(restUrl, releaseAnnotation, restOptions) - .then((response) => { - if (response.statusCode === 200) { - deferred.resolve(response.result); - } - else { - deferred.reject(JSON.stringify(response, null, 2)); - } - }, (error) => { - deferred.reject(error); - }); - - return deferred.promise; -} \ No newline at end of file diff --git a/Tasks/Common/azurerest-common/globals/mocha/index.d.ts b/Tasks/Common/azurerest-common/globals/mocha/index.d.ts deleted file mode 100644 index ae7de0faa03c..000000000000 --- a/Tasks/Common/azurerest-common/globals/mocha/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -// Generated by typings -// Source: https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/a361a8ab3c327f208d3f82ad206971d4a63d8c25/mocha/mocha.d.ts -interface MochaSetupOptions { - //milliseconds to wait before considering a test slow - slow?: number; - - // timeout in milliseconds - timeout?: number; - - // ui name "bdd", "tdd", "exports" etc - ui?: string; - - //array of accepted globals - globals?: any[]; - - // reporter instance (function or string), defaults to `mocha.reporters.Spec` - reporter?: any; - - // bail on the first test failure - bail?: boolean; - - // ignore global leaks - ignoreLeaks?: boolean; - - // grep string or regexp to filter tests with - grep?: any; -} - -declare var mocha: Mocha; -declare var describe: Mocha.IContextDefinition; -declare var xdescribe: Mocha.IContextDefinition; -// alias for `describe` -declare var context: Mocha.IContextDefinition; -// alias for `describe` -declare var suite: Mocha.IContextDefinition; -declare var it: Mocha.ITestDefinition; -declare var xit: Mocha.ITestDefinition; -// alias for `it` -declare var test: Mocha.ITestDefinition; -declare var specify: Mocha.ITestDefinition; - -interface MochaDone { - (error?: any): any; -} - -interface ActionFunction { - (done: MochaDone): any | PromiseLike -} - -declare function setup(action: ActionFunction): void; -declare function teardown(action: ActionFunction): void; -declare function suiteSetup(action: ActionFunction): void; -declare function suiteTeardown(action: ActionFunction): void; -declare function before(action: ActionFunction): void; -declare function before(description: string, action: ActionFunction): void; -declare function after(action: ActionFunction): void; -declare function after(description: string, action: ActionFunction): void; -declare function beforeEach(action: ActionFunction): void; -declare function beforeEach(description: string, action: ActionFunction): void; -declare function afterEach(action: ActionFunction): void; -declare function afterEach(description: string, action: ActionFunction): void; - -declare class Mocha { - currentTest: Mocha.ITestDefinition; - constructor(options?: { - grep?: RegExp; - ui?: string; - reporter?: string; - timeout?: number; - bail?: boolean; - }); - - /** Setup mocha with the given options. */ - setup(options: MochaSetupOptions): Mocha; - bail(value?: boolean): Mocha; - addFile(file: string): Mocha; - /** Sets reporter by name, defaults to "spec". */ - reporter(name: string): Mocha; - /** Sets reporter constructor, defaults to mocha.reporters.Spec. */ - reporter(reporter: (runner: Mocha.IRunner, options: any) => any): Mocha; - ui(value: string): Mocha; - grep(value: string): Mocha; - grep(value: RegExp): Mocha; - invert(): Mocha; - ignoreLeaks(value: boolean): Mocha; - checkLeaks(): Mocha; - /** - * Function to allow assertion libraries to throw errors directly into mocha. - * This is useful when running tests in a browser because window.onerror will - * only receive the 'message' attribute of the Error. - */ - throwError(error: Error): void; - /** Enables growl support. */ - growl(): Mocha; - globals(value: string): Mocha; - globals(values: string[]): Mocha; - useColors(value: boolean): Mocha; - useInlineDiffs(value: boolean): Mocha; - timeout(value: number): Mocha; - slow(value: number): Mocha; - enableTimeouts(value: boolean): Mocha; - asyncOnly(value: boolean): Mocha; - noHighlighting(value: boolean): Mocha; - /** Runs tests and invokes `onComplete()` when finished. */ - run(onComplete?: (failures: number) => void): Mocha.IRunner; -} - -// merge the Mocha class declaration with a module -declare namespace Mocha { - /** Partial interface for Mocha's `Runnable` class. */ - interface IRunnable { - title: string; - fn: Function; - async: boolean; - sync: boolean; - timedOut: boolean; - } - - /** Partial interface for Mocha's `Suite` class. */ - interface ISuite { - parent: ISuite; - title: string; - - fullTitle(): string; - } - - /** Partial interface for Mocha's `Test` class. */ - interface ITest extends IRunnable { - parent: ISuite; - pending: boolean; - - fullTitle(): string; - } - - /** Partial interface for Mocha's `Runner` class. */ - interface IRunner {} - - interface IContextDefinition { - (description: string, spec: () => void): ISuite; - only(description: string, spec: () => void): ISuite; - skip(description: string, spec: () => void): void; - timeout(ms: number): void; - } - - interface ITestDefinition { - (expectation: string, assertion?: ActionFunction): ITest; - only(expectation: string, assertion?: ActionFunction): ITest; - skip(expectation: string, assertion?: ActionFunction): void; - timeout(ms: number): void; - state: "failed" | "passed"; - } - - export module reporters { - export class Base { - stats: { - suites: number; - tests: number; - passes: number; - pending: number; - failures: number; - }; - - constructor(runner: IRunner); - } - - export class Doc extends Base {} - export class Dot extends Base {} - export class HTML extends Base {} - export class HTMLCov extends Base {} - export class JSON extends Base {} - export class JSONCov extends Base {} - export class JSONStream extends Base {} - export class Landing extends Base {} - export class List extends Base {} - export class Markdown extends Base {} - export class Min extends Base {} - export class Nyan extends Base {} - export class Progress extends Base { - /** - * @param options.open String used to indicate the start of the progress bar. - * @param options.complete String used to indicate a complete test on the progress bar. - * @param options.incomplete String used to indicate an incomplete test on the progress bar. - * @param options.close String used to indicate the end of the progress bar. - */ - constructor(runner: IRunner, options?: { - open?: string; - complete?: string; - incomplete?: string; - close?: string; - }); - } - export class Spec extends Base {} - export class TAP extends Base {} - export class XUnit extends Base { - constructor(runner: IRunner, options?: any); - } - } -} - -declare module "mocha" { - export = Mocha; -} diff --git a/Tasks/Common/azurerest-common/globals/mocha/typings.json b/Tasks/Common/azurerest-common/globals/mocha/typings.json deleted file mode 100644 index aab9d1c1302c..000000000000 --- a/Tasks/Common/azurerest-common/globals/mocha/typings.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "resolution": "main", - "tree": { - "src": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/a361a8ab3c327f208d3f82ad206971d4a63d8c25/mocha/mocha.d.ts", - "raw": "registry:dt/mocha#2.2.5+20160720003353", - "typings": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/a361a8ab3c327f208d3f82ad206971d4a63d8c25/mocha/mocha.d.ts" - } -} diff --git a/Tasks/Common/azurerest-common/globals/node/index.d.ts b/Tasks/Common/azurerest-common/globals/node/index.d.ts deleted file mode 100644 index 1dc54b352d88..000000000000 --- a/Tasks/Common/azurerest-common/globals/node/index.d.ts +++ /dev/null @@ -1,3350 +0,0 @@ -// Generated by typings -// Source: https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/ab8d917787092fdfb16390f2bee6de8ab5c1783c/node/node.d.ts -interface Error { - stack?: string; -} - -interface ErrorConstructor { - captureStackTrace(targetObject: Object, constructorOpt?: Function): void; - stackTraceLimit: number; -} - -// compat for TypeScript 1.8 -// if you use with --target es3 or --target es5 and use below definitions, -// use the lib.es6.d.ts that is bundled with TypeScript 1.8. -interface MapConstructor { } -interface WeakMapConstructor { } -interface SetConstructor { } -interface WeakSetConstructor { } - -/************************************************ -* * -* GLOBAL * -* * -************************************************/ -declare var process: NodeJS.Process; -declare var global: NodeJS.Global; - -declare var __filename: string; -declare var __dirname: string; - -declare function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; -declare function clearTimeout(timeoutId: NodeJS.Timer): void; -declare function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; -declare function clearInterval(intervalId: NodeJS.Timer): void; -declare function setImmediate(callback: (...args: any[]) => void, ...args: any[]): any; -declare function clearImmediate(immediateId: any): void; - -interface NodeRequireFunction { - (id: string): any; -} - -interface NodeRequire extends NodeRequireFunction { - resolve(id: string): string; - cache: any; - extensions: any; - main: any; -} - -declare var require: NodeRequire; - -interface NodeModule { - exports: any; - require: NodeRequireFunction; - id: string; - filename: string; - loaded: boolean; - parent: any; - children: any[]; -} - -declare var module: NodeModule; - -// Same as module.exports -declare var exports: any; -declare var SlowBuffer: { - new (str: string, encoding?: string): Buffer; - new (size: number): Buffer; - new (size: Uint8Array): Buffer; - new (array: any[]): Buffer; - prototype: Buffer; - isBuffer(obj: any): boolean; - byteLength(string: string, encoding?: string): number; - concat(list: Buffer[], totalLength?: number): Buffer; -}; - - -// Buffer class -type BufferEncoding = "ascii" | "utf8" | "utf16le" | "ucs2" | "binary" | "hex"; -interface Buffer extends NodeBuffer { } - -/** - * Raw data is stored in instances of the Buffer class. - * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. - * Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' - */ -declare var Buffer: { - /** - * Allocates a new buffer containing the given {str}. - * - * @param str String to store in buffer. - * @param encoding encoding to use, optional. Default is 'utf8' - */ - new (str: string, encoding?: string): Buffer; - /** - * Allocates a new buffer of {size} octets. - * - * @param size count of octets to allocate. - */ - new (size: number): Buffer; - /** - * Allocates a new buffer containing the given {array} of octets. - * - * @param array The octets to store. - */ - new (array: Uint8Array): Buffer; - /** - * Produces a Buffer backed by the same allocated memory as - * the given {ArrayBuffer}. - * - * - * @param arrayBuffer The ArrayBuffer with which to share memory. - */ - new (arrayBuffer: ArrayBuffer): Buffer; - /** - * Allocates a new buffer containing the given {array} of octets. - * - * @param array The octets to store. - */ - new (array: any[]): Buffer; - /** - * Copies the passed {buffer} data onto a new {Buffer} instance. - * - * @param buffer The buffer to copy. - */ - new (buffer: Buffer): Buffer; - prototype: Buffer; - /** - * Allocates a new Buffer using an {array} of octets. - * - * @param array - */ - from(array: any[]): Buffer; - /** - * When passed a reference to the .buffer property of a TypedArray instance, - * the newly created Buffer will share the same allocated memory as the TypedArray. - * The optional {byteOffset} and {length} arguments specify a memory range - * within the {arrayBuffer} that will be shared by the Buffer. - * - * @param arrayBuffer The .buffer property of a TypedArray or a new ArrayBuffer() - * @param byteOffset - * @param length - */ - from(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer; - /** - * Copies the passed {buffer} data onto a new Buffer instance. - * - * @param buffer - */ - from(buffer: Buffer): Buffer; - /** - * Creates a new Buffer containing the given JavaScript string {str}. - * If provided, the {encoding} parameter identifies the character encoding. - * If not provided, {encoding} defaults to 'utf8'. - * - * @param str - */ - from(str: string, encoding?: string): Buffer; - /** - * Returns true if {obj} is a Buffer - * - * @param obj object to test. - */ - isBuffer(obj: any): obj is Buffer; - /** - * Returns true if {encoding} is a valid encoding argument. - * Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' - * - * @param encoding string to test. - */ - isEncoding(encoding: string): boolean; - /** - * Gives the actual byte length of a string. encoding defaults to 'utf8'. - * This is not the same as String.prototype.length since that returns the number of characters in a string. - * - * @param string string to test. - * @param encoding encoding used to evaluate (defaults to 'utf8') - */ - byteLength(string: string, encoding?: string): number; - /** - * Returns a buffer which is the result of concatenating all the buffers in the list together. - * - * If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. - * If the list has exactly one item, then the first item of the list is returned. - * If the list has more than one item, then a new Buffer is created. - * - * @param list An array of Buffer objects to concatenate - * @param totalLength Total length of the buffers when concatenated. - * If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly. - */ - concat(list: Buffer[], totalLength?: number): Buffer; - /** - * The same as buf1.compare(buf2). - */ - compare(buf1: Buffer, buf2: Buffer): number; - /** - * Allocates a new buffer of {size} octets. - * - * @param size count of octets to allocate. - * @param fill if specified, buffer will be initialized by calling buf.fill(fill). - * If parameter is omitted, buffer will be filled with zeros. - * @param encoding encoding used for call to buf.fill while initalizing - */ - alloc(size: number, fill?: string | Buffer | number, encoding?: string): Buffer; - /** - * Allocates a new buffer of {size} octets, leaving memory not initialized, so the contents - * of the newly created Buffer are unknown and may contain sensitive data. - * - * @param size count of octets to allocate - */ - allocUnsafe(size: number): Buffer; - /** - * Allocates a new non-pooled buffer of {size} octets, leaving memory not initialized, so the contents - * of the newly created Buffer are unknown and may contain sensitive data. - * - * @param size count of octets to allocate - */ - allocUnsafeSlow(size: number): Buffer; -}; - -/************************************************ -* * -* GLOBAL INTERFACES * -* * -************************************************/ -declare namespace NodeJS { - export interface ErrnoException extends Error { - errno?: string; - code?: string; - path?: string; - syscall?: string; - stack?: string; - } - - export class EventEmitter { - addListener(event: string|symbol, listener: Function): this; - on(event: string|symbol, listener: Function): this; - once(event: string|symbol, listener: Function): this; - removeListener(event: string|symbol, listener: Function): this; - removeAllListeners(event?: string|symbol): this; - setMaxListeners(n: number): this; - getMaxListeners(): number; - listeners(event: string|symbol): Function[]; - emit(event: string|symbol, ...args: any[]): boolean; - listenerCount(type: string|symbol): number; - // Added in Node 6... - prependListener(event: string|symbol, listener: Function): this; - prependOnceListener(event: string|symbol, listener: Function): this; - eventNames(): (string|symbol)[]; - } - - export interface ReadableStream extends EventEmitter { - readable: boolean; - read(size?: number): string | Buffer; - setEncoding(encoding: string): void; - pause(): ReadableStream; - resume(): ReadableStream; - pipe(destination: T, options?: { end?: boolean; }): T; - unpipe(destination?: T): void; - unshift(chunk: string): void; - unshift(chunk: Buffer): void; - wrap(oldStream: ReadableStream): ReadableStream; - } - - export interface WritableStream extends EventEmitter { - writable: boolean; - write(buffer: Buffer | string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - } - - export interface ReadWriteStream extends ReadableStream, WritableStream { - pause(): ReadWriteStream; - resume(): ReadWriteStream; - } - - export interface Events extends EventEmitter { } - - export interface Domain extends Events { - run(fn: Function): void; - add(emitter: Events): void; - remove(emitter: Events): void; - bind(cb: (err: Error, data: any) => any): any; - intercept(cb: (data: any) => any): any; - dispose(): void; - - addListener(event: string, listener: Function): this; - on(event: string, listener: Function): this; - once(event: string, listener: Function): this; - removeListener(event: string, listener: Function): this; - removeAllListeners(event?: string): this; - } - - export interface MemoryUsage { - rss: number; - heapTotal: number; - heapUsed: number; - } - - export interface ProcessVersions { - http_parser: string; - node: string; - v8: string; - ares: string; - uv: string; - zlib: string; - modules: string; - openssl: string; - } - - export interface Process extends EventEmitter { - stdout: WritableStream; - stderr: WritableStream; - stdin: ReadableStream; - argv: string[]; - execArgv: string[]; - execPath: string; - abort(): void; - chdir(directory: string): void; - cwd(): string; - env: any; - exit(code?: number): void; - exitCode: number; - getgid(): number; - setgid(id: number): void; - setgid(id: string): void; - getuid(): number; - setuid(id: number): void; - setuid(id: string): void; - version: string; - versions: ProcessVersions; - config: { - target_defaults: { - cflags: any[]; - default_configuration: string; - defines: string[]; - include_dirs: string[]; - libraries: string[]; - }; - variables: { - clang: number; - host_arch: string; - node_install_npm: boolean; - node_install_waf: boolean; - node_prefix: string; - node_shared_openssl: boolean; - node_shared_v8: boolean; - node_shared_zlib: boolean; - node_use_dtrace: boolean; - node_use_etw: boolean; - node_use_openssl: boolean; - target_arch: string; - v8_no_strict_aliasing: number; - v8_use_snapshot: boolean; - visibility: string; - }; - }; - kill(pid: number, signal?: string | number): void; - pid: number; - title: string; - arch: string; - platform: string; - memoryUsage(): MemoryUsage; - nextTick(callback: Function, ...args: any[]): void; - umask(mask?: number): number; - uptime(): number; - hrtime(time?: number[]): number[]; - domain: Domain; - - // Worker - send?(message: any, sendHandle?: any): void; - disconnect(): void; - connected: boolean; - } - - export interface Global { - Array: typeof Array; - ArrayBuffer: typeof ArrayBuffer; - Boolean: typeof Boolean; - Buffer: typeof Buffer; - DataView: typeof DataView; - Date: typeof Date; - Error: typeof Error; - EvalError: typeof EvalError; - Float32Array: typeof Float32Array; - Float64Array: typeof Float64Array; - Function: typeof Function; - GLOBAL: Global; - Infinity: typeof Infinity; - Int16Array: typeof Int16Array; - Int32Array: typeof Int32Array; - Int8Array: typeof Int8Array; - Intl: typeof Intl; - JSON: typeof JSON; - Map: MapConstructor; - Math: typeof Math; - NaN: typeof NaN; - Number: typeof Number; - Object: typeof Object; - Promise: Function; - RangeError: typeof RangeError; - ReferenceError: typeof ReferenceError; - RegExp: typeof RegExp; - Set: SetConstructor; - String: typeof String; - Symbol: Function; - SyntaxError: typeof SyntaxError; - TypeError: typeof TypeError; - URIError: typeof URIError; - Uint16Array: typeof Uint16Array; - Uint32Array: typeof Uint32Array; - Uint8Array: typeof Uint8Array; - Uint8ClampedArray: Function; - WeakMap: WeakMapConstructor; - WeakSet: WeakSetConstructor; - clearImmediate: (immediateId: any) => void; - clearInterval: (intervalId: NodeJS.Timer) => void; - clearTimeout: (timeoutId: NodeJS.Timer) => void; - console: typeof console; - decodeURI: typeof decodeURI; - decodeURIComponent: typeof decodeURIComponent; - encodeURI: typeof encodeURI; - encodeURIComponent: typeof encodeURIComponent; - escape: (str: string) => string; - eval: typeof eval; - global: Global; - isFinite: typeof isFinite; - isNaN: typeof isNaN; - parseFloat: typeof parseFloat; - parseInt: typeof parseInt; - process: Process; - root: Global; - setImmediate: (callback: (...args: any[]) => void, ...args: any[]) => any; - setInterval: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer; - setTimeout: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer; - undefined: typeof undefined; - unescape: (str: string) => string; - gc: () => void; - v8debug?: any; - } - - export interface Timer { - ref(): void; - unref(): void; - } -} - -interface IterableIterator { } - -/** - * @deprecated - */ -interface NodeBuffer extends Uint8Array { - write(string: string, offset?: number, length?: number, encoding?: string): number; - toString(encoding?: string, start?: number, end?: number): string; - toJSON(): {type: 'Buffer', data: any[]}; - equals(otherBuffer: Buffer): boolean; - compare(otherBuffer: Buffer, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number; - copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number; - slice(start?: number, end?: number): Buffer; - writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number; - readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number; - readIntLE(offset: number, byteLength: number, noAssert?: boolean): number; - readIntBE(offset: number, byteLength: number, noAssert?: boolean): number; - readUInt8(offset: number, noAssert?: boolean): number; - readUInt16LE(offset: number, noAssert?: boolean): number; - readUInt16BE(offset: number, noAssert?: boolean): number; - readUInt32LE(offset: number, noAssert?: boolean): number; - readUInt32BE(offset: number, noAssert?: boolean): number; - readInt8(offset: number, noAssert?: boolean): number; - readInt16LE(offset: number, noAssert?: boolean): number; - readInt16BE(offset: number, noAssert?: boolean): number; - readInt32LE(offset: number, noAssert?: boolean): number; - readInt32BE(offset: number, noAssert?: boolean): number; - readFloatLE(offset: number, noAssert?: boolean): number; - readFloatBE(offset: number, noAssert?: boolean): number; - readDoubleLE(offset: number, noAssert?: boolean): number; - readDoubleBE(offset: number, noAssert?: boolean): number; - swap16(): Buffer; - swap32(): Buffer; - swap64(): Buffer; - writeUInt8(value: number, offset: number, noAssert?: boolean): number; - writeUInt16LE(value: number, offset: number, noAssert?: boolean): number; - writeUInt16BE(value: number, offset: number, noAssert?: boolean): number; - writeUInt32LE(value: number, offset: number, noAssert?: boolean): number; - writeUInt32BE(value: number, offset: number, noAssert?: boolean): number; - writeInt8(value: number, offset: number, noAssert?: boolean): number; - writeInt16LE(value: number, offset: number, noAssert?: boolean): number; - writeInt16BE(value: number, offset: number, noAssert?: boolean): number; - writeInt32LE(value: number, offset: number, noAssert?: boolean): number; - writeInt32BE(value: number, offset: number, noAssert?: boolean): number; - writeFloatLE(value: number, offset: number, noAssert?: boolean): number; - writeFloatBE(value: number, offset: number, noAssert?: boolean): number; - writeDoubleLE(value: number, offset: number, noAssert?: boolean): number; - writeDoubleBE(value: number, offset: number, noAssert?: boolean): number; - fill(value: any, offset?: number, end?: number): this; - indexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number; - lastIndexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number; - entries(): IterableIterator<[number, number]>; - includes(value: string | number | Buffer, byteOffset?: number, encoding?: string): boolean; - keys(): IterableIterator; - values(): IterableIterator; -} - -/************************************************ -* * -* MODULES * -* * -************************************************/ -declare module "buffer" { - export var INSPECT_MAX_BYTES: number; - var BuffType: typeof Buffer; - var SlowBuffType: typeof SlowBuffer; - export { BuffType as Buffer, SlowBuffType as SlowBuffer }; -} - -declare module "querystring" { - export interface StringifyOptions { - encodeURIComponent?: Function; - } - - export interface ParseOptions { - maxKeys?: number; - decodeURIComponent?: Function; - } - - export function stringify(obj: T, sep?: string, eq?: string, options?: StringifyOptions): string; - export function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): any; - export function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): T; - export function escape(str: string): string; - export function unescape(str: string): string; -} - -declare module "events" { - export class EventEmitter extends NodeJS.EventEmitter { - static EventEmitter: EventEmitter; - static listenerCount(emitter: EventEmitter, event: string|symbol): number; // deprecated - static defaultMaxListeners: number; - - addListener(event: string|symbol, listener: Function): this; - on(event: string|symbol, listener: Function): this; - once(event: string|symbol, listener: Function): this; - prependListener(event: string|symbol, listener: Function): this; - prependOnceListener(event: string|symbol, listener: Function): this; - removeListener(event: string|symbol, listener: Function): this; - removeAllListeners(event?: string|symbol): this; - setMaxListeners(n: number): this; - getMaxListeners(): number; - listeners(event: string|symbol): Function[]; - emit(event: string|symbol, ...args: any[]): boolean; - eventNames(): (string|symbol)[]; - listenerCount(type: string|symbol): number; - } -} - -declare module "http" { - import * as events from "events"; - import * as net from "net"; - import * as stream from "stream"; - - export interface RequestOptions { - protocol?: string; - host?: string; - hostname?: string; - family?: number; - port?: number; - localAddress?: string; - socketPath?: string; - method?: string; - path?: string; - headers?: { [key: string]: any }; - auth?: string; - agent?: Agent | boolean; - } - - export interface Server extends net.Server { - setTimeout(msecs: number, callback: Function): void; - maxHeadersCount: number; - timeout: number; - listening: boolean; - } - /** - * @deprecated Use IncomingMessage - */ - export interface ServerRequest extends IncomingMessage { - connection: net.Socket; - } - export interface ServerResponse extends stream.Writable { - // Extended base methods - write(buffer: Buffer): boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - write(str: string, encoding?: string, fd?: string): boolean; - - writeContinue(): void; - writeHead(statusCode: number, reasonPhrase?: string, headers?: any): void; - writeHead(statusCode: number, headers?: any): void; - statusCode: number; - statusMessage: string; - headersSent: boolean; - setHeader(name: string, value: string | string[]): void; - setTimeout(msecs: number, callback: Function): ServerResponse; - sendDate: boolean; - getHeader(name: string): string; - removeHeader(name: string): void; - write(chunk: any, encoding?: string): any; - addTrailers(headers: any): void; - finished: boolean; - - // Extended base methods - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - end(data?: any, encoding?: string): void; - } - export interface ClientRequest extends stream.Writable { - // Extended base methods - write(buffer: Buffer): boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - write(str: string, encoding?: string, fd?: string): boolean; - - write(chunk: any, encoding?: string): void; - abort(): void; - setTimeout(timeout: number, callback?: Function): void; - setNoDelay(noDelay?: boolean): void; - setSocketKeepAlive(enable?: boolean, initialDelay?: number): void; - - setHeader(name: string, value: string | string[]): void; - getHeader(name: string): string; - removeHeader(name: string): void; - addTrailers(headers: any): void; - - // Extended base methods - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - end(data?: any, encoding?: string): void; - } - export interface IncomingMessage extends stream.Readable { - httpVersion: string; - httpVersionMajor: string; - httpVersionMinor: string; - connection: net.Socket; - headers: any; - rawHeaders: string[]; - trailers: any; - rawTrailers: any; - setTimeout(msecs: number, callback: Function): NodeJS.Timer; - /** - * Only valid for request obtained from http.Server. - */ - method?: string; - /** - * Only valid for request obtained from http.Server. - */ - url?: string; - /** - * Only valid for response obtained from http.ClientRequest. - */ - statusCode?: number; - /** - * Only valid for response obtained from http.ClientRequest. - */ - statusMessage?: string; - socket: net.Socket; - destroy(error?: Error): void; - } - /** - * @deprecated Use IncomingMessage - */ - export interface ClientResponse extends IncomingMessage { } - - export interface AgentOptions { - /** - * Keep sockets around in a pool to be used by other requests in the future. Default = false - */ - keepAlive?: boolean; - /** - * When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. - * Only relevant if keepAlive is set to true. - */ - keepAliveMsecs?: number; - /** - * Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity - */ - maxSockets?: number; - /** - * Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256. - */ - maxFreeSockets?: number; - } - - export class Agent { - maxSockets: number; - sockets: any; - requests: any; - - constructor(opts?: AgentOptions); - - /** - * Destroy any sockets that are currently in use by the agent. - * It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, - * then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, - * sockets may hang open for quite a long time before the server terminates them. - */ - destroy(): void; - } - - export var METHODS: string[]; - - export var STATUS_CODES: { - [errorCode: number]: string; - [errorCode: string]: string; - }; - export function createServer(requestListener?: (request: IncomingMessage, response: ServerResponse) => void): Server; - export function createClient(port?: number, host?: string): any; - export function request(options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest; - export function get(options: any, callback?: (res: IncomingMessage) => void): ClientRequest; - export var globalAgent: Agent; -} - -declare module "cluster" { - import * as child from "child_process"; - import * as events from "events"; - import * as net from "net"; - - // interfaces - export interface ClusterSettings { - execArgv?: string[]; // default: process.execArgv - exec?: string; - args?: string[]; - silent?: boolean; - stdio?: any[]; - uid?: number; - gid?: number; - } - - export interface ClusterSetupMasterSettings { - exec?: string; // default: process.argv[1] - args?: string[]; // default: process.argv.slice(2) - silent?: boolean; // default: false - stdio?: any[]; - } - - export interface Address { - address: string; - port: number; - addressType: number | "udp4" | "udp6"; // 4, 6, -1, "udp4", "udp6" - } - - export class Worker extends events.EventEmitter { - id: string; - process: child.ChildProcess; - suicide: boolean; - send(message: any, sendHandle?: any): boolean; - kill(signal?: string): void; - destroy(signal?: string): void; - disconnect(): void; - isConnected(): boolean; - isDead(): boolean; - exitedAfterDisconnect: boolean; - - /** - * events.EventEmitter - * 1. disconnect - * 2. error - * 3. exit - * 4. listening - * 5. message - * 6. online - */ - addListener(event: string, listener: Function): this; - addListener(event: "disconnect", listener: () => void): this; - addListener(event: "error", listener: (code: number, signal: string) => void): this; - addListener(event: "exit", listener: (code: number, signal: string) => void): this; - addListener(event: "listening", listener: (address: Address) => void): this; - addListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - addListener(event: "online", listener: () => void): this; - - on(event: string, listener: Function): this; - on(event: "disconnect", listener: () => void): this; - on(event: "error", listener: (code: number, signal: string) => void): this; - on(event: "exit", listener: (code: number, signal: string) => void): this; - on(event: "listening", listener: (address: Address) => void): this; - on(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - on(event: "online", listener: () => void): this; - - once(event: string, listener: Function): this; - once(event: "disconnect", listener: () => void): this; - once(event: "error", listener: (code: number, signal: string) => void): this; - once(event: "exit", listener: (code: number, signal: string) => void): this; - once(event: "listening", listener: (address: Address) => void): this; - once(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - once(event: "online", listener: () => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "disconnect", listener: () => void): this; - prependListener(event: "error", listener: (code: number, signal: string) => void): this; - prependListener(event: "exit", listener: (code: number, signal: string) => void): this; - prependListener(event: "listening", listener: (address: Address) => void): this; - prependListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - prependListener(event: "online", listener: () => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "disconnect", listener: () => void): this; - prependOnceListener(event: "error", listener: (code: number, signal: string) => void): this; - prependOnceListener(event: "exit", listener: (code: number, signal: string) => void): this; - prependOnceListener(event: "listening", listener: (address: Address) => void): this; - prependOnceListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - prependOnceListener(event: "online", listener: () => void): this; - } - - export interface Cluster extends events.EventEmitter { - Worker: Worker; - disconnect(callback?: Function): void; - fork(env?: any): Worker; - isMaster: boolean; - isWorker: boolean; - // TODO: cluster.schedulingPolicy - settings: ClusterSettings; - setupMaster(settings?: ClusterSetupMasterSettings): void; - worker: Worker; - workers: { - [index: string]: Worker - }; - - /** - * events.EventEmitter - * 1. disconnect - * 2. exit - * 3. fork - * 4. listening - * 5. message - * 6. online - * 7. setup - */ - addListener(event: string, listener: Function): this; - addListener(event: "disconnect", listener: (worker: Worker) => void): this; - addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; - addListener(event: "fork", listener: (worker: Worker) => void): this; - addListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; - addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - addListener(event: "online", listener: (worker: Worker) => void): this; - addListener(event: "setup", listener: (settings: any) => void): this; - - on(event: string, listener: Function): this; - on(event: "disconnect", listener: (worker: Worker) => void): this; - on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; - on(event: "fork", listener: (worker: Worker) => void): this; - on(event: "listening", listener: (worker: Worker, address: Address) => void): this; - on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - on(event: "online", listener: (worker: Worker) => void): this; - on(event: "setup", listener: (settings: any) => void): this; - - once(event: string, listener: Function): this; - once(event: "disconnect", listener: (worker: Worker) => void): this; - once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; - once(event: "fork", listener: (worker: Worker) => void): this; - once(event: "listening", listener: (worker: Worker, address: Address) => void): this; - once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - once(event: "online", listener: (worker: Worker) => void): this; - once(event: "setup", listener: (settings: any) => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "disconnect", listener: (worker: Worker) => void): this; - prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; - prependListener(event: "fork", listener: (worker: Worker) => void): this; - prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; - prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - prependListener(event: "online", listener: (worker: Worker) => void): this; - prependListener(event: "setup", listener: (settings: any) => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): this; - prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; - prependOnceListener(event: "fork", listener: (worker: Worker) => void): this; - prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; - prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - prependOnceListener(event: "online", listener: (worker: Worker) => void): this; - prependOnceListener(event: "setup", listener: (settings: any) => void): this; - - } - - export function disconnect(callback ?: Function): void; - export function fork(env?: any): Worker; - export var isMaster: boolean; - export var isWorker: boolean; - // TODO: cluster.schedulingPolicy - export var settings: ClusterSettings; - export function setupMaster(settings?: ClusterSetupMasterSettings): void; - export var worker: Worker; - export var workers: { - [index: string]: Worker - }; - - /** - * events.EventEmitter - * 1. disconnect - * 2. exit - * 3. fork - * 4. listening - * 5. message - * 6. online - * 7. setup - */ - export function addListener(event: string, listener: Function): Cluster; - export function addListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; - export function addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; - export function addListener(event: "fork", listener: (worker: Worker) => void): Cluster; - export function addListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; - export function addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. - export function addListener(event: "online", listener: (worker: Worker) => void): Cluster; - export function addListener(event: "setup", listener: (settings: any) => void): Cluster; - - export function on(event: string, listener: Function): Cluster; - export function on(event: "disconnect", listener: (worker: Worker) => void): Cluster; - export function on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; - export function on(event: "fork", listener: (worker: Worker) => void): Cluster; - export function on(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; - export function on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. - export function on(event: "online", listener: (worker: Worker) => void): Cluster; - export function on(event: "setup", listener: (settings: any) => void): Cluster; - - export function once(event: string, listener: Function): Cluster; - export function once(event: "disconnect", listener: (worker: Worker) => void): Cluster; - export function once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; - export function once(event: "fork", listener: (worker: Worker) => void): Cluster; - export function once(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; - export function once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. - export function once(event: "online", listener: (worker: Worker) => void): Cluster; - export function once(event: "setup", listener: (settings: any) => void): Cluster; - - export function removeListener(event: string, listener: Function): Cluster; - export function removeAllListeners(event?: string): Cluster; - export function setMaxListeners(n: number): Cluster; - export function getMaxListeners(): number; - export function listeners(event: string): Function[]; - export function emit(event: string, ...args: any[]): boolean; - export function listenerCount(type: string): number; - - export function prependListener(event: string, listener: Function): Cluster; - export function prependListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; - export function prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; - export function prependListener(event: "fork", listener: (worker: Worker) => void): Cluster; - export function prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; - export function prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. - export function prependListener(event: "online", listener: (worker: Worker) => void): Cluster; - export function prependListener(event: "setup", listener: (settings: any) => void): Cluster; - - export function prependOnceListener(event: string, listener: Function): Cluster; - export function prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; - export function prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; - export function prependOnceListener(event: "fork", listener: (worker: Worker) => void): Cluster; - export function prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; - export function prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. - export function prependOnceListener(event: "online", listener: (worker: Worker) => void): Cluster; - export function prependOnceListener(event: "setup", listener: (settings: any) => void): Cluster; - - export function eventNames(): string[]; -} - -declare module "zlib" { - import * as stream from "stream"; - export interface ZlibOptions { chunkSize?: number; windowBits?: number; level?: number; memLevel?: number; strategy?: number; dictionary?: any; } - - export interface Gzip extends stream.Transform { } - export interface Gunzip extends stream.Transform { } - export interface Deflate extends stream.Transform { } - export interface Inflate extends stream.Transform { } - export interface DeflateRaw extends stream.Transform { } - export interface InflateRaw extends stream.Transform { } - export interface Unzip extends stream.Transform { } - - export function createGzip(options?: ZlibOptions): Gzip; - export function createGunzip(options?: ZlibOptions): Gunzip; - export function createDeflate(options?: ZlibOptions): Deflate; - export function createInflate(options?: ZlibOptions): Inflate; - export function createDeflateRaw(options?: ZlibOptions): DeflateRaw; - export function createInflateRaw(options?: ZlibOptions): InflateRaw; - export function createUnzip(options?: ZlibOptions): Unzip; - - export function deflate(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function deflateSync(buf: Buffer, options?: ZlibOptions): any; - export function deflateRaw(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function deflateRawSync(buf: Buffer, options?: ZlibOptions): any; - export function gzip(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function gzipSync(buf: Buffer, options?: ZlibOptions): any; - export function gunzip(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function gunzipSync(buf: Buffer, options?: ZlibOptions): any; - export function inflate(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function inflateSync(buf: Buffer, options?: ZlibOptions): any; - export function inflateRaw(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function inflateRawSync(buf: Buffer, options?: ZlibOptions): any; - export function unzip(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function unzipSync(buf: Buffer, options?: ZlibOptions): any; - - // Constants - export var Z_NO_FLUSH: number; - export var Z_PARTIAL_FLUSH: number; - export var Z_SYNC_FLUSH: number; - export var Z_FULL_FLUSH: number; - export var Z_FINISH: number; - export var Z_BLOCK: number; - export var Z_TREES: number; - export var Z_OK: number; - export var Z_STREAM_END: number; - export var Z_NEED_DICT: number; - export var Z_ERRNO: number; - export var Z_STREAM_ERROR: number; - export var Z_DATA_ERROR: number; - export var Z_MEM_ERROR: number; - export var Z_BUF_ERROR: number; - export var Z_VERSION_ERROR: number; - export var Z_NO_COMPRESSION: number; - export var Z_BEST_SPEED: number; - export var Z_BEST_COMPRESSION: number; - export var Z_DEFAULT_COMPRESSION: number; - export var Z_FILTERED: number; - export var Z_HUFFMAN_ONLY: number; - export var Z_RLE: number; - export var Z_FIXED: number; - export var Z_DEFAULT_STRATEGY: number; - export var Z_BINARY: number; - export var Z_TEXT: number; - export var Z_ASCII: number; - export var Z_UNKNOWN: number; - export var Z_DEFLATED: number; - export var Z_NULL: number; -} - -declare module "os" { - export interface CpuInfo { - model: string; - speed: number; - times: { - user: number; - nice: number; - sys: number; - idle: number; - irq: number; - }; - } - - export interface NetworkInterfaceInfo { - address: string; - netmask: string; - family: string; - mac: string; - internal: boolean; - } - - export function hostname(): string; - export function loadavg(): number[]; - export function uptime(): number; - export function freemem(): number; - export function totalmem(): number; - export function cpus(): CpuInfo[]; - export function type(): string; - export function release(): string; - export function networkInterfaces(): { [index: string]: NetworkInterfaceInfo[] }; - export function homedir(): string; - export function userInfo(options?: { encoding: string }): { username: string, uid: number, gid: number, shell: any, homedir: string } - export var constants: { - UV_UDP_REUSEADDR: number, - errno: { - SIGHUP: number; - SIGINT: number; - SIGQUIT: number; - SIGILL: number; - SIGTRAP: number; - SIGABRT: number; - SIGIOT: number; - SIGBUS: number; - SIGFPE: number; - SIGKILL: number; - SIGUSR1: number; - SIGSEGV: number; - SIGUSR2: number; - SIGPIPE: number; - SIGALRM: number; - SIGTERM: number; - SIGCHLD: number; - SIGSTKFLT: number; - SIGCONT: number; - SIGSTOP: number; - SIGTSTP: number; - SIGTTIN: number; - SIGTTOU: number; - SIGURG: number; - SIGXCPU: number; - SIGXFSZ: number; - SIGVTALRM: number; - SIGPROF: number; - SIGWINCH: number; - SIGIO: number; - SIGPOLL: number; - SIGPWR: number; - SIGSYS: number; - SIGUNUSED: number; - }, - signals: { - E2BIG: number; - EACCES: number; - EADDRINUSE: number; - EADDRNOTAVAIL: number; - EAFNOSUPPORT: number; - EAGAIN: number; - EALREADY: number; - EBADF: number; - EBADMSG: number; - EBUSY: number; - ECANCELED: number; - ECHILD: number; - ECONNABORTED: number; - ECONNREFUSED: number; - ECONNRESET: number; - EDEADLK: number; - EDESTADDRREQ: number; - EDOM: number; - EDQUOT: number; - EEXIST: number; - EFAULT: number; - EFBIG: number; - EHOSTUNREACH: number; - EIDRM: number; - EILSEQ: number; - EINPROGRESS: number; - EINTR: number; - EINVAL: number; - EIO: number; - EISCONN: number; - EISDIR: number; - ELOOP: number; - EMFILE: number; - EMLINK: number; - EMSGSIZE: number; - EMULTIHOP: number; - ENAMETOOLONG: number; - ENETDOWN: number; - ENETRESET: number; - ENETUNREACH: number; - ENFILE: number; - ENOBUFS: number; - ENODATA: number; - ENODEV: number; - ENOENT: number; - ENOEXEC: number; - ENOLCK: number; - ENOLINK: number; - ENOMEM: number; - ENOMSG: number; - ENOPROTOOPT: number; - ENOSPC: number; - ENOSR: number; - ENOSTR: number; - ENOSYS: number; - ENOTCONN: number; - ENOTDIR: number; - ENOTEMPTY: number; - ENOTSOCK: number; - ENOTSUP: number; - ENOTTY: number; - ENXIO: number; - EOPNOTSUPP: number; - EOVERFLOW: number; - EPERM: number; - EPIPE: number; - EPROTO: number; - EPROTONOSUPPORT: number; - EPROTOTYPE: number; - ERANGE: number; - EROFS: number; - ESPIPE: number; - ESRCH: number; - ESTALE: number; - ETIME: number; - ETIMEDOUT: number; - ETXTBSY: number; - EWOULDBLOCK: number; - EXDEV: number; - }, - }; - export function arch(): string; - export function platform(): string; - export function tmpdir(): string; - export var EOL: string; - export function endianness(): "BE" | "LE"; -} - -declare module "https" { - import * as tls from "tls"; - import * as events from "events"; - import * as http from "http"; - - export interface ServerOptions { - pfx?: any; - key?: any; - passphrase?: string; - cert?: any; - ca?: any; - crl?: any; - ciphers?: string; - honorCipherOrder?: boolean; - requestCert?: boolean; - rejectUnauthorized?: boolean; - NPNProtocols?: any; - SNICallback?: (servername: string, cb: (err: Error, ctx: tls.SecureContext) => any) => any; - } - - export interface RequestOptions extends http.RequestOptions { - pfx?: any; - key?: any; - passphrase?: string; - cert?: any; - ca?: any; - ciphers?: string; - rejectUnauthorized?: boolean; - secureProtocol?: string; - } - - export interface Agent extends http.Agent { } - - export interface AgentOptions extends http.AgentOptions { - pfx?: any; - key?: any; - passphrase?: string; - cert?: any; - ca?: any; - ciphers?: string; - rejectUnauthorized?: boolean; - secureProtocol?: string; - maxCachedSessions?: number; - } - - export var Agent: { - new (options?: AgentOptions): Agent; - }; - export interface Server extends tls.Server { } - export function createServer(options: ServerOptions, requestListener?: Function): Server; - export function request(options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; - export function get(options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; - export var globalAgent: Agent; -} - -declare module "punycode" { - export function decode(string: string): string; - export function encode(string: string): string; - export function toUnicode(domain: string): string; - export function toASCII(domain: string): string; - export var ucs2: ucs2; - interface ucs2 { - decode(string: string): number[]; - encode(codePoints: number[]): string; - } - export var version: any; -} - -declare module "repl" { - import * as stream from "stream"; - import * as readline from "readline"; - - export interface ReplOptions { - prompt?: string; - input?: NodeJS.ReadableStream; - output?: NodeJS.WritableStream; - terminal?: boolean; - eval?: Function; - useColors?: boolean; - useGlobal?: boolean; - ignoreUndefined?: boolean; - writer?: Function; - completer?: Function; - replMode?: any; - breakEvalOnSigint?: any; - } - - export interface REPLServer extends readline.ReadLine { - defineCommand(keyword: string, cmd: Function | { help: string, action: Function }): void; - displayPrompt(preserveCursor?: boolean): void - } - - export function start(options: ReplOptions): REPLServer; -} - -declare module "readline" { - import * as events from "events"; - import * as stream from "stream"; - - export interface Key { - sequence?: string; - name?: string; - ctrl?: boolean; - meta?: boolean; - shift?: boolean; - } - - export interface ReadLine extends events.EventEmitter { - setPrompt(prompt: string): void; - prompt(preserveCursor?: boolean): void; - question(query: string, callback: (answer: string) => void): void; - pause(): ReadLine; - resume(): ReadLine; - close(): void; - write(data: string | Buffer, key?: Key): void; - } - - export interface Completer { - (line: string): CompleterResult; - (line: string, callback: (err: any, result: CompleterResult) => void): any; - } - - export interface CompleterResult { - completions: string[]; - line: string; - } - - export interface ReadLineOptions { - input: NodeJS.ReadableStream; - output?: NodeJS.WritableStream; - completer?: Completer; - terminal?: boolean; - historySize?: number; - } - - export function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer, terminal?: boolean): ReadLine; - export function createInterface(options: ReadLineOptions): ReadLine; - - export function cursorTo(stream: NodeJS.WritableStream, x: number, y: number): void; - export function moveCursor(stream: NodeJS.WritableStream, dx: number | string, dy: number | string): void; - export function clearLine(stream: NodeJS.WritableStream, dir: number): void; - export function clearScreenDown(stream: NodeJS.WritableStream): void; -} - -declare module "vm" { - export interface Context { } - export interface ScriptOptions { - filename?: string; - lineOffset?: number; - columnOffset?: number; - displayErrors?: boolean; - timeout?: number; - cachedData?: Buffer; - produceCachedData?: boolean; - } - export interface RunningScriptOptions { - filename?: string; - lineOffset?: number; - columnOffset?: number; - displayErrors?: boolean; - timeout?: number; - } - export class Script { - constructor(code: string, options?: ScriptOptions); - runInContext(contextifiedSandbox: Context, options?: RunningScriptOptions): any; - runInNewContext(sandbox?: Context, options?: RunningScriptOptions): any; - runInThisContext(options?: RunningScriptOptions): any; - } - export function createContext(sandbox?: Context): Context; - export function isContext(sandbox: Context): boolean; - export function runInContext(code: string, contextifiedSandbox: Context, options?: RunningScriptOptions): any; - export function runInDebugContext(code: string): any; - export function runInNewContext(code: string, sandbox?: Context, options?: RunningScriptOptions): any; - export function runInThisContext(code: string, options?: RunningScriptOptions): any; -} - -declare module "child_process" { - import * as events from "events"; - import * as stream from "stream"; - - export interface ChildProcess extends events.EventEmitter { - stdin: stream.Writable; - stdout: stream.Readable; - stderr: stream.Readable; - stdio: [stream.Writable, stream.Readable, stream.Readable]; - pid: number; - kill(signal?: string): void; - send(message: any, sendHandle?: any): boolean; - connected: boolean; - disconnect(): void; - unref(): void; - ref(): void; - } - - export interface SpawnOptions { - cwd?: string; - env?: any; - stdio?: any; - detached?: boolean; - uid?: number; - gid?: number; - shell?: boolean | string; - } - export function spawn(command: string, args?: string[], options?: SpawnOptions): ChildProcess; - - export interface ExecOptions { - cwd?: string; - env?: any; - shell?: string; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - uid?: number; - gid?: number; - } - export interface ExecOptionsWithStringEncoding extends ExecOptions { - encoding: BufferEncoding; - } - export interface ExecOptionsWithBufferEncoding extends ExecOptions { - encoding: string; // specify `null`. - } - export function exec(command: string, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - export function exec(command: string, options: ExecOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - // usage. child_process.exec("tsc", {encoding: null as string}, (err, stdout, stderr) => {}); - export function exec(command: string, options: ExecOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess; - export function exec(command: string, options: ExecOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - - export interface ExecFileOptions { - cwd?: string; - env?: any; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - uid?: number; - gid?: number; - } - export interface ExecFileOptionsWithStringEncoding extends ExecFileOptions { - encoding: BufferEncoding; - } - export interface ExecFileOptionsWithBufferEncoding extends ExecFileOptions { - encoding: string; // specify `null`. - } - export function execFile(file: string, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - export function execFile(file: string, options?: ExecFileOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - // usage. child_process.execFile("file.sh", {encoding: null as string}, (err, stdout, stderr) => {}); - export function execFile(file: string, options?: ExecFileOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess; - export function execFile(file: string, options?: ExecFileOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - export function execFile(file: string, args?: string[], callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - export function execFile(file: string, args?: string[], options?: ExecFileOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - // usage. child_process.execFile("file.sh", ["foo"], {encoding: null as string}, (err, stdout, stderr) => {}); - export function execFile(file: string, args?: string[], options?: ExecFileOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess; - export function execFile(file: string, args?: string[], options?: ExecFileOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - - export interface ForkOptions { - cwd?: string; - env?: any; - execPath?: string; - execArgv?: string[]; - silent?: boolean; - uid?: number; - gid?: number; - } - export function fork(modulePath: string, args?: string[], options?: ForkOptions): ChildProcess; - - export interface SpawnSyncOptions { - cwd?: string; - input?: string | Buffer; - stdio?: any; - env?: any; - uid?: number; - gid?: number; - timeout?: number; - killSignal?: string; - maxBuffer?: number; - encoding?: string; - shell?: boolean | string; - } - export interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions { - encoding: BufferEncoding; - } - export interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions { - encoding: string; // specify `null`. - } - export interface SpawnSyncReturns { - pid: number; - output: string[]; - stdout: T; - stderr: T; - status: number; - signal: string; - error: Error; - } - export function spawnSync(command: string): SpawnSyncReturns; - export function spawnSync(command: string, options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns; - export function spawnSync(command: string, options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns; - export function spawnSync(command: string, options?: SpawnSyncOptions): SpawnSyncReturns; - export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns; - export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns; - export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptions): SpawnSyncReturns; - - export interface ExecSyncOptions { - cwd?: string; - input?: string | Buffer; - stdio?: any; - env?: any; - shell?: string; - uid?: number; - gid?: number; - timeout?: number; - killSignal?: string; - maxBuffer?: number; - encoding?: string; - } - export interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions { - encoding: BufferEncoding; - } - export interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions { - encoding: string; // specify `null`. - } - export function execSync(command: string): Buffer; - export function execSync(command: string, options?: ExecSyncOptionsWithStringEncoding): string; - export function execSync(command: string, options?: ExecSyncOptionsWithBufferEncoding): Buffer; - export function execSync(command: string, options?: ExecSyncOptions): Buffer; - - export interface ExecFileSyncOptions { - cwd?: string; - input?: string | Buffer; - stdio?: any; - env?: any; - uid?: number; - gid?: number; - timeout?: number; - killSignal?: string; - maxBuffer?: number; - encoding?: string; - } - export interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions { - encoding: BufferEncoding; - } - export interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions { - encoding: string; // specify `null`. - } - export function execFileSync(command: string): Buffer; - export function execFileSync(command: string, options?: ExecFileSyncOptionsWithStringEncoding): string; - export function execFileSync(command: string, options?: ExecFileSyncOptionsWithBufferEncoding): Buffer; - export function execFileSync(command: string, options?: ExecFileSyncOptions): Buffer; - export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptionsWithStringEncoding): string; - export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptionsWithBufferEncoding): Buffer; - export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptions): Buffer; -} - -declare module "url" { - export interface Url { - href?: string; - protocol?: string; - auth?: string; - hostname?: string; - port?: string; - host?: string; - pathname?: string; - search?: string; - query?: string | any; - slashes?: boolean; - hash?: string; - path?: string; - } - - export function parse(urlStr: string, parseQueryString?: boolean, slashesDenoteHost?: boolean): Url; - export function format(url: Url): string; - export function resolve(from: string, to: string): string; -} - -declare module "dns" { - export interface MxRecord { - exchange: string, - priority: number - } - - export function lookup(domain: string, family: number, callback: (err: Error, address: string, family: number) => void): string; - export function lookup(domain: string, callback: (err: Error, address: string, family: number) => void): string; - export function resolve(domain: string, rrtype: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolve(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolve4(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolve6(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolveMx(domain: string, callback: (err: Error, addresses: MxRecord[]) =>void ): string[]; - export function resolveTxt(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolveSrv(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolveNs(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolveCname(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function reverse(ip: string, callback: (err: Error, domains: string[]) => void): string[]; - export function setServers(servers: string[]): void; - - //Error codes - export var NODATA: string; - export var FORMERR: string; - export var SERVFAIL: string; - export var NOTFOUND: string; - export var NOTIMP: string; - export var REFUSED: string; - export var BADQUERY: string; - export var BADNAME: string; - export var BADFAMILY: string; - export var BADRESP: string; - export var CONNREFUSED: string; - export var TIMEOUT: string; - export var EOF: string; - export var FILE: string; - export var NOMEM: string; - export var DESTRUCTION: string; - export var BADSTR: string; - export var BADFLAGS: string; - export var NONAME: string; - export var BADHINTS: string; - export var NOTINITIALIZED: string; - export var LOADIPHLPAPI: string; - export var ADDRGETNETWORKPARAMS: string; - export var CANCELLED: string; -} - -declare module "net" { - import * as stream from "stream"; - - export interface Socket extends stream.Duplex { - // Extended base methods - write(buffer: Buffer): boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - write(str: string, encoding?: string, fd?: string): boolean; - - connect(port: number, host?: string, connectionListener?: Function): void; - connect(path: string, connectionListener?: Function): void; - bufferSize: number; - setEncoding(encoding?: string): void; - write(data: any, encoding?: string, callback?: Function): void; - destroy(): void; - pause(): Socket; - resume(): Socket; - setTimeout(timeout: number, callback?: Function): void; - setNoDelay(noDelay?: boolean): void; - setKeepAlive(enable?: boolean, initialDelay?: number): void; - address(): { port: number; family: string; address: string; }; - unref(): void; - ref(): void; - - remoteAddress: string; - remoteFamily: string; - remotePort: number; - localAddress: string; - localPort: number; - bytesRead: number; - bytesWritten: number; - - // Extended base methods - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - end(data?: any, encoding?: string): void; - } - - export var Socket: { - new (options?: { fd?: string; type?: string; allowHalfOpen?: boolean; }): Socket; - }; - - export interface ListenOptions { - port?: number; - host?: string; - backlog?: number; - path?: string; - exclusive?: boolean; - } - - export interface Server extends Socket { - listen(port: number, hostname?: string, backlog?: number, listeningListener?: Function): Server; - listen(port: number, hostname?: string, listeningListener?: Function): Server; - listen(port: number, backlog?: number, listeningListener?: Function): Server; - listen(port: number, listeningListener?: Function): Server; - listen(path: string, backlog?: number, listeningListener?: Function): Server; - listen(path: string, listeningListener?: Function): Server; - listen(handle: any, backlog?: number, listeningListener?: Function): Server; - listen(handle: any, listeningListener?: Function): Server; - listen(options: ListenOptions, listeningListener?: Function): Server; - close(callback?: Function): Server; - address(): { port: number; family: string; address: string; }; - getConnections(cb: (error: Error, count: number) => void): void; - ref(): Server; - unref(): Server; - maxConnections: number; - connections: number; - } - export function createServer(connectionListener?: (socket: Socket) => void): Server; - export function createServer(options?: { allowHalfOpen?: boolean; }, connectionListener?: (socket: Socket) => void): Server; - export function connect(options: { port: number, host?: string, localAddress?: string, localPort?: string, family?: number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket; - export function connect(port: number, host?: string, connectionListener?: Function): Socket; - export function connect(path: string, connectionListener?: Function): Socket; - export function createConnection(options: { port: number, host?: string, localAddress?: string, localPort?: string, family?: number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket; - export function createConnection(port: number, host?: string, connectionListener?: Function): Socket; - export function createConnection(path: string, connectionListener?: Function): Socket; - export function isIP(input: string): number; - export function isIPv4(input: string): boolean; - export function isIPv6(input: string): boolean; -} - -declare module "dgram" { - import * as events from "events"; - - interface RemoteInfo { - address: string; - port: number; - size: number; - } - - interface AddressInfo { - address: string; - family: string; - port: number; - } - - interface BindOptions { - port: number; - address?: string; - exclusive?: boolean; - } - - interface SocketOptions { - type: "udp4" | "udp6"; - reuseAddr?: boolean; - } - - export function createSocket(type: string, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; - export function createSocket(options: SocketOptions, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; - - export interface Socket extends events.EventEmitter { - send(msg: Buffer | String | any[], port: number, address: string, callback?: (error: Error, bytes: number) => void): void; - send(msg: Buffer | String | any[], offset: number, length: number, port: number, address: string, callback?: (error: Error, bytes: number) => void): void; - bind(port?: number, address?: string, callback?: () => void): void; - bind(options: BindOptions, callback?: Function): void; - close(callback?: any): void; - address(): AddressInfo; - setBroadcast(flag: boolean): void; - setTTL(ttl: number): void; - setMulticastTTL(ttl: number): void; - setMulticastLoopback(flag: boolean): void; - addMembership(multicastAddress: string, multicastInterface?: string): void; - dropMembership(multicastAddress: string, multicastInterface?: string): void; - ref(): void; - unref(): void; - } -} - -declare module "fs" { - import * as stream from "stream"; - import * as events from "events"; - - interface Stats { - isFile(): boolean; - isDirectory(): boolean; - isBlockDevice(): boolean; - isCharacterDevice(): boolean; - isSymbolicLink(): boolean; - isFIFO(): boolean; - isSocket(): boolean; - dev: number; - ino: number; - mode: number; - nlink: number; - uid: number; - gid: number; - rdev: number; - size: number; - blksize: number; - blocks: number; - atime: Date; - mtime: Date; - ctime: Date; - birthtime: Date; - } - - interface FSWatcher extends events.EventEmitter { - close(): void; - - /** - * events.EventEmitter - * 1. change - * 2. error - */ - addListener(event: string, listener: Function): this; - addListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; - addListener(event: "error", listener: (code: number, signal: string) => void): this; - - on(event: string, listener: Function): this; - on(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; - on(event: "error", listener: (code: number, signal: string) => void): this; - - once(event: string, listener: Function): this; - once(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; - once(event: "error", listener: (code: number, signal: string) => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; - prependListener(event: "error", listener: (code: number, signal: string) => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; - prependOnceListener(event: "error", listener: (code: number, signal: string) => void): this; - } - - export interface ReadStream extends stream.Readable { - close(): void; - destroy(): void; - - /** - * events.EventEmitter - * 1. open - * 2. close - */ - addListener(event: string, listener: Function): this; - addListener(event: "open", listener: (fd: number) => void): this; - addListener(event: "close", listener: () => void): this; - - on(event: string, listener: Function): this; - on(event: "open", listener: (fd: number) => void): this; - on(event: "close", listener: () => void): this; - - once(event: string, listener: Function): this; - once(event: "open", listener: (fd: number) => void): this; - once(event: "close", listener: () => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "open", listener: (fd: number) => void): this; - prependListener(event: "close", listener: () => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "open", listener: (fd: number) => void): this; - prependOnceListener(event: "close", listener: () => void): this; - } - - export interface WriteStream extends stream.Writable { - close(): void; - bytesWritten: number; - path: string | Buffer; - - /** - * events.EventEmitter - * 1. open - * 2. close - */ - addListener(event: string, listener: Function): this; - addListener(event: "open", listener: (fd: number) => void): this; - addListener(event: "close", listener: () => void): this; - - on(event: string, listener: Function): this; - on(event: "open", listener: (fd: number) => void): this; - on(event: "close", listener: () => void): this; - - once(event: string, listener: Function): this; - once(event: "open", listener: (fd: number) => void): this; - once(event: "close", listener: () => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "open", listener: (fd: number) => void): this; - prependListener(event: "close", listener: () => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "open", listener: (fd: number) => void): this; - prependOnceListener(event: "close", listener: () => void): this; - } - - /** - * Asynchronous rename. - * @param oldPath - * @param newPath - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function rename(oldPath: string, newPath: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - /** - * Synchronous rename - * @param oldPath - * @param newPath - */ - export function renameSync(oldPath: string, newPath: string): void; - export function truncate(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function truncate(path: string | Buffer, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function truncateSync(path: string | Buffer, len?: number): void; - export function ftruncate(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function ftruncate(fd: number, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function ftruncateSync(fd: number, len?: number): void; - export function chown(path: string | Buffer, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chownSync(path: string | Buffer, uid: number, gid: number): void; - export function fchown(fd: number, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fchownSync(fd: number, uid: number, gid: number): void; - export function lchown(path: string | Buffer, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchownSync(path: string | Buffer, uid: number, gid: number): void; - export function chmod(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chmod(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chmodSync(path: string | Buffer, mode: number): void; - export function chmodSync(path: string | Buffer, mode: string): void; - export function fchmod(fd: number, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fchmod(fd: number, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fchmodSync(fd: number, mode: number): void; - export function fchmodSync(fd: number, mode: string): void; - export function lchmod(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchmod(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchmodSync(path: string | Buffer, mode: number): void; - export function lchmodSync(path: string | Buffer, mode: string): void; - export function stat(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; - export function lstat(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; - export function fstat(fd: number, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; - export function statSync(path: string | Buffer): Stats; - export function lstatSync(path: string | Buffer): Stats; - export function fstatSync(fd: number): Stats; - export function link(srcpath: string | Buffer, dstpath: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function linkSync(srcpath: string | Buffer, dstpath: string | Buffer): void; - export function symlink(srcpath: string | Buffer, dstpath: string | Buffer, type?: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function symlinkSync(srcpath: string | Buffer, dstpath: string | Buffer, type?: string): void; - export function readlink(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, linkString: string) => any): void; - export function readlinkSync(path: string | Buffer): string; - export function realpath(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void; - export function realpath(path: string | Buffer, cache: { [path: string]: string }, callback: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void; - export function realpathSync(path: string | Buffer, cache?: { [path: string]: string }): string; - /* - * Asynchronous unlink - deletes the file specified in {path} - * - * @param path - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function unlink(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous unlink - deletes the file specified in {path} - * - * @param path - */ - export function unlinkSync(path: string | Buffer): void; - /* - * Asynchronous rmdir - removes the directory specified in {path} - * - * @param path - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function rmdir(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous rmdir - removes the directory specified in {path} - * - * @param path - */ - export function rmdirSync(path: string | Buffer): void; - /* - * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdir(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdir(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdir(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdirSync(path: string | Buffer, mode?: number): void; - /* - * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdirSync(path: string | Buffer, mode?: string): void; - /* - * Asynchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory. - * - * @param prefix - * @param callback The created folder path is passed as a string to the callback's second parameter. - */ - export function mkdtemp(prefix: string, callback?: (err: NodeJS.ErrnoException, folder: string) => void): void; - /* - * Synchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory. - * - * @param prefix - * @returns Returns the created folder path. - */ - export function mkdtempSync(prefix: string): string; - export function readdir(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, files: string[]) => void): void; - export function readdirSync(path: string | Buffer): string[]; - export function close(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function closeSync(fd: number): void; - export function open(path: string | Buffer, flags: string | number, callback: (err: NodeJS.ErrnoException, fd: number) => void): void; - export function open(path: string | Buffer, flags: string | number, mode: number, callback: (err: NodeJS.ErrnoException, fd: number) => void): void; - export function openSync(path: string | Buffer, flags: string | number, mode?: number): number; - export function utimes(path: string | Buffer, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function utimes(path: string | Buffer, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function utimesSync(path: string | Buffer, atime: number, mtime: number): void; - export function utimesSync(path: string | Buffer, atime: Date, mtime: Date): void; - export function futimes(fd: number, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function futimes(fd: number, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function futimesSync(fd: number, atime: number, mtime: number): void; - export function futimesSync(fd: number, atime: Date, mtime: Date): void; - export function fsync(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fsyncSync(fd: number): void; - export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; - export function write(fd: number, buffer: Buffer, offset: number, length: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; - export function write(fd: number, data: any, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; - export function write(fd: number, data: any, offset: number, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; - export function write(fd: number, data: any, offset: number, encoding: string, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; - export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number): number; - export function writeSync(fd: number, data: any, position?: number, enconding?: string): number; - export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; - export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param encoding - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, encoding: string, callback: (err: NodeJS.ErrnoException, data: string) => void): void; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer. - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, options: { encoding: string; flag?: string; }, callback: (err: NodeJS.ErrnoException, data: string) => void): void; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer. - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, options: { flag?: string; }, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void; - /* - * Synchronous readFile - Synchronously reads the entire contents of a file. - * - * @param fileName - * @param encoding - */ - export function readFileSync(filename: string, encoding: string): string; - /* - * Synchronous readFile - Synchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer. - */ - export function readFileSync(filename: string, options: { encoding: string; flag?: string; }): string; - /* - * Synchronous readFile - Synchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer. - */ - export function readFileSync(filename: string, options?: { flag?: string; }): Buffer; - export function writeFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void; - export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; - export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void; - export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function appendFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void; - export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; - export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void; - export function watchFile(filename: string, listener: (curr: Stats, prev: Stats) => void): void; - export function watchFile(filename: string, options: { persistent?: boolean; interval?: number; }, listener: (curr: Stats, prev: Stats) => void): void; - export function unwatchFile(filename: string, listener?: (curr: Stats, prev: Stats) => void): void; - export function watch(filename: string, listener?: (event: string, filename: string) => any): FSWatcher; - export function watch(filename: string, encoding: string, listener?: (event: string, filename: string | Buffer) => any): FSWatcher; - export function watch(filename: string, options: { persistent?: boolean; recursive?: boolean; encoding?: string }, listener?: (event: string, filename: string | Buffer) => any): FSWatcher; - export function exists(path: string | Buffer, callback?: (exists: boolean) => void): void; - export function existsSync(path: string | Buffer): boolean; - - interface Constants { - /** Constant for fs.access(). File is visible to the calling process. */ - F_OK: number; - - /** Constant for fs.access(). File can be read by the calling process. */ - R_OK: number; - - /** Constant for fs.access(). File can be written by the calling process. */ - W_OK: number; - - /** Constant for fs.access(). File can be executed by the calling process. */ - X_OK: number; - } - - export const constants: Constants; - - /** Tests a user's permissions for the file specified by path. */ - export function access(path: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void; - export function access(path: string | Buffer, mode: number, callback: (err: NodeJS.ErrnoException) => void): void; - /** Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise. */ - export function accessSync(path: string | Buffer, mode?: number): void; - export function createReadStream(path: string | Buffer, options?: { - flags?: string; - encoding?: string; - fd?: number; - mode?: number; - autoClose?: boolean; - start?: number; - end?: number; - }): ReadStream; - export function createWriteStream(path: string | Buffer, options?: { - flags?: string; - encoding?: string; - fd?: number; - mode?: number; - }): WriteStream; - export function fdatasync(fd: number, callback: Function): void; - export function fdatasyncSync(fd: number): void; -} - -declare module "path" { - - /** - * A parsed path object generated by path.parse() or consumed by path.format(). - */ - export interface ParsedPath { - /** - * The root of the path such as '/' or 'c:\' - */ - root: string; - /** - * The full directory path such as '/home/user/dir' or 'c:\path\dir' - */ - dir: string; - /** - * The file name including extension (if any) such as 'index.html' - */ - base: string; - /** - * The file extension (if any) such as '.html' - */ - ext: string; - /** - * The file name without extension (if any) such as 'index' - */ - name: string; - } - - /** - * Normalize a string path, reducing '..' and '.' parts. - * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. - * - * @param p string path to normalize. - */ - export function normalize(p: string): string; - /** - * Join all arguments together and normalize the resulting path. - * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. - * - * @param paths string paths to join. - */ - export function join(...paths: any[]): string; - /** - * Join all arguments together and normalize the resulting path. - * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. - * - * @param paths string paths to join. - */ - export function join(...paths: string[]): string; - /** - * The right-most parameter is considered {to}. Other parameters are considered an array of {from}. - * - * Starting from leftmost {from} paramter, resolves {to} to an absolute path. - * - * If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory. - * - * @param pathSegments string paths to join. Non-string arguments are ignored. - */ - export function resolve(...pathSegments: any[]): string; - /** - * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. - * - * @param path path to test. - */ - export function isAbsolute(path: string): boolean; - /** - * Solve the relative path from {from} to {to}. - * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. - * - * @param from - * @param to - */ - export function relative(from: string, to: string): string; - /** - * Return the directory name of a path. Similar to the Unix dirname command. - * - * @param p the path to evaluate. - */ - export function dirname(p: string): string; - /** - * Return the last portion of a path. Similar to the Unix basename command. - * Often used to extract the file name from a fully qualified path. - * - * @param p the path to evaluate. - * @param ext optionally, an extension to remove from the result. - */ - export function basename(p: string, ext?: string): string; - /** - * Return the extension of the path, from the last '.' to end of string in the last portion of the path. - * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string - * - * @param p the path to evaluate. - */ - export function extname(p: string): string; - /** - * The platform-specific file separator. '\\' or '/'. - */ - export var sep: string; - /** - * The platform-specific file delimiter. ';' or ':'. - */ - export var delimiter: string; - /** - * Returns an object from a path string - the opposite of format(). - * - * @param pathString path to evaluate. - */ - export function parse(pathString: string): ParsedPath; - /** - * Returns a path string from an object - the opposite of parse(). - * - * @param pathString path to evaluate. - */ - export function format(pathObject: ParsedPath): string; - - export module posix { - export function normalize(p: string): string; - export function join(...paths: any[]): string; - export function resolve(...pathSegments: any[]): string; - export function isAbsolute(p: string): boolean; - export function relative(from: string, to: string): string; - export function dirname(p: string): string; - export function basename(p: string, ext?: string): string; - export function extname(p: string): string; - export var sep: string; - export var delimiter: string; - export function parse(p: string): ParsedPath; - export function format(pP: ParsedPath): string; - } - - export module win32 { - export function normalize(p: string): string; - export function join(...paths: any[]): string; - export function resolve(...pathSegments: any[]): string; - export function isAbsolute(p: string): boolean; - export function relative(from: string, to: string): string; - export function dirname(p: string): string; - export function basename(p: string, ext?: string): string; - export function extname(p: string): string; - export var sep: string; - export var delimiter: string; - export function parse(p: string): ParsedPath; - export function format(pP: ParsedPath): string; - } -} - -declare module "string_decoder" { - export interface NodeStringDecoder { - write(buffer: Buffer): string; - end(buffer?: Buffer): string; - } - export var StringDecoder: { - new (encoding?: string): NodeStringDecoder; - }; -} - -declare module "tls" { - import * as crypto from "crypto"; - import * as net from "net"; - import * as stream from "stream"; - - var CLIENT_RENEG_LIMIT: number; - var CLIENT_RENEG_WINDOW: number; - - export interface Certificate { - /** - * Country code. - */ - C: string; - /** - * Street. - */ - ST: string; - /** - * Locality. - */ - L: string; - /** - * Organization. - */ - O: string; - /** - * Organizational unit. - */ - OU: string; - /** - * Common name. - */ - CN: string; - } - - export interface CipherNameAndProtocol { - /** - * The cipher name. - */ - name: string; - /** - * SSL/TLS protocol version. - */ - version: string; - } - - export class TLSSocket extends stream.Duplex { - /** - * Returns the bound address, the address family name and port of the underlying socket as reported by - * the operating system. - * @returns {any} - An object with three properties, e.g. { port: 12346, family: 'IPv4', address: '127.0.0.1' }. - */ - address(): { port: number; family: string; address: string }; - /** - * A boolean that is true if the peer certificate was signed by one of the specified CAs, otherwise false. - */ - authorized: boolean; - /** - * The reason why the peer's certificate has not been verified. - * This property becomes available only when tlsSocket.authorized === false. - */ - authorizationError: Error; - /** - * Static boolean value, always true. - * May be used to distinguish TLS sockets from regular ones. - */ - encrypted: boolean; - /** - * Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection. - * @returns {CipherNameAndProtocol} - Returns an object representing the cipher name - * and the SSL/TLS protocol version of the current connection. - */ - getCipher(): CipherNameAndProtocol; - /** - * Returns an object representing the peer's certificate. - * The returned object has some properties corresponding to the field of the certificate. - * If detailed argument is true the full chain with issuer property will be returned, - * if false only the top certificate without issuer property. - * If the peer does not provide a certificate, it returns null or an empty object. - * @param {boolean} detailed - If true; the full chain with issuer property will be returned. - * @returns {any} - An object representing the peer's certificate. - */ - getPeerCertificate(detailed?: boolean): { - subject: Certificate; - issuerInfo: Certificate; - issuer: Certificate; - raw: any; - valid_from: string; - valid_to: string; - fingerprint: string; - serialNumber: string; - }; - /** - * Could be used to speed up handshake establishment when reconnecting to the server. - * @returns {any} - ASN.1 encoded TLS session or undefined if none was negotiated. - */ - getSession(): any; - /** - * NOTE: Works only with client TLS sockets. - * Useful only for debugging, for session reuse provide session option to tls.connect(). - * @returns {any} - TLS session ticket or undefined if none was negotiated. - */ - getTLSTicket(): any; - /** - * The string representation of the local IP address. - */ - localAddress: string; - /** - * The numeric representation of the local port. - */ - localPort: string; - /** - * The string representation of the remote IP address. - * For example, '74.125.127.100' or '2001:4860:a005::68'. - */ - remoteAddress: string; - /** - * The string representation of the remote IP family. 'IPv4' or 'IPv6'. - */ - remoteFamily: string; - /** - * The numeric representation of the remote port. For example, 443. - */ - remotePort: number; - /** - * Initiate TLS renegotiation process. - * - * NOTE: Can be used to request peer's certificate after the secure connection has been established. - * ANOTHER NOTE: When running as the server, socket will be destroyed with an error after handshakeTimeout timeout. - * @param {TlsOptions} options - The options may contain the following fields: rejectUnauthorized, - * requestCert (See tls.createServer() for details). - * @param {Function} callback - callback(err) will be executed with null as err, once the renegotiation - * is successfully completed. - */ - renegotiate(options: TlsOptions, callback: (err: Error) => any): any; - /** - * Set maximum TLS fragment size (default and maximum value is: 16384, minimum is: 512). - * Smaller fragment size decreases buffering latency on the client: large fragments are buffered by - * the TLS layer until the entire fragment is received and its integrity is verified; - * large fragments can span multiple roundtrips, and their processing can be delayed due to packet - * loss or reordering. However, smaller fragments add extra TLS framing bytes and CPU overhead, - * which may decrease overall server throughput. - * @param {number} size - TLS fragment size (default and maximum value is: 16384, minimum is: 512). - * @returns {boolean} - Returns true on success, false otherwise. - */ - setMaxSendFragment(size: number): boolean; - } - - export interface TlsOptions { - host?: string; - port?: number; - pfx?: string | Buffer[]; - key?: string | string[] | Buffer | any[]; - passphrase?: string; - cert?: string | string[] | Buffer | Buffer[]; - ca?: string | string[] | Buffer | Buffer[]; - crl?: string | string[]; - ciphers?: string; - honorCipherOrder?: boolean; - requestCert?: boolean; - rejectUnauthorized?: boolean; - NPNProtocols?: string[] | Buffer; - SNICallback?: (servername: string, cb: (err: Error, ctx: SecureContext) => any) => any; - ecdhCurve?: string; - dhparam?: string | Buffer; - handshakeTimeout?: number; - ALPNProtocols?: string[] | Buffer; - sessionTimeout?: number; - ticketKeys?: any; - sessionIdContext?: string; - secureProtocol?: string; - } - - export interface ConnectionOptions { - host?: string; - port?: number; - socket?: net.Socket; - pfx?: string | Buffer - key?: string | string[] | Buffer | Buffer[]; - passphrase?: string; - cert?: string | string[] | Buffer | Buffer[]; - ca?: string | Buffer | (string | Buffer)[]; - rejectUnauthorized?: boolean; - NPNProtocols?: (string | Buffer)[]; - servername?: string; - path?: string; - ALPNProtocols?: (string | Buffer)[]; - checkServerIdentity?: (servername: string, cert: string | Buffer | (string | Buffer)[]) => any; - secureProtocol?: string; - secureContext?: Object; - session?: Buffer; - minDHSize?: number; - } - - export interface Server extends net.Server { - close(): Server; - address(): { port: number; family: string; address: string; }; - addContext(hostName: string, credentials: { - key: string; - cert: string; - ca: string; - }): void; - maxConnections: number; - connections: number; - } - - export interface ClearTextStream extends stream.Duplex { - authorized: boolean; - authorizationError: Error; - getPeerCertificate(): any; - getCipher: { - name: string; - version: string; - }; - address: { - port: number; - family: string; - address: string; - }; - remoteAddress: string; - remotePort: number; - } - - export interface SecurePair { - encrypted: any; - cleartext: any; - } - - export interface SecureContextOptions { - pfx?: string | Buffer; - key?: string | Buffer; - passphrase?: string; - cert?: string | Buffer; - ca?: string | Buffer; - crl?: string | string[] - ciphers?: string; - honorCipherOrder?: boolean; - } - - export interface SecureContext { - context: any; - } - - export function createServer(options: TlsOptions, secureConnectionListener?: (cleartextStream: ClearTextStream) => void): Server; - export function connect(options: ConnectionOptions, secureConnectionListener?: () => void): ClearTextStream; - export function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () => void): ClearTextStream; - export function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () => void): ClearTextStream; - export function createSecurePair(credentials?: crypto.Credentials, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair; - export function createSecureContext(details: SecureContextOptions): SecureContext; -} - -declare module "crypto" { - export interface Certificate { - exportChallenge(spkac: string | Buffer): Buffer; - exportPublicKey(spkac: string | Buffer): Buffer; - verifySpkac(spkac: Buffer): boolean; - } - export var Certificate: { - new (): Certificate; - (): Certificate; - } - - export var fips: boolean; - - export interface CredentialDetails { - pfx: string; - key: string; - passphrase: string; - cert: string; - ca: string | string[]; - crl: string | string[]; - ciphers: string; - } - export interface Credentials { context?: any; } - export function createCredentials(details: CredentialDetails): Credentials; - export function createHash(algorithm: string): Hash; - export function createHmac(algorithm: string, key: string | Buffer): Hmac; - - type Utf8AsciiLatin1Encoding = "utf8" | "ascii" | "latin1"; - type HexBase64Latin1Encoding = "latin1" | "hex" | "base64"; - type Utf8AsciiBinaryEncoding = "utf8" | "ascii" | "binary"; - type HexBase64BinaryEncoding = "binary" | "base64" | "hex"; - type ECDHKeyFormat = "compressed" | "uncompressed" | "hybrid"; - - export interface Hash extends NodeJS.ReadWriteStream { - update(data: string | Buffer): Hash; - update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Hash; - digest(): Buffer; - digest(encoding: HexBase64Latin1Encoding): string; - } - export interface Hmac extends NodeJS.ReadWriteStream { - update(data: string | Buffer): Hmac; - update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Hmac; - digest(): Buffer; - digest(encoding: HexBase64Latin1Encoding): string; - } - export function createCipher(algorithm: string, password: any): Cipher; - export function createCipheriv(algorithm: string, key: any, iv: any): Cipher; - export interface Cipher extends NodeJS.ReadWriteStream { - update(data: Buffer): Buffer; - update(data: string, input_encoding: Utf8AsciiBinaryEncoding): Buffer; - update(data: Buffer, input_encoding: any, output_encoding: HexBase64BinaryEncoding): string; - update(data: string, input_encoding: Utf8AsciiBinaryEncoding, output_encoding: HexBase64BinaryEncoding): string; - final(): Buffer; - final(output_encoding: string): string; - setAutoPadding(auto_padding?: boolean): void; - getAuthTag(): Buffer; - setAAD(buffer: Buffer): void; - } - export function createDecipher(algorithm: string, password: any): Decipher; - export function createDecipheriv(algorithm: string, key: any, iv: any): Decipher; - export interface Decipher extends NodeJS.ReadWriteStream { - update(data: Buffer): Buffer; - update(data: string, input_encoding: HexBase64BinaryEncoding): Buffer; - update(data: Buffer, input_encoding: any, output_encoding: Utf8AsciiBinaryEncoding): string; - update(data: string, input_encoding: HexBase64BinaryEncoding, output_encoding: Utf8AsciiBinaryEncoding): string; - final(): Buffer; - final(output_encoding: string): string; - setAutoPadding(auto_padding?: boolean): void; - setAuthTag(tag: Buffer): void; - setAAD(buffer: Buffer): void; - } - export function createSign(algorithm: string): Signer; - export interface Signer extends NodeJS.WritableStream { - update(data: string | Buffer): Signer; - update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Signer; - sign(private_key: string | { key: string; passphrase: string }): Buffer; - sign(private_key: string | { key: string; passphrase: string }, output_format: HexBase64Latin1Encoding): string; - } - export function createVerify(algorith: string): Verify; - export interface Verify extends NodeJS.WritableStream { - update(data: string | Buffer): Verify; - update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Verify; - verify(object: string, signature: Buffer): boolean; - verify(object: string, signature: string, signature_format: HexBase64Latin1Encoding): boolean; - } - export function createDiffieHellman(prime_length: number, generator?: number): DiffieHellman; - export function createDiffieHellman(prime: Buffer): DiffieHellman; - export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding): DiffieHellman; - export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: number | Buffer): DiffieHellman; - export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: string, generator_encoding: HexBase64Latin1Encoding): DiffieHellman; - export interface DiffieHellman { - generateKeys(): Buffer; - generateKeys(encoding: HexBase64Latin1Encoding): string; - computeSecret(other_public_key: Buffer): Buffer; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string; - getPrime(): Buffer; - getPrime(encoding: HexBase64Latin1Encoding): string; - getGenerator(): Buffer; - getGenerator(encoding: HexBase64Latin1Encoding): string; - getPublicKey(): Buffer; - getPublicKey(encoding: HexBase64Latin1Encoding): string; - getPrivateKey(): Buffer; - getPrivateKey(encoding: HexBase64Latin1Encoding): string; - setPublicKey(public_key: Buffer): void; - setPublicKey(public_key: string, encoding: string): void; - setPrivateKey(private_key: Buffer): void; - setPrivateKey(private_key: string, encoding: string): void; - verifyError: number; - } - export function getDiffieHellman(group_name: string): DiffieHellman; - export function pbkdf2(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, digest: string, callback: (err: Error, derivedKey: Buffer) => any): void; - export function pbkdf2Sync(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, digest: string): Buffer; - export function randomBytes(size: number): Buffer; - export function randomBytes(size: number, callback: (err: Error, buf: Buffer) => void): void; - export function pseudoRandomBytes(size: number): Buffer; - export function pseudoRandomBytes(size: number, callback: (err: Error, buf: Buffer) => void): void; - export interface RsaPublicKey { - key: string; - padding?: number; - } - export interface RsaPrivateKey { - key: string; - passphrase?: string, - padding?: number; - } - export function publicEncrypt(public_key: string | RsaPublicKey, buffer: Buffer): Buffer - export function privateDecrypt(private_key: string | RsaPrivateKey, buffer: Buffer): Buffer - export function privateEncrypt(private_key: string | RsaPrivateKey, buffer: Buffer): Buffer - export function publicDecrypt(public_key: string | RsaPublicKey, buffer: Buffer): Buffer - export function getCiphers(): string[]; - export function getCurves(): string[]; - export function getHashes(): string[]; - export interface ECDH { - generateKeys(): Buffer; - generateKeys(encoding: HexBase64Latin1Encoding): string; - generateKeys(encoding: HexBase64Latin1Encoding, format: ECDHKeyFormat): string; - computeSecret(other_public_key: Buffer): Buffer; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string; - getPrivateKey(): Buffer; - getPrivateKey(encoding: HexBase64Latin1Encoding): string; - getPublicKey(): Buffer; - getPublicKey(encoding: HexBase64Latin1Encoding): string; - getPublicKey(encoding: HexBase64Latin1Encoding, format: ECDHKeyFormat): string; - setPrivateKey(private_key: Buffer): void; - setPrivateKey(private_key: string, encoding: HexBase64Latin1Encoding): void; - } - export function createECDH(curve_name: string): ECDH; - export var DEFAULT_ENCODING: string; -} - -declare module "stream" { - import * as events from "events"; - - class internal extends events.EventEmitter { - pipe(destination: T, options?: { end?: boolean; }): T; - } - namespace internal { - - export class Stream extends internal { } - - export interface ReadableOptions { - highWaterMark?: number; - encoding?: string; - objectMode?: boolean; - read?: (size?: number) => any; - } - - export class Readable extends events.EventEmitter implements NodeJS.ReadableStream { - readable: boolean; - constructor(opts?: ReadableOptions); - _read(size: number): void; - read(size?: number): any; - setEncoding(encoding: string): void; - pause(): Readable; - resume(): Readable; - pipe(destination: T, options?: { end?: boolean; }): T; - unpipe(destination?: T): void; - unshift(chunk: any): void; - wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream; - push(chunk: any, encoding?: string): boolean; - - /** - * Event emitter - * The defined events on documents including: - * 1. close - * 2. data - * 3. end - * 4. readable - * 5. error - **/ - addListener(event: string, listener: Function): this; - addListener(event: string, listener: Function): this; - addListener(event: "close", listener: () => void): this; - addListener(event: "data", listener: (chunk: Buffer | string) => void): this; - addListener(event: "end", listener: () => void): this; - addListener(event: "readable", listener: () => void): this; - addListener(event: "error", listener: (err: Error) => void): this; - - emit(event: string, ...args: any[]): boolean; - emit(event: "close"): boolean; - emit(event: "data", chunk: Buffer | string): boolean; - emit(event: "end"): boolean; - emit(event: "readable"): boolean; - emit(event: "error", err: Error): boolean; - - on(event: string, listener: Function): this; - on(event: "close", listener: () => void): this; - on(event: "data", listener: (chunk: Buffer | string) => void): this; - on(event: "end", listener: () => void): this; - on(event: "readable", listener: () => void): this; - on(event: "error", listener: (err: Error) => void): this; - - once(event: string, listener: Function): this; - once(event: "close", listener: () => void): this; - once(event: "data", listener: (chunk: Buffer | string) => void): this; - once(event: "end", listener: () => void): this; - once(event: "readable", listener: () => void): this; - once(event: "error", listener: (err: Error) => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "close", listener: () => void): this; - prependListener(event: "data", listener: (chunk: Buffer | string) => void): this; - prependListener(event: "end", listener: () => void): this; - prependListener(event: "readable", listener: () => void): this; - prependListener(event: "error", listener: (err: Error) => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "close", listener: () => void): this; - prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this; - prependOnceListener(event: "end", listener: () => void): this; - prependOnceListener(event: "readable", listener: () => void): this; - prependOnceListener(event: "error", listener: (err: Error) => void): this; - - removeListener(event: string, listener: Function): this; - removeListener(event: "close", listener: () => void): this; - removeListener(event: "data", listener: (chunk: Buffer | string) => void): this; - removeListener(event: "end", listener: () => void): this; - removeListener(event: "readable", listener: () => void): this; - removeListener(event: "error", listener: (err: Error) => void): this; - } - - export interface WritableOptions { - highWaterMark?: number; - decodeStrings?: boolean; - objectMode?: boolean; - write?: (chunk: string | Buffer, encoding: string, callback: Function) => any; - writev?: (chunks: { chunk: string | Buffer, encoding: string }[], callback: Function) => any; - } - - export class Writable extends events.EventEmitter implements NodeJS.WritableStream { - writable: boolean; - constructor(opts?: WritableOptions); - _write(chunk: any, encoding: string, callback: Function): void; - write(chunk: any, cb?: Function): boolean; - write(chunk: any, encoding?: string, cb?: Function): boolean; - end(): void; - end(chunk: any, cb?: Function): void; - end(chunk: any, encoding?: string, cb?: Function): void; - - /** - * Event emitter - * The defined events on documents including: - * 1. close - * 2. drain - * 3. error - * 4. finish - * 5. pipe - * 6. unpipe - **/ - addListener(event: string, listener: Function): this; - addListener(event: "close", listener: () => void): this; - addListener(event: "drain", listener: () => void): this; - addListener(event: "error", listener: (err: Error) => void): this; - addListener(event: "finish", listener: () => void): this; - addListener(event: "pipe", listener: (src: Readable) => void): this; - addListener(event: "unpipe", listener: (src: Readable) => void): this; - - emit(event: string, ...args: any[]): boolean; - emit(event: "close"): boolean; - emit(event: "drain", chunk: Buffer | string): boolean; - emit(event: "error", err: Error): boolean; - emit(event: "finish"): boolean; - emit(event: "pipe", src: Readable): boolean; - emit(event: "unpipe", src: Readable): boolean; - - on(event: string, listener: Function): this; - on(event: "close", listener: () => void): this; - on(event: "drain", listener: () => void): this; - on(event: "error", listener: (err: Error) => void): this; - on(event: "finish", listener: () => void): this; - on(event: "pipe", listener: (src: Readable) => void): this; - on(event: "unpipe", listener: (src: Readable) => void): this; - - once(event: string, listener: Function): this; - once(event: "close", listener: () => void): this; - once(event: "drain", listener: () => void): this; - once(event: "error", listener: (err: Error) => void): this; - once(event: "finish", listener: () => void): this; - once(event: "pipe", listener: (src: Readable) => void): this; - once(event: "unpipe", listener: (src: Readable) => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "close", listener: () => void): this; - prependListener(event: "drain", listener: () => void): this; - prependListener(event: "error", listener: (err: Error) => void): this; - prependListener(event: "finish", listener: () => void): this; - prependListener(event: "pipe", listener: (src: Readable) => void): this; - prependListener(event: "unpipe", listener: (src: Readable) => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "close", listener: () => void): this; - prependOnceListener(event: "drain", listener: () => void): this; - prependOnceListener(event: "error", listener: (err: Error) => void): this; - prependOnceListener(event: "finish", listener: () => void): this; - prependOnceListener(event: "pipe", listener: (src: Readable) => void): this; - prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this; - - removeListener(event: string, listener: Function): this; - removeListener(event: "close", listener: () => void): this; - removeListener(event: "drain", listener: () => void): this; - removeListener(event: "error", listener: (err: Error) => void): this; - removeListener(event: "finish", listener: () => void): this; - removeListener(event: "pipe", listener: (src: Readable) => void): this; - removeListener(event: "unpipe", listener: (src: Readable) => void): this; - } - - export interface DuplexOptions extends ReadableOptions, WritableOptions { - allowHalfOpen?: boolean; - readableObjectMode?: boolean; - writableObjectMode?: boolean; - } - - // Note: Duplex extends both Readable and Writable. - export class Duplex extends Readable implements NodeJS.ReadWriteStream { - // Readable - pause(): Duplex; - resume(): Duplex; - // Writeable - writable: boolean; - constructor(opts?: DuplexOptions); - _write(chunk: any, encoding: string, callback: Function): void; - write(chunk: any, cb?: Function): boolean; - write(chunk: any, encoding?: string, cb?: Function): boolean; - end(): void; - end(chunk: any, cb?: Function): void; - end(chunk: any, encoding?: string, cb?: Function): void; - } - - export interface TransformOptions extends ReadableOptions, WritableOptions { - transform?: (chunk: string | Buffer, encoding: string, callback: Function) => any; - flush?: (callback: Function) => any; - } - - // Note: Transform lacks the _read and _write methods of Readable/Writable. - export class Transform extends events.EventEmitter implements NodeJS.ReadWriteStream { - readable: boolean; - writable: boolean; - constructor(opts?: TransformOptions); - _transform(chunk: any, encoding: string, callback: Function): void; - _flush(callback: Function): void; - read(size?: number): any; - setEncoding(encoding: string): void; - pause(): Transform; - resume(): Transform; - pipe(destination: T, options?: { end?: boolean; }): T; - unpipe(destination?: T): void; - unshift(chunk: any): void; - wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream; - push(chunk: any, encoding?: string): boolean; - write(chunk: any, cb?: Function): boolean; - write(chunk: any, encoding?: string, cb?: Function): boolean; - end(): void; - end(chunk: any, cb?: Function): void; - end(chunk: any, encoding?: string, cb?: Function): void; - } - - export class PassThrough extends Transform { } - } - - export = internal; -} - -declare module "util" { - export interface InspectOptions { - showHidden?: boolean; - depth?: number; - colors?: boolean; - customInspect?: boolean; - } - - export function format(format: any, ...param: any[]): string; - export function debug(string: string): void; - export function error(...param: any[]): void; - export function puts(...param: any[]): void; - export function print(...param: any[]): void; - export function log(string: string): void; - export function inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string; - export function inspect(object: any, options: InspectOptions): string; - export function isArray(object: any): boolean; - export function isRegExp(object: any): boolean; - export function isDate(object: any): boolean; - export function isError(object: any): boolean; - export function inherits(constructor: any, superConstructor: any): void; - export function debuglog(key: string): (msg: string, ...param: any[]) => void; - export function isBoolean(object: any): boolean; - export function isBuffer(object: any): boolean; - export function isFunction(object: any): boolean; - export function isNull(object: any): boolean; - export function isNullOrUndefined(object: any): boolean; - export function isNumber(object: any): boolean; - export function isObject(object: any): boolean; - export function isPrimitive(object: any): boolean; - export function isString(object: any): boolean; - export function isSymbol(object: any): boolean; - export function isUndefined(object: any): boolean; - export function deprecate(fn: Function, message: string): Function; -} - -declare module "assert" { - function internal(value: any, message?: string): void; - namespace internal { - export class AssertionError implements Error { - name: string; - message: string; - actual: any; - expected: any; - operator: string; - generatedMessage: boolean; - - constructor(options?: { - message?: string; actual?: any; expected?: any; - operator?: string; stackStartFunction?: Function - }); - } - - export function fail(actual: any, expected: any, message: string, operator: string): void; - export function ok(value: any, message?: string): void; - export function equal(actual: any, expected: any, message?: string): void; - export function notEqual(actual: any, expected: any, message?: string): void; - export function deepEqual(actual: any, expected: any, message?: string): void; - export function notDeepEqual(acutal: any, expected: any, message?: string): void; - export function strictEqual(actual: any, expected: any, message?: string): void; - export function notStrictEqual(actual: any, expected: any, message?: string): void; - export function deepStrictEqual(actual: any, expected: any, message?: string): void; - export function notDeepStrictEqual(actual: any, expected: any, message?: string): void; - export var throws: { - (block: Function, message?: string): void; - (block: Function, error: Function, message?: string): void; - (block: Function, error: RegExp, message?: string): void; - (block: Function, error: (err: any) => boolean, message?: string): void; - }; - - export var doesNotThrow: { - (block: Function, message?: string): void; - (block: Function, error: Function, message?: string): void; - (block: Function, error: RegExp, message?: string): void; - (block: Function, error: (err: any) => boolean, message?: string): void; - }; - - export function ifError(value: any): void; - } - - export = internal; -} - -declare module "tty" { - import * as net from "net"; - - export function isatty(fd: number): boolean; - export interface ReadStream extends net.Socket { - isRaw: boolean; - setRawMode(mode: boolean): void; - isTTY: boolean; - } - export interface WriteStream extends net.Socket { - columns: number; - rows: number; - isTTY: boolean; - } -} - -declare module "domain" { - import * as events from "events"; - - export class Domain extends events.EventEmitter implements NodeJS.Domain { - run(fn: Function): void; - add(emitter: events.EventEmitter): void; - remove(emitter: events.EventEmitter): void; - bind(cb: (err: Error, data: any) => any): any; - intercept(cb: (data: any) => any): any; - dispose(): void; - members: any[]; - enter(): void; - exit(): void; - } - - export function create(): Domain; -} - -declare module "constants" { - export var E2BIG: number; - export var EACCES: number; - export var EADDRINUSE: number; - export var EADDRNOTAVAIL: number; - export var EAFNOSUPPORT: number; - export var EAGAIN: number; - export var EALREADY: number; - export var EBADF: number; - export var EBADMSG: number; - export var EBUSY: number; - export var ECANCELED: number; - export var ECHILD: number; - export var ECONNABORTED: number; - export var ECONNREFUSED: number; - export var ECONNRESET: number; - export var EDEADLK: number; - export var EDESTADDRREQ: number; - export var EDOM: number; - export var EEXIST: number; - export var EFAULT: number; - export var EFBIG: number; - export var EHOSTUNREACH: number; - export var EIDRM: number; - export var EILSEQ: number; - export var EINPROGRESS: number; - export var EINTR: number; - export var EINVAL: number; - export var EIO: number; - export var EISCONN: number; - export var EISDIR: number; - export var ELOOP: number; - export var EMFILE: number; - export var EMLINK: number; - export var EMSGSIZE: number; - export var ENAMETOOLONG: number; - export var ENETDOWN: number; - export var ENETRESET: number; - export var ENETUNREACH: number; - export var ENFILE: number; - export var ENOBUFS: number; - export var ENODATA: number; - export var ENODEV: number; - export var ENOENT: number; - export var ENOEXEC: number; - export var ENOLCK: number; - export var ENOLINK: number; - export var ENOMEM: number; - export var ENOMSG: number; - export var ENOPROTOOPT: number; - export var ENOSPC: number; - export var ENOSR: number; - export var ENOSTR: number; - export var ENOSYS: number; - export var ENOTCONN: number; - export var ENOTDIR: number; - export var ENOTEMPTY: number; - export var ENOTSOCK: number; - export var ENOTSUP: number; - export var ENOTTY: number; - export var ENXIO: number; - export var EOPNOTSUPP: number; - export var EOVERFLOW: number; - export var EPERM: number; - export var EPIPE: number; - export var EPROTO: number; - export var EPROTONOSUPPORT: number; - export var EPROTOTYPE: number; - export var ERANGE: number; - export var EROFS: number; - export var ESPIPE: number; - export var ESRCH: number; - export var ETIME: number; - export var ETIMEDOUT: number; - export var ETXTBSY: number; - export var EWOULDBLOCK: number; - export var EXDEV: number; - export var WSAEINTR: number; - export var WSAEBADF: number; - export var WSAEACCES: number; - export var WSAEFAULT: number; - export var WSAEINVAL: number; - export var WSAEMFILE: number; - export var WSAEWOULDBLOCK: number; - export var WSAEINPROGRESS: number; - export var WSAEALREADY: number; - export var WSAENOTSOCK: number; - export var WSAEDESTADDRREQ: number; - export var WSAEMSGSIZE: number; - export var WSAEPROTOTYPE: number; - export var WSAENOPROTOOPT: number; - export var WSAEPROTONOSUPPORT: number; - export var WSAESOCKTNOSUPPORT: number; - export var WSAEOPNOTSUPP: number; - export var WSAEPFNOSUPPORT: number; - export var WSAEAFNOSUPPORT: number; - export var WSAEADDRINUSE: number; - export var WSAEADDRNOTAVAIL: number; - export var WSAENETDOWN: number; - export var WSAENETUNREACH: number; - export var WSAENETRESET: number; - export var WSAECONNABORTED: number; - export var WSAECONNRESET: number; - export var WSAENOBUFS: number; - export var WSAEISCONN: number; - export var WSAENOTCONN: number; - export var WSAESHUTDOWN: number; - export var WSAETOOMANYREFS: number; - export var WSAETIMEDOUT: number; - export var WSAECONNREFUSED: number; - export var WSAELOOP: number; - export var WSAENAMETOOLONG: number; - export var WSAEHOSTDOWN: number; - export var WSAEHOSTUNREACH: number; - export var WSAENOTEMPTY: number; - export var WSAEPROCLIM: number; - export var WSAEUSERS: number; - export var WSAEDQUOT: number; - export var WSAESTALE: number; - export var WSAEREMOTE: number; - export var WSASYSNOTREADY: number; - export var WSAVERNOTSUPPORTED: number; - export var WSANOTINITIALISED: number; - export var WSAEDISCON: number; - export var WSAENOMORE: number; - export var WSAECANCELLED: number; - export var WSAEINVALIDPROCTABLE: number; - export var WSAEINVALIDPROVIDER: number; - export var WSAEPROVIDERFAILEDINIT: number; - export var WSASYSCALLFAILURE: number; - export var WSASERVICE_NOT_FOUND: number; - export var WSATYPE_NOT_FOUND: number; - export var WSA_E_NO_MORE: number; - export var WSA_E_CANCELLED: number; - export var WSAEREFUSED: number; - export var SIGHUP: number; - export var SIGINT: number; - export var SIGILL: number; - export var SIGABRT: number; - export var SIGFPE: number; - export var SIGKILL: number; - export var SIGSEGV: number; - export var SIGTERM: number; - export var SIGBREAK: number; - export var SIGWINCH: number; - export var SSL_OP_ALL: number; - export var SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number; - export var SSL_OP_CIPHER_SERVER_PREFERENCE: number; - export var SSL_OP_CISCO_ANYCONNECT: number; - export var SSL_OP_COOKIE_EXCHANGE: number; - export var SSL_OP_CRYPTOPRO_TLSEXT_BUG: number; - export var SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number; - export var SSL_OP_EPHEMERAL_RSA: number; - export var SSL_OP_LEGACY_SERVER_CONNECT: number; - export var SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number; - export var SSL_OP_MICROSOFT_SESS_ID_BUG: number; - export var SSL_OP_MSIE_SSLV2_RSA_PADDING: number; - export var SSL_OP_NETSCAPE_CA_DN_BUG: number; - export var SSL_OP_NETSCAPE_CHALLENGE_BUG: number; - export var SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number; - export var SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number; - export var SSL_OP_NO_COMPRESSION: number; - export var SSL_OP_NO_QUERY_MTU: number; - export var SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number; - export var SSL_OP_NO_SSLv2: number; - export var SSL_OP_NO_SSLv3: number; - export var SSL_OP_NO_TICKET: number; - export var SSL_OP_NO_TLSv1: number; - export var SSL_OP_NO_TLSv1_1: number; - export var SSL_OP_NO_TLSv1_2: number; - export var SSL_OP_PKCS1_CHECK_1: number; - export var SSL_OP_PKCS1_CHECK_2: number; - export var SSL_OP_SINGLE_DH_USE: number; - export var SSL_OP_SINGLE_ECDH_USE: number; - export var SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number; - export var SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number; - export var SSL_OP_TLS_BLOCK_PADDING_BUG: number; - export var SSL_OP_TLS_D5_BUG: number; - export var SSL_OP_TLS_ROLLBACK_BUG: number; - export var ENGINE_METHOD_DSA: number; - export var ENGINE_METHOD_DH: number; - export var ENGINE_METHOD_RAND: number; - export var ENGINE_METHOD_ECDH: number; - export var ENGINE_METHOD_ECDSA: number; - export var ENGINE_METHOD_CIPHERS: number; - export var ENGINE_METHOD_DIGESTS: number; - export var ENGINE_METHOD_STORE: number; - export var ENGINE_METHOD_PKEY_METHS: number; - export var ENGINE_METHOD_PKEY_ASN1_METHS: number; - export var ENGINE_METHOD_ALL: number; - export var ENGINE_METHOD_NONE: number; - export var DH_CHECK_P_NOT_SAFE_PRIME: number; - export var DH_CHECK_P_NOT_PRIME: number; - export var DH_UNABLE_TO_CHECK_GENERATOR: number; - export var DH_NOT_SUITABLE_GENERATOR: number; - export var NPN_ENABLED: number; - export var RSA_PKCS1_PADDING: number; - export var RSA_SSLV23_PADDING: number; - export var RSA_NO_PADDING: number; - export var RSA_PKCS1_OAEP_PADDING: number; - export var RSA_X931_PADDING: number; - export var RSA_PKCS1_PSS_PADDING: number; - export var POINT_CONVERSION_COMPRESSED: number; - export var POINT_CONVERSION_UNCOMPRESSED: number; - export var POINT_CONVERSION_HYBRID: number; - export var O_RDONLY: number; - export var O_WRONLY: number; - export var O_RDWR: number; - export var S_IFMT: number; - export var S_IFREG: number; - export var S_IFDIR: number; - export var S_IFCHR: number; - export var S_IFBLK: number; - export var S_IFIFO: number; - export var S_IFSOCK: number; - export var S_IRWXU: number; - export var S_IRUSR: number; - export var S_IWUSR: number; - export var S_IXUSR: number; - export var S_IRWXG: number; - export var S_IRGRP: number; - export var S_IWGRP: number; - export var S_IXGRP: number; - export var S_IRWXO: number; - export var S_IROTH: number; - export var S_IWOTH: number; - export var S_IXOTH: number; - export var S_IFLNK: number; - export var O_CREAT: number; - export var O_EXCL: number; - export var O_NOCTTY: number; - export var O_DIRECTORY: number; - export var O_NOATIME: number; - export var O_NOFOLLOW: number; - export var O_SYNC: number; - export var O_SYMLINK: number; - export var O_DIRECT: number; - export var O_NONBLOCK: number; - export var O_TRUNC: number; - export var O_APPEND: number; - export var F_OK: number; - export var R_OK: number; - export var W_OK: number; - export var X_OK: number; - export var UV_UDP_REUSEADDR: number; - export var SIGQUIT: number; - export var SIGTRAP: number; - export var SIGIOT: number; - export var SIGBUS: number; - export var SIGUSR1: number; - export var SIGUSR2: number; - export var SIGPIPE: number; - export var SIGALRM: number; - export var SIGCHLD: number; - export var SIGSTKFLT: number; - export var SIGCONT: number; - export var SIGSTOP: number; - export var SIGTSTP: number; - export var SIGTTIN: number; - export var SIGTTOU: number; - export var SIGURG: number; - export var SIGXCPU: number; - export var SIGXFSZ: number; - export var SIGVTALRM: number; - export var SIGPROF: number; - export var SIGIO: number; - export var SIGPOLL: number; - export var SIGPWR: number; - export var SIGSYS: number; - export var SIGUNUSED: number; - export var defaultCoreCipherList: string; - export var defaultCipherList: string; - export var ENGINE_METHOD_RSA: number; - export var ALPN_ENABLED: number; -} - -declare module "process" { - export = process; -} - -declare module "v8" { - interface HeapSpaceInfo { - space_name: string; - space_size: number; - space_used_size: number; - space_available_size: number; - physical_space_size: number; - } - export function getHeapStatistics(): { total_heap_size: number, total_heap_size_executable: number, total_physical_size: number, total_avaialble_size: number, used_heap_size: number, heap_size_limit: number }; - export function getHeapSpaceStatistics(): HeapSpaceInfo[]; - export function setFlagsFromString(flags: string): void; -} - -declare module "timers" { - export function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; - export function clearTimeout(timeoutId: NodeJS.Timer): void; - export function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; - export function clearInterval(intervalId: NodeJS.Timer): void; - export function setImmediate(callback: (...args: any[]) => void, ...args: any[]): any; - export function clearImmediate(immediateId: any): void; -} - -declare module "console" { - export = console; -} \ No newline at end of file diff --git a/Tasks/Common/azurerest-common/globals/node/typings.json b/Tasks/Common/azurerest-common/globals/node/typings.json deleted file mode 100644 index 98c1869d1d0a..000000000000 --- a/Tasks/Common/azurerest-common/globals/node/typings.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "resolution": "main", - "tree": { - "src": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/ab8d917787092fdfb16390f2bee6de8ab5c1783c/node/node.d.ts", - "raw": "registry:dt/node#6.0.0+20160920093002", - "typings": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/ab8d917787092fdfb16390f2bee6de8ab5c1783c/node/node.d.ts" - } -} diff --git a/Tasks/Common/azurerest-common/globals/q/index.d.ts b/Tasks/Common/azurerest-common/globals/q/index.d.ts deleted file mode 100644 index 4449c31841ff..000000000000 --- a/Tasks/Common/azurerest-common/globals/q/index.d.ts +++ /dev/null @@ -1,357 +0,0 @@ -// Generated by typings -// Source: https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/623f30ab194a3486e014ca39bc7f2089897d6ce4/q/Q.d.ts -declare function Q(promise: Q.IPromise): Q.Promise; -/** - * If value is not a promise, returns a promise that is fulfilled with value. - */ -declare function Q(value: T): Q.Promise; - -declare namespace Q { - interface IPromise { - then(onFulfill?: (value: T) => U | IPromise, onReject?: (error: any) => U | IPromise): IPromise; - } - - interface Deferred { - promise: Promise; - resolve(value?: T): void; - resolve(value?: IPromise): void; - reject(reason: any): void; - notify(value: any): void; - makeNodeResolver(): (reason: any, value: T) => void; - } - - interface Promise { - /** - * Like a finally clause, allows you to observe either the fulfillment or rejection of a promise, but to do so without modifying the final value. This is useful for collecting resources regardless of whether a job succeeded, like closing a database connection, shutting a server down, or deleting an unneeded key from an object. - - * finally returns a promise, which will become resolved with the same fulfillment value or rejection reason as promise. However, if callback returns a promise, the resolution of the returned promise will be delayed until the promise returned from callback is finished. - */ - fin(finallyCallback: () => any): Promise; - /** - * Like a finally clause, allows you to observe either the fulfillment or rejection of a promise, but to do so without modifying the final value. This is useful for collecting resources regardless of whether a job succeeded, like closing a database connection, shutting a server down, or deleting an unneeded key from an object. - - * finally returns a promise, which will become resolved with the same fulfillment value or rejection reason as promise. However, if callback returns a promise, the resolution of the returned promise will be delayed until the promise returned from callback is finished. - */ - finally(finallyCallback: () => any): Promise; - - /** - * The then method from the Promises/A+ specification, with an additional progress handler. - */ - then(onFulfill?: (value: T) => U | IPromise, onReject?: (error: any) => U | IPromise, onProgress?: Function): Promise; - - /** - * Like then, but "spreads" the array into a variadic fulfillment handler. If any of the promises in the array are rejected, instead calls onRejected with the first rejected promise's rejection reason. - * - * This is especially useful in conjunction with all - */ - spread(onFulfill: (...args: any[]) => IPromise | U, onReject?: (reason: any) => IPromise | U): Promise; - - fail(onRejected: (reason: any) => U | IPromise): Promise; - - /** - * A sugar method, equivalent to promise.then(undefined, onRejected). - */ - catch(onRejected: (reason: any) => U | IPromise): Promise; - - /** - * A sugar method, equivalent to promise.then(undefined, undefined, onProgress). - */ - progress(onProgress: (progress: any) => any): Promise; - - /** - * Much like then, but with different behavior around unhandled rejection. If there is an unhandled rejection, either because promise is rejected and no onRejected callback was provided, or because onFulfilled or onRejected threw an error or returned a rejected promise, the resulting rejection reason is thrown as an exception in a future turn of the event loop. - * - * This method should be used to terminate chains of promises that will not be passed elsewhere. Since exceptions thrown in then callbacks are consumed and transformed into rejections, exceptions at the end of the chain are easy to accidentally, silently ignore. By arranging for the exception to be thrown in a future turn of the event loop, so that it won't be caught, it causes an onerror event on the browser window, or an uncaughtException event on Node.js's process object. - * - * Exceptions thrown by done will have long stack traces, if Q.longStackSupport is set to true. If Q.onerror is set, exceptions will be delivered there instead of thrown in a future turn. - * - * The Golden Rule of done vs. then usage is: either return your promise to someone else, or if the chain ends with you, call done to terminate it. - */ - done(onFulfilled?: (value: T) => any, onRejected?: (reason: any) => any, onProgress?: (progress: any) => any): void; - - /** - * If callback is a function, assumes it's a Node.js-style callback, and calls it as either callback(rejectionReason) when/if promise becomes rejected, or as callback(null, fulfillmentValue) when/if promise becomes fulfilled. If callback is not a function, simply returns promise. - */ - nodeify(callback: (reason: any, value: any) => void): Promise; - - /** - * Returns a promise to get the named property of an object. Essentially equivalent to - * - * promise.then(function (o) { - * return o[propertyName]; - * }); - */ - get(propertyName: String): Promise; - set(propertyName: String, value: any): Promise; - delete(propertyName: String): Promise; - /** - * Returns a promise for the result of calling the named method of an object with the given array of arguments. The object itself is this in the function, just like a synchronous method call. Essentially equivalent to - * - * promise.then(function (o) { - * return o[methodName].apply(o, args); - * }); - */ - post(methodName: String, args: any[]): Promise; - /** - * Returns a promise for the result of calling the named method of an object with the given variadic arguments. The object itself is this in the function, just like a synchronous method call. - */ - invoke(methodName: String, ...args: any[]): Promise; - fapply(args: any[]): Promise; - fcall(...args: any[]): Promise; - - /** - * Returns a promise for an array of the property names of an object. Essentially equivalent to - * - * promise.then(function (o) { - * return Object.keys(o); - * }); - */ - keys(): Promise; - - /** - * A sugar method, equivalent to promise.then(function () { return value; }). - */ - thenResolve(value: U): Promise; - /** - * A sugar method, equivalent to promise.then(function () { throw reason; }). - */ - thenReject(reason: any): Promise; - - /** - * Attaches a handler that will observe the value of the promise when it becomes fulfilled, returning a promise for that same value, perhaps deferred but not replaced by the promise returned by the onFulfilled handler. - */ - tap(onFulfilled: (value: T) => any): Promise; - - timeout(ms: number, message?: string): Promise; - /** - * Returns a promise that will have the same result as promise, but will only be fulfilled or rejected after at least ms milliseconds have passed. - */ - delay(ms: number): Promise; - - /** - * Returns whether a given promise is in the fulfilled state. When the static version is used on non-promises, the result is always true. - */ - isFulfilled(): boolean; - /** - * Returns whether a given promise is in the rejected state. When the static version is used on non-promises, the result is always false. - */ - isRejected(): boolean; - /** - * Returns whether a given promise is in the pending state. When the static version is used on non-promises, the result is always false. - */ - isPending(): boolean; - - valueOf(): any; - - /** - * Returns a "state snapshot" object, which will be in one of three forms: - * - * - { state: "pending" } - * - { state: "fulfilled", value: } - * - { state: "rejected", reason: } - */ - inspect(): PromiseState; - } - - interface PromiseState { - /** - * "fulfilled", "rejected", "pending" - */ - state: string; - value?: T; - reason?: any; - } - - // If no value provided, returned promise will be of void type - export function when(): Promise; - - // if no fulfill, reject, or progress provided, returned promise will be of same type - export function when(value: T | IPromise): Promise; - - // If a non-promise value is provided, it will not reject or progress - export function when(value: T | IPromise, onFulfilled: (val: T) => U | IPromise, onRejected?: (reason: any) => U | IPromise, onProgress?: (progress: any) => any): Promise; - - /** - * Currently "impossible" (and I use the term loosely) to implement due to TypeScript limitations as it is now. - * See: https://github.com/Microsoft/TypeScript/issues/1784 for discussion on it. - */ - // export function try(method: Function, ...args: any[]): Promise; - - export function fbind(method: (...args: any[]) => T | IPromise, ...args: any[]): (...args: any[]) => Promise; - - export function fcall(method: (...args: any[]) => T, ...args: any[]): Promise; - - export function send(obj: any, functionName: string, ...args: any[]): Promise; - export function invoke(obj: any, functionName: string, ...args: any[]): Promise; - export function mcall(obj: any, functionName: string, ...args: any[]): Promise; - - export function denodeify(nodeFunction: Function, ...args: any[]): (...args: any[]) => Promise; - export function nbind(nodeFunction: Function, thisArg: any, ...args: any[]): (...args: any[]) => Promise; - export function nfbind(nodeFunction: Function, ...args: any[]): (...args: any[]) => Promise; - export function nfcall(nodeFunction: Function, ...args: any[]): Promise; - export function nfapply(nodeFunction: Function, args: any[]): Promise; - - export function ninvoke(nodeModule: any, functionName: string, ...args: any[]): Promise; - export function npost(nodeModule: any, functionName: string, args: any[]): Promise; - export function nsend(nodeModule: any, functionName: string, ...args: any[]): Promise; - export function nmcall(nodeModule: any, functionName: string, ...args: any[]): Promise; - - /** - * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. - */ - export function all(promises: [IPromise, IPromise, IPromise, IPromise, IPromise, IPromise]): Promise<[A, B, C, D, E, F]>; - /** - * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. - */ - export function all(promises: [IPromise, IPromise, IPromise, IPromise, IPromise]): Promise<[A, B, C, D, E]>; - /** - * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. - */ - export function all(promises: [IPromise, IPromise, IPromise, IPromise]): Promise<[A, B, C, D]>; - /** - * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. - */ - export function all(promises: [IPromise, IPromise, IPromise]): Promise<[A, B, C]>; - /** - * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. - */ - export function all(promises: [IPromise, IPromise]): Promise<[A, B]>; - /** - * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. - */ - export function all(promises: IPromise[]): Promise; - - /** - * Returns a promise for the first of an array of promises to become settled. - */ - export function race(promises: IPromise[]): Promise; - - /** - * Returns a promise that is fulfilled with an array of promise state snapshots, but only after all the original promises have settled, i.e. become either fulfilled or rejected. - */ - export function allSettled(promises: IPromise[]): Promise[]>; - - export function allResolved(promises: IPromise[]): Promise[]>; - - /** - * Like then, but "spreads" the array into a variadic fulfillment handler. If any of the promises in the array are rejected, instead calls onRejected with the first rejected promise's rejection reason. - * This is especially useful in conjunction with all. - */ - export function spread(promises: IPromise[], onFulfilled: (...args: T[]) => U | IPromise, onRejected?: (reason: any) => U | IPromise): Promise; - - /** - * Returns a promise that will have the same result as promise, except that if promise is not fulfilled or rejected before ms milliseconds, the returned promise will be rejected with an Error with the given message. If message is not supplied, the message will be "Timed out after " + ms + " ms". - */ - export function timeout(promise: Promise, ms: number, message?: string): Promise; - - /** - * Returns a promise that will have the same result as promise, but will only be fulfilled or rejected after at least ms milliseconds have passed. - */ - export function delay(promise: Promise, ms: number): Promise; - /** - * Returns a promise that will have the same result as promise, but will only be fulfilled or rejected after at least ms milliseconds have passed. - */ - export function delay(value: T, ms: number): Promise; - /** - * Returns a promise that will be fulfilled with undefined after at least ms milliseconds have passed. - */ - export function delay(ms: number): Promise ; - /** - * Returns whether a given promise is in the fulfilled state. When the static version is used on non-promises, the result is always true. - */ - export function isFulfilled(promise: Promise): boolean; - /** - * Returns whether a given promise is in the rejected state. When the static version is used on non-promises, the result is always false. - */ - export function isRejected(promise: Promise): boolean; - /** - * Returns whether a given promise is in the pending state. When the static version is used on non-promises, the result is always false. - */ - export function isPending(promise: Promise): boolean; - - /** - * Returns a "deferred" object with a: - * promise property - * resolve(value) method - * reject(reason) method - * notify(value) method - * makeNodeResolver() method - */ - export function defer(): Deferred; - - /** - * Returns a promise that is rejected with reason. - */ - export function reject(reason?: any): Promise; - - export function Promise(resolver: (resolve: (val: T | IPromise) => void , reject: (reason: any) => void , notify: (progress: any) => void ) => void ): Promise; - - /** - * Creates a new version of func that accepts any combination of promise and non-promise values, converting them to their fulfillment values before calling the original func. The returned version also always returns a promise: if func does a return or throw, then Q.promised(func) will return fulfilled or rejected promise, respectively. - * - * This can be useful for creating functions that accept either promises or non-promise values, and for ensuring that the function always returns a promise even in the face of unintentional thrown exceptions. - */ - export function promised(callback: (...args: any[]) => T): (...args: any[]) => Promise; - - /** - * Returns whether the given value is a Q promise. - */ - export function isPromise(object: any): boolean; - /** - * Returns whether the given value is a promise (i.e. it's an object with a then function). - */ - export function isPromiseAlike(object: any): boolean; - /** - * Returns whether a given promise is in the pending state. When the static version is used on non-promises, the result is always false. - */ - export function isPending(object: any): boolean; - /** - * If an object is not a promise, it is as "near" as possible. - * If a promise is rejected, it is as "near" as possible too. - * If it’s a fulfilled promise, the fulfillment value is nearer. - * If it’s a deferred promise and the deferred has been resolved, the - * resolution is "nearer". - */ - export function nearer(promise: Promise): T; - - /** - * This is an experimental tool for converting a generator function into a deferred function. This has the potential of reducing nested callbacks in engines that support yield. - */ - export function async(generatorFunction: any): (...args: any[]) => Promise; - export function nextTick(callback: Function): void; - - /** - * A settable property that will intercept any uncaught errors that would otherwise be thrown in the next tick of the event loop, usually as a result of done. Can be useful for getting the full stack trace of an error in browsers, which is not usually possible with window.onerror. - */ - export var onerror: (reason: any) => void; - /** - * A settable property that lets you turn on long stack trace support. If turned on, "stack jumps" will be tracked across asynchronous promise operations, so that if an uncaught error is thrown by done or a rejection reason's stack property is inspected in a rejection callback, a long stack trace is produced. - */ - export var longStackSupport: boolean; - - /** - * Calling resolve with a pending promise causes promise to wait on the passed promise, becoming fulfilled with its fulfillment value or rejected with its rejection reason (or staying pending forever, if the passed promise does). - * Calling resolve with a rejected promise causes promise to be rejected with the passed promise's rejection reason. - * Calling resolve with a fulfilled promise causes promise to be fulfilled with the passed promise's fulfillment value. - * Calling resolve with a non-promise value causes promise to be fulfilled with that value. - */ - export function resolve(object: IPromise): Promise; - /** - * Calling resolve with a pending promise causes promise to wait on the passed promise, becoming fulfilled with its fulfillment value or rejected with its rejection reason (or staying pending forever, if the passed promise does). - * Calling resolve with a rejected promise causes promise to be rejected with the passed promise's rejection reason. - * Calling resolve with a fulfilled promise causes promise to be fulfilled with the passed promise's fulfillment value. - * Calling resolve with a non-promise value causes promise to be fulfilled with that value. - */ - export function resolve(object: T): Promise; - - /** - * Resets the global "Q" variable to the value it has before Q was loaded. - * This will either be undefined if there was no version or the version of Q which was already loaded before. - * @returns { The last version of Q. } - */ - export function noConflict(): typeof Q; -} - -declare module "q" { - export = Q; -} \ No newline at end of file diff --git a/Tasks/Common/azurerest-common/globals/q/typings.json b/Tasks/Common/azurerest-common/globals/q/typings.json deleted file mode 100644 index 3d59355a87e8..000000000000 --- a/Tasks/Common/azurerest-common/globals/q/typings.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "resolution": "main", - "tree": { - "src": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/623f30ab194a3486e014ca39bc7f2089897d6ce4/q/Q.d.ts", - "raw": "registry:dt/q#0.0.0+20160613154756", - "typings": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/623f30ab194a3486e014ca39bc7f2089897d6ce4/q/Q.d.ts" - } -} diff --git a/Tasks/Common/azurerest-common/index.d.ts b/Tasks/Common/azurerest-common/index.d.ts deleted file mode 100644 index bbb3a42c2b21..000000000000 --- a/Tasks/Common/azurerest-common/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -/// -/// diff --git a/Tasks/Common/azurerest-common/kududeploymentstatusutility.ts b/Tasks/Common/azurerest-common/kududeploymentstatusutility.ts deleted file mode 100644 index 081cf77f2563..000000000000 --- a/Tasks/Common/azurerest-common/kududeploymentstatusutility.ts +++ /dev/null @@ -1,98 +0,0 @@ -import tl = require('vsts-task-lib/task'); -var utility = require('./utility.js'); - -export function getUpdateHistoryRequest(webAppPublishKuduUrl: string, isDeploymentSuccess: boolean, customMessage, deploymentId: string): any { - - var status = isDeploymentSuccess ? 4 : 3; - var status_text = (status == 4) ? "success" : "failed"; - var author = getDeploymentAuthor(); - - var buildUrl = tl.getVariable('build.buildUri'); - var releaseUrl = tl.getVariable('release.releaseUri'); - - var buildId = tl.getVariable('build.buildId'); - var releaseId = tl.getVariable('release.releaseId'); - - var buildNumber = tl.getVariable('build.buildNumber'); - var releaseName = tl.getVariable('release.releaseName'); - - var collectionUrl = tl.getVariable('system.TeamFoundationCollectionUri'); - var teamProject = tl.getVariable('system.teamProjectId'); - - var commitId = tl.getVariable('build.sourceVersion'); - var repoName = tl.getVariable('build.repository.name'); - var repoProvider = tl.getVariable('build.repository.provider'); - - var buildOrReleaseUrl = "" ; - deploymentId = deploymentId ? deploymentId : utility.generateDeploymentId(); - - if(releaseUrl !== undefined) { - buildOrReleaseUrl = collectionUrl + teamProject + "/_apps/hub/ms.vss-releaseManagement-web.hub-explorer?releaseId=" + releaseId + "&_a=release-summary"; - } - else if(buildUrl !== undefined) { - buildOrReleaseUrl = collectionUrl + teamProject + "/_build?buildId=" + buildId + "&_a=summary"; - } - else { - throw new Error(tl.loc('CannotupdatedeploymentstatusuniquedeploymentIdCannotBeRetrieved')); - } - - var message = { - type : customMessage.type, - commitId : commitId, - buildId : buildId, - releaseId : releaseId, - buildNumber : buildNumber, - releaseName : releaseName, - repoProvider : repoProvider, - repoName : repoName, - collectionUrl : collectionUrl, - teamProject : teamProject - }; - // Append Custom Messages to original message - for(var attribute in customMessage) { - message[attribute] = customMessage[attribute]; - } - - var deploymentLogType: string = message['type']; - var active: boolean = false; - if(deploymentLogType.toLowerCase() === "deployment" && isDeploymentSuccess) { - active = true; - } - - var requestBody = { - active : active, - status : status, - status_text : status_text, - message : JSON.stringify(message), - author : author, - deployer : 'VSTS', - details : buildOrReleaseUrl - }; - - var webAppHostUrl = webAppPublishKuduUrl.split(':')[0]; - var requestUrl = "https://" + encodeURIComponent(webAppHostUrl) + "/api/deployments/" + encodeURIComponent(deploymentId); - - var requestDetails = { - "requestBody": requestBody, - "requestUrl": requestUrl - }; - return requestDetails; -} - -function getDeploymentAuthor(): string { - var author = tl.getVariable('build.sourceVersionAuthor'); - - if(author === undefined) { - author = tl.getVariable('build.requestedfor'); - } - - if(author === undefined) { - author = tl.getVariable('release.requestedfor'); - } - - if(author === undefined) { - author = tl.getVariable('agent.name'); - } - - return author; -} \ No newline at end of file diff --git a/Tasks/Common/azurerest-common/npm-shrinkwrap.json b/Tasks/Common/azurerest-common/npm-shrinkwrap.json deleted file mode 100644 index 1fda020a7fd3..000000000000 --- a/Tasks/Common/azurerest-common/npm-shrinkwrap.json +++ /dev/null @@ -1,91 +0,0 @@ -{ - "name": "azurerest-common", - "version": "1.0.0", - "dependencies": { - "balanced-match": { - "version": "0.4.2", - "from": "balanced-match@https://registry.npmjs.org/balanced-match/-/balanced-match-0.4.2.tgz", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-0.4.2.tgz" - }, - "brace-expansion": { - "version": "1.1.6", - "from": "brace-expansion@https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.6.tgz", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.6.tgz" - }, - "concat-map": { - "version": "0.0.1", - "from": "concat-map@https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz" - }, - "minimatch": { - "version": "3.0.3", - "from": "minimatch@https://registry.npmjs.org/minimatch/-/minimatch-3.0.3.tgz", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.3.tgz" - }, - "mockery": { - "version": "1.7.0", - "from": "mockery@https://registry.npmjs.org/mockery/-/mockery-1.7.0.tgz", - "resolved": "https://registry.npmjs.org/mockery/-/mockery-1.7.0.tgz" - }, - "node-uuid": { - "version": "1.4.7", - "from": "node-uuid@https://registry.npmjs.org/node-uuid/-/node-uuid-1.4.7.tgz", - "resolved": "https://registry.npmjs.org/node-uuid/-/node-uuid-1.4.7.tgz" - }, - "q": { - "version": "1.4.1", - "from": "q@https://registry.npmjs.org/q/-/q-1.4.1.tgz", - "resolved": "https://registry.npmjs.org/q/-/q-1.4.1.tgz" - }, - "sax": { - "version": "1.2.1", - "from": "sax@https://registry.npmjs.org/sax/-/sax-1.2.1.tgz", - "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.1.tgz" - }, - "semver": { - "version": "5.3.0", - "from": "semver@https://registry.npmjs.org/semver/-/semver-5.3.0.tgz", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.3.0.tgz" - }, - "shelljs": { - "version": "0.3.0", - "from": "shelljs@https://registry.npmjs.org/shelljs/-/shelljs-0.3.0.tgz", - "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.3.0.tgz" - }, - "tunnel": { - "version": "0.0.4", - "from": "tunnel@0.0.4", - "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.4.tgz" - }, - "typed-rest-client": { - "version": "0.12.0", - "from": "typed-rest-client@0.12.0", - "resolved": "https://registry.npmjs.org/typed-rest-client/-/typed-rest-client-0.12.0.tgz" - }, - "underscore": { - "version": "1.8.3", - "from": "underscore@1.8.3", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.8.3.tgz" - }, - "uuid": { - "version": "3.1.0", - "from": "uuid@latest", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.1.0.tgz" - }, - "vsts-task-lib": { - "version": "2.0.1-preview", - "from": "vsts-task-lib@https://registry.npmjs.org/vsts-task-lib/-/vsts-task-lib-2.0.1-preview.tgz", - "resolved": "https://registry.npmjs.org/vsts-task-lib/-/vsts-task-lib-2.0.1-preview.tgz" - }, - "xml2js": { - "version": "0.4.13", - "from": "xml2js@https://registry.npmjs.org/xml2js/-/xml2js-0.4.13.tgz", - "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.13.tgz" - }, - "xmlbuilder": { - "version": "8.2.2", - "from": "xmlbuilder@https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-8.2.2.tgz", - "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-8.2.2.tgz" - } - } -} diff --git a/Tasks/Common/azurerest-common/package.json b/Tasks/Common/azurerest-common/package.json deleted file mode 100644 index d6cae1ac393d..000000000000 --- a/Tasks/Common/azurerest-common/package.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "name": "azurerest-common", - "version": "1.0.0", - "description": "Common Library for Azure Rest Calls", - "repository": { - "type": "git", - "url": "git+ssh://git@github.com/Microsoft/vsts-tasks.git" - }, - "author": "Microsoft Corporation", - "license": "MIT", - "bugs": { - "url": "https://github.com/Microsoft/vsts-tasks/issues" - }, - "homepage": "https://github.com/Microsoft/vsts-tasks#readme", - "dependencies": { - "q": "1.4.1", - "typed-rest-client": "0.12.0", - "uuid": "3.1.0", - "vsts-task-lib": "2.0.1-preview", - "xml2js": "0.4.13" - } -} diff --git a/Tasks/Common/azurerest-common/tsconfig.json b/Tasks/Common/azurerest-common/tsconfig.json deleted file mode 100644 index bf3139d06f75..000000000000 --- a/Tasks/Common/azurerest-common/tsconfig.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "compilerOptions": { - "module": "commonjs", - "target": "es6", - "declaration": true, - "noImplicitAny": false, - "sourceMap": false - } -} \ No newline at end of file diff --git a/Tasks/Common/azurerest-common/typings.json b/Tasks/Common/azurerest-common/typings.json deleted file mode 100644 index 995a03c36d3e..000000000000 --- a/Tasks/Common/azurerest-common/typings.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "globalDependencies": { - "mocha": "registry:dt/mocha#2.2.5+20160720003353", - "node": "registry:dt/node#6.0.0+20160920093002", - "q": "registry:dt/q#0.0.0+20160613154756" - } -} diff --git a/Tasks/Common/azurerest-common/utility.ts b/Tasks/Common/azurerest-common/utility.ts deleted file mode 100644 index fafd3956f496..000000000000 --- a/Tasks/Common/azurerest-common/utility.ts +++ /dev/null @@ -1,37 +0,0 @@ -import tl = require('vsts-task-lib/task'); - -export function generateDeploymentId(): string { - var buildUrl = tl.getVariable('build.buildUri'); - var releaseUrl = tl.getVariable('release.releaseUri'); - - var buildId = tl.getVariable('build.buildId'); - var releaseId = tl.getVariable('release.releaseId'); - - if(releaseUrl !== undefined) { - return releaseId + Date.now(); - } - else if(buildUrl !== undefined) { - return buildId + Date.now(); - } - else { - throw new Error(tl.loc('CannotupdatedeploymentstatusuniquedeploymentIdCannotBeRetrieved')); - } -} - -export function getDeploymentUri(): string { - let buildUri = tl.getVariable("Build.BuildUri"); - let releaseWebUrl = tl.getVariable("Release.ReleaseWebUrl"); - let collectionUrl = tl.getVariable('System.TeamFoundationCollectionUri'); - let teamProject = tl.getVariable('System.TeamProjectId'); - let buildId = tl.getVariable('build.buildId'); - - if (!!releaseWebUrl) { - return releaseWebUrl; - } - - if (!!buildUri) { - return `${collectionUrl}${teamProject}/_build?buildId=${buildId}&_a=summary`; - } - - return ""; -} diff --git a/Tasks/Common/webdeployment-common/deployusingmsdeploy.ts b/Tasks/Common/webdeployment-common/deployusingmsdeploy.ts index dd2ca73edb3a..5a6133714e83 100644 --- a/Tasks/Common/webdeployment-common/deployusingmsdeploy.ts +++ b/Tasks/Common/webdeployment-common/deployusingmsdeploy.ts @@ -46,18 +46,18 @@ export async function DeployUsingMSDeploy(webDeployPkg, webAppName, publishingPr var retryCount = (retryCountParam && !(isNaN(Number(retryCountParam)))) ? Number(retryCountParam): DEFAULT_RETRY_COUNT; try { - var shouldContinue = true; - while(shouldContinue) { + while(true) { try { - await executeMSDeploy(msDeployCmdArgs); - shouldContinue = false; - } catch (error) { - shouldContinue = (msDeployUtility.shouldRetryMSDeploy() && retryCount-- > 0); - if(!shouldContinue) { + retryCount -= 1; + await executeMSDeploy(msDeployCmdArgs); + break; + } + catch (error) { + if(retryCount == 0) { throw error; - } else { - console.log("Retrying to deploy app service."); } + console.log(error); + console.log(tl.loc('RetryToDeploy')); } } if(publishingProfile != null) { diff --git a/Tasks/Common/webdeployment-common/msdeployutility.ts b/Tasks/Common/webdeployment-common/msdeployutility.ts index f0b408c56f1f..9788107f6d21 100644 --- a/Tasks/Common/webdeployment-common/msdeployutility.ts +++ b/Tasks/Common/webdeployment-common/msdeployutility.ts @@ -190,8 +190,10 @@ export function redirectMSDeployErrorToConsole() { if(errorFileContent.indexOf("ERROR_INSUFFICIENT_ACCESS_TO_SITE_FOLDER") !== -1) { tl.warning(tl.loc("Trytodeploywebappagainwithappofflineoptionselected")); } - - if(errorFileContent.indexOf("FILE_IN_USE") !== -1) { + else if(errorFileContent.indexOf("An error was encountered when processing operation 'Delete Directory' on 'D:\\home\\site\\wwwroot\\app_data\\jobs'") !== -1) { + tl.warning(tl.loc('WebJobsInProgressIssue')); + } + else if(errorFileContent.indexOf("FILE_IN_USE") !== -1) { tl.warning(tl.loc("Trytodeploywebappagainwithrenamefileoptionselected")); } @@ -200,21 +202,4 @@ export function redirectMSDeployErrorToConsole() { tl.rmRF(msDeployErrorFilePath); } -} - -export function shouldRetryMSDeploy() { - var msDeployErrorFilePath = tl.getVariable('System.DefaultWorkingDirectory') + '\\' + ERROR_FILE_NAME; - - if(tl.exist(msDeployErrorFilePath)) { - var errorFileContent = fs.readFileSync(msDeployErrorFilePath).toString(); - - if(errorFileContent !== "") { - if(errorFileContent.indexOf("ERROR_CONNECTION_TERMINATED") != -1) { - tl.warning(errorFileContent); - return true; - } - } - } - - return false; } \ No newline at end of file diff --git a/Tasks/Common/webdeployment-common/packageUtility.ts b/Tasks/Common/webdeployment-common/packageUtility.ts new file mode 100644 index 000000000000..de25c9ec61d1 --- /dev/null +++ b/Tasks/Common/webdeployment-common/packageUtility.ts @@ -0,0 +1,18 @@ +import tl = require('vsts-task-lib/task'); +import utility = require('./utility'); + +export class PackageUtility { + public static getPackagePath(packagePath: string): string { + var availablePackages: string[] = utility.findfiles(packagePath); + if(availablePackages.length == 0) { + throw new Error(tl.loc('Nopackagefoundwithspecifiedpattern', packagePath)); + } + + if(availablePackages.length > 1) { + throw new Error(tl.loc('MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern', packagePath)); + } + + return availablePackages[0]; + } +} + diff --git a/Tasks/Common/webdeployment-common/utility.ts b/Tasks/Common/webdeployment-common/utility.ts index c673ff2de75d..b0e1fd92548a 100644 --- a/Tasks/Common/webdeployment-common/utility.ts +++ b/Tasks/Common/webdeployment-common/utility.ts @@ -119,7 +119,7 @@ export function findfiles(filepath){ var allFiles = tl.find(findPathRoot); // Now matching the pattern against all files - filesList = tl.match(allFiles, filepath, '', {matchBase: true}); + filesList = tl.match(allFiles, filepath, '', {matchBase: true, nocase: !!tl.osType().match(/^Win/) }); // Fail if no matching files were found if (!filesList || filesList.length == 0) { diff --git a/Tasks/Common/webdeployment-common/webconfigutil.ts b/Tasks/Common/webdeployment-common/webconfigutil.ts index 4cde7ee6da51..478d0bee525a 100644 --- a/Tasks/Common/webdeployment-common/webconfigutil.ts +++ b/Tasks/Common/webdeployment-common/webconfigutil.ts @@ -57,7 +57,7 @@ function addMissingParametersValue(appType: string, webConfigParameters) { } return resultAppTypeParams; } -export function addWebConfigFile(folderPath: any, webConfigParameters, rootDirectoryPath: string) { +export function addWebConfigFile(folderPath: any, webConfigParameters, rootDirectoryPath?: string) { //Generate the web.config file if it does not already exist. var webConfigPath = path.join(folderPath, "web.config"); if (!tl.exist(webConfigPath)) { diff --git a/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0.ts b/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0.ts index a0b84375fd83..8ed5bde90e66 100644 --- a/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0.ts +++ b/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0.ts @@ -56,7 +56,7 @@ describe('IISWebsiteDeploymentOnMachineGroup test suite', function() { tr.run(); var expectedErr = 'Error: msdeploy failed with return code: 1'; - assert(tr.invokedToolCount == 1, 'should have invoked tool once'); + assert(tr.invokedToolCount == 3, 'should have invoked tool thrice despite failure'); assert(tr.errorIssues.length > 0 || tr.stderr.length > 0, 'should have written to stderr'); assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'E should have said: ' + expectedErr); assert(tr.failed, 'task should have failed'); @@ -93,7 +93,7 @@ describe('IISWebsiteDeploymentOnMachineGroup test suite', function() { let tp = path.join(__dirname, 'L0WindowsManyPackage.js'); let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp); - tr.run(); + tr.run(); assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); assert(tr.stderr.length > 0 || tr.errorIssues.length > 0, 'should have written to stderr'); var expectedErr = 'Error: loc_mock_MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern'; @@ -108,7 +108,7 @@ describe('IISWebsiteDeploymentOnMachineGroup test suite', function() { tr.run(); - assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); + assert(tr.invokedToolCount == 0, 'should not have invoked any tool'); assert(tr.stderr.length > 0 || tr.errorIssues.length > 0, 'should have written to stderr'); var expectedErr = 'Error: loc_mock_Nopackagefoundwithspecifiedpattern'; assert(tr.stdErrContained(expectedErr) || tr.createdErrorIssue(expectedErr), 'should have said: ' + expectedErr); diff --git a/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0WindowsFailDefault.ts b/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0WindowsFailDefault.ts index 80774e1f3521..3bb8e5d25fea 100644 --- a/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0WindowsFailDefault.ts +++ b/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0WindowsFailDefault.ts @@ -40,7 +40,6 @@ let a: any = { "webAppPkg.zip": true, "DefaultWorkingDirectory\\error.txt": true }, - "rmRF": { "DefaultWorkingDirectory\\error.txt": true } diff --git a/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0WindowsManyPackage.ts b/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0WindowsManyPackage.ts index 20d29787c207..c8fe1fa8d354 100644 --- a/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0WindowsManyPackage.ts +++ b/Tasks/IISWebAppDeploymentOnMachineGroup/Tests/L0WindowsManyPackage.ts @@ -28,8 +28,10 @@ let a: ma.TaskLibAnswers = { }, "find": { "webAppPkgPattern/": ["webAppPkgPattern/webAppPkg1.zip", "webAppPkgPattern/webAppPkg2.zip"] + }, + "osType": { + "osType": "Windows" } - } tr.setAnswers(a);