feat: init e2e test workflow for Package Manager Support

.changeset/metal-tomatoes-check.md

@@ -0,0 +1,6 @@
+---
+'create-amplify': patch
+---
+
+1. Create Amplify (temporarily) uses environment variable for Package Manager
+2. Create Amplify uses `yes` option to choose the default value for prompts

.github/workflows/poc-e2e-flow-test.yml

@@ -0,0 +1,55 @@
+# Description: This workflow mimic the flow of behaviors when user using Amplify CLI;
+
+name: 'poc-e2e-flow-test'
+
+on: # TODO: need to change the trigger
+  push:
+    branches:
+      - poc/e2e-test
+
+jobs:
+  create-amplify-project:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+        node-version: [18]
+        pkg-manager: [npm, yarn, yarn-stable, pnpm]
+    runs-on: ${{ matrix.os }}
+    env:
+      PACKAGE_MANAGER_EXECUTABLE: ${{ matrix.pkg-manager }} # TODO: remove PACKAGE_MANAGER_EXECUTABLE once CLI is able to getPackageManager().
+    steps:
+      - name: Checkout aws-amplify/amplify-cli repo
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1. TODO: try only fetch .github/workflow
+      - name: Setup Node.js
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 #4.0.0
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+      - name: Local Publish create-amplify
+        shell: bash
+        run: npm run install:local && npm run build && npm run vend
+      - name: ${{matrix.pkg-manager}}-create-amplify-project
+        if: matrix.pkg-manager != 'yarn-stable'
+        shell: bash
+        run: |
+          mkdir -p /tmp/amplify-project; cd /tmp/amplify-project
+          npm install -g ${{matrix.pkg-manager}}
+          echo "$(${{matrix.pkg-manager}}) config set registry http://localhost:4873"
+          ${{matrix.pkg-manager}} config set registry http://localhost:4873
+          echo "$(${{matrix.pkg-manager}}) config get registry"
+          ${{matrix.pkg-manager}} config get registry
+          ${{matrix.pkg-manager}} create amplify --yes
+
+      - name: yarn-stable-create-amplify-project
+        if: matrix.pkg-manager == 'yarn-stable'
+        shell: bash
+        run: |
+          mkdir -p /tmp/amplify-project; cd /tmp/amplify-project
+          corepack enable
+          echo "yarn set version stable"
+          yarn set version stable
+          echo "yarn version $(yarn --version)"
+          yarn config set unsafeHttpWhitelist localhost
+          yarn config set npmRegistryServer http://localhost:4873
+          PACKAGE_MANAGER_EXECUTABLE=yarn yarn create amplify --yes

packages/create-amplify/src/get_project_root.test.ts

@@ -2,8 +2,8 @@ import { afterEach, describe, it } from 'node:test';
 import assert from 'assert';
 import fsp from 'fs/promises';
 import path from 'path';
-import { getProjectRoot } from './get_project_root.js';
 import { AmplifyPrompter } from '@aws-amplify/cli-core';
+import { getProjectRoot } from './get_project_root.js';
 
 const originalEnv = process.env;
 
@@ -68,4 +68,19 @@ void describe('getProjectRoot', () => {
     );
     assert.equal(projectRoot, path.resolve(userInput));
   });
+
+  void it('use default options if `yes`', async (ctx) => {
+    process.env.npm_config_yes = 'false';
+    process.argv = ['node', 'test.js', '--yes'];
+    const userInput = 'test';
+    const fsMkDirSyncMock = ctx.mock.method(fsp, 'mkdir', () => undefined);
+    ctx.mock.method(fsp, 'stat', () => Promise.reject(new Error()));
+    ctx.mock.method(AmplifyPrompter, 'input', () => Promise.resolve(userInput));
+
+    const projectRoot = await getProjectRoot();
+
+    assert.equal(fsMkDirSyncMock.mock.callCount(), 1);
+    assert.equal(fsMkDirSyncMock.mock.calls[0].arguments[0], process.cwd());
+    assert.equal(projectRoot, process.cwd());
+  });
 });

packages/create-amplify/src/get_project_root.ts

@@ -1,13 +1,20 @@
 import fsp from 'fs/promises';
 import path from 'path';
