WIP - Adding Playwright Tests

.github/workflows/playwright.yml

@@ -0,0 +1,57 @@
+name: Playwright Tests
+# todo, this GitHub Action should either be Triggered by Pantheon's build process
+# phoning back to GitHub Actions after the deployment completes
+# Or the GitHub Action will need to poll somehow that the deployment has completed.
+# The Gatsby Build Process could place a file that reports that Git Hash that it was
+# built from. Check that via polling.
+# consider this for polling. https://github.com/artiz/poll-endpoint
+# https://github.com/marketplace/actions/poll-endpoint
+on:
+  pull_request:
+    branches: [ main, master ]
+env:
+  GITHUB_PR_NUMBER: ${{ github.event.number }}
+  # @todo figure out how to make this work on main.
+  GIT_SHA:  ${{ github.event.pull_request.head.sha }}
+
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./tests
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 18
+    - name: Print Commit SHA
+      run:  echo $GIT_SHA
+    - name: Check githead
+      run:  curl https://pr-${GITHUB_PR_NUMBER}-documentation.appa.pantheon.site/githead.txt
+
+    # @todo, this is a hack to get the githead from the build process.
+    # - uses: artiz/[email protected]
+    #   with:
+    #     url: https://pr-${{ github.event.number }}-documentation.appa.pantheon.site/githead-${{ github.event.pull_request.head.sha }}.txt
+    #     method: GET
+    #     expectStatus: 200
+    #     expectBody: ${{ github.event.pull_request.head.sha }}
+    #     #expectBodyRegex: "git commit"
+    #     timeout: 600000
+    #     interval: 5000
+
+    - name: Install dependencies
+      run:  npm ci
+    - name: Install Playwright Browsers
+      run:  npx playwright install --with-deps
+
+    - name: Run Playwright tests
+      run: npx playwright test
+    - uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: playwright-report
+        path: tests/playwright-report/
+        retention-days: 30

.gitignore

@@ -67,6 +67,9 @@ typings/
 .cache/
 public
 
+# This file is made during the build process. It is used to determine the current git commit hash.
+static/githead.txt
+
 # Mac files
 .DS_Store
 

gatsby-node.js

@@ -601,6 +601,10 @@ exports.onCreateNode = ({ node, getNode, actions }) => {
     }
   }
 
+/**
+ * Todo, create a page for the git hash.
+ */
+
   // Releases and Changelog Content
   var nodeString = node.internal.type.toString()
   var isReleaseJson = nodeString.includes("ReleasesJson")

package.json

@@ -85,7 +85,8 @@
     "node": ">=18.0.0 <20.0.0"
   },
   "scripts": {
-    "build": "gatsby build --prefix-paths --log-pages",
+
+    "build": "echo   $(git rev-parse  HEAD) > static/githead-$(git rev-parse  HEAD).txt && gatsby build --prefix-paths --log-pages",
     "develop": "gatsby develop",
     "format": "prettier --write src/**/*.{js,jsx}",
     "start": "npm run develop",

tests/.gitignore

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

tests/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "tests",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {},
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@playwright/test": "^1.40.1",
+    "@types/node": "^20.10.5"
+  }
+}

tests/playwright-tests/example.spec.ts

@@ -0,0 +1,38 @@
+import { test, expect } from '@playwright/test';
+
+test('has title', async ({ page }) => {
+  await page.goto('/certification');
+  // Expect a title "to contain" a substring.
+  await expect(page).toHaveTitle(/Certification Program/);
+
+  /* @todo, add a test of Searching */
+});
+
+test('Use Search Form', async ({ page }) => {
+  await page.goto('/');
+  // Enter the word "Terminus" into the search box.
+  await page.fill('#searchform input', 'Terminus');
+  // Submit the form
+  await page.press('#searchform input', 'Enter');
+  // Check that the page contains "Introduction | Terminus Guide | Pantheon Docs"
+//
+  //const searchResults = page.getByTestId('h3 a').nth(0);
+
+  // const searchResults = page.getByClassName('search-results').nth(0);
+  // await expect(searchResults).toHaveText('Terminus Platform Support');
+
+const firstResult = await page.locator('h3 a')
+    .filter({ hasText: "Terminus Platform Support" }) //orderID in variable
+    //.getByRole('span', { hasText: 'Queued' })
+
+
+  await firstResult.click();
+
+  // check that the current path is guides/platform-considerations/terminus-platform
+  // ignore the base URL.
+//  await expect(page).toHaveURL('https://docs.pantheon.io/guides/platform-considerations/terminus-platform');
+// check that the current path contains guides/platform-considerations/terminus-platform
+  await expect(page).toHaveURL(/guides\/platform-considerations\/terminus-platform/);
+
+
+});

tests/playwright.config.ts

@@ -0,0 +1,53 @@
+import { defineConfig, devices } from '@playwright/test';
+
+/* todo, decide whether or not to use dotenv */
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './playwright-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: {
+    video: 'on',
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    // TODO, update this url to handle building on the main branch.
+    baseURL: process.env.GITHUB_PR_NUMBER ? 'https://pr-' + process.env.GITHUB_PR_NUMBER + '-documentation.appa.pantheon.site' : 'http://localhost:8000',
+
+    /* 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'] },
+    },
+
+    {
+      name: 'firefox',
+      use: { ...devices['Desktop Firefox'] },
+    },
+
+    {
+      name: 'webkit',
+      use: { ...devices['Desktop Safari'] },
+    },
+  ],
+});