From 0e7a69c8aede7f8cfcd1f0bd582ab5930386cf09 Mon Sep 17 00:00:00 2001
From: Dan Livings <dan.livings@dxw.com>
Date: Thu, 14 Nov 2024 17:20:10 +0000
Subject: [PATCH] Allow Playwright tests to be authenticated

The `GH_TOKEN` environment variable can be used both locally and in CI
to avoid testing the GitHub OAuth flow (which is provided by the Octokit
library and can therefore be assumed to be well tested).

In local development the token can be retrieved by logging into Towtruck
and then copying the value of the `Token` cookie.

In CI, the correct value is automatically populated by GitHub Actions
into a secret.
---
 .github/workflows/playwright.yml        |   2 ++
 e2es/auth.setup.js                      |  20 ++++++++++++++++++++
 e2es/{seedTestData.js => seed.setup.js} |   0
 e2es/testData/towtruck.db               | Bin 16384 -> 16384 bytes
 e2es/towtruck.spec.js                   |   6 +++++-
 playwright.config.js                    |   8 ++++----
 6 files changed, 31 insertions(+), 5 deletions(-)
 create mode 100644 e2es/auth.setup.js
 rename e2es/{seedTestData.js => seed.setup.js} (100%)

diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml
index 739fb0d..282cb61 100644
--- a/.github/workflows/playwright.yml
+++ b/.github/workflows/playwright.yml
@@ -30,6 +30,8 @@ jobs:
           CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
           WEBHOOK_SECRET: ${{ secrets.WEBHOOK_SECRET }}
           REDIRECT_URL_BASE: ${{ secrets.REDIRECT_URL_BASE }}
+          PLAYWRIGHT_GITHUB_USERNAME: ${{ secrets.PLAYWRIGHT_GITHUB_USERNAME }}
+          PLAYWRIGHT_GITHUB_PASSWORD: ${{ secrets.PLAYWRIGHT_GITHUB_PASSWORD }}
       - uses: actions/upload-artifact@v4
         if: always()
         with:
