Merge pull request #20 from umd-mith/minimal-e2e-tests

.github/workflows/run-tests.yml

@@ -0,0 +1,47 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  test:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    env:
+      AIRTABLE_PEOPLE_BASE_ID: appk2btw36qEO3vFo
+      AIRTABLE_RESEARCH_BASE_ID: appTv9J1zxqaNgBHi
+      AIRTABLE_EVENTS_BASE_ID: tbl6CURONRn8ML6le
+      AIRTABLE_POSTS_BASE_ID: appsY0VXF7pbv3mKR
+      AIRTABLE_MITH_BASE_ID: appMWsw8HKjjokBg2
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - name: Install dependencies
+        run: npm ci
+      - name: Cache Playwright browsers
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/ms-playwright
+          key: ${{ runner.os }}-playwright-${{ hashFiles('**/package-lock.json') }}
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+      # - name: Start Gatsby development server
+      #   env:
+      #     AIRTABLE_TOKEN: ${{ secrets.AIRTABLE_TOKEN }}
+      #   run: |
+      #     npm run develop &
+      #     npx wait-on http://localhost:8000 --timeout 300000
+
+      - name: Run Playwright tests
+        env:
+          AIRTABLE_TOKEN: ${{ secrets.AIRTABLE_TOKEN  }}
+        run: npx playwright test
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30

.github/workflows/staging.yml

@@ -7,7 +7,11 @@ on:
   workflow_dispatch:
 
 jobs:
+  test:
+    uses: ./.github/workflows/run-tests.yml
+
   build:
+    needs: test
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.gitignore

@@ -80,3 +80,9 @@ releases
 
 # Tool versioning info
 .tool-versions
+
+# Playwright tests
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

README.md

@@ -23,8 +23,8 @@ You may also build the site locally and `rsync` the built site if you have the r
 
 To build the site you will need to install a few things:
 
-* [Node](https://nodejs.org): a JavaScript programming environment
-* [Git](https://git-scm.com/): version control software
+- [Node](https://nodejs.org): a JavaScript programming environment
+- [Git](https://git-scm.com/): version control software
 
 Then you will need to get this repository:
 
@@ -46,3 +46,11 @@ You will also need a personal token from Airtable. Once logged in, you can gener
 Now you are ready to start the development server:
 
     npm run develop
+
+## Test
+
+To run the project's tests:
+
+`npm run test`
+
+You may also be required to install Playwright and test browser binaries with `npx playwright install`

package.json

@@ -12,6 +12,7 @@
     "build": "gatsby build",
     "build-pages": "BASEPATH=/mith-static gatsby build --prefix-paths",
     "develop": "gatsby develop",
+    "test": "playwright test",
     "clean": "gatsby clean",
     "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\""
   },
@@ -49,6 +50,8 @@
     "request": "^2.88.2"
   },
   "devDependencies": {
+    "@playwright/test": "^1.45.1",
+    "@types/node": "^20.14.10",
     "airtable": "^0.12.2",
     "chalk": "^5.3.0",
     "dayjs": "^1.11.11",

playwright.config.ts

@@ -0,0 +1,81 @@
+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: [["list", { printSteps: true }]],
+  /* 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",
+  },
+
+  timeout: 100000,
+
+  /* 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 start",
+    port: 8000,
+    reuseExistingServer: !process.env.CI,
+    timeout: 300000,
+  },
+})