Remaining connectToGitHub command implementation (#355)

Author: MicroFish91

package.nls.json

@@ -27,7 +27,7 @@
     "containerApps.openConsoleInPortal": "Open Console in Portal",
     "containerApps.editScalingRange": "Edit Scaling Range...",
     "containerApps.addScaleRule": "Add Scale Rule...",
-    "containerApps.connectToGitHub": "Connect to a GitHub Repository...",
+    "containerApps.connectToGitHub": "Connect to GitHub Repository...",
     "containerApps.startStreamingLogs": "Start Streaming Logs...",
     "containerApps.stopStreamingLogs": "Stop Streaming Logs..."
 }

src/commands/connectToGitHub/DockerfileLocationInputStep.ts

@@ -0,0 +1,28 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizardPromptStep } from "@microsoft/vscode-azext-utils";
+import { localize } from "../../utils/localize";
+import { validateUtils } from "../../utils/validateUtils";
+import type { IConnectToGitHubContext } from "./IConnectToGitHubContext";
+
+export class DockerfileLocationInputStep extends AzureWizardPromptStep<IConnectToGitHubContext> {
+    public async prompt(context: IConnectToGitHubContext): Promise<void> {
+        context.dockerfilePath = (await context.ui.showInputBox({
+            value: './Dockerfile',
+            prompt: localize('dockerfileLocationPrompt', "Enter the relative location of the Dockerfile in the repository."),
+            validateInput: this.validateInput
+        })).trim();
+    }
+
+    public shouldPrompt(context: IConnectToGitHubContext): boolean {
+        return !context.dockerfilePath;
+    }
+
+    private validateInput(dockerfilePath: string): string | undefined {
+        dockerfilePath = dockerfilePath ? dockerfilePath.trim() : '';
+        return !validateUtils.isValidLength(dockerfilePath) ? validateUtils.getInvalidLengthMessage() : undefined;
+    }
+}

src/commands/connectToGitHub/GitHubRepositoryConnectStep.ts

@@ -0,0 +1,64 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import type { ContainerAppsAPIClient, SourceControl } from "@azure/arm-appcontainers";
+import { AzureWizardExecuteStep, nonNullProp } from "@microsoft/vscode-azext-utils";
+import type { Progress } from "vscode";
+import { ext } from "../../extensionVariables";
+import { createContainerAppsClient } from "../../utils/azureClients";
+import { localize } from "../../utils/localize";
+import { listCredentialsFromRegistry } from "../imageSource/containerRegistry/acr/listCredentialsFromRegistry";
+import type { IConnectToGitHubContext } from "./IConnectToGitHubContext";
+
+export class GitHubRepositoryConnectStep extends AzureWizardExecuteStep<IConnectToGitHubContext> {
+    public priority: number = 300;
+
+    public async execute(context: IConnectToGitHubContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
+        const client: ContainerAppsAPIClient = await createContainerAppsClient(context, context.subscription);
+        const { username, password } = await listCredentialsFromRegistry(context, nonNullProp(context, 'registry'));
+
+        const rgName: string = context.targetContainer.resourceGroup;
+        const caName: string = context.targetContainer.name;
+
+        const scName: string = 'current';
+        const scEnvelope: SourceControl = {
+            repoUrl: context.gitHubRepositoryUrl,
+            branch: context.gitHubBranch,
+            githubActionConfiguration: {
+                contextPath: context.dockerfilePath,
+                image: context.repositoryName,
+                azureCredentials: {
+                    clientId: context.servicePrincipalId,
+                    clientSecret: context.servicePrincipalSecret,
+                    tenantId: context.subscription.tenantId
+                },
+                registryInfo: {
+                    registryUrl: context.registry?.loginServer,
+                    registryUserName: username,
+                    registryPassword: password.value
+                }
+            }
+        };
+        const requestOptions = {
+            customHeaders: {
+                'x-ms-github-auxiliary': nonNullProp(context, 'gitHubAccessToken')
+            }
+        };
+
+        const connecting: string = localize('connectingRepository', 'Connecting "{0}"...', context.gitHubRepository);
+        progress.report({ message: connecting });
+
+        await client.containerAppsSourceControls.beginCreateOrUpdateAndWait(rgName, caName, scName, scEnvelope, { requestOptions });
+        ext.state.notifyChildrenChanged(context.targetContainer.id);
+
+        const gitHubRepository: string = `${context.gitHubOrg || context.gitHubRepositoryOwner}/${context.gitHubRepository}`;
+        const connected: string = localize('connectedRepository', 'Connected repository "{0}" to container app "{1}".', gitHubRepository, context.targetContainer.name);
+        ext.outputChannel.appendLog(connected);
+    }
+
+    public shouldExecute(): boolean {
+        return true;
+    }
+}

src/commands/connectToGitHub/ServicePrincipalIdInputStep.ts

