refactor(cypress): merge the integration workspace (#3992)

Merge the contents of the integration workspace with the top level package. Fixes: canonical/app-tribe#1010.
canonical · Jun 3, 2022 · db6969e · db6969e
1 parent 5304ecc
commit db6969e
Show file tree

Hide file tree

Showing 47 changed files with 49 additions and 109 deletions.
diff --git a/integration/.env → .env.test b/integration/.env → .env.test
diff --git a/.github/workflows/accessibility.yml b/.github/workflows/accessibility.yml
@@ -34,7 +34,7 @@ jobs:
           install: false
           spec: "**/accessibility/**/*.spec.ts"
           wait-on: "${{env.MAAS_URL}}/MAAS/r/machines"
-          working-directory: integration
+          working-directory: cypress
       - name: Create issue on failure
         if: failure()
         uses: JasonEtco/create-an-issue@v2

diff --git a/.github/workflows/cypress.yml b/.github/workflows/cypress.yml
@@ -32,7 +32,7 @@ jobs:
           install: false
           spec: "**/no-users/**/*.spec.ts"
           wait-on: "${{env.MAAS_URL}}/MAAS/r/machines"
-          working-directory: integration
+          working-directory: cypress
       - name: Create MAAS admin
         run: sudo maas createadmin --username=admin --password=test [email protected]
       - name: Create MAAS non-admin user
@@ -47,12 +47,12 @@ jobs:
           install: false
           spec: "**/with-users/**/*.spec.ts"
           wait-on: "${{env.MAAS_URL}}/MAAS/r/machines"
-          working-directory: integration
+          working-directory: cypress
       - uses: actions/upload-artifact@v3
         if: failure()
         with:
           name: cypress-screenshots
-          path: integration/cypress/screenshots
+          path: cypress/screenshots
       - name: Create issue on failure
         if: failure()
         uses: JasonEtco/create-an-issue@v2
@@ -80,7 +80,7 @@ jobs:
           browser: chrome
           config: baseUrl=http://maas.io/docs
           spec: "**/docs-links/**/*.spec.ts"
-          working-directory: integration
+          working-directory: cypress
       - name: Create issue on failure
         if: failure()
         uses: JasonEtco/create-an-issue@v2

diff --git a/.gitignore b/.gitignore
@@ -17,6 +17,11 @@ yarn-error.log*
 # build
 /build
 
+# cypress
+cypress/screenshots
+cypress/videos
+cypress.env.json
+
 # local configuration
 .env.*.local
 .env.local

diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ Community contributions are most welcome, and there are a number of ways to part
 
 When submitting a PR, please take note that MAAS UI uses the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) format. To help you conform to this, you can run `yarn commit` instead of `git commit` for an interactive prompt.
 
-Please see [HACKING](HACKING.md) for details on setting up a MAAS UI development environment.
+Please see [HACKING](/docs/HACKING.md) for details on setting up a MAAS UI development environment.
 
 ## Feedback
 

