Simplify e2e setup (#895)

- Remove unused dotenv package
- Remove redundant package playwright (already have playwright/test)
- Remove dotenv package
- Consolidate dependencies and devDependencies

Author: lorenyu

Makefile

@@ -32,8 +32,8 @@ __check_defined = \
 	e2e-clean-image \
 	e2e-clean-report \
 	e2e-merge-reports \
+	e2e-setup \
 	e2e-setup-ci \
-	e2e-setup-native \
 	e2e-show-report \
 	e2e-test \
 	e2e-test-native \
@@ -96,17 +96,16 @@ e2e-clean-report: ## Remove the local e2e report folders and content
 	rm -rf ./e2e/test-results
 
 e2e-merge-reports: ## Merge E2E blob reports from multiple shards into an HTML report
-	cd e2e && npm run e2e-merge-reports
+	cd e2e && npm run merge-reports
 
-e2e-setup-ci: ## Setup end-to-end tests for CI
-	cd e2e && npm run e2e-setup
-
-e2e-setup-native: ## Setup end-to-end tests
+e2e-setup: ## Setup end-to-end tests
 	cd e2e && npm install
-	cd e2e && npm run e2e-setup
+
+e2e-setup-ci: ## Setup end-to-end tests for CI
+	cd e2e && npm ci
 
 e2e-show-report: ## Show the E2E report
-	cd e2e && npm run e2e-show-report
+	cd e2e && npm run show-report
 
 e2e-test: ## Run E2E tests in a Docker container and copy the report locally
 e2e-test: e2e-build
@@ -122,18 +121,18 @@ e2e-test: e2e-build
 		-v $(PWD)/e2e/playwright-report:/e2e/playwright-report \
 		-v $(PWD)/e2e/blob-report:/e2e/blob-report \
 		$(E2E_IMAGE_NAME) \
-		$(E2E_ARGS)
+		npm test -- $(E2E_ARGS)
 	@echo "Run 'make e2e-show-report' to view the test report"
 
 e2e-test-native: ## Run end-to-end tests natively
 	@:$(call check_defined, APP_NAME, You must pass in a specific APP_NAME)
 	@echo "Running e2e tests with CI=${CI}, APP_NAME=${APP_NAME}, BASE_URL=${BASE_URL}"
-	cd e2e && APP_NAME=$(APP_NAME) BASE_URL=$(BASE_URL) npm run e2e-test -- $(E2E_ARGS)
+	cd e2e && APP_NAME=$(APP_NAME) BASE_URL=$(BASE_URL) npm test -- $(E2E_ARGS)
 
 e2e-test-native-ui: ## Run end-to-end tests natively in UI mode
 	@:$(call check_defined, APP_NAME, You must pass in a specific APP_NAME)
 	@echo "Running e2e UI tests natively with APP_NAME=$(APP_NAME), BASE_URL=$(BASE_URL)"
-	cd e2e && APP_NAME=$(APP_NAME) BASE_URL=$(BASE_URL) npm run e2e-test:ui -- $(E2E_ARGS)
+	cd e2e && APP_NAME=$(APP_NAME) BASE_URL=$(BASE_URL) npm run test:ui -- $(E2E_ARGS)
 
 ###########
 ## Infra ##

docs/e2e/e2e-checks.md

@@ -48,13 +48,14 @@ First, make sure the application you want to test is running.
 To run end-to-end tests natively, first install Playwright with:
 
 ```bash
-make e2e-setup-native
+make e2e-setup
 ```
 
 Then, run the tests with your app name and base url:
 ```bash
 make e2e-test-native APP_NAME=app
 ```
+
 >* `BASE_URL` is optional for both `e2e-test-native` and `e2e-test-native-ui` targets. It will by default use the app-specific (`/e2e/<APP_NAME>/playwright.config.js`) `baseURL`
 
 ### Run tests in UI mode

e2e/Dockerfile

@@ -12,12 +12,8 @@ COPY e2e/package.json e2e/package-lock.json ./
 
 # install deps
 RUN npm ci
-RUN npm run e2e-setup
 
 # Copy entire e2e folder over
 COPY e2e /e2e
 
-ENTRYPOINT ["npm", "run", "e2e-test", "--"]
-
-# Optional additional args
-CMD [""]
+CMD ["npm", "test", "--"]

e2e/package-lock.json

@@ -1,20 +1,15 @@
 {
-    "name": "e2e",
-    "version": "1.0.0",
-    "scripts": {
-      "e2e-merge-reports": "npx playwright merge-reports --reporter html blob-report",
-      "e2e-setup": "npx playwright install --with-deps",
-      "e2e-show-report": "npx playwright show-report",
-      "e2e-test": "./run-e2e-test",
-      "e2e-test:ui": "./run-e2e-test --ui"
-    },
-    "devDependencies": {
-      "@playwright/test": "^1.49.0",
-      "@types/node": "^22.10.1"
-    },
-    "dependencies": {
-      "@axe-core/playwright": "^4.10.1",
-      "dotenv": "^16.4.7",
-      "playwright": "^1.49.0"
-    }
+  "name": "e2e",
+  "version": "1.0.0",
+  "scripts": {
+    "merge-reports": "npx playwright merge-reports --reporter html blob-report",
+    "show-report": "npx playwright show-report",
+    "test": "./run-e2e-test",
+    "test:ui": "./run-e2e-test --ui"
+  },
+  "devDependencies": {
+    "@axe-core/playwright": "^4.10.1",
+    "@playwright/test": "^1.49.0",
+    "@types/node": "^22.10.1"
   }
+}

e2e/package.json

@@ -1,10 +1,5 @@
-// Load environment variables from .env file if it exists
-import * as dotenv from 'dotenv';
-
 import { defineConfig, devices } from "@playwright/test";
 
-dotenv.config();
-
 /**
  * See https://playwright.dev/docs/test-configuration.
  */

e2e/playwright.config.js

@@ -5,7 +5,7 @@
 
 # Ensure APP_NAME is provided
 if [[ -z "${APP_NAME}" ]]; then
-  echo "You must pass in a specific APP_NAME. IE: APP_NAME=app npm run e2e-test" >&2
+  echo "You must pass in a specific APP_NAME. IE: APP_NAME=app npm test" >&2
   exit 1
 fi