Detect if new changes break existing links

Added a unit test which determines if any static links have been broken by iterating over the build output and comparing it to a snapshot of existing links. The test will fail if a page is removed and no redirect is added for it.

.github/workflows/validate.yml

@@ -30,3 +30,4 @@ jobs:
       - run: yarn test
       - run: ./build.sh
       - run: yarn linkinator
+      - run: yarn integration

Dockerfile.integration

@@ -0,0 +1,3 @@
+FROM node:18-alpine
+
+RUN apk add rsync

README.md

@@ -39,3 +39,11 @@ To build and preview Centrapay Docs using the static files that are deployed to
 docker compose run script yarn build
 docker compose run script yarn preview
 ```
+
+## Integration Tests
+
+```
+docker compose run ruby-script bundle exec jekyll build
+docker compose run script yarn build --mode development
+docker compose run integration yarn integration
+```

docker-compose-dev.yml

@@ -5,6 +5,8 @@ services:
     volumes: [ node-modules:/work/node_modules ]
   script:
     volumes: [ node-modules:/work/node_modules ]
+  integration:
+    volumes: [ node-modules:/work/node_modules ]
   legacy:
     volumes: [ bundle:/usr/local/bundle ]
   ruby-script:

docker-compose.yml

@@ -46,3 +46,14 @@ services:
         echo "
         To execute a script, run:
         docker-compose run ruby-script {command}"
+  integration:
+    build:
+      context: .
+      dockerfile: Dockerfile.integration
+    init: true
+    working_dir: /work
+    volumes: [ ".:/work" ]
+    command: |
+      echo '
+        Skipping integration tests. To execute integration tests, run:
+        docker compose run integration yarn integration'

package.json

@@ -6,7 +6,8 @@
     "dev": "astro dev",
     "build": "astro build",
     "preview": "astro preview",
-    "test": "vitest --watch=false"
+    "test": "vitest --watch=false",
+    "integration": "rsync -a dist/* _site/ && vitest --watch=false --config vitest.integration.config.js"
   },
   "devDependencies": {
     "@astrojs/mdx": "^1.0.3",
@@ -32,6 +33,7 @@
     "linkinator": "^5.0.2",
     "mdast-util-to-string": "^3.1.1",
     "mermaid": "^9.3.0",
+    "path": "^0.12.7",
     "remark-html": "^15.0.2",
     "remark-parse": "^10.0.1",
     "remark-sectionize": "^1.1.1",
@@ -40,6 +42,7 @@
     "unist-util-find-after": "^4.0.1",
     "unist-util-visit": "^4.1.2",
     "vitest": "^0.28.3",
-    "vue": "^3.2.47"
+    "vue": "^3.2.47",
+    "jsdom": "^22.1.0"
   }
 }