@public-ui/visual-tests 3.0.0-rc.1 → 3.0.0-rc.11

package/README.md

@@ -48,8 +48,12 @@ Add the following npm scripts to the theme's `package.json`:
 }
 ```
 
-- `THEME_MODULE` defines the relative path to the TypeScript module containing the the theme definitions. Without file extension.
-- `THEME_EXPERT` defines the name of the export within the the module. (e.g., `export const THEME_NAME = {/**/};`) Defaults to `default`.
+### Environment variables
+
+- `THEME_MODULE`: Define the relative path to the TypeScript module containing the theme definitions. Without file extension.
+- `THEME_EXPERT`: Define the name of the export within the module. (e.g., `export const THEME_NAME = {/**/};`) Defaults to `default`.
+- `KOLIBRI_VISUAL_TESTS_TIMEOUT`: Define the Playwright [test timeout](https://playwright.dev/docs/test-timeouts).
+- `KOLIBRI_VISUAL_TESTS_EXPECT_TIMEOUT`: Define the Playwright [expect timeout](https://playwright.dev/docs/test-timeouts).
 
 Run the tests with `npm test`. The first time, this will create a new folder `snapshots` which is supposed to be committed to the repository.
 In the following runs, new screenshots will be compared to this reference.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@public-ui/visual-tests",
-  "version": "3.0.0-rc.1",
+  "version": "3.0.0-rc.11",
   "license": "EUPL-1.2",
   "homepage": "https://public-ui.github.io",
   "repository": {
@@ -15,6 +15,9 @@
     "name": "Informationstechnikzentrum Bund",
     "email": "kolibri@itzbund.de"
   },
+  "engines": {
+    "pnpm": "^10"
+  },
   "type": "module",
   "sideEffects": false,
   "description": "Provides utility to run visual regression tests for themes.",
@@ -22,19 +25,19 @@
     "kolibri-visual-test": "src/index.js"
   },
   "dependencies": {
-    "@playwright/test": "1.49.0",
-    "axe-playwright": "2.0.3",
-    "portfinder": "1.0.32",
+    "@playwright/test": "1.49.1",
+    "axe-playwright": "2.1.0",
+    "portfinder": "1.0.35",
     "serve": "14.2.4",
-    "@public-ui/sample-react": "3.0.0-rc.1"
+    "@public-ui/sample-react": "3.0.0-rc.11"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "7.25.9",
+    "@babel/eslint-parser": "7.26.10",
     "@babel/plugin-syntax-import-attributes": "7.26.0",
-    "@babel/preset-env": "7.26.0",
+    "@babel/preset-env": "7.26.9",
     "eslint": "8.57.1",
-    "knip": "5.37.1",
-    "prettier": "3.3.3"
+    "knip": "5.46.0",
+    "prettier": "3.5.3"
   },
   "files": [
     "playwright.config.js",
@@ -43,7 +46,8 @@
   ],
   "scripts": {
     "format": "prettier --check src",
-    "lint": "eslint src",
+    "lint": "pnpm lint:eslint",
+    "lint:eslint": "eslint src",
     "unused": "knip",
     "postinstall": "pnpm exec playwright install"
   }

package/playwright.config.js

@@ -2,19 +2,24 @@ import { defineConfig, devices } from '@playwright/test';
 import * as path from 'path';
 import * as process from 'process';
 
-const PORT = Number(process.env.KOLIBRI_VISUAL_TEST_PORT);
-const URL = `http://localhost:${PORT}`;
+// Validate and set ENVs
+const PORT = parseInt(process.env.KOLIBRI_VISUAL_TEST_PORT || '', 10);
+const BASE_URL = `http://localhost:${PORT}`;
 