diff --git a/e2es/auth.setup.js b/e2es/auth.setup.js
new file mode 100644
index 0000000..ffe974e
--- /dev/null
+++ b/e2es/auth.setup.js
@@ -0,0 +1,20 @@
+import { test as setup } from '@playwright/test';
+
+const USERNAME = process.env.PLAYWRIGHT_GITHUB_USERNAME;
+const PASSWORD = process.env.PLAYWRIGHT_GITHUB_PASSWORD;
+
+setup('authenticate', async ({ page, baseURL }, testInfo) => {
+  await page.goto(baseURL);
+  await page.getByRole('button', { name: 'Login with GitHub' }).click();
+
+  await page.waitForURL(/https:\/\/github.com\/login/);
+
+  await page.getByLabel('Username or email address').fill(USERNAME);
+  await page.getByLabel('Password').fill(PASSWORD);
+
+  await page.locator('[type=submit]').click();
+
+  await page.waitForURL(baseURL);
+
+  await page.context().storageState({ path: testInfo.outputPath('user.json') });
+});
diff --git a/e2es/seedTestData.js b/e2es/seed.setup.js
similarity index 100%
rename from e2es/seedTestData.js
rename to e2es/seed.setup.js
diff --git a/e2es/testData/towtruck.db b/e2es/testData/towtruck.db
index 7c112129059dba5c3cfd147bcebe87942f45d10b..80f2c5e42d8a17e96ed940618a288ec875cfd049 100644
GIT binary patch
delta 1345
zcmZ{k&u`LT7{^<nlwWOWXZseqseoMsRyGq4ZZqznaq;4!iHV7s*^~y!fL013@c<<{
zJ!qo#yo-r)b&{BQ83+G@#iQPgJ315N!DI*Df{8Ds9^ZaH&-eR0&-<qBHr{UIZ#~h>
zag4*e-XI<L8rY#eg?ECl0}}CzyyEM4zY*8H(;gM?5+})||L3;(02j?ghQtzCrIV_v
zx@Ht>TD6(K-<Y-fY!@uj?pl+3BVh^IJWD}c8LwT+O<F4xPeD9v*T>Ad!~6ThCXhmQ
z?YOojp0b|v*N*!8SRf(GY%c1DoXk2bb`>#xW7UjD+!NOLO|TrWHMw)%QTm&IM+O(L
z(}|S)GA3AG1o{{}o`FZUs&FtZJC?R5!~}(Pl@5hCSPr@;r9ltGNqbJ&EI7J20FPQ}
zuWbpysHES~m2%NAij{)asHoK>ypLqs<AxTrd-V<FR!J)u|IiE$QN`)1>9wL((bubn
zTK&tC&=<q74eMO2AU=%x?IHNb>S#B;%dtZoh{RBI++=T6@_9hUXOGA~am>-HP4S+Y
z5KQ1G&PNN>GkS|DGoR@n^hN3e#W63ad1jK@r*6^><`VOs{<v-KN7kkZ_$=_zCeY^L
zX6mXDIsq{d{699BF-yS9ba+{N0=U4zuWll;(7dXvmAqQHT~rNr2BwV}?JBV&voJw%
zCiGc}XIzygC-L+gG#jf~%1yOoXyzOpc@4wKBW@JZ_mB#^O^0~t^-}4odKYf8W(4IS
zyfC^=#1o|huDdt@Vv9_{{&~kTkj(OWvEp}QkR+QS?7MaPpijVtd=Sb4G;ALJwve>J
R1MrSf5JKVxkmuE0^bZ%*x$yu1

delta 1191
zcmZva%WD%+6vk(g%;eF|^Uf>A(k5wIQw@o3sv_A$7osb-)?&pW4SCF%Nvwh~nNr%~
z(z`1NR`3A<F=lTT1;w2^MHjBz*uO#W-li}&Nq56Jzx#dXd}lfxy3?UQ_{1fSlIboj
z{1AG=Gw$xx_3-83FXm5B4LJUv%uWBS&!oG|9Q&6Y^xQVBxXVJ2iYGIh$+~G<PN`wl
zAH#w47A*6V^_KibaW8VHks5uF2k(G3g&#!SCL#0>Yy&-l`O*5GvNPYM0LEuLd`V;x
znUcH;%&Re=O-~Bj>NY5Za6PqIAb3vuXoMP+f*WqpYoukCf(P27oR*MBa>QdlqieVC
zxP|bfTuJW(Er{nIQG>ax0dE-9G(}OLk(|0)_N?sn^6|#RYH&|E51$(VepN-W)~r+_
zt*r!$4b@!<UX5M~Y)!L4n2#3w%Bj~hP?)3M4iRSmTP)xM3jsWhx~qGJ{lgj6*KVc!
zcr%@7*z0ztT5_CHt!Qo3%zEPfqm4w$H;xsphs|>4Ud1Xp9=1RuEJdnWcB5p~?6taM
z);%tQB9OUNYM%FV+x$~uMfk)Y@>%XZ|5A7&{1yQBom=Hsge$@e{-Ebx;Mhe5<xj&e
zT3nKc-`*;4KVyhz7!)^66!WSfiD%KX3|SpWF-e%Hw&a+^pF;{GY#y9$b8(~)B@~Ew
zP)JSFnI0#IWQN340x6RkWGF)<GQQKXO&p)WMwh>3K0sa#Cp->9PSd5(#P+#tv^|SP
zS5F?jx>l;O<9%Xq+-K&{*yMY1Yzzbtkkn5$K)1eT*8SrIVR7^~_^^i__RdCn91*W_
F;(xO}c|HID

diff --git a/e2es/towtruck.spec.js b/e2es/towtruck.spec.js
index 0f469fb..166bd5d 100644
--- a/e2es/towtruck.spec.js
+++ b/e2es/towtruck.spec.js
@@ -5,7 +5,11 @@ test("has dependency info", async ({ page, baseURL }) => {
 
   await expect(page).toHaveTitle(/Towtruck/);
 
-  page.getByText("There are 3 repositories that Towtruck is tracking for dxw.");
+  expect(await page.getByText("There is 1 organisation using Towtruck that you are a member of.").count()).toBe(1);
+
+  await page.getByRole("link", { name: "dxw", exact: true }).click();
+
+  expect(await page.getByText("There are 3 repositories that Towtruck is tracking for dxw.").count()).toBe(1);
 
   const tableHeadings = [
     "Name",
diff --git a/playwright.config.js b/playwright.config.js
index b6ce368..14254a2 100644
--- a/playwright.config.js
+++ b/playwright.config.js
@@ -33,19 +33,19 @@ export default defineConfig({
 
   projects: [
     {
-      name: "setup data",
-      testMatch: /seed\.test\.data\.js/,
+      name: "setup",
+      testMatch: /.*\.setup\.js/,
     },
     {
       name: "chromium",
       use: { ...devices["Desktop Chrome"] },
-      dependencies: ["setup data"],
+      dependencies: ["setup"],
     },
   ],
 
   /* Run your local dev server before starting the tests */
   webServer: {
-    command: "node ./e2es/seedTestData.js && script/server",
+    command: "script/server",
     url: "http://127.0.0.1:3000",
     reuseExistingServer: !process.env.CI,
   },