Removed coverage setup from Playwright tests and CI

zonia3000 · zonia3000 · commit 6c771a4c6b50 · 2024-01-29T09:40:56.000+01:00
diff --git a/.github/workflows/coverage.yaml b/.github/workflows/coverage.yaml
diff --git a/.github/workflows/end_to_end_tests.yaml b/.github/workflows/end_to_end_tests.yaml
@@ -36,12 +36,3 @@ jobs:
 
       - name: Run Playwright tests
         run: npx playwright test --workers=1
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: playwright-coverage
-          path: coverage-playwright/
-          retention-days: 30
-
-    env:
-      ENABLE_COVERAGE: "true"
diff --git a/.github/workflows/unit_tests.yaml b/.github/workflows/unit_tests.yaml
@@ -26,13 +26,4 @@ jobs:
         run: npm install
 
       - name: Run vitest tests
-        run: npx vitest run --coverage.enabled --coverage.provider=istanbul --coverage.include=src --coverage.reporter=json --coverage.all
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: unit-coverage
-          path: coverage-unit/
-          retention-days: 30
-
-    env:
-      ENABLE_COVERAGE: "true"
+        run: npx vitest run
diff --git a/.nycrc b/.nycrc
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 *Note: Numbers like (\#123) point to closed Pull Requests on the fractal-web repository.*
 
+# Unreleased
+
+* Removed coverage setup from Playwright tests and CI (\#399).
+
 # 0.8.2
 
 * Improvements on worflow task form (\#393):
diff --git a/docs/development/tests.md b/docs/development/tests.md
@@ -18,24 +18,15 @@ To execute the tests seeing the browser add the `--headed` flag or the `--debug`
 
 ## Coverage
 
+> Warning: code coverage results are not reliable at the moment
+
 Coverage for the unit tests:
 
 ```
-ENABLE_COVERAGE=true npx vitest run --coverage.enabled --coverage.provider=istanbul --coverage.include=src --coverage.reporter=json --coverage.all
+npx vitest --coverage
 ```
 
-Warning: coverage takes some time using the option `--coverage.all`.
-
-Coverage for the playwright tests is automatically collected when running `ENABLE_COVERAGE=true npx playwright test`.
-
-To generate a merged html report:
-
-```
-mkdir coverage-all
-cp coverage-playwright/* coverage-all
-cp coverage-unit/* coverage-all
-npx nyc report --report-dir ./coverage-html --temp-dir ./coverage-all --reporter=html --exclude-after-remap false
-```
+Warning: coverage takes some time, since we are using the option `{ all: true }`.
 
 ### Local `fractal-server` instance
 
diff --git a/playwright.config.js b/playwright.config.js
@@ -39,7 +39,7 @@ export default defineConfig({
 
 	webServer: [
 		{
-			command: './tests/start-test-server.sh 1.4.2a5',
+			command: './tests/start-test-server.sh 1.4.2',
 			port: 8000,
 			waitForPort: true,
 			stdout: 'pipe',
diff --git a/tests/add_single_task.spec.js b/tests/add_single_task.spec.js
@@ -1,4 +1,5 @@
-import { expect, test, waitPageLoading } from './base_test.js';
+import { expect, test } from '@playwright/test';
+import { waitPageLoading } from './utils.js';
 import { fileURLToPath } from 'url';
 import path from 'path';
 
@@ -10,7 +11,7 @@ test('Add single tasks', async ({ page }) => {
 	await waitPageLoading(page);
 
 	await test.step('Select "Add a single task" form', async () => {
-		await page.getByLabel('Single task').click({ force: true });
+		await page.getByText('Single task').click();
 	});
 
 	const createBtn = page.getByRole('button', { name: /^Create$/ });
diff --git a/tests/admin_jobs.spec.js b/tests/admin_jobs.spec.js
@@ -1,4 +1,5 @@
-import { expect, test, waitPageLoading } from './base_test.js';
+import { expect, test } from '@playwright/test';
+import { waitPageLoading } from './utils.js';
 import { PageWithWorkflow } from './workflow_fixture.js';
 import * as fs from 'fs';
 
diff --git a/tests/auth.setup.js b/tests/auth.setup.js
@@ -1,5 +1,5 @@
 import { test as setup } from '@playwright/test';
-import { waitPageLoading } from './base_test';
+import { waitPageLoading } from './utils.js';
 
 const authFile = 'tests/.auth/user.json';
 
diff --git a/tests/base_test.js b/tests/base_test.js
diff --git a/tests/collect_core_tasks.setup.js b/tests/collect_core_tasks.setup.js
@@ -1,4 +1,5 @@
-import { expect, test, waitPageLoading } from './base_test.js';
+import { expect, test } from '@playwright/test';
+import { waitPageLoading } from './utils.js';
 
 test('Collect core tasks', async ({ page }) => {
 	await page.goto('/tasks');
diff --git a/tests/create_project.spec.js b/tests/create_project.spec.js
@@ -1,4 +1,5 @@
-import { expect, test, waitPageLoading } from './base_test.js';
+import { expect, test } from '@playwright/test';
+import { waitPageLoading } from './utils.js';
 
 test('Create and delete a project', async ({ page }) => {
 	await page.goto('/projects');
diff --git a/tests/dataset_crud.spec.js b/tests/dataset_crud.spec.js
@@ -1,4 +1,4 @@
-import { waitPageLoading } from './base_test.js';
+import { waitPageLoading } from './utils.js';
 import { expect, test } from './project_fixture.js';
 
 test('Create, update and delete a dataset', async ({ page, project }) => {
diff --git a/tests/import_workflow.spec.js b/tests/import_workflow.spec.js
@@ -1,5 +1,5 @@
 import { fileURLToPath } from 'url';
-import { waitPageLoading } from './base_test.js';
+import { waitPageLoading } from './utils.js';
 import { expect, test } from './project_fixture.js';
 import path from 'path';
 
diff --git a/tests/jobs.spec.js b/tests/jobs.spec.js
@@ -1,4 +1,4 @@
-import { waitPageLoading } from './base_test.js';
+import { waitPageLoading } from './utils.js';
 import { expect, test } from './workflow_fixture.js';
 
 test('Execute jobs', async ({ page, workflow }) => {
diff --git a/tests/jschema.spec.js b/tests/jschema.spec.js
@@ -1,4 +1,4 @@
-import { waitModalClosed, waitPageLoading } from './base_test.js';
+import { waitModalClosed, waitPageLoading } from './utils.js';
 import { expect, test } from './workflow_fixture.js';
 import { fileURLToPath } from 'url';
 import path from 'path';
@@ -13,7 +13,7 @@ test('JSON Schema validation', async ({ page, browserName, workflow }) => {
 	await test.step('Go to "Add a single task" form', async () => {
 		await page.goto('/tasks');
 		await waitPageLoading(page);
-		await page.getByLabel('Single task').click({ force: true });
+		await page.getByText('Single task').click();
 	});
 
 	const randomTaskName = 'validation-test-' + Math.random().toString(36).substring(7);
diff --git a/tests/login_logout.spec.js b/tests/login_logout.spec.js
@@ -1,4 +1,5 @@
-import { expect, test, waitPageLoading } from './base_test.js';
+import { expect, test } from '@playwright/test';
+import { waitPageLoading } from './utils.js';
 
 // Reset storage state for this file to avoid being authenticated
 test.use({ storageState: { cookies: [], origins: [] } });
diff --git a/tests/profile.spec.js b/tests/profile.spec.js
@@ -1,4 +1,5 @@
-import { expect, test, waitPageLoading } from './base_test.js';
+import { expect, test } from '@playwright/test';
+import { waitPageLoading } from './utils.js';
 
 test('User profile', async ({ page }) => {
 	await test.step('Open user profile page', async () => {
diff --git a/tests/project_fixture.js b/tests/project_fixture.js
@@ -1,5 +1,5 @@
-import { test as playwrightTest, mergeTests } from '@playwright/test';
-import { test as baseTest, waitPageLoading } from './base_test.js';
+import { test as baseTest, mergeTests } from '@playwright/test';
+import { waitPageLoading } from './utils.js';
 
 export class PageWithProject {
 	/**
@@ -62,7 +62,7 @@ export class PageWithProject {
 	}
 }
 
-const projectTest = playwrightTest.extend({
+const projectTest = baseTest.extend({
 	project: async ({ page }, use) => {
 		const project = new PageWithProject(page);
 		await project.createProject();
diff --git a/tests/slurm_account.spec.js b/tests/slurm_account.spec.js
@@ -1,4 +1,4 @@
-import { waitPageLoading } from './base_test.js';
+import { waitPageLoading } from './utils.js';
 import { expect, test } from './workflow_fixture.js';
 
 test('Add SLURM accounts for the admin and execute workflow using a specific account', async ({
diff --git a/tests/users_crud.spec.js b/tests/users_crud.spec.js
@@ -1,4 +1,5 @@
-import { expect, test, waitPageLoading } from './base_test.js';
+import { expect, test } from '@playwright/test';
+import { waitPageLoading } from './utils.js';
 
 test('Create, update and delete a user', async ({ page }) => {
 	await test.step('Open the admin area', async () => {
diff --git a/tests/utils.js b/tests/utils.js
@@ -0,0 +1,21 @@
+import * as crypto from 'crypto';
+
+export function generateUUID() {
+	return crypto.randomBytes(16).toString('hex');
+}
+
+/**
+ * Wait until spinner disappear
+ * @param {import('@playwright/test').Page} page
+ */
+export async function waitPageLoading(page) {
+	await page.waitForFunction(() => !document.querySelector('.loading')?.classList.contains('show'));
+}
+
+/**
+ * Wait until modal is closed
+ * @param {import('@playwright/test').Page} page
+ */
+export async function waitModalClosed(page) {
+	await page.waitForFunction(() => document.querySelector('.modal.show') === null);
+}
diff --git a/tests/workflow_fixture.js b/tests/workflow_fixture.js
@@ -1,5 +1,5 @@
-import { test as playwrightTest, mergeTests } from '@playwright/test';
-import { test as baseTest, waitPageLoading } from './base_test.js';
+import { test as baseTest, mergeTests } from '@playwright/test';
+import { waitPageLoading } from './utils.js';
 import { PageWithProject } from './project_fixture.js';
 
 export class PageWithWorkflow extends PageWithProject {
@@ -51,7 +51,7 @@ export class PageWithWorkflow extends PageWithProject {
 	}
 }
 
-const workflowTest = playwrightTest.extend({
+const workflowTest = baseTest.extend({
 	workflow: async ({ page }, use) => {
 		const workflow = new PageWithWorkflow(page);
 		await workflow.createProject();
diff --git a/vite.config.js b/vite.config.js

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ export default defineConfig({`
`39`	`39`
`40`	`40`	`webServer: [`
`41`	`41`	`{`
`42`		`- command: './tests/start-test-server.sh 1.4.2a5',`
	`42`	`+ command: './tests/start-test-server.sh 1.4.2',`
`43`	`43`	`port: 8000,`
`44`	`44`	`waitForPort: true,`
`45`	`45`	`stdout: 'pipe',`