@@ -0,0 +1,28 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizardPromptStep } from "@microsoft/vscode-azext-utils";
+import { localize } from "../../utils/localize";
+import { validateUtils } from "../../utils/validateUtils";
+import type { IConnectToGitHubContext } from "./IConnectToGitHubContext";
+
+export class ServicePrincipalIdInputStep extends AzureWizardPromptStep<IConnectToGitHubContext> {
+    public async prompt(context: IConnectToGitHubContext): Promise<void> {
+        context.servicePrincipalId = (await context.ui.showInputBox({
+            prompt: localize('servicePrincipalIdPrompt', 'Enter the service principal ID'),
+            validateInput: this.validateInput
+        })).trim();
+        context.valuesToMask.push(context.servicePrincipalId);
+    }
+
+    public shouldPrompt(context: IConnectToGitHubContext): boolean {
+        return !context.servicePrincipalId;
+    }
+
+    private validateInput(id: string): string | undefined {
+        id = id ? id.trim() : '';
+        return !validateUtils.isValidLength(id) ? validateUtils.getInvalidLengthMessage() : undefined;
+    }
+}

src/commands/connectToGitHub/ServicePrincipalSecretInputStep.ts

@@ -0,0 +1,28 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizardPromptStep } from "@microsoft/vscode-azext-utils";
+import { localize } from "../../utils/localize";
+import { validateUtils } from "../../utils/validateUtils";
+import type { IConnectToGitHubContext } from "./IConnectToGitHubContext";
+
+export class ServicePrincipalSecretInputStep extends AzureWizardPromptStep<IConnectToGitHubContext> {
+    public async prompt(context: IConnectToGitHubContext): Promise<void> {
+        context.servicePrincipalSecret = (await context.ui.showInputBox({
+            prompt: localize('servicePrincipalSecretPrompt', 'Enter the service principal secret'),
+            validateInput: this.validateInput
+        })).trim();
+        context.valuesToMask.push(context.servicePrincipalSecret);
+    }
+
+    public shouldPrompt(context: IConnectToGitHubContext): boolean {
+        return !context.servicePrincipalSecret;
+    }
+
+    private validateInput(secret: string): string | undefined {
+        secret = secret ? secret.trim() : '';
+        return !validateUtils.isValidLength(secret) ? validateUtils.getInvalidLengthMessage() : undefined;
+    }
+}

src/commands/connectToGitHub/connectToGitHub.ts

@@ -8,11 +8,18 @@ import { GitHubBranchListStep } from "../../gitHub/GitHubBranchListStep";
 import { GitHubOrgListStep } from "../../gitHub/GitHubOrgListStep";
 import { GitHubRepositoryListStep } from "../../gitHub/GitHubRepositoryListStep";
 import { getGitHubAccessToken } from "../../gitHub/getGitHubAccessToken";
-import { ContainerAppItem } from "../../tree/ContainerAppItem";
+import type { ContainerAppItem } from "../../tree/ContainerAppItem";
 import { createActivityContext } from "../../utils/activityUtils";
 import { localize } from "../../utils/localize";
 import { pickContainerApp } from "../../utils/pickContainerApp";
