test: add end-to-end tests with Playwright

.devcontainer/cpp-test/devcontainer.json

@@ -0,0 +1,4 @@
+{
+  "image": "ghcr.io/philips-software/amp-devcontainer-cpp:${localEnv:IMAGE_VERSION}",
+  "workspaceFolder": "/workspaces/amp-devcontainer/.devcontainer/cpp/e2e/workspace"
+}

.devcontainer/cpp/devcontainer.json

@@ -3,12 +3,19 @@
     "dockerfile": "Dockerfile",
     "context": "../.."
   },
+  "forwardPorts": [6080],
   "remoteEnv": {
     "CONTAINER_FLAVOR": "cpp"
   },
   "mounts": [
     "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind"
   ],
+  "features": {
+    "ghcr.io/devcontainers/features/desktop-lite:1.2.0": {},
+    "ghcr.io/devcontainers/features/github-cli:1.0.13": {},
+    "ghcr.io/devcontainers/features/node:1.5.0": {}
+  },
+  "postCreateCommand": "npm install && npx playwright install-deps && npx playwright install",
   "customizations": {
     "vscode": {
       "settings": {
@@ -23,6 +30,7 @@
         "[email protected]",
         "[email protected]",
         "[email protected]",
+        "[email protected]",
         "[email protected]",
         "[email protected]",
         "[email protected]",

.devcontainer/cpp/e2e/playwright.config.ts

@@ -0,0 +1,30 @@
+import { defineConfig, devices } from '@playwright/test';
+import path from 'path';
+
+require('dotenv').config();
+
+export const STORAGE_STATE = path.join(__dirname, 'playwright/.auth/user.json');
+
+export default defineConfig({
+  testDir: './tests',
+  fullyParallel: false,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: 1,
+  reporter: 'html',
+  use: {
+    baseURL: 'https://github.com',
+    trace: 'on-first-retry'
+  },
+  projects: [
+    { name: 'setup', testMatch: '**/*.setup.ts' },
+    {
+      name: 'chromium',
+      use: {
+        ...devices['Desktop Chrome'],
+        storageState: STORAGE_STATE
+      },
+      dependencies: ['setup']
+    }
+  ]
+});

.devcontainer/cpp/e2e/tests/authentication.setup.ts

@@ -0,0 +1,29 @@
+import { test as setup } from '@playwright/test';
+import * as OTPAuth from 'otpauth';
+import { STORAGE_STATE } from '../playwright.config';
+
+setup('authenticate', async ({ page }) => {
+  await page.goto('https://github.com/login');
+  await page.getByLabel('Username or email address').fill(process.env.GITHUB_USER!);
+  await page.getByLabel('Password').fill(process.env.GITHUB_PASSWORD!);
+  await page.getByRole('button', { name: 'Sign in', exact: true }).click();
+
+  let totp = new OTPAuth.TOTP({
+    issuer: 'GitHub',
+    label: 'GitHub',
+    algorithm: 'SHA1',
+    digits: 6,
+    period: 30,
+    secret: process.env.GITHUB_TOTP_SECRET!
+  });
+
+  let code = totp.generate();
+  await page.getByPlaceholder('XXXXXX').fill(code);
+
+  // Wait until the page receives the cookies.
+  //
+  // Sometimes login flow sets cookies in the process of several redirects.
+  // Wait for the final URL to ensure that the cookies are actually set.
+  await page.waitForURL('https://github.com/');
+  await page.context().storageState({ path: STORAGE_STATE });
+});

.devcontainer/cpp/e2e/tests/smoke.spec.ts

@@ -0,0 +1,6 @@
+import { test, expect } from '@playwright/test';
+
+test('has title', async ({ page }) => {
+  await page.goto('/');
+  await expect(page).toHaveTitle(/GitHub/);
+});

.devcontainer/cpp/e2e/workspace/CMakeLists.txt

@@ -0,0 +1,5 @@
+cmake_minimum_required(VERSION 3.24)
+
+project(e2e-test VERSION 1.0.0)
+
+add_executable(e2e-test main.cpp)

.devcontainer/cpp/e2e/workspace/CMakePresets.json

@@ -0,0 +1,42 @@
+{
+  "version": 3,
+  "configurePresets": [
+    {
+      "name": "defaults",
+      "hidden": true,
+      "binaryDir": "${sourceDir}/build/${presetName}",
+      "generator": "Ninja Multi-Config",
+      "cacheVariables": {
+        "CMAKE_CONFIGURATION_TYPES": "Debug;Release;RelWithDebInfo;MinSizeRel"
+      }
+    },
+    {
+      "name": "host",
+      "displayName": "host",
+      "description": "Build for host",
+      "inherits": "defaults"
+    }
+  ],
+  "buildPresets": [
+    {
+      "name": "host-Debug",
+      "configuration": "Debug",
+      "configurePreset": "host"
+    },
+    {
+      "name": "host-Release",
+      "configuration": "Release",
+      "configurePreset": "host"
+    },
+    {
+      "name": "host-RelWithDebInfo",
+      "configuration": "RelWithDebInfo",
+      "configurePreset": "host"
+    },
+    {
+      "name": "host-MinSizeRel",
+      "configuration": "MinSizeRel",
+      "configurePreset": "host"
+    }
+  ]
+}

.devcontainer/cpp/e2e/workspace/main.cpp

@@ -0,0 +1,7 @@
+#include <iostream>
+
+int main()
+{
+    std::cout << "Hello World!" << std::endl;
+    return 0;
+}

.github/dependabot.yml

@@ -5,7 +5,7 @@ updates:
   - package-ecosystem: github-actions
     directory: /
     schedule:
-      interval: daily
+      interval: weekly
     groups:
       github-actions:
         update-types:
@@ -16,8 +16,16 @@ updates:
   - package-ecosystem: docker
     directory: .devcontainer
     schedule:
-      interval: daily
+      interval: weekly
+  - package-ecosystem: devcontainers
+    directory: .devcontainer
+    schedule:
+      interval: weekly
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: weekly
   - package-ecosystem: pip
     directory: .devcontainer
     schedule:
-      interval: daily
+      interval: weekly

.github/workflows/acceptance-test.yml

@@ -0,0 +1,36 @@
+---
+name: Acceptance Test
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        with:
+          node-version: 18
+      - run: npm ci
+      - run: npx playwright install --with-deps
+      - run: |
+          gh codespace create --branch ${{ github.head_ref }} --machine basicLinux32gb
+        env:
+          GH_TOKEN: ${{ secrets.TEST_GITHUB_TOKEN }}
+          IMAGE_VERSION: pr-${{ github.event.pull_request.number }}
+      - run: cd .devcontainer/cpp/e2e && npm test
+        env:
+          GITHUB_USER: ${{ secrets.TEST_GITHUB_USER }}
+          GITHUB_PASSWORD: ${{ secrets.TEST_GITHUB_PASSWORD }}
+          GITHUB_TOTP_SECRET: ${{ secrets.TEST_GITHUB_TOTP_SECRET }}

.gitignore

@@ -1,8 +1,13 @@
+.auth/
 .xwin-cache/
 .xwin-hash/
 build/
 megalinter-reports/
 mutants.out/
+node_modules/
+playwright-report/
 target/
+test-results/
+.env
 *.profdata
 *.profraw

README.md

@@ -107,8 +107,22 @@ This project uses [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.htm
 
 The containers can be built and tested locally by importing this repository in VS Code with the [Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) plug-in installed. As a prerequisite Docker needs to be installed on the host system. Alternatively a GitHub Codespace can be started.
 
+#### Running the Integration Tests
+
 A test task is available to run the included `bats` tests. Choose `Tasks: Run Test Task` from the command pallette (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>).
 
+#### Running the Acceptance Tests
+
+Create an .env file with the following contents, this assumes a GitHub account that has rights to create a Codespace on this repository and is configured for time-based one-time password (TOTP) two-factor authentication (2FA).
+
+```dotenv
+GITHUB_USER=
+GITHUB_PASSWORD=
+GITHUB_TOTP_SECRET=
+```
+
+Test can now be run using the Test Explorer. The user interface, when selected, is available [here](http://localhost:6080) by-default. When port 6080 is already taken another port will be exposed. This can be seen with the Ports view (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>, Ports: Focus on Ports View).
+
 ## Reporting vulnerabilities
 
 If you find a vulnerability, please report it to us!

package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "@playwright/test": "^1.45.2",
+    "@types/node": "^20.14.11",
+    "dotenv": "^16.4.5",
+    "otpauth": "^9.3.1"
+  },
+  "scripts": {
+    "test": "cd $INIT_CWD && npx playwright test"
+  }
+}