Add e2e tests

.env

@@ -1,2 +1,3 @@
 MONGO_DB_URL=
 NEXT_PUBLIC_NODE_ENV=
+PLAYWRIGHT_BASE_URL=

.github/workflows/deployment.yml

@@ -25,4 +25,4 @@ jobs:
         run: npm run lint
 
       - name: Unit Tests
-        run: npm run test
+        run: npm run test:unit

.github/workflows/playwright.yml

@@ -0,0 +1,43 @@
+name: E2e tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    timeout-minutes: 60
+
+    steps:
+    - name: Wait for HTTP Status Code 200 from the Vercel Preview Deploy
+      uses: patrickedqvist/[email protected]
+      id: waitForVercelPreviewDeploy
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        max_timeout: 300
+
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
+
+    - name: Run Playwright tests
+      env:
+        PLAYWRIGHT_BASE_URL: ${{ steps.waitForVercelPreviewDeploy.outputs.url }}
+      run: npx playwright test
+
+    - uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.gitignore

@@ -7,6 +7,10 @@
 
 # testing
 /coverage
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
 
 # next.js
 /.next/

README.md

@@ -30,10 +30,16 @@ npm run fix
 
 ## Testing
 
-Tests are built with [Vitest](https://vitest.dev/).
+Unit Tests are built with [Vitest](https://vitest.dev/).
 
 ```bash
-npm run test
+npm run test:unit
+```
+
+E2e Tests are built with [Playwright](https://playwright.dev/).
+
+```bash
+npm run test:e2e
 ```
 
 ## Development configuration

next-env.d.ts

@@ -2,4 +2,4 @@
 /// <reference types="next/image-types/global" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/basic-features/typescript for more information.
+// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

package.json

@@ -12,7 +12,8 @@
     "fix": "npm run fix:js && npm run fix:css",
     "fix:js": "next lint --fix",
     "fix:css": "stylelint \"**/*.css\" --fix",
-    "test": "vitest"
+    "test:unit": "vitest",
+    "test:e2e": "playwright test"
   },
   "dependencies": {
     "accept-language": "^3.0.20",
@@ -31,6 +32,7 @@
     "react-i18next": "^15.0.1"
   },
   "devDependencies": {
+    "@playwright/test": "^1.47.0",
     "@testing-library/jest-dom": "^6.4.8",
     "@testing-library/react": "^16.0.1",
     "@types/exenv": "^1.2.2",
@@ -41,6 +43,7 @@
     "@typescript-eslint/eslint-plugin": "^7.17.0",
     "@typescript-eslint/parser": "^7.18.0",
     "@vitejs/plugin-react": "4.3.1",
+    "dotenv-cli": "^7.4.2",
     "eslint": "^8.56.0",
     "eslint-config-next": "^14.2.6",
     "eslint-plugin-import": "^2.29.1",

playwright.config.ts

@@ -0,0 +1,43 @@
+import path from 'node:path'
+
+import { defineConfig, devices } from '@playwright/test'
+import dotenv from 'dotenv'
+
+
+dotenv.config({ path: path.resolve(__dirname, '.env') })
+
+const environment = process.env.NEXT_PUBLIC_NODE_ENV || 'development'
+
+export default defineConfig({
+  forbidOnly: environment !== 'development',
+  fullyParallel: true,
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+    {
+      name: 'webkit',
+      use: { ...devices['Desktop Safari'] },
+    },
+    {
+      name: 'Mobile Chrome',
+      use: { ...devices['Pixel 5'] },
+    },
+    {
+      name: 'Mobile Safari',
+      use: { ...devices['iPhone 12'] },
+    },
+  ],
+  reporter: 'html',
+  retries: environment !== 'development' ? 2 : 0,
+  testDir: './src/',
+  testMatch: '**/*.e2e.ts',
+  use: {
+    baseURL: process.env.PLAYWRIGHT_BASE_URL || 'http://localhost:3000',
+    screenshot: 'only-on-failure',
+    trace: 'retain-on-failure',
+    video: 'retain-on-failure',
+  },
+  workers: environment !== 'development' ? 1 : undefined,
+})

src/app/[locale]/__e2e__/fixtures/index.ts

@@ -0,0 +1,2 @@
+export * from './page/AppPage'
+export * from './test/testAppPage'

src/app/[locale]/__e2e__/fixtures/page/AppPage.ts

@@ -0,0 +1,8 @@
+import { BasePage } from 'src/tests/playwright/fixtures'
+
+
+export class AppPage extends BasePage {
+  async goto(): Promise<void> {
+    await this.page.goto('/')
+  }
+}

src/app/[locale]/__e2e__/fixtures/test/testAppPage.ts

@@ -0,0 +1,11 @@
+import test from '@playwright/test'
+
+import { AppPage } from '../page/AppPage'
+
+
+export const testAppPage = test.extend<{ appPage: AppPage }>({
+  async appPage({ page }, use) {
+    const appPage = new AppPage(page)
+    await use(appPage)
+  }
+})

src/app/[locale]/app.e2e.ts

@@ -0,0 +1,32 @@
+import { expect } from '@playwright/test'
+
+import { testAppPage as test } from './__e2e__/fixtures'
+
+
+test.beforeEach(async ({ appPage }) => {
+  await appPage.goto()
+})
+
+test.describe('src / app / [locale] > app', () => {
+  test('check header existance', async ({ appPage }) => {
+    expect(appPage.header.getElement()).toBeDefined()
+    expect(appPage.header.getElement()).toBeInViewport()
+
+    expect(appPage.header.getLogo()).toBeDefined()
+    expect(appPage.header.getLogo()).toBeInViewport()
+  })
+
+  test('check navigation menu', async ({ appPage }) => {
+    expect(appPage.navigation.getElement()).toBeInViewport()
+
+    expect(appPage.navigation.getMenu('')).toBeDefined()
+    expect(appPage.navigation.getMenu('places')).toBeDefined()
+  })
+
+  test('check locales menu', async ({ appPage }) => {
+    expect(appPage.locales.getElement()).toBeInViewport()
+
+    expect(appPage.locales.getLanguage('en')).toBeDefined()
+    expect(appPage.locales.getLanguage('it')).toBeDefined()
+  })
+})

src/tests/playwright/fixtures/index.ts

@@ -0,0 +1 @@
+export * from './page/BasePage'