feat: init e2e test workflow for Package Manager Support #533

0618 · 2023-10-30T23:05:05Z

Issue #, if available:

Description of changes:

This PR is to initiate the e2e test infra to minic the users using different Package Managers.

Once this PR is merged, we'll be able to continue working on refactoring the Package Managers Support.

TODO:

Check how console support Package Managers
Refactor Create Amplify for varias Package Managers test: use GH workflow for e2e test of create amplify #636
Refactor class PackageManagerConfigurator for comment -> test: use GH workflow for e2e test of create amplify #636 (comment)
Update GH workflow
Add sandbox and other functional categories to GH workflow
Work on sandbox and other functional categories
Change e2e test trigger

Tested in the PoC workflow https://github.com/aws-amplify/samsara-cli/actions/runs/6699545910

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

changeset-bot · 2023-10-30T23:05:09Z

🦋 Changeset detected

Latest commit: 3de87ad

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages

Name	Type
@aws-amplify/form-generator	Minor
@aws-amplify/integration-tests	Patch
@aws-amplify/auth-construct-alpha	Patch
@aws-amplify/backend-auth	Patch
@aws-amplify/backend-cli	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

0618 · 2023-10-30T23:06:04Z

packages/create-amplify/src/npm_package_manager_controller.ts

    if (type === 'dev') {
-      args.push('--save-dev');
+      args.push('-D');


The code here is already merged in https://github.com/aws-amplify/samsara-cli/pull/507/files, I'm not sure why it shows up in this PR...

* fix: flatten auth login with types * chore: update snapshots * chore: update api * chore: add changeset

sobolk · 2023-10-31T18:07:19Z

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

+on: # TODO: need to change the trigger
+  push:
+    branches:
+      - poc/e2e-test


At some point we'll need to hook this up into health_checks.
Which means either stuffing this into health_checks OR investing in reusable workflow. See https://docs.github.com/en/actions/using-workflows/reusing-workflows (we did this for canaries in classic CLI).

@edwardfoyle what do you think? health_checks.yml started to be quite big.

We can add it to health_checks once it's merged to main

sobolk · 2023-10-31T18:08:42Z

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

+      - poc/e2e-test
+
+jobs:
+  create-amplify-project:


We should figure out how to change this from create-amplify-project to
run_e2e_with_package_manager , so that all e2e tests that do call package manager use it (sandbox, pipeline deploy in addition to create amplify).

if it's a workflow, we can make is a re-usable GH workflow, however, it seems like just a shared workflow setup (metrics, etc), which I think we have to write it each time

sobolk · 2023-10-31T18:12:14Z

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

+      - 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


The actions should focus on setting up the runner machine. I.e. making sure package manager is installed and in desired version and available in $PATH (this is a candidate for custom action).

But the test scenario itself should be placed in TS files that contain existing e2e tests. I.e. tests and test framework should be changed to accept package manager setting somehow.

Did you mean after the GH workflow setup the test environments, and we should run packages/integration-tests/src/test-e2e/create_amplify.test.ts ?

and later just all e2e tests when they work.

Ok. Should I update in this PR to run the test-e2e/create_amplify.test.ts?

yes lets do that.

test-e2e/create_amplify.test.ts takes more effort to modify than I anticipated. Do you think we can get this PR merged first? It would make it smaller to review as well :D

that's fine.
remember that on this branch smaller reviews don't void a need for big review at the end.

if you want to merge this please leave todo comment in workflow that summarizes our discussion here.

Sure. Done 3de87ad

* feat: create amplify skip prompts for `--yes` option (#507) * feat: add env ci support * test: update unit tests * feat: create amplify --yes option * chore: remove un-used code * feat: support Panage Manager env var * chore: add comments * chore: remove env.CI * chore: update changeset * chore: rename PACKAGE_MANAGER_EXECUTABLE * fix: tests * fix npm -> npx * feat: init e2e test workflow for Package Manager Support (#533) * test: init e2e flow test * fix GH hash * use dynamic pkg manager * setup nodejs with npm * setup more pkg managers * install pkg managers * fix yarn1 and change step name * fix yarn1 * fix yarn1 * split yarn1 into 2 steps * fix yarn1 * fix yarn1 win * exclude bun on windows * yarn1 windows * setup yarn3 * yarn3 * yarn3 yarnPath * yarn use 3rd party action * try yarn3 * set yarn 3.6.x * set yarn berry * set yarn stable and pass --yes * feat: add env ci support * test: update unit tests * feat: create amplify --yes option * chore: remove un-used code * feat: support Panage Manager env var * chore: add comments * chore: remove env.CI * chore: update changeset * chore: rename PACKAGE_MANAGER_EXECUTABLE * fix: tests * use Env Var PACKAGE_MANAGER_EXECUTABLE * fix npm -> npx, remove bun * fix npm -> npx * change -- --yes * chore: update package.lock * chore: remove @Alpha * fix: clean up yarn * fix: change yarn1 to yarn * chore: rename yarn step * chore: use env * fix: yarn-stable env var * add comments * chore: update sample app with new imports (#541) * feat: use "use client"; directive in generated react components (#540) * fix: flatten prop types auth (#534) * fix: flatten auth login with types * chore: update snapshots * chore: update api * chore: add changeset * chore: add TODO --------- Co-authored-by: Amplifiyer <[email protected]> Co-authored-by: Spencer Stolworthy <[email protected]> Co-authored-by: awsluja <[email protected]> * fix: pnpm init and env var (#563) * fix: npm_project_initializer to use env var * fix: pnpm init * chore: update package.lock * chore: update package.lock * test: use GH workflow for e2e test of create amplify (#636) * feat: setup GH workflow for create amplify * chore: changeset * fix: add pkg type for modern yarn * fix npm install * feat: test Node v20 and Node v19 * feat: test Node v20 and yarn-stable with Node 19 * feat: exclude yarn-stable * feat: include node 20 and exclude node 19 * feat: use node 20 for others, use node 19 for yarn-stable * chore: add TODO to use Node 20 * fix: e2e tests (#771) * chore: change branch to poc/pms-create-amplify * fix: gitIgnore test * fix: refactor e2e for pms * chore: update package.lock * chore: update package.lock * temp: refactor * temp: run 1 test * temp: fix npx * temp: install packages for yarn * temp: update initial_project_file_generator * temp: install ts for yarn * temp: ignore node_modules and yarn.lock * temp: create yarn.lock for yarn stable * temp: fix yarn-stable init * temp: fix --help * fix: assert for gitignore * chore: change yarn stable install * fix: not install yarn stable globally * add @yarnpkg/sdks base * yarn stable use node-modules * remove emoji * remove @yarnpkg/sdks * yarn stable use node 18.18 * yarn stable use node 20 * chore: re-enable all tests * Revert "chore: re-enable all tests" This reverts commit f7a167b. * chore: uncomment test * chore: enable all initialStatues * test: change concurrencyLevel for yarn and yarn stable * add yarn-stable to test fails fast * chore: update changeset * chore: change workflow trigger * chore: yarn not install typescript in root folder * chore: update package.lock * Revert "chore: yarn not install typescript in root folder" This reverts commit 0d83dd0. * chore: remove comment * chore: fix typo * chore: rename yarn-classic and yarn modern * fix(create_amplify.test): after merge main * fix the concurrency for yarn classic and modern, and fix expect * feat: package manager support create amplify (#793) * chore: update package.lock * init * feat: dynamically get package manager * chore: change workflow trigger * chore: change workflow trigger * chore: rename npm functions * chore: update output log * fix: pnpm cache clear command * chore: refactor packageManager * fix: remove pnpm store * chore: create package_manager file * chore: change workflow trigger * chore: refactor PackageManager Controller and Initializer * fix: update types * chore: refactor to use factory * chore: remove try catch from the controllers * chore: change type * chore: use abstract class * fix tests * fix: PackageManagerBase * chore: refactor PackageManagerControllerFactory * chore: refactor packageJsonExists * chore: cleanup code * fix: projectJsonExists * remove package_manager file * chore: refactor package_manager props into package manager controllers * chore: rename packageManagerControllerFactory * chore: make projectRoot, userAgent, getPackageManagerName private * chore: refactor ensureInitialized * chore: refactor PackageManagerController to extend PackageManagerControllerFactory * Revert "chore: refactor PackageManagerController to extend PackageManagerControllerFactory" This reverts commit 7ddc64f. * chore: refactor to inject PackageManagerControllerFactory to xPackageManagerController * chore: move initialProjectFileGenerator to packageManagerController * fix: initializeAMplifyFolder * fix: generateInitialProjectFiles * fix: template path * chore: refactor getPackageManagerController yarn-modern * chore: create getWelcomeMessage * Revert "chore: refactor getPackageManagerController yarn-modern" This reverts commit 28da8a9. * chore: refactor generateInitialProjectFiles for yarn-modern * chore: cleanup code * chore: remove PackageManagerControllerFactory index * chore: remove ensureInitialized * Revert "chore: remove ensureInitialized" This reverts commit 96483ce. * Revert "Revert "chore: remove ensureInitialized"" This reverts commit 7c59c80. * temp: add initializeProject to PackageManagerController * temp: revert InitialProjectFileGenerator * fix: InitialProjectFileGenerator * test: restore initial_project_file_generator * move installDependencies and getWelcomeMessage to PackageManagerController * add addLockFile * add JSDocs and resolve some review comments * fix: create_amplify.test * chore: add addTypescript * chore: refactor generateInitialProjectFiles * Update packages/create-amplify/src/package-manager-controller/package_manager_controller_factory.ts Co-authored-by: Edward Foyle <[email protected]> * chore: refactor generateInitialProjectFiles again * chore: refactor welcomeMessage * test: add package_manager_controller_factory * test: fix test types * chore: comments update * chore: handle process.env.npm_config_user_agent undefined * chore: move addLockFile and addTypescript into initializeTsConfig * test: refactor packageManagerControllerFactory * fix: yarn initializeTsConfig * fix: yarn modern initializeTsConfig * fix: amplify_project_creator test * chore: refactor contructor * chore: update package.lock * fix: pnpm init, remove --debug, etc * test: add test for NpmPackageManagerController * fix build error * chore: refactor NpmPackageManagerController * test: add test for xPackageManagerController * chore: convert fs to fsp * fix yarn modern --------- Co-authored-by: Edward Foyle <[email protected]> * chore: update package-lock * test: add deploy test (#901) * chore: add e2e_flow.test * add deploy test but don't work * comment out deploy test * fix: e2e test assert * chore: update package.lock * add deploy test * use before and after * change amplifyCli to execa * change test trigger * Revert "change amplifyCli to execa" This reverts commit 9f85439. * setupProfile * Revert "Revert "change amplifyCli to execa"" This reverts commit 4950b7d. * remove fail test and initialStates * install @aws-amplify/backend-deployer * chore: update changeset * chore: set nodeLinker in test project * fix execaOptions syntax error * fix: npx in cdk deployer * chore: update changeset * fix: yarn modern build * chore: update package-lock * chore: remove some asserts * chore: remove synth * install packages to fix yarn * remove create-amplify help * simplify before and after * remove one packageManagerSetup * refactor packageManagerSetup * fix yarn- * move yarn add to setupPackageManager * fix type error * Revert "fix type error" and "move yarn add to setupPackageManager" This reverts commit d88ef61. * try fix pnpm for windows by adding @AWS-SDK+credential-providers * remove the pnpm patch * add nodir to dictionary * move setupPackageManager to a new file * rename PACKAGE_MANAGER_EXECUTABLE to PACKAGE_MANAGER * refactor packageManagerSetup to use switch * refactor packageManagerSetup to initializeX * use beforeEach and afterEach * add TODO comment * temp * simplify yarn-modern treatments * misc changes * add TODO comments * exclude pnpm on windows * Revert "exclude pnpm on windows" This reverts commit dd7b423. * exclude pnpm on windows * resolve review comments * fix syntax error * address review comments * move this.packageManager logic to ctor * fix yarn-modern * add packageManagerCli and packageManagerExecutable * fix yarn * address review comments * rename package_manager_sanity_check * update workflow yml * chore: update package-lock * move npm proxy to before and after * change comments * feat(backend-deploy): use packageManagerController (#947) * fix logger * fix logLevel * change workflow trigger to include poc/pms-cli-core * move package_manager_controller to cli-core * chore: update changeset * move npm_config_user_agent to getPackageManagerName and add runWithPackageManager * fix build error * modify executeWithDebugLogger * add getPackageManagerCommandArgs * refactor cdk_deployer to use package manager * install cli-core * fix execaChildProcess type * use PackageManagerControllerFactory in cdkDeployer * fix amplify/amplify path * chore: update API.md * clean up package-manager-controller export * update API.md * add type PackageManagerController * use PackageManagerController type from plugin-types * rename PackageManagerControllerBase and use plugin-types * change workflow trigger to exclude poc/pms-cli-core * refactor BackendDeployerFactory to take PackageManagerController * clean up getPackageManagerCommandArgs * add projectRoot and rename packageManagerControllerBase file * set projectRoot default value * rename execute_with_debugger_logger * use execa Options * Revert "use execa Options" This reverts commit 30cd61e. * rename executeChildProcessWithPackageManager to executeCommand * make BackendDeployerFactory param mandatory * make BackendDeployerFactory param mandatory * remove DependencyType * remove @aws-amplify/platform-core from cli-core * remove some default projectRoot * remove all default projectRoot * inject printer to factory * update package-lock * fix cli-core version in backend-deployer * move @aws-amplify/cli-core to devDep * add getCommand * change execa option type * change projectRoot to private * rename projectRoot to cwd * change ./ to cwd * remove @aws-amplify/cli-core from backend-deployer * patch dependencies_validator for execa * fix getCommand, cdk_deployer.test, amplify_project_creator.test * fix initial_project_file_generator.test * fix executeWithDebugLogger test * fix YarnModernPackageManagerController test * fix packageManagerControllerFactory test * fix lint error * Update packages/cli-core/src/package-manager-controller/package_manager_controller_factory.ts Co-authored-by: Kamil Sobol <[email protected]> * remove never used packageManagerExecutable * update changeset * feat: add Package Manager test to health_checks (#968) * add package-manager-tests to health-checks * remove poc-e2e-flow-test * add run_package_manager_tests_tests condition * fix run_package_manager_tests_tests condition * remove amplify-backend_windows-latest_8-core * use re-usable action for run-e2e * Revert "remove amplify-backend_windows-latest_8-core" This reverts commit 547834a. * Revert "use re-usable action for run-e2e" This reverts commit 3159e01. * revert re-usable action * Update .changeset/new-timers-warn.md Co-authored-by: Kamil Sobol <[email protected]> * clean up commented code * use amplify-backend_windows-latest_8-core * Update .changeset/new-timers-warn.md Co-authored-by: Edward Foyle <[email protected]> * remove inaccurate JSdoc * remove integration-tests from changeset --------- Co-authored-by: Amplifiyer <[email protected]> Co-authored-by: Spencer Stolworthy <[email protected]> Co-authored-by: awsluja <[email protected]> Co-authored-by: Edward Foyle <[email protected]> Co-authored-by: Kamil Sobol <[email protected]>

0618 added 30 commits October 25, 2023 13:33

test: init e2e flow test

2f4e039

fix GH hash

04e6ee4

use dynamic pkg manager

d88786b

setup nodejs with npm

c0eb0d4

setup more pkg managers

215acbf

install pkg managers

95842bb

fix yarn1 and change step name

aaebae2

fix yarn1

45d990c

fix yarn1

ee1c6c3

split yarn1 into 2 steps

f856bb8

fix yarn1

1b11e6e

fix yarn1 win

fd937e1

exclude bun on windows

6e6d06f

yarn1 windows

41c89ea

setup yarn3

c690620

yarn3

fd2d010

yarn3 yarnPath

f030ce0

yarn use 3rd party action

974bfa6

try yarn3

a938e15

set yarn 3.6.x

c71302f

set yarn berry

71af9a8

set yarn stable and pass --yes

b28d8b9

feat: add env ci support

b41bb05

test: update unit tests

e722f11

feat: create amplify --yes option

7dca6da

chore: remove un-used code

70fad76

feat: support Panage Manager env var

dc2df4b

chore: add comments

c423170

Merge branch 'main' into env-ci

518a43c

chore: remove env.CI

7b88772

0618 added 6 commits October 30, 2023 14:49

fix: change yarn1 to yarn

a574541

chore: rename yarn step

73ff607

chore: use env

00b9499

fix: yarn-stable env var

fbf5b1a

add comments

9c6d8a6

Merge branch 'main' into poc/e2e-test

185be00

0618 requested review from edwardfoyle, sobolk and Amplifiyer as code owners October 30, 2023 23:05

0618 commented Oct 30, 2023

View reviewed changes

0618 and others added 6 commits October 31, 2023 09:45

Merge branch 'main' into poc/e2e-test

a59cf5a

Merge branch 'poc/package-manager-support' into poc/e2e-test

3aba42f

chore: update sample app with new imports (#541)

633ec61

feat: use "use client"; directive in generated react components (#540)

863dc24

fix: flatten prop types auth (#534)

d0119b2

* fix: flatten auth login with types * chore: update snapshots * chore: update api * chore: add changeset

Merge branch 'main' into poc/e2e-test

47d2a4f

0618 requested review from swaminator, renebrandel, abdallahshaban557 and josefaidt as code owners October 31, 2023 18:11

sobolk reviewed Oct 31, 2023

View reviewed changes

chore: add TODO

3de87ad

sobolk approved these changes Oct 31, 2023

View reviewed changes

awsluja approved these changes Oct 31, 2023

View reviewed changes

0618 merged commit c7af239 into poc/package-manager-support Oct 31, 2023
12 checks passed

0618 deleted the poc/e2e-test branch October 31, 2023 21:59

0618 mentioned this pull request Nov 13, 2023

test: use GH workflow for e2e test of create amplify #636

Merged

0618 mentioned this pull request Jan 30, 2024

feat: package manager support #960

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: init e2e test workflow for Package Manager Support #533

feat: init e2e test workflow for Package Manager Support #533

0618 commented Oct 30, 2023 •

edited

Loading

changeset-bot bot commented Oct 30, 2023 •

edited

Loading

0618 Oct 30, 2023

sobolk Oct 31, 2023

0618 Oct 31, 2023

sobolk Oct 31, 2023

0618 Oct 31, 2023

sobolk Oct 31, 2023

0618 Oct 31, 2023

sobolk Oct 31, 2023

sobolk Oct 31, 2023

0618 Oct 31, 2023 •

edited

Loading

sobolk Oct 31, 2023

0618 Oct 31, 2023

sobolk Oct 31, 2023

sobolk Oct 31, 2023

0618 Oct 31, 2023

feat: init e2e test workflow for Package Manager Support #533

feat: init e2e test workflow for Package Manager Support #533

Conversation

0618 commented Oct 30, 2023 • edited Loading

changeset-bot bot commented Oct 30, 2023 • edited Loading

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0618 Oct 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0618 commented Oct 30, 2023 •

edited

Loading

changeset-bot bot commented Oct 30, 2023 •

edited

Loading

0618 Oct 31, 2023 •

edited

Loading