-console.log('Serving React Sample app:', URL);
+const CWD = process.env.KOLIBRI_CWD ?? '';
+const TIMEOUT = parseInt(process.env.KOLIBRI_VISUAL_TESTS_TIMEOUT || '15000', 10);
+const EXPECT_TIMEOUT = parseInt(process.env.KOLIBRI_VISUAL_TESTS_EXPECT_TIMEOUT || '5000', 10);
+const BUILD_PATH = process.env.KOLIBRI_VISUAL_TESTS_BUILD_PATH ?? '';
+const THEME = (process.env.THEME_EXPORT || 'default').toLocaleLowerCase();
 
 /**
  * See https://playwright.dev/docs/test-configuration.
  */
 export default defineConfig({
 	testDir: './tests',
-	snapshotDir: path.join(process.env.KOLIBRI_CWD ?? '', 'snapshots'),
+	snapshotDir: path.join(CWD, 'snapshots'),
 	// snapshotPathTemplate: '',
-	outputDir: path.join(process.env.KOLIBRI_CWD ?? '', 'test-results'),
+	outputDir: path.join(CWD, 'test-results'),
 	/* Run tests in files in parallel */
 	fullyParallel: true,
 	/* Fail the build on CI if you accidentally left test.only in the source code. */
@@ -24,18 +29,22 @@ export default defineConfig({
 	/* Opt out of parallel tests on CI. */
 	workers: process.env.CI ? 1 : undefined,
 	/* Allow to override the expectation timeout for slow environments */
-	timeout: process.env.KOLIBRI_VISUAL_TESTS_TIMEOUT ? Number(process.env.KOLIBRI_VISUAL_TESTS_TIMEOUT) : undefined,
+	timeout: TIMEOUT,
 	/* Reporter to use. See https://playwright.dev/docs/test-reporters */
 	reporter: 'line',
 	/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
 	use: {
 		/* Base URL to use in actions like `await page.goto('/')`. */
-		baseURL: URL,
+		baseURL: BASE_URL,
 
 		/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
 		trace: 'on-first-retry',
 	},
 
+	expect: {
+		timeout: EXPECT_TIMEOUT,
+	},
+
 	/* Configure projects for major browsers */
 	projects: [
 		// {
@@ -55,8 +64,9 @@ export default defineConfig({
 	/* Run your local dev server before starting the tests */
 	webServer: {
 		command: `npx serve -p ${PORT}`,
-		cwd: path.resolve(process.env.KOLIBRI_VISUAL_TESTS_BUILD_PATH),
-		url: URL,
+		cwd: path.resolve(BUILD_PATH),
+		url: BASE_URL,
 		reuseExistingServer: false,
 	},
+	snapshotPathTemplate: `{snapshotDir}/theme-${THEME}/{arg}-{projectName}-{platform}{ext}`,
 });

package/src/index.js

@@ -19,15 +19,8 @@ if (!tempDir) {
 process.env.THEME_MODULE = path.join(process.cwd(), process.env.THEME_MODULE); // Use current working directory (i.e. the theme folder) to complete module path
 const visualsTestModulePath = fileURLToPath(new URL('..', import.meta.url));
 const binaryPath = fileURLToPath(new URL('../node_modules/.bin', import.meta.url));
-
-let sampleReactPath = '../node_modules/@public-ui/sample-react';
-let backSteps = ``;
-let workingDir = null;
-do {
-	const url = new URL(backSteps + sampleReactPath, import.meta.url);
-	workingDir = fileURLToPath(url);
-	backSteps += `../`;
-} while (!fs.existsSync(workingDir) && path.resolve(process.cwd(), backSteps) !== '/');
+const sampleReactPackageJsonPath = import.meta.resolve('@public-ui/sample-react/package.json');
+const workingDir = fileURLToPath(path.dirname(sampleReactPackageJsonPath));
 
 if (!fs.existsSync(workingDir)) {
 	throw new Error('Could not find React Sample App package. Please install it with "npm install @public-ui/sample-react".');

package/tests/axe-snapshots.spec.js

@@ -36,21 +36,31 @@ test.use({
 	},
 });
 
-const blocklist = [];
-
 ROUTES.forEach((options, route) => {
-	if (blocklist.includes(route)) {
+	// Skip unnecessary axe tests
+	if (options?.axe?.skip === true) {
 		return;
 	}
 	test(`snapshot for ${route}`, async ({ page }, testInfo) => {
 		const outputPath = rename(testInfo.outputDir);
-		await page.goto(`/#${route}?hideMenus`, { waitUntil: 'networkidle' });
-		if (options?.viewportSize) {
-			await page.setViewportSize(options.viewportSize);
+		const hideMenusParam = `${route.includes('?') ? '&' : '?'}hideMenus`;
+		await page.goto(`/#${route}${hideMenusParam}`);
+		await page.waitForLoadState('networkidle');
+		await page.addStyleTag({
+			content: `
+				* {
+					transition: none !important;
+					animation: none !important;
+				}
+			`,
+		});
+		if (options?.snapshot?.viewportSize) {
+			await page.setViewportSize(options?.snapshot?.viewportSize);
 		}
-		if (options?.waitForTimeout) {
-			await page.waitForTimeout(options.waitForTimeout);
+		if (options?.snapshot?.waitForTimeout) {
+			await page.waitForTimeout(options?.snapshot?.waitForTimeout);
 		}
+
 		await injectAxe(page);
 		await checkA11y(
 			page,
@@ -67,7 +77,7 @@ ROUTES.forEach((options, route) => {
 					html: true,
 				},
 			},
-			options?.axe?.skipFailures ?? true,
+			options?.axe?.skipFailures ?? false,
 			'html',
 			{
 				outputDirPath: outputPath.replace(/\/[^/]+$/, ''),