Add e2e tests

.github/workflows/e2e.yml

@@ -0,0 +1,33 @@
+name: E2E tests
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./e2e
+    steps:
+      - uses: actions/checkout@v4
+      - name: Read .nvmrc
+        id: nvmrc
+        run: echo ::set-output name=NODE_VERSION::$(cat .nvmrc)
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ steps.nvm.outputs.NODE_VERSION }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Install Playwright Browsers
+        run: npm run pw install --with-deps
+      - name: Run Playwright tests
+        run: npm test
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 10

e2e/.gitignore

@@ -0,0 +1,4 @@
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

e2e/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "flex-showcases-e2e",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "pw": "playwright",
+    "test": "playwright test"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@playwright/test": "^1.46.1",
+    "@types/node": "^22.5.0"
+  }
+}

e2e/playwright.config.ts

@@ -0,0 +1,51 @@
+import { defineConfig, devices } from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './tests',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* 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: 'http://127.0.0.1:3000',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: {
+        ...devices['Desktop Chrome'],
+        viewport: { width: 1920, height: 1080 },
+      },
+    },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});

e2e/tests/report-builder/report-builder.po.ts

@@ -0,0 +1,16 @@
+import { Page } from '@playwright/test';
+
+export class ReportBuilderPage {
+  /**
+   * @todo: Extract to config file
+   */
+  public readonly URL = 'https://d2ojv9ksm0gp58.cloudfront.net/report-builder/';
+
+  constructor(
+    private page: Page,
+  ) {}
+
+  public gotoMainPage = () => this.page.goto(this.URL);
+  public tableContainer = () => this.page.locator('.regular-table-container');
+  public chartOneBar = () => this.page.locator('.bars-container .bar').first();
+}

e2e/tests/report-builder/report-builder.spec.ts

@@ -0,0 +1,17 @@
+import { test, expect } from '@playwright/test';
+import { ReportBuilderPage } from './report-builder.po';
+
+test.describe('Report builder', () => {
+  test('should have working initial screen', async ({ page }) => {
+    // given
+    const reportBuilderPage = new ReportBuilderPage(page);
+
+    // when
+    await reportBuilderPage.gotoMainPage();
+    await reportBuilderPage.tableContainer().waitFor({ state: 'visible' });
+    await reportBuilderPage.chartOneBar().waitFor({ state: 'visible' });
+
+    // then
+    await expect(page).toHaveScreenshot({ threshold: 0.35 });
+  });
+});