@pagopa/dx-cli 0.21.1 → 0.21.2

package/dist/adapters/commander/commands/__tests__/init.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Tests for confirmGitHubRepoCreation in the init command.
+ */
+export {};

package/dist/adapters/commander/commands/__tests__/init.test.js

@@ -0,0 +1,48 @@
+/**
+ * Tests for confirmGitHubRepoCreation in the init command.
+ */
+import inquirer from "inquirer";
+import { afterEach, describe, expect, it, vi } from "vitest";
+import { confirmGitHubRepoCreation } from "../init.js";
+vi.mock("inquirer");
+const makePayload = (overrides = {}) => ({
+    repoDescription: "A test repo",
+    repoName: "test-repo",
+    repoOwner: "pagopa",
+    ...overrides,
+});
+describe("confirmGitHubRepoCreation", () => {
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+    it("returns true when the user confirms", async () => {
+        vi.mocked(inquirer.prompt).mockResolvedValue({ confirm: true });
+        const result = await confirmGitHubRepoCreation(makePayload());
+        expect(result.isOk()).toBe(true);
+        expect(result._unsafeUnwrap()).toBe(true);
+    });
+    it("returns false when the user declines", async () => {
+        vi.mocked(inquirer.prompt).mockResolvedValue({ confirm: false });
+        const result = await confirmGitHubRepoCreation(makePayload());
+        expect(result.isOk()).toBe(true);
+        expect(result._unsafeUnwrap()).toBe(false);
+    });
+    it("prompts with the correct repository name and owner", async () => {
+        vi.mocked(inquirer.prompt).mockResolvedValue({ confirm: true });
+        const payload = makePayload({ repoName: "my-repo", repoOwner: "my-org" });
+        await confirmGitHubRepoCreation(payload);
+        expect(inquirer.prompt).toHaveBeenCalledWith(expect.objectContaining({
+            message: expect.stringContaining("my-org/my-repo"),
+            type: "confirm",
+        }));
+    });
+    it("returns an error result when the prompt rejects", async () => {
+        const cause = new Error("non-interactive TTY");
+        vi.mocked(inquirer.prompt).mockRejectedValue(cause);
+        const result = await confirmGitHubRepoCreation(makePayload());
+        expect(result.isErr()).toBe(true);
+        const err = result._unsafeUnwrapErr();
+        expect(err).toBeInstanceOf(Error);
+        expect(err.cause).toBe(cause);
+    });
+});

package/dist/adapters/commander/commands/init.d.ts

@@ -1,6 +1,7 @@
 import { Command } from "commander";
 import { ResultAsync } from "neverthrow";
 import { GitHubService } from "../../../domain/github.js";
