Scaffold deployWorkspaceProject command and add open workspace logic (#447)

MicroFish91 · web-flow · commit 13924e871e24 · 2023-09-15T11:36:43.000-07:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -86,6 +86,11 @@
                 "title": "%containerApps.deployImageApi%",
                 "category": "Azure Container Apps"
             },
+            {
+                "command": "containerApps.deployWorkspaceProject",
+                "title": "%containerApps.deployWorkspaceProject%",
+                "category": "Azure Container Apps"
+            },
             {
                 "command": "containerApps.deleteContainerApp",
                 "title": "%containerApps.deleteContainerApp%",
@@ -230,7 +235,34 @@
                 "category": "Azure Container Apps"
             }
         ],
+        "submenus": [
+            {
+                "id": "containerApps.submenus.workspaceActions",
+                "label": "Azure Container Apps",
+                "icon": {
+                    "light": "resources/azure-containerapps.svg",
+                    "dark": "resources/azure-containerapps.svg"
+                }
+            }
+        ],
         "menus": {
+            "containerApps.submenus.workspaceActions": [
+                {
+                    "command": "containerApps.deployWorkspaceProject",
+                    "group": "1_deploy@1"
+                },
+                {
+                    "command": "containerApps.createContainerApp",
+                    "group": "2_create@1"
+                }
+            ],
+            "view/title": [
+                {
+                    "submenu": "containerApps.submenus.workspaceActions",
+                    "when": "view == azureWorkspace",
+                    "group": "navigation@4"
+                }
+            ],
             "view/item/context": [
                 {
                     "command": "containerApps.createManagedEnvironment",
@@ -518,7 +550,7 @@
         "@azure/storage-blob": "^12.4.1",
         "@microsoft/vscode-azext-azureutils": "^2.0.0",
         "@microsoft/vscode-azext-github": "^1.0.0",
-        "@microsoft/vscode-azext-utils": "^2.0.0",
+        "@microsoft/vscode-azext-utils": "^2.0.5",
         "@microsoft/vscode-azureresources-api": "^2.0.2",
         "buffer": "^6.0.3",
         "dayjs": "^1.11.3",
diff --git a/package.nls.json b/package.nls.json
@@ -9,6 +9,7 @@
     "containerApps.editContainerApp": "Edit Container App (Advanced)...",
     "containerApps.deployImage": "Update Container App Image...",
     "containerApps.deployImageApi": "Update Container App Image (API)...",
+    "containerApps.deployWorkspaceProject": "Deploy Project from Workspace...",
     "containerApps.deleteContainerApp": "Delete Container App...",
     "containerApps.disableIngress": "Disable Ingress for Container App",
     "containerApps.enableIngress": "Enable Ingress for Container App...",
diff --git a/src/commands/createContainerApp/ContainerAppNameStep.ts b/src/commands/createContainerApp/ContainerAppNameStep.ts
@@ -5,7 +5,7 @@
 
 import { ContainerAppsAPIClient } from "@azure/arm-appcontainers";
 import { getResourceGroupFromId } from "@microsoft/vscode-azext-azureutils";
-import { AzureWizardPromptStep } from "@microsoft/vscode-azext-utils";
+import { AzureWizardPromptStep, nonNullProp } from "@microsoft/vscode-azext-utils";
 import { createContainerAppsAPIClient } from '../../utils/azureClients';
 import { localize } from "../../utils/localize";
 import { ICreateContainerAppContext } from './ICreateContainerAppContext';
@@ -41,7 +41,7 @@ export class ContainerAppNameStep extends AzureWizardPromptStep<ICreateContainer
         // do the API call last
         try {
             const client: ContainerAppsAPIClient = await createContainerAppsAPIClient(context);
-            const managedEnvironmentRg = getResourceGroupFromId(context.managedEnvironmentId);
+            const managedEnvironmentRg = getResourceGroupFromId(nonNullProp(context, 'managedEnvironmentId'));
             await client.containerApps.get(managedEnvironmentRg, name);
             return localize('containerAppExists', 'The container app "{0}" already exists in resource group "{1}". Please enter a unique name.', name, managedEnvironmentRg);
         } catch (err) {
diff --git a/src/commands/createContainerApp/ICreateContainerAppContext.ts b/src/commands/createContainerApp/ICreateContainerAppContext.ts
@@ -3,13 +3,16 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import type { ManagedEnvironment } from '@azure/arm-appcontainers';
 import type { IResourceGroupWizardContext } from '@microsoft/vscode-azext-azureutils';
 import type { ExecuteActivityContext } from '@microsoft/vscode-azext-utils';
 import type { IContainerAppContext } from '../IContainerAppContext';
 import type { ImageSourceBaseContext } from '../deployImage/imageSource/ImageSourceBaseContext';
 import type { IngressContext } from '../ingress/IngressContext';
 
 export interface ICreateContainerAppContext extends IResourceGroupWizardContext, ImageSourceBaseContext, IngressContext, IContainerAppContext, ExecuteActivityContext {
-    managedEnvironmentId: string;
     newContainerAppName?: string;
+
+    managedEnvironmentId?: string;
+    managedEnvironment?: ManagedEnvironment;
 }
diff --git a/src/commands/createManagedEnvironment/IManagedEnvironmentContext.ts b/src/commands/createManagedEnvironment/IManagedEnvironmentContext.ts
@@ -6,9 +6,12 @@
 import { ManagedEnvironment } from "@azure/arm-appcontainers";
 import { Workspace } from '@azure/arm-operationalinsights';
 import { IResourceGroupWizardContext } from '@microsoft/vscode-azext-azureutils';
-import { ExecuteActivityContext } from '@microsoft/vscode-azext-utils';
+import { ExecuteActivityContext, ISubscriptionActionContext } from '@microsoft/vscode-azext-utils';
+import { AzureSubscription } from "@microsoft/vscode-azureresources-api";
+
+export interface IManagedEnvironmentContext extends ISubscriptionActionContext, IResourceGroupWizardContext, ExecuteActivityContext {
+    subscription: AzureSubscription;
 
-export interface IManagedEnvironmentContext extends IResourceGroupWizardContext, ExecuteActivityContext {
     newManagedEnvironmentName?: string;
     logAnalyticsWorkspace?: Workspace;
 
diff --git a/src/commands/createManagedEnvironment/createManagedEnvironment.ts b/src/commands/createManagedEnvironment/createManagedEnvironment.ts
@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { LocationListStep, ResourceGroupCreateStep, VerifyProvidersStep } from "@microsoft/vscode-azext-azureutils";
-import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, createSubscriptionContext, IActionContext, nonNullProp, subscriptionExperience } from "@microsoft/vscode-azext-utils";
+import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, IActionContext, createSubscriptionContext, nonNullProp, subscriptionExperience } from "@microsoft/vscode-azext-utils";
 import { AzureSubscription } from "@microsoft/vscode-azureresources-api";
 import { ext } from "../../extensionVariables";
 import { createActivityContext } from "../../utils/activityUtils";
@@ -20,7 +20,8 @@ export async function createManagedEnvironment(context: IActionContext, node?: {
     const wizardContext: IManagedEnvironmentContext = {
         ...context,
         ...createSubscriptionContext(subscription),
-        ...(await createActivityContext())
+        ...(await createActivityContext()),
+        subscription
     };
 
     const title: string = localize('createManagedEnv', 'Create Container Apps environment');
diff --git a/src/commands/deployImage/imageSource/buildImageInAzure/DockerFileItemStep.ts b/src/commands/deployImage/imageSource/buildImageInAzure/DockerFileItemStep.ts
@@ -11,10 +11,10 @@ import type { IBuildImageInAzureContext } from "./IBuildImageInAzureContext";
 
 export class DockerFileItemStep extends AzureWizardPromptStep<IBuildImageInAzureContext> {
     public async prompt(context: IBuildImageInAzureContext): Promise<void> {
-        context.dockerFilePath = await selectWorkspaceFile(context, localize('dockerFilePick', 'Select a Dockerfile'), { filters: {} }, DOCKERFILE_GLOB_PATTERN);
+        context.dockerfilePath = await selectWorkspaceFile(context, localize('dockerFilePick', 'Select a Dockerfile'), { filters: {} }, DOCKERFILE_GLOB_PATTERN);
     }
 
     public shouldPrompt(context: IBuildImageInAzureContext): boolean {
-        return !context.dockerFilePath;
+        return !context.dockerfilePath;
     }
 }
diff --git a/src/commands/deployImage/imageSource/buildImageInAzure/IBuildImageInAzureContext.ts b/src/commands/deployImage/imageSource/buildImageInAzure/IBuildImageInAzureContext.ts
@@ -9,7 +9,7 @@ import { IContainerRegistryImageContext } from '../containerRegistry/IContainerR
 
 export interface IBuildImageInAzureContext extends IContainerRegistryImageContext {
     rootFolder: vscode.WorkspaceFolder;
-    dockerFilePath: string;
+    dockerfilePath: string;
     imageName: string;
     os: 'Windows' | 'Linux';
 
diff --git a/src/commands/deployImage/imageSource/buildImageInAzure/ImageNameStep.ts b/src/commands/deployImage/imageSource/buildImageInAzure/ImageNameStep.ts
@@ -10,7 +10,7 @@ import type { IBuildImageInAzureContext } from "./IBuildImageInAzureContext";
 
 export class ImageNameStep extends AzureWizardPromptStep<IBuildImageInAzureContext> {
     public async prompt(context: IBuildImageInAzureContext): Promise<void> {
-        const suggestedImageName = await getSuggestedName(context, context.dockerFilePath);
+        const suggestedImageName = await getSuggestedName(context, context.dockerfilePath);
 
         context.imageName = await context.ui.showInputBox({
             prompt: localize('imageNamePrompt', 'Enter a name for the image'),
diff --git a/src/commands/deployImage/imageSource/buildImageInAzure/RunStep.ts b/src/commands/deployImage/imageSource/buildImageInAzure/RunStep.ts
@@ -23,7 +23,7 @@ export class RunStep extends AzureWizardExecuteStep<IBuildImageInAzureContext> {
                 isPushEnabled: true,
                 sourceLocation: context.uploadedSourceLocation,
                 platform: { os: context.os },
-                dockerFilePath: path.relative(rootUri.path, context.dockerFilePath)
+                dockerFilePath: path.relative(rootUri.path, context.dockerfilePath)
             };
 
             const building: string = localize('buildingImage', 'Building image "{0}" in registry "{1}"...', context.imageName, context.registryName);
diff --git a/src/commands/deployWorkspaceProject/DeployWorkspaceProjectContext.ts b/src/commands/deployWorkspaceProject/DeployWorkspaceProjectContext.ts
@@ -0,0 +1,15 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import type { ExecuteActivityContext } from "@microsoft/vscode-azext-utils";
+import type { ICreateContainerAppContext } from "../createContainerApp/ICreateContainerAppContext";
+import type { IManagedEnvironmentContext } from "../createManagedEnvironment/IManagedEnvironmentContext";
+import type { IBuildImageInAzureContext } from "../deployImage/imageSource/buildImageInAzure/IBuildImageInAzureContext";
+import type { CreateAcrContext } from "../deployImage/imageSource/containerRegistry/acr/createAcr/CreateAcrContext";
+
+// Use intersection typing instead of an interface here to bypass some minor (relatively trivial) type mismatch issues introduced by having to use the 'Partial' utility
+export type DeployWorkspaceProjectContext = IManagedEnvironmentContext & ICreateContainerAppContext & CreateAcrContext & Partial<IBuildImageInAzureContext> & ExecuteActivityContext & {
+    shouldSaveDeploySettings?: boolean;
+};
diff --git a/src/commands/deployWorkspaceProject/deployWorkspaceProject.ts b/src/commands/deployWorkspaceProject/deployWorkspaceProject.ts
@@ -0,0 +1,59 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, IActionContext, ISubscriptionContext, createSubscriptionContext, subscriptionExperience } from "@microsoft/vscode-azext-utils";
+import { AzureSubscription } from "@microsoft/vscode-azureresources-api";
+import { ProgressLocation, window } from "vscode";
+import { ext } from "../../extensionVariables";
+import { createActivityContext } from "../../utils/activityUtils";
+import { localize } from "../../utils/localize";
+import type { DeployWorkspaceProjectContext } from "./DeployWorkspaceProjectContext";
+import { getDefaultContextValues } from "./getDefaultValues/getDefaultContextValues";
+
+export async function deployWorkspaceProject(context: IActionContext): Promise<void> {
+    ext.outputChannel.appendLog(localize('beginCommandExecution', '--------Initializing deploy workspace project--------'));
+
+    const subscription: AzureSubscription = await subscriptionExperience(context, ext.rgApiV2.resources.azureResourceTreeDataProvider);
+    const subscriptionContext: ISubscriptionContext = createSubscriptionContext(subscription);
+
+    // Show loading indicator while we configure default values
+    let defaultContextValues: Partial<DeployWorkspaceProjectContext> | undefined;
+    await window.withProgress({
+        location: ProgressLocation.Notification,
+        cancellable: false,
+        title: localize('loadingWorkspaceTitle', 'Loading workspace project deployment configurations...')
+    }, async () => {
+        defaultContextValues = await getDefaultContextValues({ ...context, ...subscriptionContext });
+    });
+
+    const wizardContext: DeployWorkspaceProjectContext = {
+        ...context,
+        ...subscriptionContext,
+        ...await createActivityContext(),
+        ...defaultContextValues,
+        activityChildren: [],
+        subscription,
+    };
+
+    const promptSteps: AzureWizardPromptStep<DeployWorkspaceProjectContext>[] = [
+        // new DeployWorkspaceProjectConfirmStep(),
+        // new DefaultResourcesNameStep()
+    ];
+
+    const executeSteps: AzureWizardExecuteStep<DeployWorkspaceProjectContext>[] = [
+        // new DeployWorkspaceProjectSaveSettingsStep()
+    ];
+
+    const wizard: AzureWizard<DeployWorkspaceProjectContext> = new AzureWizard(wizardContext, {
+        title: localize('deployWorkspaceProjectTitle', 'Deploy workspace project to a container app'),
+        promptSteps,
+        executeSteps,
+        showLoadingPrompt: true
+    });
+
+    await wizard.prompt();
+
+    throw new Error('Not finished implementing');
+}
diff --git a/src/commands/deployWorkspaceProject/getDefaultValues/getDefaultContextValues.ts b/src/commands/deployWorkspaceProject/getDefaultValues/getDefaultContextValues.ts
@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import type { ISubscriptionActionContext } from "@microsoft/vscode-azext-utils";
+import type { DeployWorkspaceProjectContext } from "../DeployWorkspaceProjectContext";
+import { getWorkspaceProjectPaths } from "./getWorkspaceProjectPaths";
+
+export async function getDefaultContextValues(context: ISubscriptionActionContext): Promise<Partial<DeployWorkspaceProjectContext>> {
+    const { rootFolder, dockerfilePath } = await getWorkspaceProjectPaths(context);
+
+    // const settings: IDeployWorkspaceProjectSettings | undefined = await getDeployWorkspaceProjectSettings(rootFolder);
+    // if (!settings) {
+    //     ext.outputChannel.appendLog(localize('noWorkspaceSettings', 'Scanned and found no matching resource settings at "{0}".', relativeSettingsFilePath));
+    // } else if (!settings.containerAppResourceGroupName || !settings.containerAppName || !settings.containerRegistryName) {
+    //     ext.outputChannel.appendLog(localize('resourceSettingsIncomplete', 'Scanned and found incomplete container app resource settings at "{0}".', relativeSettingsFilePath));
+    // }
+
+    return {
+        // ...await getDefaultContainerAppsResources(context, settings),
+        // ...await getDefaultAzureContainerRegistry(context, settings),
+        // newRegistrySku: KnownSkuName.Basic,
+        dockerfilePath,
+        // environmentVariables: await EnvironmentVariablesListStep.workspaceHasEnvFile() ? undefined : [],
+        // imageSource: ImageSource.RemoteAcrBuild,
+        // os: AcrBuildSupportedOS.Linux,
+        rootFolder,
+    };
+}
diff --git a/src/commands/deployWorkspaceProject/getDefaultValues/getWorkspaceProjectPaths.ts b/src/commands/deployWorkspaceProject/getDefaultValues/getWorkspaceProjectPaths.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 { IActionContext, UserCancelledError, nonNullValue } from "@microsoft/vscode-azext-utils";
+import { Uri, WorkspaceFolder, commands, workspace } from "vscode";
+import { DOCKERFILE_GLOB_PATTERN, browseItem } from "../../../constants";
+import { localize } from "../../../utils/localize";
+import { getRootWorkspaceFolder } from "../../../utils/workspaceUtils";
+
+export async function getWorkspaceProjectPaths(context: IActionContext): Promise<{ rootFolder: WorkspaceFolder, dockerfilePath: string }> {
+    const prompt: string = localize('selectRootWorkspace', 'Select a project with a Dockerfile');
+    const rootFolder: WorkspaceFolder | undefined = await getRootWorkspaceFolder(prompt);
+
+    if (!rootFolder) {
+        await context.ui.showQuickPick([browseItem], { placeHolder: prompt });
+        await commands.executeCommand('vscode.openFolder');
+
+        // Silently throw an exception to exit the command while VS Code reloads the new workspace
+        throw new UserCancelledError();
+    }
+
+    // Todo: Add logic allowing users to choose their workspace Dockerfile
+    const dockerfileUris: Uri[] = await workspace.findFiles(DOCKERFILE_GLOB_PATTERN);
+    if (!dockerfileUris.length) {
+        throw new Error(localize('noDockerfileError', 'Unable to locate a Dockerfile in your project\'s root.'));
+    } else if (dockerfileUris.length > 1) {
+        throw new Error(localize('multipleDockerfileError', 'Multiple Dockerfiles found. Unable to determine the correct Dockerfile to use in your project\'s root.'));
+    }
+
+    return {
+        rootFolder: nonNullValue(rootFolder),
+        dockerfilePath: dockerfileUris[0].path
+    };
+}
diff --git a/src/commands/registerCommands.ts b/src/commands/registerCommands.ts
diff --git a/src/constants.ts b/src/constants.ts
diff --git a/src/utils/workspaceUtils.ts b/src/utils/workspaceUtils.ts

Original file line number	Diff line number	Diff line change
`@@ -11,10 +11,10 @@ import type { IBuildImageInAzureContext } from "./IBuildImageInAzureContext";`
`11`	`11`
`12`	`12`	`export class DockerFileItemStep extends AzureWizardPromptStep<IBuildImageInAzureContext> {`
`13`	`13`	`public async prompt(context: IBuildImageInAzureContext): Promise<void> {`
`14`		`- context.dockerFilePath = await selectWorkspaceFile(context, localize('dockerFilePick', 'Select a Dockerfile'), { filters: {} }, DOCKERFILE_GLOB_PATTERN);`
	`14`	`+ context.dockerfilePath = await selectWorkspaceFile(context, localize('dockerFilePick', 'Select a Dockerfile'), { filters: {} }, DOCKERFILE_GLOB_PATTERN);`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`public shouldPrompt(context: IBuildImageInAzureContext): boolean {`
`18`		`- return !context.dockerFilePath;`
	`18`	`+ return !context.dockerfilePath;`
`19`	`19`	`}`
`20`	`20`	`}`