diff --git a/integration/cypress.json → cypress.json b/integration/cypress.json → cypress.json
diff --git a/integration/.eslintrc.js → cypress/.eslintrc.js b/integration/.eslintrc.js → cypress/.eslintrc.js
diff --git a/integration/cypress/constants.ts → cypress/constants.ts b/integration/cypress/constants.ts → cypress/constants.ts
diff --git a/integration/cypress/fixtures/example.json → cypress/fixtures/example.json b/integration/cypress/fixtures/example.json → cypress/fixtures/example.json
diff --git a/...ation/accessibility/accessibility.spec.ts → ...ation/accessibility/accessibility.spec.ts b/...ation/accessibility/accessibility.spec.ts → ...ation/accessibility/accessibility.spec.ts
diff --git a/...integration/docs-links/docs-links.spec.ts → ...integration/docs-links/docs-links.spec.ts b/...integration/docs-links/docs-links.spec.ts → ...integration/docs-links/docs-links.spec.ts
diff --git a/...ypress/integration/no-users/login.spec.ts → cypress/integration/no-users/login.spec.ts b/...ypress/integration/no-users/login.spec.ts → cypress/integration/no-users/login.spec.ts
diff --git a/integration/cypress/integration/utils.ts → cypress/integration/utils.ts b/integration/cypress/integration/utils.ts → cypress/integration/utils.ts
diff --git a/...ntegration/with-users/base/footer.spec.ts → ...ntegration/with-users/base/footer.spec.ts b/...ntegration/with-users/base/footer.spec.ts → ...ntegration/with-users/base/footer.spec.ts
diff --git a/...ntegration/with-users/base/header.spec.ts → ...ntegration/with-users/base/header.spec.ts b/...ntegration/with-users/base/header.spec.ts → ...ntegration/with-users/base/header.spec.ts
diff --git a/...ation/with-users/controllers/list.spec.ts → ...ation/with-users/controllers/list.spec.ts b/...ation/with-users/controllers/list.spec.ts → ...ation/with-users/controllers/list.spec.ts
diff --git a/...on/with-users/dashboard/dashboard.spec.ts → ...on/with-users/dashboard/dashboard.spec.ts b/...on/with-users/dashboard/dashboard.spec.ts → ...on/with-users/dashboard/dashboard.spec.ts
diff --git a/...tegration/with-users/devices/list.spec.ts → ...tegration/with-users/devices/list.spec.ts b/...tegration/with-users/devices/list.spec.ts → ...tegration/with-users/devices/list.spec.ts
diff --git a/...tegration/with-users/domains/list.spec.ts → ...tegration/with-users/domains/list.spec.ts b/...tegration/with-users/domains/list.spec.ts → ...tegration/with-users/domains/list.spec.ts
diff --git a/...ntegration/with-users/images/list.spec.ts → ...ntegration/with-users/images/list.spec.ts b/...ntegration/with-users/images/list.spec.ts → ...ntegration/with-users/images/list.spec.ts
diff --git a/...s/integration/with-users/kvm/list.spec.ts → ...s/integration/with-users/kvm/list.spec.ts b/...s/integration/with-users/kvm/list.spec.ts → ...s/integration/with-users/kvm/list.spec.ts
diff --git a/...ntegration/with-users/legacy/auth.spec.ts → ...ntegration/with-users/legacy/auth.spec.ts b/...ntegration/with-users/legacy/auth.spec.ts → ...ntegration/with-users/legacy/auth.spec.ts
diff --git a/...ntegration/with-users/login/login.spec.ts → ...ntegration/with-users/login/login.spec.ts b/...ntegration/with-users/login/login.spec.ts → ...ntegration/with-users/login/login.spec.ts
diff --git a/...tegration/with-users/machines/add.spec.ts → ...tegration/with-users/machines/add.spec.ts b/...tegration/with-users/machines/add.spec.ts → ...tegration/with-users/machines/add.spec.ts
diff --git a/...egration/with-users/machines/list.spec.ts → ...egration/with-users/machines/list.spec.ts b/...egration/with-users/machines/list.spec.ts → ...egration/with-users/machines/list.spec.ts
diff --git a/...integration/with-users/pools/list.spec.ts → ...integration/with-users/pools/list.spec.ts b/...integration/with-users/pools/list.spec.ts → ...integration/with-users/pools/list.spec.ts
diff --git a/...ation/with-users/preferences/base.spec.ts → ...ation/with-users/preferences/base.spec.ts b/...ation/with-users/preferences/base.spec.ts → ...ation/with-users/preferences/base.spec.ts
diff --git a/...egration/with-users/settings/base.spec.ts → ...egration/with-users/settings/base.spec.ts b/...egration/with-users/settings/base.spec.ts → ...egration/with-users/settings/base.spec.ts
diff --git a/...ers/settings/configuration/deploy.spec.ts → ...ers/settings/configuration/deploy.spec.ts b/...ers/settings/configuration/deploy.spec.ts → ...ers/settings/configuration/deploy.spec.ts
diff --git a/...ion/with-users/settings/users/add.spec.ts → ...ion/with-users/settings/users/add.spec.ts b/...ion/with-users/settings/users/add.spec.ts → ...ion/with-users/settings/users/add.spec.ts
diff --git a/...on/with-users/settings/users/list.spec.ts → ...on/with-users/settings/users/list.spec.ts b/...on/with-users/settings/users/list.spec.ts → ...on/with-users/settings/users/list.spec.ts
diff --git a/...ntegration/with-users/subnets/add.spec.ts → ...ntegration/with-users/subnets/add.spec.ts b/...ntegration/with-users/subnets/add.spec.ts → ...ntegration/with-users/subnets/add.spec.ts
diff --git a/...ration/with-users/subnets/subnets.spec.ts → ...ration/with-users/subnets/subnets.spec.ts b/...ration/with-users/subnets/subnets.spec.ts → ...ration/with-users/subnets/subnets.spec.ts
diff --git a/...integration/with-users/zones/list.spec.ts → ...integration/with-users/zones/list.spec.ts b/...integration/with-users/zones/list.spec.ts → ...integration/with-users/zones/list.spec.ts
diff --git a/cypress/percy.sh b/cypress/percy.sh
@@ -0,0 +1,9 @@
+#! /usr/bin/env bash
+
+if [ -f ../.env.test.local ]; then
+    source ../.env.test.local
+elif [ -f ../.env.test ]; then
+    source ../.env.test
+fi
+
+PERCY_TOKEN=$PERCY_TOKEN PERCY_BRANCH=local percy exec -- cypress run --config integrationFolder=percy
diff --git a/integration/cypress/percy/percy.spec.ts → cypress/percy/percy.spec.ts b/integration/cypress/percy/percy.spec.ts → cypress/percy/percy.spec.ts
diff --git a/integration/cypress/plugins/index.js → cypress/plugins/index.js b/integration/cypress/plugins/index.js → cypress/plugins/index.js
diff --git a/integration/cypress/support/commands.ts → cypress/support/commands.ts b/integration/cypress/support/commands.ts → cypress/support/commands.ts
diff --git a/integration/cypress/support/index.ts → cypress/support/index.ts b/integration/cypress/support/index.ts → cypress/support/index.ts
diff --git a/integration/cypress/tsconfig.json → cypress/tsconfig.json b/integration/cypress/tsconfig.json → cypress/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "strict": true,
-    "baseUrl": "../node_modules",
+    "baseUrl": "../ui/node_modules",
     "target": "es6",
     "lib": ["es2017", "dom"],
     "types": ["cypress", "cypress-axe", "@testing-library/cypress", "@percy/cypress"],

