cached + parallel tests (#25)

* wip 1 * wip2 * simplify * no tty * intermediate docker image * fix stdio * tweaks * test.sh * packages/e2e * concurrency 1 * macos-14 * runs-on: ubuntu-latest * remove set -ex * -container.image * doc * default concurrency * playwright rejection * -test.sh * test.sh out.sh * rn e2e-{test,build} * -dependsOn * doc
pmndrs · Jul 29, 2024 · 2657fe3 · 2657fe3
1 parent dad2072
commit 2657fe3
Show file tree

Hide file tree

Showing 179 changed files with 502 additions and 331 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,11 +21,11 @@ jobs:
       group: ${{ github.event_name != 'pull_request' && 'group-pushmain' || github.run_id }}
       cancel-in-progress: ${{ github.event_name != 'pull_request' }}
 
-    container:
-      image: ghcr.io/pmndrs/playwright:main
-      credentials:
-        username: ${{ github.actor }}
-        password: ${{ secrets.GITHUB_TOKEN }}
+    # container:
+    #   image: ghcr.io/pmndrs/playwright:main
+    #   credentials:
+    #     username: ${{ github.actor }}
+    #     password: ${{ secrets.GITHUB_TOKEN }}
 
     steps:
       # Build
@@ -43,7 +43,7 @@ jobs:
           BASE_PATH: ${{ steps.configurepages.outputs.base_path }}
 
       # Tests (only for PRs)
-      - run: npm test
+      - run: ./test.sh
         if: github.event_name == 'pull_request'
         env:
           BASE_PATH: ${{ steps.configurepages.outputs.base_path }}

diff --git a/README.md b/README.md
@@ -35,8 +35,8 @@ This will:
 
 - a `--base` set to `${BASE_PATH}/${app_name}`
 - a custom vite `--config`, whith a `monkey()` plugin that will:
-  - [`deterministic`](packages/examples/src/deterministic.js) script into `src/index.jsx`
-  - monkeypatch the `<Canvas>` with [`CheesyCanvas`](packages/examples/src/CheesyCanvas.jsx) for setting up the scene for playwright screenshots
+  - [`deterministic`](packages/e2e/src/deterministic.js) script into `src/index.jsx`
+  - monkeypatch the `<Canvas>` with [`CheesyCanvas`](packages/e2e/src/CheesyCanvas.jsx) for setting up the scene for playwright screenshots
 
 2. build the Next.js `apps/website`
 3. copy final result into `out` folder
@@ -58,12 +58,41 @@ Pre-requisites:
 
 - [build](#build)
 
+> [!WARNING]
+> Do not forget to (re-)[build]() first!
+
 ```sh
-$ docker run --init --rm -v $(pwd):/app -w /app ghcr.io/pmndrs/playwright:main npm test
+$ npm test
 ```
 
+To update the snapshots: `npm test -- -- --update-snapshots`
+
 > [!IMPORTANT]
-> If running on mac m-series, you'll need to add `--platform linux/arm64` to the docker command.
+> If you built the project with eg. `BASE_PATH=/examples` you'll need to:
+>
+> ```sh
+> $ BASE_PATH=/examples npm test
+> ```
+
+## Docker
+
+For generating reproductible snapshots, we still build static `out/` folder locally, but use dockerised environment to run playwright tests against:
+
+```sh
+$ ./test.sh
+```
+
+> [!NOTE]
+> A `-v "$(pwd)":/app` volume is mounted to the container, so any snapshot will be written to the host machine.
+
+To update the snapshots: `./test.sh --update`
+
+> [!IMPORTANT]
+> If you built the project with eg. `BASE_PATH=/examples` you'll need to:
+>
+> ```sh
+> $ BASE_PATH=/examples ./test.sh
+> ```
 
 # Colophon
 

diff --git a/demos/aquarium/package.json b/demos/aquarium/package.json
@@ -27,8 +27,9 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
-    "preview": "vite preview"
+    "build2": "tsc && e2e-build $npm_package_name",
+    "preview": "vite preview",
+    "test": "e2e-test $npm_package_name"
   },
   "browserslist": [
     ">0.2%",

diff --git a/demos/arkanoid-under-60-loc/package.json b/demos/arkanoid-under-60-loc/package.json
@@ -27,7 +27,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/arkanoid/package.json b/demos/arkanoid/package.json
@@ -22,7 +22,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/audio-analyser/package.json b/demos/audio-analyser/package.json
@@ -28,7 +28,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/backdrop-and-cables/package.json b/demos/backdrop-and-cables/package.json
@@ -28,7 +28,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/baking-soft-shadows/package.json b/demos/baking-soft-shadows/package.json
@@ -28,8 +28,9 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
-    "preview": "vite preview"
+    "build2": "tsc && e2e-build $npm_package_name",
+    "preview": "vite preview",
+    "test": "e2e-test $npm_package_name"
   },
   "browserslist": [
     ">0.2%",

diff --git a/demos/basic-ballpit/package.json b/demos/basic-ballpit/package.json
@@ -27,7 +27,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/basic-demo/package.json b/demos/basic-demo/package.json
@@ -25,7 +25,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/bestservedbold-christmas-baubles/package.json b/demos/bestservedbold-christmas-baubles/package.json
@@ -31,7 +31,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/bezier-curves-and-nodes/package.json b/demos/bezier-curves-and-nodes/package.json
@@ -30,7 +30,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/bloom-hdr-workflow-gltf/package.json b/demos/bloom-hdr-workflow-gltf/package.json
@@ -30,7 +30,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/bouncy-watch/package.json b/demos/bouncy-watch/package.json
@@ -27,7 +27,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/bounds-and-makedefault/package.json b/demos/bounds-and-makedefault/package.json
@@ -26,7 +26,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/bruno-simons-20k-challenge/package.json b/demos/bruno-simons-20k-challenge/package.json
@@ -32,7 +32,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/building-dynamic-envmaps/package.json b/demos/building-dynamic-envmaps/package.json
@@ -32,7 +32,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/building-live-envmaps/package.json b/demos/building-live-envmaps/package.json
@@ -28,7 +28,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/bvh/package.json b/demos/bvh/package.json
@@ -24,7 +24,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "bbuild2": "tsc && vite-build $npm_package_name",
+    "bbuild2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/camera-scroll/package.json b/demos/camera-scroll/package.json
@@ -28,7 +28,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/camera-shake/package.json b/demos/camera-shake/package.json
@@ -26,7 +26,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/canvas-text/package.json b/demos/canvas-text/package.json
@@ -21,7 +21,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/cards-with-border-radius/package.json b/demos/cards-with-border-radius/package.json
@@ -18,7 +18,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/cards/package.json b/demos/cards/package.json
@@ -26,7 +26,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/caustics/package.json b/demos/caustics/package.json
@@ -16,7 +16,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/cell-fracture/package.json b/demos/cell-fracture/package.json
@@ -27,7 +27,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/clones/package.json b/demos/clones/package.json
@@ -29,7 +29,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/clouds/package.json b/demos/clouds/package.json
@@ -15,7 +15,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "eslintConfig": {

diff --git a/demos/color-grading/package.json b/demos/color-grading/package.json
@@ -25,7 +25,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/confetti/package.json b/demos/confetti/package.json
@@ -30,7 +30,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/csg-bunny-usegroups/package.json b/demos/csg-bunny-usegroups/package.json
@@ -24,7 +24,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/csg-house/package.json b/demos/csg-house/package.json
@@ -24,7 +24,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/csg-operations-rapier-physics/package.json b/demos/csg-operations-rapier-physics/package.json
@@ -29,7 +29,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/dbismut-furniture/package.json b/demos/dbismut-furniture/package.json
@@ -24,7 +24,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/diamond-refraction/package.json b/demos/diamond-refraction/package.json
@@ -30,7 +30,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [

diff --git a/demos/diamond-ring/package.json b/demos/diamond-ring/package.json
@@ -31,7 +31,7 @@
   "scripts": {
     "dev": "vite --host --open",
     "build": "tsc && vite build",
-    "build2": "tsc && vite-build $npm_package_name",
+    "build2": "tsc && e2e-build $npm_package_name",
     "preview": "vite preview"
   },
   "browserslist": [