Merge pull request #517 from Lemoncode/feature/#514-Configure-Playwright-e2e

setup Playwright with initial e2e test and scripts

Author: brauliodiez

.gitignore

@@ -22,3 +22,7 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

e2e/launch-mongodb-designer-link.spec.ts

@@ -0,0 +1,8 @@
+import { test, expect } from '@playwright/test';
+
+test('navigates to and verifies MongoDB Designer URL', async ({ page }) => {
+  await page.goto('');
+
+  await page.getByRole('link', { name: 'Launch MongoDB Designer' }).click();
+  await expect(page).toHaveURL('http://localhost:5173/editor.html');
+});

package-lock.json

@@ -4,14 +4,17 @@
   "version": "0.0.0",
   "type": "module",
   "scripts": {
+    "postinstall": "npm run install:e2e-browsers",
+    "install:e2e-browsers": "npx playwright install",
     "dev": "vite",
     "build": "tsc && vite build",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview",
     "format": "prettier --write .",
     "test": "vitest",
-    "prepare": "husky install",
-    "tsc-check": "tsc --noEmit"
+    "prepare": "husky || \"No need to install husky\"",
+    "tsc-check": "tsc --noEmit",
+    "e2e": "playwright test --ui"
   },
   "dependencies": {
     "@lemoncode/fonk": "^1.5.4",
@@ -26,6 +29,7 @@
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
+    "@playwright/test": "^1.48.1",
     "@testing-library/dom": "^9.3.4",
     "@testing-library/react": "^14.2.1",
     "@types/jest": "^29.5.11",

package.json

@@ -0,0 +1,59 @@
+import { defineConfig, devices } from '@playwright/test';
+
+const BASE_URL = 'http://localhost:5173/';
+
+export default defineConfig({
+  testDir: './e2e',
+  fullyParallel: true,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 1 : undefined,
+  reporter: 'html',
+  use: {
+    baseURL: BASE_URL,
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    {
+      name: 'firefox',
+      use: { ...devices['Desktop Firefox'] },
+    },
+
+    {
+      name: 'webkit',
+      use: { ...devices['Desktop Safari'] },
+    },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: 'npm run dev',
+    reuseExistingServer: !process.env.CI,
+  },
+});

playwright.config.ts

@@ -2,16 +2,7 @@ import { defineConfig } from 'vite';
 import { fileURLToPath, URL } from 'node:url';
 import react from '@vitejs/plugin-react';
 import checker from 'vite-plugin-checker';
-import type { UserConfig as VitestUserConfigInterface } from 'vitest/config';
-
-const vitestConfig: VitestUserConfigInterface = {
-  test: {
-    setupFiles: ['./vitest.setup.ts'],
-    globals: true,
-    restoreMocks: true,
-    environment: 'jsdom',
-  },
-};
+import { configDefaults } from 'vitest/config';
 
 // https://vitejs.dev/config/
 export default defineConfig({
@@ -24,7 +15,14 @@ export default defineConfig({
       },
     },
   },
-  test: vitestConfig.test,
+  test: {
+    setupFiles: ['./vitest.setup.ts'],
+    globals: true,
+    environment: 'jsdom',
+    restoreMocks: true,
+    include: ['./src/**/*.spec.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+    exclude: [...configDefaults.exclude, 'e2e/*'],
+  },
   resolve: {
     alias: {
       '@': fileURLToPath(new URL('./src', import.meta.url)),