diff --git a/HACKING.md → docs/HACKING.md b/HACKING.md → docs/HACKING.md
@@ -558,7 +558,7 @@ maas $PROFILE maas set-config name=completed_intro value=false
 
 Integration tests currently run against the maas edge snap (main) [on github actions](https://github.com/canonical-web-and-design/maas-ui/actions?query=workflow%3ACypress) with [Cypress](https://cypress.io).
 
-For details on developing integration tests, see the integration testing [README](integration/README.md).
+For details on developing integration tests, see the integration testing [README](/docs/INTEGRATION.md).
 
 ## Unit tests
 

diff --git a/integration/README.md → docs/INTEGRATION.md b/integration/README.md → docs/INTEGRATION.md
@@ -16,12 +16,11 @@ This will automatically start legacy, ui and proxy servers and run the Cypress t
 
 ## Edit local configuration
 
-By default, cypress will run tests using the configuration defined in [cypress.json](/integration/cypress.json).
+By default, cypress will run tests using the configuration defined in [cypress.json](/cypress/cypress.json).
 
 If you wish to overwrite any of the settings (e.g. MAAS URL or username/password) you can create a local configuration file:
 
 ```shell
-cd integration
 touch cypress.env.json
 ```
 
@@ -44,7 +43,6 @@ yarn serve
 Then open the Cypress Test Runner by running:
 
 ```shell
-cd integration
 yarn cypress-open
 ```
 

diff --git a/RELEASE.md → docs/RELEASE.md b/RELEASE.md → docs/RELEASE.md
diff --git a/integration/.gitignore b/integration/.gitignore
diff --git a/integration/package.json b/integration/package.json
diff --git a/integration/percy.sh b/integration/percy.sh
diff --git a/package.json b/package.json
@@ -11,8 +11,12 @@
     "build-legacy": "cd legacy && yarn install && yarn build",
     "build-root": "cd root && yarn install && yarn build",
     "build-ui": "cd ui && yarn install && yarn build",
-    "cypress-open": "yarn --cwd integration cypress-open",
-    "cypress-run": "yarn --cwd integration cypress-run",
+    "serve-frontends": "yarn --cwd proxy serve-frontends",
+    "serve-base": "yarn --cwd proxy serve-base",
+    "cypress-run": "yarn cypress run",
+    "cypress-run-a11y": "yarn cypress run --config integrationFolder=cypress/integration/accessibility",
+    "cypress-open": "yarn cypress open",
+    "percy": "./cypress/percy.sh",
     "copy-build": "mkdir -p build && yarn copy-root && yarn copy-legacy-assets && yarn copy-ui-css",
     "copy-legacy-assets": "cp -R legacy/dist/assets build/",
     "copy-root": "cp -R root/dist/* build/",
@@ -35,9 +39,9 @@
     "lint-ui": "cd ui && yarn run lint",
     "lint-shared": "cd shared && yarn run lint",
     "lint-root": "cd root && yarn run lint",
-    "lint-cypress": "cd integration && yarn run lint",
+    "lint-cypress": "eslint -c cypress/.eslintrc.js \"cypress/**/*.{ts,tsx}\"",
     "lint": "yarn build-shared && yarn lint-legacy && yarn lint-ui && yarn lint-shared && yarn lint-root && yarn lint-cypress",
-    "test-cypress": "yarn --cwd integration run cypress-test",
+    "test-cypress": "yarn --cwd shared build && start-server-and-test serve-frontends '8401|8402' serve-base 'tcp:8400|8404' cypress-run",
     "test-legacy": "cd legacy && yarn run test",
     "test-ui": "cd ui && yarn run test --watchAll=false",
     "test-shared": "cd shared && yarn run test",
@@ -46,7 +50,6 @@
   },
   "workspaces": {
     "packages": [
-      "integration",
       "legacy",
       "proxy",
       "shared",
@@ -63,7 +66,24 @@
     ]
   },
   "devDependencies": {
-    "cz-conventional-changelog": "3.3.0"
+    "@maas-ui/maas-ui-shared": "3.3.0",
+    "@percy/cli": "1.1.4",
+    "@percy/cypress": "3.1.1",
+    "@testing-library/cypress": "8.0.2",
+    "@typescript-eslint/eslint-plugin": "5.23.0",
+    "@typescript-eslint/parser": "5.23.0",
+    "concurrently": "7.1.0",
+    "cypress": "9.6.1",
+    "cypress-axe": "0.14.0",
+    "cypress-wait-until": "1.7.2",
+    "cz-conventional-changelog": "3.3.0",
+    "dotenv-flow": "3.2.0",
+    "eslint-plugin-cypress": "2.12.1",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-no-only-tests": "2.6.0",
+    "nanoid": "3.3.4",
+    "npm-package-json-lint": "6.3.0",
+    "start-server-and-test": "1.14.0"
   },
   "config": {
     "commitizen": {