feat: add e2e tests

.env.development.example

@@ -40,7 +40,7 @@ AUTH_GITHUB_SCOPE=read:user,user:email
 AUTH_GITHUB_FIRST_NAME_KEY=name
 AUTH_GITHUB_LAST_NAME_KEY=login
 AUTH_GITHUB_IDENTIFIER_KEY=id
-AUTH_GITHUB_REDIRECT_ALLOW_LIST=http://localhost:13010
+AUTH_GITHUB_REDIRECT_ALLOW_LIST=http://localhost:13010,http://localhost:13000
 
 # GitHub API
 # A classic token (not scoped), required permissions are: read:org, read:user

.env.e2e.example

@@ -0,0 +1,74 @@
+# E2E specific
+ENABLE_E2E_MOCKS=true
+
+# DB
+DB_CLIENT=mysql
+# This is an ip of `host.docker.internal` on Linux
+DB_HOST=172.17.0.1
+DB_PORT=13306
+DB_DATABASE=dashboard-globalping
+DB_USER=directus
+DB_PASSWORD=password
+# Collation mapping from here: https://github.com/sidorares/node-mysql2/blob/bded4980065319e58a4f87d828cc355fb79f5bd3/lib/constants/charsets.js#L199
+DB_CHARSET_NUMBER=224
+
+# Directus
+# https://docs.directus.io/self-hosted/config-options.html#general
+PUBLIC_URL=http://127.0.0.1:18055
+LOG_LEVEL=trace
+CORS_ENABLED=true
+CORS_ORIGIN=http://127.0.0.1:13000,http://127.0.0.1:13010
+SESSION_COOKIE_NAME=dash_session_token
+SESSION_COOKIE_SAME_SITE=lax
+# Important: we assume all queries are unlimited by default
+QUERY_LIMIT_DEFAULT=-1
+# https://docs.directus.io/self-hosted/config-options.html#security
+KEY=directus
+SECRET=xxx
+# https://docs.directus.io/self-hosted/config-options.html#sso-oauth2-and-openid
+AUTH_GITHUB_CLIENT_ID=gh_client_id
+AUTH_GITHUB_CLIENT_SECRET=gh_client_secret
+# https://docs.directus.io/self-hosted/config-options.html#admin-account
+[email protected]
+ADMIN_PASSWORD=password
+
+# Directus GitHub Auth
+# https://docs.directus.io/self-hosted/config-options.html#sso-oauth2-and-openid
+AUTH_PROVIDERS=github
+AUTH_GITHUB_DRIVER=oauth2
+AUTH_GITHUB_AUTHORIZE_URL=https://github.com/login/oauth/authorize
+AUTH_GITHUB_ACCESS_URL=https://github.com/login/oauth/access_token
+AUTH_GITHUB_PROFILE_URL=https://api.github.com/user
+AUTH_GITHUB_ALLOW_PUBLIC_REGISTRATION=true
+AUTH_GITHUB_SCOPE=read:user,user:email
+AUTH_GITHUB_FIRST_NAME_KEY=name
+AUTH_GITHUB_LAST_NAME_KEY=login
+AUTH_GITHUB_IDENTIFIER_KEY=id
+AUTH_GITHUB_REDIRECT_ALLOW_LIST=http://127.0.0.1:13010,http://127.0.0.1:13000
+
+# GitHub API
+# A classic token (not scoped), required permissions are: read:org, read:user
+GITHUB_ACCESS_TOKEN=
+# Generated during enabling of webhooks and passed to the app, to validate requests
+# Create the webhook at https://github.com/sponsors/jsdelivr/globalping-dash-directus/webhooks/441768912/edit#deliveries
+# See WEBHOOK_FLOW_ID in .env.example for the webhook URL
+GITHUB_WEBHOOK_SECRET=
+
+# Globalping API
+GLOBALPING_URL=http://host.docker.internal:3000/v1
+GP_SYSTEM_KEY=
+
+# Geonames API
+GEONAMES_USERNAME=
+
+# App
+CREDITS_PER_DOLLAR=2000
+CREDITS_PER_ADOPTED_PROBE_DAY=150
+ADOPTED_PROBES_CHECK_TIME_MAX_DEVIATION_MINS=5
+# To trigger credits assignment probe need to be online >20 hours during the day. Current "Adopted probes status CRON" is "*/10 * * * *", which is 6 times an hour
+# So required value is 20 * 6 = 120
+ADOPTED_PROBES_REQUIRED_ONLINE_TIMES=120
+
+# Are updated during `npm run init`
+AUTH_GITHUB_DEFAULT_ROLE_ID=
+AUTH_DISABLE_DEFAULT=false

