fix 🐛: Update CI and tests

.github/scripts/compare_screenshots.py

@@ -0,0 +1,91 @@
+"""
+Script to use in CIs 
+
+This will run only the tests on chromium and compare the screenshots from a given commit to
+another.
+
+It was just becoming a mess to handle it all in actions so this rough
+script translates the logic
+"""
+
+import subprocess
+import sys
+import shutil
+from pathlib import Path
+
+
+def run_playwright_tests(before_commit, after_commit):
+    commands = [
+        "cp tests/teia.screenshots.spec.ts tests/teia.screenshots.head",
+        f"git checkout {before_commit}",
+        "cp tests/teia.screenshots.head tests/teia.screenshots.spec.ts",
+        "sudo apt update",
+        "npm ci --maxsockets 1",
+        "npx playwright install chromium --with-deps",
+        "npx playwright test --project chromium",
+        "echo 'before commit screenshot dir:'",
+        "ls ./screenshot",
+        "git checkout tests/teia.screenshots.spec.ts",
+    ]
+
+    for cmd in commands:
+        subprocess.run(cmd, shell=True, check=True)
+
+    shutil.move("./screenshot", "./screenshot-before")
+
+    commands = [
+        f"git checkout {after_commit}",
+        "cp tests/teia.screenshots.head tests/teia.screenshots.spec.ts",
+        "npm ci --maxsockets 1",
+        "npx playwright install chromium --with-deps",  # yes strange but after the reinstall this is needed again
+        "npx playwright test --project chromium",
+        "echo 'after commit screenshot dir:'",
+        "ls ./screenshot",
+        "git checkout tests/teia.screenshots.spec.ts",
+    ]
+    for cmd in commands:
+        subprocess.run(cmd, shell=True, check=True)
+
+
+def generate_side_by_side_images():
+    before_dir = Path("./screenshot-before")
+    after_dir = Path("./screenshot")
+    output_dir = Path("./side_by_side_images")
+
+    subprocess.run("sudo apt-get install graphicsmagick -y", shell=True, check=True)
+
+    output_dir.mkdir(exist_ok=True)
+
+    # themes = ["light", "dark", "kawaii", "midnight", "grass", "aqua", "coffee"]
+
+    all_images = [f for f in Path(before_dir).iterdir() if f.suffix == ".png"]
+
+    for image in all_images:
+        before_image_path = before_dir / image.name
+        after_image_path = after_dir / image.name
+        output_image = output_dir / f"side_by_side_{image.name}"
+
+        montage_cmd = f"gm montage -geometry +0+0 -tile 2x1 '{before_image_path.as_posix()}' '{after_image_path.as_posix()}' '{output_image.as_posix()}'"
+        subprocess.run(montage_cmd, shell=True, check=True)
+
+
+def cleanup_artifacts():
+    pass
+
+
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        print("Usage: python compare_screenshots.py <before_commit> [after_commit]")
+        sys.exit(1)
+
+    before_commit = sys.argv[1]
+    after_commit = sys.argv[2]
+
+    print(f"Comparing from {before_commit} to {after_commit}")
+
+    run_playwright_tests(before_commit, after_commit)
+    generate_side_by_side_images()
+
+    # with open(os.environ["GITHUB_OUTPUT"], "a") as env_file:
+    #     env_file.write(f"before_commit={before_commit}\n")
+    #     env_file.write(f"after_commit={after_commit if after_commit else ''}\n")

.github/workflows/playwright-compare.yml

@@ -0,0 +1,42 @@
+name: 📷 Playwright Compare
+
+on:
+  workflow_dispatch:
+    inputs:
+      before-commit:
+        description: 'The commit hash or branch name for "before" screenshots'
+        required: true
+      after-commit:
+        description: 'The commit hash or branch name for "after" screenshots (optional)'
+        required: false
+
+jobs:
+  compare-screenshots:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      #   - name: Set up Python
+      #     uses: actions/setup-python@v2
+      #     with:
+      #       python-version: '3.x'
+
+      - name: Run Python script
+        id: run-python
+        run: |
+          before_commit="${{ github.event.inputs.before-commit }}"
+          after_commit="${{ github.event.inputs.after-commit }}"
+          if [ -z "$after_commit" ]; then
+            after_commit="${{ github.sha }}"
+          fi
+          python .github/scripts/compare_screenshots.py "$before_commit" "$after_commit"
+
+      - name: Upload side-by-side images
+        uses: actions/upload-artifact@v3
+        with:
+          name: side-by-side-images-${{ steps.run-python.outputs.cache_key }}
+          path: side_by_side_images

.github/workflows/playwright.yml

@@ -3,7 +3,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  test:
+  take-screenshots:
     concurrency: ci-${{ github.ref }}
     timeout-minutes: 20
     runs-on: ubuntu-latest
@@ -13,14 +13,13 @@ jobs:
         with:
           node-version: 18
       - name: Install dependencies
-        run: npm ci
+        run: npm ci --maxsockets 1
       - 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: screenshots
-          path: screenshots/
+          name: screenshot
+          path: screenshot/
           retention-days: 30