-import { IConnectToGitHubContext } from "./IConnectToGitHubContext";
+import { AcrListStep } from "../imageSource/containerRegistry/acr/AcrListStep";
+import { AcrRepositoriesListStep } from "../imageSource/containerRegistry/acr/AcrRepositoriesListStep";
+import { DockerfileLocationInputStep } from "./DockerfileLocationInputStep";
+import { GitHubRepositoryConnectStep } from "./GitHubRepositoryConnectStep";
+import type { IConnectToGitHubContext } from "./IConnectToGitHubContext";
+import { ServicePrincipalIdInputStep } from "./ServicePrincipalIdInputStep";
+import { ServicePrincipalSecretInputStep } from "./ServicePrincipalSecretInputStep";
+import { isGitHubConnected } from "./isGitHubConnected";
 
 export async function connectToGitHub(context: ITreeItemPickerContext & Partial<IConnectToGitHubContext>, node?: ContainerAppItem): Promise<void> {
     if (!node) {
@@ -31,21 +38,25 @@ export async function connectToGitHub(context: ITreeItemPickerContext & Partial<
         gitHubAccessToken: await getGitHubAccessToken()
     };
 
-    const title: string = localize('connectGitHubRepository', 'Connect a GitHub repository');
+    if (await isGitHubConnected(wizardContext)) {
+        throw new Error(localize('gitHubAlreadyConnected', '"{0}" is already connected to a GitHub repository.', containerApp.name));
+    }
+
+    const title: string = localize('connectGitHubRepository', 'Connect a GitHub repository to "{0}"', containerApp.name);
 
     const promptSteps: AzureWizardPromptStep<IConnectToGitHubContext>[] = [
         new GitHubOrgListStep(),
         new GitHubRepositoryListStep(),
-        new GitHubBranchListStep()
-        // new DockerfileLocationInputStep(),
-        // new AcrListStep(),
-        // new AcrRepositoriesListStep(),
-        // new ServicePrincipalIdInputStep(),
-        // new ServicePrincipalSecretInputStep()
+        new GitHubBranchListStep(),
+        new DockerfileLocationInputStep(),
+        new AcrListStep(),
+        new AcrRepositoriesListStep(),
+        new ServicePrincipalIdInputStep(),
+        new ServicePrincipalSecretInputStep()
     ];
 
     const executeSteps: AzureWizardExecuteStep<IConnectToGitHubContext>[] = [
-        // new GithubActionCreateStep()
+        new GitHubRepositoryConnectStep()
     ];
 
     const wizard: AzureWizard<IConnectToGitHubContext> = new AzureWizard(wizardContext, {
@@ -56,8 +67,6 @@ export async function connectToGitHub(context: ITreeItemPickerContext & Partial<
     });
 
     await wizard.prompt();
-    // await wizard.execute();
-
-    throw new Error("'connectToGitHub' is not fully implemented yet.");
+    await wizard.execute();
 }
 

src/commands/connectToGitHub/getContainerAppSourceControl.ts

@@ -0,0 +1,17 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import type { ContainerAppsAPIClient, SourceControl } from "@azure/arm-appcontainers";
+import { uiUtils } from "@microsoft/vscode-azext-azureutils";
+import { IActionContext, createSubscriptionContext } from "@microsoft/vscode-azext-utils";
+import type { AzureSubscription } from "@microsoft/vscode-azureresources-api";
+import type { ContainerAppModel } from "../../tree/ContainerAppItem";
+import { createContainerAppsAPIClient } from "../../utils/azureClients";
+
+export async function getContainerAppSourceControl(context: IActionContext, subscription: AzureSubscription, containerApp: ContainerAppModel): Promise<SourceControl | undefined> {
+    const client: ContainerAppsAPIClient = await createContainerAppsAPIClient([context, createSubscriptionContext(subscription)]);
+    const sourceControlsIterator = client.containerAppsSourceControls.listByContainerApp(containerApp.resourceGroup, containerApp.name);
+    return (await uiUtils.listAllIterator(sourceControlsIterator))[0];
+}

src/commands/connectToGitHub/isGitHubConnected.ts

@@ -0,0 +1,13 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import type { IActionContext } from "@microsoft/vscode-azext-utils";
+import type { AzureSubscription } from "@microsoft/vscode-azureresources-api";
+import type { ContainerAppModel } from "../../tree/ContainerAppItem";
+import { getContainerAppSourceControl } from "./getContainerAppSourceControl";
+
+export async function isGitHubConnected(context: IActionContext & { subscription: AzureSubscription, targetContainer: ContainerAppModel }): Promise<boolean> {
+    return !!await getContainerAppSourceControl(context, context.subscription, context.targetContainer);
+}

src/utils/validateUtils.ts

@@ -0,0 +1,43 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { localize } from "./localize";
+
+export namespace validateUtils {
+    const thirtyTwoBitMaxSafeInteger: number = 2147483647;
+    // Estimated using UTF-8 encoding, where a character can be up to ~4 bytes long
+    const maxSafeCharacterLength: number = thirtyTwoBitMaxSafeInteger / 32;
+
+    /**
+     * Validates that the given input string is the appropriate length as determined by the optional lower and upper limit parameters
+     */
+    export function isValidLength(value: string, lowerLimitIncl?: number, upperLimitIncl?: number): boolean {
+        lowerLimitIncl ??= 1;
+        upperLimitIncl = (!upperLimitIncl || upperLimitIncl > maxSafeCharacterLength) ? maxSafeCharacterLength : upperLimitIncl;
+
+        if (lowerLimitIncl > upperLimitIncl || value.length < lowerLimitIncl || value.length > upperLimitIncl) {
+            return false;
+        } else {
+            return true;
+        }
+    }
+
+    /**
+     * Provides a message that can be used to inform the user of invalid input lengths as determined by the optional lower and upper limit parameters
+     */
+    export const getInvalidLengthMessage = (lowerLimitIncl?: number, upperLimitIncl?: number): string => {
+        if (!lowerLimitIncl && !upperLimitIncl) {
+            // Could technically also correspond to a 'maxSafeCharacterLength' overflow (see 'isValidLength'),
+            // but extremely unlikely that a user would ever reach that limit naturally unless intentionally trying to break the extension
+            return localize('invalidInputLength', 'A valid input value is required to proceed.');
+        } else if (lowerLimitIncl && !upperLimitIncl) {
+            return localize('inputLengthTooShort', 'The input value must be {0} characters or greater.', lowerLimitIncl);
+        } else if (!lowerLimitIncl && upperLimitIncl) {
+            return localize('inputLengthTooLong', 'The input value must be {0} characters or less.', upperLimitIncl);
+        } else {
+            return localize('invalidBetweenInputLength', 'The input value must be between {0} and {1} characters long.', lowerLimitIncl, upperLimitIncl);
+        }
+    }
+}