+import yargs from 'yargs';
 import { AmplifyPrompter } from '@aws-amplify/cli-core';
 import { logger } from './logger.js';
 
 /**
  * Returns the project root directory.
  */
 export const getProjectRoot = async () => {
-  const useDefault = process.env.npm_config_yes === 'true';
+  const argv = await yargs(process.argv.slice(2)).options({
+    yes: {
+      type: 'boolean',
+      default: false,
+    },
+  }).argv;
+  const useDefault = process.env.npm_config_yes === 'true' || argv.yes === true;
   const defaultProjectRoot = '.';
   let projectRoot: string = useDefault
     ? defaultProjectRoot

packages/create-amplify/src/npm_package_manager_controller.test.ts

@@ -12,7 +12,7 @@ void describe('NpmPackageManagerController', () => {
     await npmPackageManagerController.installDependencies(['testDep'], 'dev');
     assert.deepStrictEqual(execaMock.mock.calls[0].arguments, [
       'npm',
-      ['install', 'testDep', '--save-dev'],
+      ['install', 'testDep', '-D'],
       { cwd: 'testPath', stdio: 'inherit' },
     ]);
   });

packages/create-amplify/src/npm_package_manager_controller.ts

@@ -15,7 +15,8 @@ export class NpmPackageManagerController implements PackageManagerController {
     private readonly projectRoot: string,
     private readonly execa = _execa
   ) {}
-  private readonly executableName = 'npm';
+  private readonly executableName =
+    process.env.PACKAGE_MANAGER_EXECUTABLE || 'npm'; // TODO: replace `process.env.PACKAGE_MANAGER_EXECUTABLE` with `getPackageManagerName()` once the test infra is ready.
 
   /**
    * Installs the given package names as devDependencies
@@ -24,9 +25,11 @@ export class NpmPackageManagerController implements PackageManagerController {
     packageNames: string[],
     type: DependencyType
   ): Promise<void> => {
-    const args = ['install'].concat(...packageNames);
+    const args = [this.executableName === 'yarn' ? 'add' : 'install'].concat(
+      ...packageNames
+    );
     if (type === 'dev') {
-      args.push('--save-dev');
+      args.push('-D');
     }
     await this.execa(this.executableName, args, {
       stdio: 'inherit',

packages/create-amplify/src/tsconfig_initializer.ts

@@ -17,6 +17,8 @@ export class TsConfigInitializer {
     private readonly existsSync = _existsSync,
     private readonly execa = _execa
   ) {}
+  private readonly executableName =
+    process.env.PACKAGE_MANAGER_EXECUTABLE || 'npx'; // TODO: replace `process.env.PACKAGE_MANAGER_EXECUTABLE` with `getPackageManagerName()` once the test infra is ready.
 
   /**
    * If tsconfig.json already exists, this is a noop. Otherwise, `npx tsc --init` is executed to create a tsconfig.json file
@@ -27,7 +29,9 @@ export class TsConfigInitializer {
       return;
     }
     this.logger.log(
-      'No tsconfig.json file found in the current directory. Running `npx tsc --init`...'
+      `No tsconfig.json file found in the current directory. Running \`${
+        this.executableName === 'npm' ? 'npx' : this.executableName
+      } tsc --init\`...`
     );
 
     const packageJson = await this.packageJsonReader.readPackageJson();
@@ -53,20 +57,28 @@ export class TsConfigInitializer {
     }
 
     try {
-      await this.execa('npx', tscArgs, {
-        stdio: 'inherit',
-        cwd: this.projectRoot,
-      });
+      await this.execa(
+        this.executableName === 'npm' ? 'npx' : this.executableName,
+        tscArgs,
+        {
+          stdio: 'inherit',
+          cwd: this.projectRoot,
+        }
+      );
     } catch {
       throw new Error(
-        '`npx tsc --init` did not exit successfully. Initialize a valid TypeScript configuration before continuing.'
+        `\`${
+          this.executableName === 'npm' ? 'npx' : this.executableName
+        } tsc --init\` did not exit successfully. Initialize a valid TypeScript configuration before continuing.`
       );
     }
 
     if (!this.tsConfigJsonExists()) {
       // this should only happen if the customer exits out of npx tsc --init before finishing
       throw new Error(
-        'tsconfig.json does not exist after running `npx tsc --init`. Initialize a valid TypeScript configuration before continuing.'
+        `tsconfig.json does not exist after running \`${
+          this.executableName === 'npm' ? 'npx' : this.executableName
+        } tsc --init\`. Initialize a valid TypeScript configuration before continuing.`
       );
     }
   };