+import { Payload as MonorepoPayload } from "../../plop/generators/monorepo/index.js";
 export declare const checkInitPreconditions: () => ResultAsync<import("execa").Result<{
     environment: {
         NO_COLOR: string;
@@ -17,6 +18,7 @@ export declare const checkAddEnvironmentPreconditions: () => ResultAsync<import(
     };
     shell: true;
 }>, Error>;
+export declare const confirmGitHubRepoCreation: (payload: MonorepoPayload) => ResultAsync<boolean, Error>;
 type InitCommandDependencies = {
     gitHubService: GitHubService;
 };

package/dist/adapters/commander/commands/init.js

@@ -2,6 +2,7 @@ import { getLogger } from "@logtape/logtape";
 import chalk from "chalk";
 import { Command } from "commander";
 import { $, ExecaError } from "execa";
+import inquirer from "inquirer";
 import { okAsync, ResultAsync } from "neverthrow";
 import * as path from "node:path";
 import { oraPromise } from "ora";
@@ -10,13 +11,28 @@ import { Repository, } from "../../../domain/github.js";
 import { tf$ } from "../../execa/terraform.js";
 import { getPlopInstance, runMonorepoGenerator } from "../../plop/index.js";
 import { exitWithError } from "../index.js";
+const isGitHubRepoCreationSkipped = (input) => "gitHubRepoCreationSkipped" in input;
 const withSpinner = (text, successText, failText, promise) => ResultAsync.fromPromise(oraPromise(promise, {
     failText,
     successText,
     text,
 }), (cause) => new Error(failText, { cause }));
-const displaySummary = (initResult) => {
-    const { pr, repository } = initResult;
+const displaySummary = (input) => {
+    const docsUrl = "https://dx.pagopa.it/getting-started";
+    if (isGitHubRepoCreationSkipped(input)) {
+        const { payload } = input;
+        console.log(chalk.yellow.bold("\nGitHub repository creation skipped."));
+        console.log(`The workspace files have been scaffolded in ${chalk.cyan(payload.repoName + "/")}.`);
+        console.log(chalk.bold("\nTo finish the setup manually:"));
+        let step = 1;
+        console.log(`${step++}. Create the GitHub repository by applying the Terraform config scaffolded at ${chalk.cyan(`${payload.repoName}/infra/repository`)}:`);
+        console.log(`       ${chalk.cyan(`cd ${payload.repoName}/infra/repository && terraform init && terraform apply`)}`);
+        console.log(`${step++}. Push the scaffolded code to the newly created repository:`);
+        console.log(`       ${chalk.cyan(`cd ${payload.repoName} && git init && git remote add origin <url> && git push`)}`);
+        console.log(`${step}. Visit ${chalk.underline(docsUrl)} to deploy your first project\n`);
+        return;
+    }
+    const { pr, repository } = input;
     console.log(chalk.green.bold("\nWorkspace created successfully!"));
     if (repository) {
         console.log(`- Name: ${chalk.cyan(repository.name)}`);
@@ -29,7 +45,7 @@ const displaySummary = (initResult) => {
         let step = 1;
         console.log(chalk.green.bold("\nNext Steps:"));
         console.log(`${step++}. Review the Pull Request in the GitHub repository: ${chalk.underline(pr.url)}`);
-        console.log(`${step}. Visit ${chalk.underline("https://dx.pagopa.it/getting-started")} to deploy your first project\n`);
+        console.log(`${step}. Visit ${chalk.underline(docsUrl)} to deploy your first project\n`);
     }
     else {
         console.log(chalk.yellow(`\n⚠️ There was an error during Pull Request creation.`));
@@ -118,6 +134,14 @@ const handleGeneratorError = (err) => {
     }
     return new Error("Failed to run the generator", { cause: err });
 };
+export const confirmGitHubRepoCreation = (payload) => ResultAsync.fromPromise(inquirer
+    .prompt({
+    default: true,
+    message: `The project is created on ${chalk.green(payload.repoName)}. Would you like to publish it to GitHub at ${chalk.green(`${payload.repoOwner}/${payload.repoName}`)} now?`,
+    name: "confirm",
+    type: "confirm",
+})
+    .then(({ confirm }) => confirm), (cause) => new Error("Failed to read GitHub publish confirmation", { cause }));
 export const makeInitCommand = ({ gitHubService, }) => new Command()
     .name("init")
     .description("Initialize a new DX workspace")
@@ -128,6 +152,8 @@ export const makeInitCommand = ({ gitHubService, }) => new Command()
         .andTee((payload) => {
         process.chdir(payload.repoName);
     })
-        .andThen((payload) => handleNewGitHubRepository(gitHubService)(payload))
+        .andThen((payload) => confirmGitHubRepoCreation(payload).andThen((confirmed) => confirmed
+        ? handleNewGitHubRepository(gitHubService)(payload)
+        : okAsync({ gitHubRepoCreationSkipped: true, payload })))
         .match(displaySummary, exitWithError(this));
 });

package/dist/adapters/plop/generators/environment/__tests__/prompts.test.js

@@ -1,6 +1,6 @@
 // Tests for workspaceSchema transforms (lowercase and trim on domain).
 import { describe, expect, it } from "vitest";
-import { workspaceSchema } from "../prompts.js";
+import { formatInitializationDetails, workspaceSchema } from "../prompts.js";
 describe("workspaceSchema — domain transforms", () => {
     it("lowercases an uppercase domain", () => {
         const result = workspaceSchema.safeParse({ domain: "API" });
@@ -23,3 +23,63 @@ describe("workspaceSchema — domain transforms", () => {
         expect(result.success && result.data.domain).toBe("");
     });
 });
+describe("formatInitializationDetails", () => {
+    const account = (overrides = {}) => ({
+        csp: "azure",
+        defaultLocation: "italynorth",
+        displayName: "DEV-FooBar",
+        id: "sub-123",
+        ...overrides,
+    });
+    const notInitializedStatus = (issues) => ({
+        initialized: false,
+        issues,
+    });
+    it("lists each uninitialized cloud account by displayName", () => {
+        const status = notInitializedStatus([
+            {
+                cloudAccount: account({ displayName: "DEV-A" }),
+                type: "CLOUD_ACCOUNT_NOT_INITIALIZED",
+            },
+            {
+                cloudAccount: account({ displayName: "DEV-B" }),
+                type: "CLOUD_ACCOUNT_NOT_INITIALIZED",
+            },
+        ]);
+        const output = formatInitializationDetails(status);
+        expect(output).toContain('Azure subscription "DEV-A"');
+        expect(output).toContain('Azure subscription "DEV-B"');
+        expect(output).toContain("managed identity");
+        expect(output).toContain("OIDC");
+        expect(output).toContain("ARM_CLIENT_ID");
+        expect(output).toContain("ARM_SUBSCRIPTION_ID");
+        expect(output).not.toContain("ARM_TENANT_ID");
+        expect(output).toContain("Key Vault");
+    });
+    it("includes the Terraform backend section when MISSING_REMOTE_BACKEND issue is present", () => {
+        const status = notInitializedStatus([
+            { cloudAccount: account(), type: "CLOUD_ACCOUNT_NOT_INITIALIZED" },
+            { type: "MISSING_REMOTE_BACKEND" },
+        ]);
+        const output = formatInitializationDetails(status);
+        expect(output).toContain("Terraform remote backend");
+        expect(output).toContain("Storage Account");
+    });
+    it("omits the Terraform backend section when no MISSING_REMOTE_BACKEND issue is present", () => {
+        const status = notInitializedStatus([
+            { cloudAccount: account(), type: "CLOUD_ACCOUNT_NOT_INITIALIZED" },
+        ]);
+        const output = formatInitializationDetails(status);
+        expect(output).not.toContain("Terraform remote backend");
+    });
+    it("omits the cloud account section when no CLOUD_ACCOUNT_NOT_INITIALIZED issues are present", () => {
+        const status = notInitializedStatus([{ type: "MISSING_REMOTE_BACKEND" }]);
+        const output = formatInitializationDetails(status);
+        expect(output).not.toContain("Azure subscription");
+        expect(output).toContain("Terraform remote backend");
+    });
+    it("returns an empty string when there are no relevant issues", () => {
+        const status = notInitializedStatus([]);
+        expect(formatInitializationDetails(status)).toBe("");
+    });
+});

package/dist/adapters/plop/generators/environment/prompts.d.ts

@@ -79,4 +79,13 @@ export declare const getCloudAccountToInitialize: (initStatus: EnvironmentInitSt
     displayName: string;
     id: string;
 }[];
+/**
+ * Build a human-readable description of the resources that will be created
+ * when initializing an environment, so users see the side effects before
+ * confirming. The exact resource names are intentionally omitted to avoid
+ * coupling the prompt copy to internal naming conventions.
+ */
+export declare const formatInitializationDetails: (initStatus: EnvironmentInitStatus & {
+    initialized: false;
+}) => string;
 export default prompts;

package/dist/adapters/plop/generators/environment/prompts.js

@@ -1,3 +1,4 @@
+import chalk from "chalk";
 import * as assert from "node:assert/strict";
 import { cloudAccountSchema, } from "../../../../domain/cloud-account.js";
 import { environmentSchema, getInitializationStatus, hasUserPermissionToInitialize, } from "../../../../domain/environment.js";
@@ -126,9 +127,10 @@ const prompts = (deps) => async (inquirer) => {
     if (initStatus.initialized) {
         return payload;
     }
+    console.log(formatInitializationDetails(initStatus));
     const initConfirm = await inquirer.prompt({
         default: true,
-        message: "The environment is not initialized. Do you want to initialize it now?",
+        message: `The environment "${payload.env.name}" is not initialized. Proceed with the setup above?`,
         name: "init",
         type: "confirm",
     });
@@ -198,4 +200,40 @@ export const getCloudLocationChoices = (regions) => regions.map((r) => ({ name:
 export const getCloudAccountToInitialize = (initStatus) => initStatus.issues
     .filter((issue) => issue.type === "CLOUD_ACCOUNT_NOT_INITIALIZED")
     .map((issue) => issue.cloudAccount);
+/**
+ * Build a human-readable description of the resources that will be created
+ * when initializing an environment, so users see the side effects before
+ * confirming. The exact resource names are intentionally omitted to avoid
+ * coupling the prompt copy to internal naming conventions.
+ */
+export const formatInitializationDetails = (initStatus) => {
+    const accountsToInit = getCloudAccountToInitialize(initStatus);
+    const missingBackend = initStatus.issues.some((issue) => issue.type === "MISSING_REMOTE_BACKEND");
+    const sections = [];
+    for (const account of accountsToInit) {
+        sections.push([
+            chalk.bold.cyan(`  Azure subscription "${account.displayName}":`),
+            `    • Bootstrap resource group and managed identity with subscription-scoped roles`,
+            `    • GitHub OIDC federated identity credential`,
+            `    • GitHub environment secrets (ARM_CLIENT_ID, ARM_SUBSCRIPTION_ID)`,
+            `    • Common Key Vault storing the GitHub runner app credentials`,
+        ].join("\n"));
+    }
+    if (missingBackend) {
+        sections.push([
+            chalk.bold.cyan(`  Terraform remote backend:`),
+            `    • Azure resource group and Storage Account for the Terraform state`,
+        ].join("\n"));
+    }
+    if (sections.length === 0) {
+        return "";
+    }
+    return [
+        "",
+        chalk.bold("The following resources will be created:"),
+        "",
+        ...sections,
+        "",
+    ].join("\n");
+};
 export default prompts;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pagopa/dx-cli",
-  "version": "0.21.1",
+  "version": "0.21.2",
   "type": "module",
   "description": "A CLI useful to manage DX tools.",
   "repository": {