Adding Azure Spring Cloud task (#14563) (#14678)

* Initial commit as task builds

* Initial commit as task builds

* UI Datasources work

* Get deployment URL works

* Now getting the correct SAS upload URL

* Jar deployment without wildcards works

* Fixing capitalization

* Adding wildcard support

* JVM options now work

* Inline datasources work!

* Environment variable parsing now works properly

* Adding set active deployment

* Set active deployment now works, fixed display names

* Refactoring into single task, adding deletion and test endpoint retrieval

* Runtime version setting now works

* Deployment tasks now waits for completion

* Spring Cloud and app names can now be entered. Resource ID or Spring Cloud Name are accepted

* Enabling steeltoe and source directory

* Build log now displayed on source deployments. Source uploads now actually work

* Working around the task library's mock dependency

* First L0 test passes, fixed bug where absent staging deployment did not error out properly with "use staging"

* First test works, interference with subsequent tests

* Refactoring tests

* Fixed issue with premature reading of environment variables

* Two tests now pass

* Added unit test for deployment info parsing, found and fixed bug in deployment info parsing

* Renaming tests for more clarity

* End-to-end deployment with mock added and works

* Refactoring to split up deployment update request generation from application

* Renaming TargetInactive parameter to UseStagingDeployment

* Adding test for 'set production' when no staging deployment exists

* Adding tests for set production deployment

* Setting single error for when named staging deployment does not exist in Set Production whether or not there's room for a new one

* Adding tests for deploying to named deployment successfully

* Adding tests to delete staging deployment

* Externalization/localization of strings

* Refactoring deployment actions to have separate methods

* Reducing deployment name to single field. Fixing bug where re-creating a deployment that has already existed returns status code 202, not 201.

* Applying code review notes

* Space fix

* Setting task version to reflect spring

* Fixing API version that prevents listing of Azure Spring Cloud instances

* Adding Main Entry Path for .NET Core deployments

* Fix for potential path traversal vulnerability and unit test thereof

* Adding missing package error messages.

* Using the standard key-value parsing library instead of custom code. Formatting fixes. Eliminating log outputs from tests.

* Removing out.tar.gz

* Removing surviving test log dumps

* Formatting, task version update, CODEOWNERS and make options

* Making myself sole CODEOWNER on Azure Spring Cloud task. 😱

* Removing 'postDeploymentScript' from make.json

Author: yevster

.github/CODEOWNERS

@@ -77,6 +77,8 @@ Tasks/AzureRmWebAppDeploymentV3/   @nadesu    @chshrikh    @pipeline-environment
 
 Tasks/AzureRmWebAppDeploymentV4/   @nadesu    @chshrikh    @pipeline-environment-team
 
+Tasks/AzureSpringCloudV0    @yevster
+
 Tasks/AzureStaticWebAppV0/  @miwebst    @brhopcra
 
 Tasks/AzureWebAppV1/  @nadesu    @chshrikh    @pipeline-environment-team

Tasks/AzureSpringCloudV0/Strings/resources.resjson/en-US/resources.resjson

@@ -0,0 +1,56 @@
+{
+  "loc.friendlyName": "Azure Spring Cloud",
+  "loc.helpMarkDown": "[Learn more about this task](https://aka.ms/azurespringcloud)",
+  "loc.description": "Deploy applications to Azure Spring Cloud and manage deployments.",
+  "loc.instanceNameFormat": "Azure Spring Cloud $(Action): $(AppName)",
+  "loc.group.displayName.ApplicationAndConfigurationSettings": "Application and Configuration Settings",
+  "loc.input.label.ConnectedServiceName": "Azure subscription",
+  "loc.input.help.ConnectedServiceName": "Select the Azure Resource Manager subscription for the deployment.",
+  "loc.input.label.Action": "Action",
+  "loc.input.help.Action": "Action to be performed on Azure Spring Cloud.",
+  "loc.input.label.AzureSpringCloud": "Azure Spring Cloud Name",
+  "loc.input.help.AzureSpringCloud": "Select the Azure Spring Cloud service to which to deploy.",
+  "loc.input.label.AppName": "App",
+  "loc.input.help.AppName": "Select the Azure Spring Cloud app to deploy.",
+  "loc.input.label.UseStagingDeployment": "Use Staging Deployment",
+  "loc.input.help.UseStagingDeployment": "Automatically select the deployment that's set as Staging at the time the task runs.",
+  "loc.input.label.CreateNewDeployment": "Create a new staging deployment if one does not exist.",
+  "loc.input.help.CreateNewDeployment": "Whether to target the deployment that's set as Staging at the time of execution. If unchecked, the 'Deployment Name' setting must be set.",
+  "loc.input.label.DeploymentName": "Deployment",
+  "loc.input.help.DeploymentName": "The deployment to which this task will apply. Lowercase letters and numbers only; must start with a letter.",
+  "loc.input.label.Package": "Package or folder",
+  "loc.input.help.Package": "File path to the package or a folder containing the Spring Cloud app contents.<br />Variables ( [Build](https://docs.microsoft.com/vsts/pipelines/build/variables) | [Release](https://docs.microsoft.com/vsts/pipelines/release/variables#default-variables)), wildcards are supported. <br/> For example, $(System.DefaultWorkingDirectory)/\\*\\*/\\*.jar.",
+  "loc.input.label.EnvironmentVariables": "Environment Variables",
+  "loc.input.help.EnvironmentVariables": "Edit the app's environment variables.",
+  "loc.input.label.JvmOptions": "JVM Options",
+  "loc.input.help.JvmOptions": "Edit the app's JVM options. A String containing JVM Options. Example: `-Xms1024m -Xmx2048m`",
+  "loc.input.label.RuntimeVersion": "Runtime Version",
+  "loc.input.help.RuntimeVersion": "The runtime on which the app will run.",
+  "loc.input.label.DotNetCoreMainEntryPath": "Main Entry Path",
+  "loc.input.help.DotNetCoreMainEntryPath": "The path to the .NET executable relative to zip root.",
+  "loc.input.label.Version": "Version",
+  "loc.messages.CompressingSourceDirectory": "Compressing source directory %s to %s",
+  "loc.messages.DeploymentLog": "Deployment Log",
+  "loc.messages.StatusCode": "Status Code",
+  "loc.messages.StartingUploadOf": "Starting upload of %s",
+  "loc.messages.CompletedUploadOf": "Upload of %s completed.",
+  "loc.messages.ResourceDoesntExist": "Resource '%s' doesn't exist. Resource should exist before deployment.",
+  "loc.messages.UnableToGetDeploymentUrl": "Unable to get deployment URL for Azure Spring Cloud '%s', Error: '%s'",
+  "loc.messages.DeploymentDoesntExist": "Deployment with name '%s' does not exist. Unable to proceed.",
+  "loc.messages.StagingDeploymentWithNameDoesntExist": "Staging deployment with name %s does not exist. Unable to proceed.",
+  "loc.messages.NoStagingDeploymentFound": "No staging deployment found.",
+  "loc.messages.TwoDeploymentsAlreadyExistCannotCreate": "Deployment with name '%s' does not exist and cannot be created, as two deployments already exist.",
+  "loc.messages.UnsupportedSourceType": "Unsupported source type for %s",
+  "loc.messages.UnknownOrUnsupportedAction": "Unknown or unsupported action: %s",
+  "loc.messages.OperationTimedOut": "Operation timed out.",
+  "loc.messages.OperationFailed": "Operation failed: %s %s",
+  "loc.messages.UnableToDeleteDeployment": "Unable to delete deployment.",
+  "loc.messages.PrivateTestEndpointNotEnabled": "Private test endpoint is not enabled.",
+  "loc.messages.UnableToRetrieveTestEndpointKeys": "Unable to retrieve test endpoint keys",
+  "loc.messages.NoDeploymentsExist": "No deployments exist.",
+  "loc.messages.UnableToGetDeploymentInformation": "Unable to get deployment information.",
+  "loc.messages.DuplicateAzureSpringCloudName": "Illegal state: multiple Azure Spring Cloud instances with same name.",
+  "loc.messages.InvalidAzureSpringCloudResourceId": "Invalid azure spring cloud resource identifier: %s",
+  "loc.messages.Nopackagefoundwithspecifiedpattern": "No package found with specified pattern: %s. Check if the package mentioned in the task is published as an artifact in the build or a previous stage and downloaded in the current job.",
+  "loc.messages.MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern": "More than one package matched with specified pattern: %s. Please restrain the search pattern."
+}

Tasks/AzureSpringCloudV0/Tests/AzureSpringCloudDeploymentProviderUnitTests.ts

@@ -0,0 +1,25 @@
+import assert = require('assert');
+import { AzureSpringCloudDeploymentProvider } from "../deploymentProvider/AzureSpringCloudDeploymentProvider"
+import { TaskParameters } from "../operations/taskparameters"
+
+
+export class AzureSpringCloudUnitTests {
+
+    public static pathTraversalAttackTest = (done: Mocha.Done) => {
+        const resourceIdWithPathAttack = '/subscriptions/mocksubid/resourceGroups/mockresouorcegroup/providers/Microsoft.AppPlatform/Spring/authorized-name/../unauthorized-name';
+        const taskParameters: TaskParameters = {
+            AzureSpringCloud: resourceIdWithPathAttack,
+            AppName: 'appName',
+            UseStagingDeployment: false,
+            Action: 'Deploy'
+        };
+
+        const provider = new AzureSpringCloudDeploymentProvider(taskParameters);
+        provider.PreDeploymentStep().then(() => {
+            done(assert.fail('Attempted path traversal attack should have failed'));
+        }).catch(error => {
+            assert.strictEqual(error.message, `loc_mock_InvalidAzureSpringCloudResourceId ${resourceIdWithPathAttack}`);
+            done();
+        });
+    }
+}

Tasks/AzureSpringCloudV0/Tests/AzureSpringCloudUnitTests.ts

@@ -0,0 +1,115 @@
+
+import { AzureEndpoint } from "azure-pipelines-tasks-azure-arm-rest-v2/azureModels";
+import { getMockEndpoint, nock } from '../node_modules/azure-pipelines-tasks-azure-arm-rest-v2/Tests/mock_utils';
+import { MOCK_RESOURCE_GROUP_NAME } from "./mock_utils";
+import assert = require('assert');
+
+export class AzureSpringCloudUnitTests {
+
+    static readonly AZURE_ENDPOINT: AzureEndpoint = getMockEndpoint();
+
+    /**
+     * Tests that deployment names are parsed correctly from API output.
+     */
+    public static testDeploymentNameRetrieval = (done: Mocha.Done) => {
+        let azureSpringCloudName = 'testDeploymentNameRetrieval';
+        let appName = 'testapp';
+        let azureSpringCloud = AzureSpringCloudUnitTests.newAzureSpringCloud(azureSpringCloudName);
+        AzureSpringCloudUnitTests.mockDeploymentListApiWithTwoDeployments(azureSpringCloudName, appName);
+        let expectedDeploymentNames = ['default', 'theOtherOne'];
+        azureSpringCloud.getAllDeploymentNames(appName)
+            .then(foundDeploymentNames => {
+                assert.deepStrictEqual(foundDeploymentNames, expectedDeploymentNames);
+                done();
+            })
+            .catch(error => done(error));
+    }
+
+    /** Prepares an instance of the AzureSpringCloudWrapper with a mock endpoint */
+    private static newAzureSpringCloud(name: string) {
+        let asc = require('../deploymentProvider/azure-arm-spring-cloud');
+        let azureSpringCloud = new asc.AzureSpringCloud(this.AZURE_ENDPOINT, `/subscriptions/${this.AZURE_ENDPOINT.subscriptionID}/resourceGroups/${MOCK_RESOURCE_GROUP_NAME}/providers/Microsoft.AppPlatform/Spring/${name}`)
+        return azureSpringCloud;
+    }
+
+    private static mockDeploymentListApiWithTwoDeployments(azureSpringCloudName: string, appName: string) {
+        console.log('mockDeploymentListApiWithTwoDeployments');
+
+        nock('https://management.azure.com').get(`/subscriptions/${this.AZURE_ENDPOINT.subscriptionID}/resourceGroups/${encodeURIComponent(MOCK_RESOURCE_GROUP_NAME)}/providers/Microsoft.AppPlatform/Spring/${azureSpringCloudName}/apps/${appName}/deployments?api-version=2020-07-01`)
+            .reply(200, {
+                "value": [
+                    {
+                        "id": `/subscriptions/${this.AZURE_ENDPOINT.subscriptionID}/resourceGroups/${encodeURIComponent(MOCK_RESOURCE_GROUP_NAME)}/providers/Microsoft.AppPlatform/Spring/${azureSpringCloudName}/apps/${appName}/deployments/default`,
+                        "name": "default",
+                        "properties": {
+                            "active": true,
+                            "appName": appName,
+                            "deploymentSettings": {
+                                "cpu": 1,
+                                "environmentVariables": null,
+                                "memoryInGB": 1,
+                                "runtimeVersion": "Java_8"
+                            },
+                            "instances": [
+                                {
+                                    "discoveryStatus": "UP",
+                                    "name": `${appName}-default-7-7b77f5b6f5-fff9t`,
+                                    "startTime": "2021-03-13T01:39:20Z",
+                                    "status": "Running"
+                                }
+                            ],
+                            "provisioningState": "Succeeded",
+                            "source": {
+                                "relativePath": "<default>",
+                                "type": "Jar"
+                            },
+                            "status": "Running"
+                        },
+                        "resourceGroup": MOCK_RESOURCE_GROUP_NAME,
+                        "sku": {
+                            "capacity": 1,
+                            "name": "S0",
+                            "tier": "Standard"
+                        },
+                        "type": `providers/Microsoft.AppPlatform/Spring/apps/deployments`
+                    },
+                    {
+                        "id": `/subscriptions/${this.AZURE_ENDPOINT.subscriptionID}/resourceGroups/${encodeURIComponent(MOCK_RESOURCE_GROUP_NAME)}/providers/Microsoft.AppPlatform/Spring/${azureSpringCloudName}/apps/${appName}/deployments/theOtherOne`,
+                        "name": "theOtherOne",
+                        "properties": {
+                            "active": true,
+                            "appName": appName,
+                            "deploymentSettings": {
+                                "cpu": 1,
+                                "environmentVariables": null,
+                                "memoryInGB": 1,
+                                "runtimeVersion": "Java_8"
+                            },
+                            "instances": [
+                                {
+                                    "discoveryStatus": "UP",
+                                    "name": `${appName}-theOtherOne-7-7b77f5b6f5-90210`,
+                                    "startTime": "2021-03-13T01:39:20Z",
+                                    "status": "Running"
+                                }
+                            ],
+                            "provisioningState": "Succeeded",
+                            "source": {
+                                "relativePath": "<default>",
+                                "type": "Jar"
+                            },
+                            "status": "Running"
+                        },
+                        "resourceGroup": MOCK_RESOURCE_GROUP_NAME,
+                        "sku": {
+                            "capacity": 1,
+                            "name": "S0",
+                            "tier": "Standard"
+                        },
+                        "type": 'Microsoft.AppPlatform/Spring/apps/deployments'
+                    }
+                ]
+
+            }).persist();
+    }
+}

Tasks/AzureSpringCloudV0/Tests/CreateNamedDeploymentFailsDeploymentDoesNotAlreadyExist.ts

@@ -0,0 +1,46 @@
+import * as path from 'path';
+import assert = require('assert');
+import mocha = require('mocha');
+import * as ttm from 'azure-pipelines-task-lib/mock-test';
+import tmrm = require('azure-pipelines-task-lib/mock-run');
+import { printTaskInputs } from './mock_utils';
+
+export class CreateNamedDeploymentFailsDeploymentDoesNotAlreadyExist {
+
+    private static mockTaskInputParameters() {
+        //Just use this to set the environment variables before any of the pipeline SDK code runs.
+        //The actual TaskMockRunner instance is irrelevant as inputs are set as environment variables,
+        //visible to the whole process. If we do this in the L0 file, it doesn't work.
+        //Otherwise, it doesn't work.
+        let tr = new tmrm.TaskMockRunner('dummypath');
+        tr.setInput('ConnectedServiceName', "AzureRM");
+        tr.setInput('Action', 'Deploy');
+        tr.setInput('AppName', 'testapp');
+        tr.setInput('AzureSpringCloud', 'CreateNamedDeploymentFailsWhenTwoDeploymentsExistL0');
+        tr.setInput('UseStagingDeployment', "false");
+        tr.setInput('Package', 'dummy.jar');
+        tr.setInput('RuntimeVersion', 'Java_11');
+        tr.setInput('CreateNewDeployment', "false");
+        tr.setInput('DeploymentName', 'nonexistentDeployment');
+        printTaskInputs();
+    }
+
+    public static mochaTest = (done: mocha.Done) => {
+
+        let taskPath = path.join(__dirname, 'CreateNamedDeploymentFailsDeploymentDoesNotAlreadyExistL0.js');
+        let mockTestRunner: ttm.MockTestRunner = new ttm.MockTestRunner(taskPath);
+        CreateNamedDeploymentFailsDeploymentDoesNotAlreadyExist.mockTaskInputParameters();
+        try {
+            mockTestRunner.run();
+            assert(mockTestRunner.failed);
+            let expectedError = 'loc_mock_DeploymentDoesntExist nonexistentDeployment';
+            assert(mockTestRunner.errorIssues.length > 0 || mockTestRunner.stderr.length > 0, 'should have written to stderr');
+            assert(mockTestRunner.stdErrContained(expectedError) || mockTestRunner.createdErrorIssue(expectedError), 'E should have said: ' + expectedError);
+            done();
+        }
+        catch (error) {
+            done(error);
+        }
+    };
+
+}

Tasks/AzureSpringCloudV0/Tests/CreateNamedDeploymentFailsDeploymentDoesNotAlreadyExistL0.ts

@@ -0,0 +1,79 @@
+import * as path from 'path';
+import tmrm = require('azure-pipelines-task-lib/mock-run');
+import { setEndpointData, setAgentsData, mockTaskArgument, mockCommonAzureAPIs, nock, mockAzureSpringCloudExists } from './mock_utils';
+import { ASC_RESOURCE_TYPE, MOCK_RESOURCE_GROUP_NAME, MOCK_SUBSCRIPTION_ID } from './mock_utils'
+
+const TEST_APP_NAME = 'testapp';
+
+export class CreateNamedDeploymentFailsDeploymentDoesNotAlreadyExistL0 {
+
+    private static readonly TEST_NAME = 'CreateNamedDeploymentFailsWhenTwoDeploymentsExistL0';
+
+    public static startTest() {
+        console.log(`running ${this.TEST_NAME}`);
+        let taskPath = path.join(__dirname, '..', 'azurespringclouddeployment.js');
+        let taskMockRunner: tmrm.TaskMockRunner = new tmrm.TaskMockRunner(taskPath);
+        setEndpointData();
+        setAgentsData();
+        mockCommonAzureAPIs();
+        mockAzureSpringCloudExists(this.TEST_NAME);
+        this.mockDeploymentListApiWithTwoDeployments();
+        taskMockRunner.setAnswers(mockTaskArgument());
+        taskMockRunner.run();
+    }
+
+    /**
+     * Simulate a deployment list API that returns a single Production deployment.
+     */
+    private static mockDeploymentListApiWithTwoDeployments() {
+        console.log('mockDeploymentListApiWithTwoDeployments');
+        console.log('defining endpoint ' + `/subscriptions/${MOCK_SUBSCRIPTION_ID}/resourceGroups/${encodeURIComponent(MOCK_RESOURCE_GROUP_NAME)}/providers/${ASC_RESOURCE_TYPE}/${this.TEST_NAME}/apps/${TEST_APP_NAME}/deployments?api-version=2020-07-01`);
+        nock('https://management.azure.com', {
+            reqheaders: {
+                "authorization": "Bearer DUMMY_ACCESS_TOKEN",
+                "content-type": "application/json; charset=utf-8",
+                "user-agent": "TFS_useragent"
+            }
+        }).get(`/subscriptions/${MOCK_SUBSCRIPTION_ID}/resourceGroups/${encodeURIComponent(MOCK_RESOURCE_GROUP_NAME)}/providers/${ASC_RESOURCE_TYPE}/${this.TEST_NAME}/apps/${TEST_APP_NAME}/deployments?api-version=2020-07-01`)
+            .reply(200, {
+                "value": [
+                    {
+                        "id": `/subscriptions/${MOCK_SUBSCRIPTION_ID}/resourceGroups/${encodeURIComponent(MOCK_RESOURCE_GROUP_NAME)}/providers/${ASC_RESOURCE_TYPE}/${this.TEST_NAME}/apps/${TEST_APP_NAME}/deployments/default`,
+                        "name": "default",
+                        "properties": {
+                            "active": true,
+                            "appName": TEST_APP_NAME,
+                            "deploymentSettings": {
+                                "cpu": 1,
+                                "environmentVariables": null,
+                                "memoryInGB": 1,
+                                "runtimeVersion": "Java_8"
+                            },
+                            "instances": [
+                                {
+                                    "discoveryStatus": "UP",
+                                    "name": `${TEST_APP_NAME}-default-7-7b77f5b6f5-fff9t`,
+                                    "startTime": "2021-03-13T01:39:20Z",
+                                    "status": "Running"
+                                }
+                            ],
+                            "provisioningState": "Succeeded",
+                            "source": {
+                                "relativePath": "<default>",
+                                "type": "Jar"
+                            },
+                            "status": "Running"
+                        },
+                        "resourceGroup": MOCK_RESOURCE_GROUP_NAME,
+                        "sku": {
+                            "capacity": 1,
+                            "name": "S0",
+                            "tier": "Standard"
+                        },
+                        "type": `${ASC_RESOURCE_TYPE}/apps/deployments`
+                    }]
+            }).persist();
+    }
+}
+
+CreateNamedDeploymentFailsDeploymentDoesNotAlreadyExistL0.startTest();