.env.example

@@ -1,5 +1,11 @@
+# File is used during execution of:
+# - migrations
+# - schema updates
+# - host inits
+# - e2e tests
+
 DB_CLIENT=mysql
-DB_HOST=localhost
+DB_HOST=127.0.0.1
 DB_PORT=13306
 DB_DATABASE=dashboard-globalping
 DB_USER=directus
@@ -11,7 +17,11 @@ MIGRATIONS_PATH=extensions/migrations
 # ID that will be used for the flow. Any valid UUID.
 # The final URL for the webhook is ${host}/flows/trigger/${WEBHOOK_FLOW_ID}
 WEBHOOK_FLOW_ID=e8a4c2b2-3ed4-4ddc-b98e-34c1952c2323
-DIRECTUS_URL=http://localhost:18055
+DIRECTUS_URL=http://127.0.0.1:18055
+
+# E2E
+# Used during nuxt build of the globalping-dash repo.
+DASH_URL=http://127.0.0.1:13010
 
 [email protected]
 ADMIN_PASSWORD=password

.eslintrc

@@ -9,7 +9,9 @@
 	"ignorePatterns": [
 		"**/dist",
 		"/extensions",
-		"**/shims.d.ts"
+		"**/shims.d.ts",
+		"test/e2e/globalping-dash",
+		"test-results"
 	],
 	"rules": {
 		"n/no-missing-import": [

.github/workflows/e2e.yml

@@ -0,0 +1,38 @@
+name: E2E
+
+on:
+  push:
+    branches: [ "*" ]
+  pull_request:
+    branches: [ "*" ]
+
+jobs:
+  build:
+    name: Run e2e tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - name: Install dependencies
+        run: |
+          corepack enable
+          pnpm install
+      - name: Install Playwright browsers
+        run: |
+          pnpm exec playwright install --with-deps chromium
+      - name: Generate env files
+        run: |
+          cp .env.e2e.example .env.e2e
+          cp .env.example .env
+      - name: Build docker compose
+        run: |
+          pnpm run test:e2e:build:directus
+      - name: Build dashboard repo
+        run: |
+          pnpm run test:e2e:build:dash
+      - name: Run tests
+        run: |
+          pnpm run test:e2e:run

.gitignore

@@ -7,3 +7,8 @@ config/local*
 .env*
 !.env*.example
 .vscode/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+/test/e2e/globalping-dash/

README.md

@@ -2,10 +2,15 @@
 
 ## Prod first deploy
 
-- copy `.env.example` to `.env` and fulfill all empty values except `ADMIN_ACCESS_TOKEN`
-- copy `.env.production.example` to the env vars of the container and fulfill all empty values except `AUTH_GITHUB_DEFAULT_ROLE_ID` and `AUTH_DISABLE_DEFAULT`
-- run the remote container
-- `pnpm run init`
+- copy `.env.example` to `.env` and fulfill all empty values except `ADMIN_ACCESS_TOKEN`.
+- copy `.env.production.example` to the env vars of the container and fulfill all empty values except `AUTH_GITHUB_DEFAULT_ROLE_ID` and `AUTH_DISABLE_DEFAULT`.
+- run the remote container.
+- `pnpm run schema:apply`
+- `pnpm run migrate`
+- get default role id and set it to the `AUTH_GITHUB_DEFAULT_ROLE_ID` env var
+- restart the container
+- login using github. Re-login as admin and give github user admin rights. Then set that value `AUTH_DISABLE_DEFAULT=true`. Then restart the container
+- Login using github. Generate a static access token for your user and save it to the local .env file as `ADMIN_ACCESS_TOKEN`
 
 ## Prod other deploys
 

docker-compose.e2e.yml

@@ -0,0 +1,30 @@
+name: e2e-globalping-dash-directus
+version: '3'
+services:
+  mariadb:
+    image: mariadb:10.11.5
+    environment:
+      - MARIADB_DATABASE=dashboard-globalping
+      - MARIADB_USER=directus
+      - MARIADB_PASSWORD=password
+      - MARIADB_ROOT_PASSWORD=root
+    ports:
+      - "13306:3306"
+    volumes:
+      - ./config/init.sql:/docker-entrypoint-initdb.d/init.sql
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "-u", "directus", "-ppassword"]
+      interval: 3s
+      timeout: 2s
+      retries: 10
+  directus:
+    depends_on:
+      mariadb:
+        condition: service_healthy
+    build:
+      context: .
+      dockerfile: Dockerfile
+    env_file:
+      - .env.e2e
+    ports:
+      - "18055:8055"

docker-compose.yml

@@ -1,3 +1,4 @@
+name: globalping-dash-directus
 version: '3'
 services:
   mariadb:
@@ -16,7 +17,7 @@ services:
       interval: 3s
       timeout: 2s
       retries: 10
-  globalping-dash-directus:
+  directus:
     depends_on:
       mariadb:
         condition: service_healthy

knexfile.js

@@ -1,29 +1,41 @@
-import _ from 'lodash';
-
 /**
  * @typedef {import('knex').Knex.Config} KnexConfig
  * @type {{ [key: string]: KnexConfig }}
  */
-export default _.merge({}, ...[ 'development' ].map((environment) => {
-	return {
-		[environment]: {
-			client: 'mysql',
-			connection: {
-				host: process.env.DB_HOST || 'localhost',
-				user: process.env.DB_USER || 'directus',
-				password: process.env.DB_PASSWORD || 'password',
-				database: process.env.DB_DATABSE || 'dashboard-globalping',
-				port: process.env.DB_PORT || 13306,
-			},
-			pool: {
-				min: 0,
-				max: 10,
-				propagateCreateError: false,
-			},
-			acquireConnectionTimeout: 2000,
-			seeds: {
-				directory: `./seeds/${environment}`,
-			},
+export default {
+	development: {
+		client: 'mysql',
+		connection: {
+			host: process.env.DB_HOST || 'localhost',
+			user: process.env.DB_USER || 'directus',
+			password: process.env.DB_PASSWORD || 'password',
+			database: process.env.DB_DATABSE || 'dashboard-globalping',
+			port: process.env.DB_PORT || 13306,
 		},
-	};
-}));
+		pool: {
+			min: 0,
+			max: 10,
+			propagateCreateError: false,
+		},
+		acquireConnectionTimeout: 2000,
+		seeds: {
+			directory: `./seeds/development`,
+		},
+	},
+	e2e: {
+		client: 'mysql',
+		connection: {
+			host: process.env.DB_HOST || '127.0.0.1',
+			user: process.env.DB_USER || 'directus',
+			password: process.env.DB_PASSWORD || 'password',
+			database: process.env.DB_DATABSE || 'dashboard-globalping',
+			port: process.env.DB_PORT || 13306,
+		},
+		pool: {
+			min: 0,
+			max: 10,
+			propagateCreateError: false,
+		},
+		acquireConnectionTimeout: 2000,
+	},
+};

package.json

@@ -14,13 +14,16 @@
 	},
 	"devDependencies": {
 		"@martin-kolarik/eslint-config": "^7.3.2",
+		"@playwright/test": "^1.48.2",
 		"@types/bluebird": "^3.5.42",
 		"@types/config": "^3.3.4",
 		"@types/eslint": "^8.56.11",
 		"@types/lodash": "^4.17.7",
 		"@types/mocha": "^10.0.7",
+		"@types/node": "^22.8.6",
 		"@typescript-eslint/eslint-plugin": "^7.18.0",
 		"cross-env": "^7.0.3",
+		"dotenv": "^16.4.5",
 		"dotenv-cli": "^7.4.2",
 		"eslint": "^8.57.0",
 		"eslint-plugin-chai-expect": "^3.1.0",
@@ -29,21 +32,28 @@
 		"eslint-plugin-n": "^16.6.2",
 		"eslint-plugin-promise": "^6.6.0",
 		"eslint-plugin-vue": "^9.27.0",
+		"execa": "^9.5.1",
 		"husky": "^8.0.3",
+		"pm2": "^5.4.2",
+		"relative-day-utc": "^1.3.0",
 		"typescript": "~5.2.2"
 	},
 	"scripts": {
 		"lint": "eslint --cache .",
 		"lint:fix": "pnpm lint --fix",
-		"init": "./scripts/init.sh",
-		"init:dev": "./scripts/init.sh --dev",
+		"init:dev": "./scripts/init.sh development",
+		"init:e2e": "./scripts/init.sh e2e",
 		"docker:ls:update": "node ./scripts/docker-ls.js",
 		"migrate": "rm -rf ./extensions/migrations/* && mkdir -p ./extensions/migrations/ && cp -rp ./src/extensions/migrations/* ./extensions/migrations/ && cp -p ./src/extensions/migration-utils.js ./extensions/ && dotenv -- npx [email protected] database migrate:latest",
 		"seed": "NODE_ENV=development dotenv -- knex seed:run",
 		"schema:apply": "npx [email protected] schema apply --yes snapshots/collections-schema.yml",
 		"schema:snapshot": "npx [email protected] schema snapshot --yes snapshots/collections-schema.yml",
 		"prepare": "husky install || echo 'Failed to install husky'; rm -f .eslintcache",
-		"build:in-sequence": "grep -E 'AS builder-[0-9]+' Dockerfile | awk -F 'AS ' '{print $2}' | xargs -r -P 1 -I STAGE docker build --target STAGE ."
+		"test:e2e": "npm run test:e2e:build:directus && npm run test:e2e:build:dash && npm run test:e2e:run",
+		"test:e2e:build:directus": "docker compose -f docker-compose.e2e.yml up --build -d && pnpm run init:e2e && docker compose -f docker-compose.e2e.yml stop",
+		"test:e2e:build:dash": "git clone https://github.com/jsdelivr/globalping-dash.git test/e2e/globalping-dash; cd test/e2e/globalping-dash && git reset --hard origin/master && git pull --force && pnpm install --ignore-workspace && dotenv -e ../../../.env -- pnpm build; cd ../../../;",
+		"test:e2e:run": "pnpm exec playwright test --grep-invert='.*generate-test\\.spec\\.ts'",
+		"test:e2e:generate": "pnpm exec playwright test test/e2e/generate-test.spec.ts --headed"
 	},
 	"repository": {
 		"type": "git",

playwright.config.ts

@@ -0,0 +1,32 @@
+import { defineConfig, devices } from '@playwright/test';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+	testDir: './test/e2e',
+	workers: 1,
+	use: {
+		baseURL: process.env.DASH_URL,
+	},
+	forbidOnly: !!process.env.CI,
+	reporter: 'list',
+	projects: [
+		{ name: 'setup', testMatch: /.*\.setup\.ts/ },
+
+		{
+			name: 'teardown', testMatch: /.*\.teardown\.ts/ },
+
+		{
+			name: 'chromium',
+			use: {
+				...devices['Desktop Chrome'],
+			},
+			dependencies: [ 'setup' ],
+			teardown: 'teardown',
+		},
+	],
+});