Add containerapps-albumapi-go test project & cases

.vscode/launch.json

@@ -92,7 +92,7 @@
                 "MOCHA_timeout": "0", // Disable time-outs
                 "DEBUGTELEMETRY": "v",
                 "NODE_DEBUG": "",
-                "ENABLE_LONG_RUNNING_TESTS": ""
+                "AzCode_UseAzureFederatedCredentials": ""
             }
         },
         {
@@ -115,7 +115,7 @@
                 "DEBUGTELEMETRY": "v",
                 "NODE_DEBUG": "",
                 "DEBUG_WEBPACK": "1",
-                "ENABLE_LONG_RUNNING_TESTS": ""
+                "AzCode_UseAzureFederatedCredentials": ""
             }
         },
         {

extension.bundle.ts

@@ -16,13 +16,22 @@
 // At runtime the tests live in dist/tests and will therefore pick up the main webpack bundle at dist/extension.bundle.js.
 export * from '@microsoft/vscode-azext-utils';
 // Export activate/deactivate for main.js
+export * from './src/commands/deployWorkspaceProject/deployWorkspaceProject';
+export * from './src/commands/deployWorkspaceProject/getDeployWorkspaceProjectResults';
 export * from './src/commands/deployWorkspaceProject/internal/DeployWorkspaceProjectInternalContext';
+export * from './src/commands/deployWorkspaceProject/settings/DeployWorkspaceProjectSettingsV1';
+export * from './src/commands/deployWorkspaceProject/settings/DeployWorkspaceProjectSettingsV2';
+export * from './src/commands/deployWorkspaceProject/settings/dwpSettingUtilsV1';
+export * from './src/commands/deployWorkspaceProject/settings/dwpSettingUtilsV2';
+export * from './src/commands/IContainerAppContext';
+export * from './src/commands/ingress/editTargetPort/getDefaultPort';
 export * from './src/commands/ingress/IngressContext';
 export * from './src/commands/ingress/IngressPromptStep';
-export * from './src/commands/ingress/editTargetPort/getDefaultPort';
 export * from './src/commands/ingress/tryGetDockerfileExposePorts';
 export { activate, deactivate } from './src/extension';
 export * from './src/extensionVariables';
+export * from './src/utils/azureClients';
+export * from './src/utils/settingUtils';
 export * from './src/utils/validateUtils';
 
 // NOTE: The auto-fix action "source.organizeImports" does weird things with this file, but there doesn't seem to be a way to disable it on a per-file basis so we'll just let it happen

test/global.test.ts

@@ -3,16 +3,17 @@
  *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import { registerAzureUtilsExtensionVariables } from '@microsoft/vscode-azext-azureutils';
 import { TestOutputChannel, TestUserInput } from '@microsoft/vscode-azext-dev';
 import * as assert from 'assert';
 import * as vscode from 'vscode';
-import { ext, registerOnActionStartHandler } from '../extension.bundle';
+import { ext, registerOnActionStartHandler, registerUIExtensionVariables } from '../extension.bundle';
 
-export let longRunningTestsEnabled: boolean;
+export const longRunningTestsEnabled: boolean = !/^(false|0)?$/i.test(process.env.AzCode_UseAzureFederatedCredentials || '');
 
 // Runs before all tests
 suiteSetup(async function (this: Mocha.Context): Promise<void> {
-    this.timeout(1 * 60 * 1000);
+    this.timeout(2 * 60 * 1000);
 
     const extension = vscode.extensions.getExtension('ms-azuretools.vscode-azurecontainerapps');
     if (!extension) {
@@ -21,11 +22,12 @@ suiteSetup(async function (this: Mocha.Context): Promise<void> {
         await extension.activate();
     }
 
+    ext.outputChannel = new TestOutputChannel();
+    registerUIExtensionVariables(ext);
+    registerAzureUtilsExtensionVariables(ext);
+
     registerOnActionStartHandler(context => {
         // Use `TestUserInput` by default so we get an error if an unexpected call to `context.ui` occurs, rather than timing out
         context.ui = new TestUserInput(vscode);
     });
-
-    ext.outputChannel = new TestOutputChannel();
-    longRunningTestsEnabled = !/^(false|0)?$/i.test(process.env.AzCode_UseAzureFederatedCredentials || '');
 });

test/nightly/deployWorkspaceProject/deployWorkspaceProject.test.ts

@@ -0,0 +1,71 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { parseAzureResourceGroupId } from '@microsoft/vscode-azext-azureutils';
+import { runWithTestActionContext } from '@microsoft/vscode-azext-dev';
+import * as assert from 'assert';
+import * as path from 'path';
+import { workspace, type Uri, type WorkspaceFolder } from 'vscode';
+import { AzExtFsExtra, deployWorkspaceProject, dwpSettingUtilsV2, settingUtils, type DeploymentConfigurationSettings, type DeployWorkspaceProjectResults } from '../../../extension.bundle';
+import { longRunningTestsEnabled } from '../../global.test';
+import { assertStringPropsMatch, getWorkspaceFolderUri } from '../../testUtils';
+import { resourceGroupsToDelete } from '../global.nightly.test';
+import { dwpTestScenarios } from './dwpTestScenarios';
+
+suite('deployWorkspaceProject', function (this: Mocha.Suite) {
+    this.timeout(15 * 60 * 1000);
+
+    suiteSetup(function (this: Mocha.Context) {
+        if (!longRunningTestsEnabled) {
+            this.skip();
+        }
+    });
+
+    for (const scenario of dwpTestScenarios) {
+        suite(scenario.label, function () {
+            const workspaceFolderUri: Uri = getWorkspaceFolderUri(scenario.folderName);
+            const rootFolder: WorkspaceFolder | undefined = workspace.getWorkspaceFolder(workspaceFolderUri);
+            assert.ok(rootFolder, 'Could not retrieve root workspace folder.');
+
+            suiteSetup(getMethodCleanWorkspaceFolderSettings(rootFolder));
+            suiteTeardown(getMethodCleanWorkspaceFolderSettings(rootFolder));
+
+            for (const testCase of scenario.testCases) {
+                test(testCase.label, async function () {
+                    await runWithTestActionContext('deployWorkspaceProject', async context => {
+                        await context.ui.runWithInputs(testCase.inputs, async () => {
+                            const results: DeployWorkspaceProjectResults = await deployWorkspaceProject(context);
+                            if (results.resourceGroupId) {
+                                const resourceGroupName: string = parseAzureResourceGroupId(results.resourceGroupId).resourceGroup;
+                                resourceGroupsToDelete.add(resourceGroupName);
+                            }
+
+                            assertStringPropsMatch(results as Partial<Record<string, string>>, testCase.expectedResults as Record<string, string | RegExp>, 'DeployWorkspaceProject results mismatch.');
+
+                            const deploymentConfigurationsV2: DeploymentConfigurationSettings[] = await dwpSettingUtilsV2.getWorkspaceDeploymentConfigurations(rootFolder) ?? [];
+                            for (const [i, expectedDeploymentConfiguration] of (testCase.expectedVSCodeSettings?.deploymentConfigurations ?? []).entries()) {
+                                const deploymentConfiguration: DeploymentConfigurationSettings = deploymentConfigurationsV2[i] ?? {};
+                                assertStringPropsMatch(deploymentConfiguration as Partial<Record<string, string>>, expectedDeploymentConfiguration, 'DeployWorkspaceProject ".vscode" saved settings mismatch.');
+                            }
+
+                            await testCase.postTestAssertion?.(context, results, 'DeployWorkspaceProject resource settings mismatch.');
+                        });
+                    });
+                });
+            }
+        });
+    }
+});
+
+function getMethodCleanWorkspaceFolderSettings(rootFolder: WorkspaceFolder) {
+    return async function cleanWorkspaceFolderSettings(): Promise<void> {
+        const settingsPath: string = settingUtils.getDefaultRootWorkspaceSettingsPath(rootFolder);
+        const vscodeFolderPath: string = path.dirname(settingsPath);
+        if (await AzExtFsExtra.pathExists(vscodeFolderPath)) {
+            await AzExtFsExtra.deleteResource(vscodeFolderPath, { recursive: true });
+        }
+    }
+}
+

test/nightly/deployWorkspaceProject/dwpTestScenarios.ts

@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { generateAlbumApiGolangTestCases } from "./testCases/albumApiGolangTestCases";
+import { generateAlbumApiJavaScriptTestCases } from "./testCases/albumApiJavaScriptTestCases";
+import { type DeployWorkspaceProjectTestCase } from "./testCases/DeployWorkspaceProjectTestCase";
+import { generateMonoRepoBasicTestCases } from "./testCases/monoRepoBasicTestCases";
+
+interface DeployWorkspaceProjectTestScenario {
+    label: string;
+    folderName: string;
+    testCases: DeployWorkspaceProjectTestCase[];
+}
+
+export const dwpTestScenarios: DeployWorkspaceProjectTestScenario[] = [
+    {
+        label: 'albumapi-go',
+        folderName: 'albumapi-go',
+        testCases: generateAlbumApiGolangTestCases()
+    },
+    {
+        label: 'albumapi-js',
+        folderName: 'albumapi-js',
+        testCases: generateAlbumApiJavaScriptTestCases()
+    },
+    {
+        label: 'monorepo',
+        folderName: 'monorepo-basic',
+        testCases: generateMonoRepoBasicTestCases()
+    },
+];

test/nightly/deployWorkspaceProject/dwpTestUtils.ts

@@ -0,0 +1,41 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { type ContainerApp, type EnvironmentVar } from "@azure/arm-appcontainers";
+import { parseAzureResourceId } from "@microsoft/vscode-azext-azureutils";
+import { nonNullProp, type IActionContext } from "@microsoft/vscode-azext-utils";
+import * as assert from "assert";
+import { createContainerAppsAPIClient, type DeployWorkspaceProjectResults } from "../../../extension.bundle";
+import { type StringOrRegExpProps } from "../../typeUtils";
+import { subscriptionContext } from "../global.nightly.test";
+import { type PostTestAssertion } from "./testCases/DeployWorkspaceProjectTestCase";
+
+export namespace dwpTestUtils {
+    export function generateExpectedResults(sharedResourceName: string, acrResourceName: string, appResourceName: string): StringOrRegExpProps<DeployWorkspaceProjectResults> {
+        return {
+            containerAppId: new RegExp(`\/resourceGroups\/${sharedResourceName}\/providers\/Microsoft\.App\/containerApps\/${appResourceName}`, 'i'),
+            imageName: new RegExp(appResourceName, 'i'),
+            logAnalyticsWorkspaceId: new RegExp(`\/resourceGroups\/${sharedResourceName}\/providers\/Microsoft\.OperationalInsights\/workspaces\/${sharedResourceName}`, 'i'),
+            managedEnvironmentId: new RegExp(`\/resourceGroups\/${sharedResourceName}\/providers\/Microsoft\.App\/managedEnvironments\/${sharedResourceName}`, 'i'),
+            registryId: new RegExp(`\/resourceGroups\/${sharedResourceName}\/providers\/Microsoft\.ContainerRegistry\/registries\/${acrResourceName}.{6}`, 'i'),
+            registryLoginServer: new RegExp(`${acrResourceName}.{6}\.azurecr\.io`, 'i'),
+            registryPassword: new RegExp('.*'),
+            registryUsername: new RegExp(`${acrResourceName}.{6}`, 'i'),
+            resourceGroupId: new RegExp(`\/resourceGroups\/${sharedResourceName}`, 'i')
+        };
+    }
+
+    export function generatePostTestAssertion(expectedContainerAppSettings: { targetPort: number | undefined, env: EnvironmentVar[] | undefined }): PostTestAssertion {
+        return async function postTestAssertion(context: IActionContext, resources: DeployWorkspaceProjectResults, errMsg?: string): Promise<void> {
+            const parsedId = parseAzureResourceId(nonNullProp(resources, 'containerAppId'));
+            const client = await createContainerAppsAPIClient(Object.assign(context, subscriptionContext));
+            const containerApp: ContainerApp = await client.containerApps.get(parsedId.resourceGroup, parsedId.resourceName);
+
+            assert.strictEqual(containerApp.configuration?.ingress?.targetPort, expectedContainerAppSettings.targetPort, errMsg ? errMsg + ' (container app target port)' : undefined);
+            assert.strictEqual(containerApp.template?.containers?.[0].image, `${resources.registryLoginServer}/${resources.imageName}`, errMsg ? errMsg + ' (container image name)' : undefined);
+            assert.deepStrictEqual(containerApp.template?.containers?.[0].env, expectedContainerAppSettings.env, errMsg ? errMsg + ' (container environment variables)' : undefined);
+        }
+    }
+}

test/nightly/deployWorkspaceProject/testCases/DeployWorkspaceProjectTestCase.ts

@@ -0,0 +1,36 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { type DeploymentConfigurationSettings, type DeployWorkspaceProjectResults, type IActionContext } from "../../../../extension.bundle";
+import { type StringOrRegExpProps } from "../../../typeUtils";
+
+export interface DeployWorkspaceProjectTestCase {
+    /**
+     * Label to display when executing the test
+     */
+    label: string;
+    /**
+     * The list of inputs that will be passed to the test UI
+     */
+    inputs: (string | RegExp)[];
+    /**
+     * The expected results that should be returned after executing the command
+     */
+    expectedResults?: StringOrRegExpProps<DeployWorkspaceProjectResults>;
+    /**
+     * The expected `.vscode` settings that should be present in the workspace folder root after executing the command
+     */
+    expectedVSCodeSettings?: VSCodeSettings;
+    /**
+     * A post test callback that can be added for further verifying any of the created resources before final suite teardown
+     */
+    postTestAssertion?: PostTestAssertion;
+}
+
+export type PostTestAssertion = (context: IActionContext, results: DeployWorkspaceProjectResults, errMsg?: string) => void | Promise<void>;
+
+export interface VSCodeSettings {
+    deploymentConfigurations?: StringOrRegExpProps<DeploymentConfigurationSettings>[];
+}

test/nightly/deployWorkspaceProject/testCases/albumApiGolangTestCases.ts

@@ -0,0 +1,69 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { randomUtils } from "@microsoft/vscode-azext-utils";
+import * as path from "path";
+import { type DeploymentConfigurationSettings } from "../../../../extension.bundle";
+import { type StringOrRegExpProps } from "../../../typeUtils";
+import { dwpTestUtils } from "../dwpTestUtils";
+import { type DeployWorkspaceProjectTestCase } from "./DeployWorkspaceProjectTestCase";
+
+export function generateAlbumApiGolangTestCases(): DeployWorkspaceProjectTestCase[] {
+    const folderName: string = 'albumapi-go';
+    const appResourceName: string = 'album-api';
+    const sharedResourceName: string = appResourceName + randomUtils.getRandomHexString(4);
+    const acrResourceName: string = sharedResourceName.replace(/[^a-zA-Z0-9]+/g, '');
+
+    return [
+        {
+            label: 'Deploy App',
+            inputs: [
+                new RegExp(folderName, 'i'),
+                new RegExp('Create new container apps environment', 'i'),
+                'Continue',
+                sharedResourceName,
+                appResourceName,
+                `.${path.sep}src`,
+                'East US',
+                'Save'
+            ],
+            expectedResults: dwpTestUtils.generateExpectedResults(sharedResourceName, acrResourceName, appResourceName),
+            expectedVSCodeSettings: {
+                deploymentConfigurations: [
+                    generateExpectedDeploymentConfiguration(sharedResourceName, acrResourceName, appResourceName)
+                ]
+            },
+            postTestAssertion: dwpTestUtils.generatePostTestAssertion({ targetPort: 8080, env: undefined })
+        },
+        {
+            label: 'Re-deploy App',
+            inputs: [
+                new RegExp(folderName, 'i'),
+                appResourceName,
+                'Continue'
+            ],
+            expectedResults: dwpTestUtils.generateExpectedResults(sharedResourceName, acrResourceName, appResourceName),
+            expectedVSCodeSettings: {
+                deploymentConfigurations: [
+                    generateExpectedDeploymentConfiguration(sharedResourceName, acrResourceName, appResourceName)
+                ]
+            },
+            postTestAssertion: dwpTestUtils.generatePostTestAssertion({ targetPort: 8080, env: undefined })
+        }
+    ];
+}
+
+function generateExpectedDeploymentConfiguration(sharedResourceName: string, acrResourceName: string, appResourceName: string): StringOrRegExpProps<DeploymentConfigurationSettings> {
+    return {
+        label: appResourceName,
+        type: 'AcrDockerBuildRequest',
+        dockerfilePath: path.join('src', 'Dockerfile'),
+        srcPath: 'src',
+        envPath: '',
+        resourceGroup: sharedResourceName,
+        containerApp: appResourceName,
+        containerRegistry: new RegExp(`${acrResourceName}.{6}`, 'i'),
+    };
+}