Rca tool

.github/scripts/set-crate-version-from-tag.sh

@@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+# Bump the version of the supportfile Rust crates from the pushed git tag.
+#
+# Used by .github/workflows/rust-python-packages.yml when the workflow is
+# triggered by a tag of the form `v<semver>` (e.g. `v0.1.2`). The leading
+# `v` is stripped and the resulting version is written to all three crate
+# Cargo.toml files so the published artifacts match the tag:
+#
+#   - rca-tool/lib/supportfile_core    (published to crates.io as `supportfile`)
+#   - rca-tool/lib/supportfile_py      (built as a Python wheel)
+#   - rca-tool/lib/supportfile_wasm    (used by the Leptos front-end build)
+#
+# After updating Cargo.toml files, the corresponding Cargo.lock entries
+# are refreshed so subsequent `cargo --locked` invocations stay green.
+#
+# Environment:
+#   GITHUB_REF_NAME — tag name as provided by GitHub Actions (e.g. `v0.1.2`).
+#                      Falls back to parsing `GITHUB_REF` if unset.
+
+set -euo pipefail
+
+ref_name="${GITHUB_REF_NAME:-}"
+if [[ -z "$ref_name" && -n "${GITHUB_REF:-}" ]]; then
+    ref_name="${GITHUB_REF#refs/tags/}"
+fi
+
+if [[ -z "$ref_name" ]]; then
+    echo "ERROR: neither GITHUB_REF_NAME nor GITHUB_REF is set" >&2
+    exit 1
+fi
+
+if [[ ! "$ref_name" =~ ^v[0-9]+\.[0-9]+\.[0-9]+([.-].+)?$ ]]; then
+    echo "ERROR: tag '$ref_name' does not look like a semver tag (expected vX.Y.Z)" >&2
+    exit 1
+fi
+
+version="${ref_name#v}"
+echo "Setting supportfile crate versions to $version (from tag $ref_name)"
+
+# Repo root is the working directory when invoked by Actions; resolve relative
+# to this script so it can also be run locally from anywhere.
+script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+repo_root="$(cd "$script_dir/../.." && pwd)"
+
+declare -a crate_dirs=(
+    "$repo_root/rca-tool/lib/supportfile_core"
+    "$repo_root/rca-tool/lib/supportfile_py"
+    "$repo_root/rca-tool/lib/supportfile_wasm"
+)
+
+for dir in "${crate_dirs[@]}"; do
+    toml="$dir/Cargo.toml"
+    if [[ ! -f "$toml" ]]; then
+        echo "ERROR: $toml not found" >&2
+        exit 1
+    fi
+    # Replace the FIRST `version = "..."` line only (package version, not
+    # dependency versions). Cargo convention places it in the [package]
+    # table at the top of the file.
+    sed -i -E "0,/^version[[:space:]]*=[[:space:]]*\".*\"/ s//version = \"$version\"/" "$toml"
+    echo "  updated $toml"
+done
+
+# Refresh Cargo.lock entries for the renamed packages so `cargo --locked`
+# continues to work in subsequent build/test/publish steps. Each crate has
+# its own lockfile; path dependencies don't hit the network.
+declare -A lock_updates=(
+    ["$repo_root/rca-tool/lib/supportfile_core"]="supportfile"
+    ["$repo_root/rca-tool/lib/supportfile_py"]="supportfile_py supportfile"
+    ["$repo_root/rca-tool/lib/supportfile_wasm"]="supportfile-wasm supportfile"
+)
+
+for dir in "${!lock_updates[@]}"; do
+    pkgs="${lock_updates[$dir]}"
+    if [[ -f "$dir/Cargo.lock" ]]; then
+        args=()
+        for p in $pkgs; do
+            args+=(-p "$p")
+        done
+        echo "  refreshing $dir/Cargo.lock for: $pkgs"
+        (cd "$dir" && cargo update "${args[@]}" --offline 2>/dev/null \
+            || cd "$dir" && cargo update "${args[@]}")
+    fi
+done
+
+echo "Done."

.github/workflows/deploy.yml

@@ -0,0 +1,304 @@
+name: Build and Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [ main, master, rca-tool ]
+    tags: [ 'v*' ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  tests:
+    uses: ./.github/workflows/test.yml
+
+  build:
+    # Local tests (the `tests` job above) run on every push, but the GitHub
+    # Pages build/deploy only happens for version releases (v* tags) or a
+    # manual run. The tag only gates the deploy — no version is injected into
+    # the built site.
+    if: ${{ startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch' }}
+    needs: tests
+    runs-on: ubuntu-latest
+    outputs:
+      leptos_js: ${{ steps.asset_manifest.outputs.leptos_js }}
+      leptos_wasm: ${{ steps.asset_manifest.outputs.leptos_wasm }}
+      leptos_css: ${{ steps.asset_manifest.outputs.leptos_css }}
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v6
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v5
+      with:
+        node-version: '22'
+
+    - name: Setup Rust toolchain
+      uses: dtolnay/rust-toolchain@stable
+      with:
+        targets: wasm32-unknown-unknown
+
+    - name: Cache Rust build artifacts
+      uses: Swatinem/rust-cache@v2
+      with:
+        workspaces: |
+          rca-tool/web-leptos -> target
+          rca-tool/lib/lzma_stream_wasm -> target
+
+    # sccache speeds up the Leptos/WASM compilation on regular pushes. It is
+    # skipped on release tag builds.
+    - name: Restore sccache files
+      id: restore-sccache
+      if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      uses: actions/cache/restore@v5
+      with:
+        path: ${{ github.workspace }}/.sccache
+        key: leptos-web-${{ runner.os }}-${{ runner.arch }}-sccache-
+        restore-keys: leptos-web-${{ runner.os }}-${{ runner.arch }}-sccache-
+
+    - name: Install sccache
+      if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      uses: taiki-e/install-action@v2
+      with:
+        tool: sccache
+
+    - name: Configure sccache
+      if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      run: |
+        set -euo pipefail
+        SCCACHE_PATH="$(command -v sccache)"
+        SCCACHE_DIR="${GITHUB_WORKSPACE}/.sccache"
+        mkdir -p "$SCCACHE_DIR"
+
+        echo "Cache restore matched key: ${{ steps.restore-sccache.outputs.cache-matched-key }}"
+        du -sh "$SCCACHE_DIR" 2>/dev/null || true
+
+        echo "SCCACHE_DIR=$SCCACHE_DIR" | tee -a "$GITHUB_ENV"
+        echo "SCCACHE_CACHE_SIZE=2G" | tee -a "$GITHUB_ENV"
+        echo "CARGO_INCREMENTAL=0" | tee -a "$GITHUB_ENV"
+        echo "RUSTC_WRAPPER=$SCCACHE_PATH" | tee -a "$GITHUB_ENV"
+
+        SCCACHE_DIR="$SCCACHE_DIR" SCCACHE_CACHE_SIZE=2G "$SCCACHE_PATH" --start-server
+        "$SCCACHE_PATH" --zero-stats || true
+        "$SCCACHE_PATH" --show-stats || true
+
+    - name: Install Trunk
+      uses: taiki-e/install-action@v2
+      with:
+        tool: trunk
+
+    - name: Install wasm-pack
+      uses: taiki-e/install-action@v2
+      with:
+        tool: wasm-pack
+
+    - name: Build Leptos UI
+      run: ./build.sh
+      working-directory: rca-tool/web-leptos
+
+    - name: Prepare deployment directory
+      run: |
+        cd rca-tool/
+        rm -rf _site
+        mkdir -p _site
+        cp -r web-leptos/dist/* _site/
+        cp README.md _site/ || true
+        touch _site/.nojekyll
+
+    - name: List deployment files
+      run: |
+        echo "Files to be deployed:"
+        ls -lh rca-tool/_site/
+
+    - name: Capture Leptos asset manifest
+      id: asset_manifest
+      run: |
+        set -euo pipefail
+        cd rca-tool/_site
+        leptos_js=$(grep -o 'rca-tool-leptos-[^"]*\.js' index.html | head -n 1)
+        leptos_wasm=$(grep -o 'rca-tool-leptos-[^"]*_bg\.wasm' index.html | head -n 1)
+        leptos_css=$(grep -o 'styles-[^"]*\.css' index.html | head -n 1)
+
+        echo "Leptos JS:   ${leptos_js}"
+        echo "Leptos WASM: ${leptos_wasm}"
+        echo "Leptos CSS:  ${leptos_css}"
+
+        echo "leptos_js=${leptos_js}" >> "$GITHUB_OUTPUT"
+        echo "leptos_wasm=${leptos_wasm}" >> "$GITHUB_OUTPUT"
+        echo "leptos_css=${leptos_css}" >> "$GITHUB_OUTPUT"
+
+    - name: Setup Pages
+      uses: actions/configure-pages@v4
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: 'rca-tool/_site'
+
+    - name: Show sccache stats
+      if: ${{ always() && !startsWith(github.ref, 'refs/tags/') }}
+      run: sccache --show-stats || true
+
+    - name: Prepare sccache files for saving
+      id: prepare-save-sccache
+      if: ${{ always() && !startsWith(github.ref, 'refs/tags/') }}
+      run: echo "SCCACHE_TIMESTAMP=$(date -u +%F-%T)" | tee -a "$GITHUB_OUTPUT"
+
+    - name: Save sccache files
+      if: ${{ always() && !startsWith(github.ref, 'refs/tags/') }}
+      uses: actions/cache/save@v5
+      with:
+        key: ${{ steps.restore-sccache.outputs.cache-primary-key }}${{ steps.prepare-save-sccache.outputs.SCCACHE_TIMESTAMP }}
+        path: ${{ github.workspace }}/.sccache
+
+  deploy:
+    if: ${{ startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch' }}
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    outputs:
+      page_url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4
+
+  post-deploy-test:
+    if: ${{ startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch' }}
+    runs-on: ubuntu-latest
+    needs: [build, deploy]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v6
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v5
+      with:
+        node-version: '22'
+
+    - name: Install dependencies
+      run: npm ci
+      working-directory: rca-tool/tests
+
+    - name: Generate test fixtures
+      run: |
+        chmod +x create-fixtures.sh
+        ./create-fixtures.sh
+      working-directory: rca-tool/tests
+
+    - name: Install Playwright Edge
+      run: npx playwright install --with-deps msedge
+      working-directory: rca-tool/tests
+
+    - name: Wait for deployment to be ready
+      env:
+        DEPLOYED_URL: ${{ needs.deploy.outputs.page_url }}
+        EXPECTED_LEPTOS_JS: ${{ needs.build.outputs.leptos_js }}
+        EXPECTED_LEPTOS_WASM: ${{ needs.build.outputs.leptos_wasm }}
+        EXPECTED_LEPTOS_CSS: ${{ needs.build.outputs.leptos_css }}
+      run: |
+        set -euo pipefail
+        CACHE_BUSTER="${GITHUB_RUN_ID}-${GITHUB_SHA}"
+        ROOT_URL="${DEPLOYED_URL%/}/"
+        ROOT_URL_BUSTED="${ROOT_URL}?cb=${CACHE_BUSTER}"
+        WORKER_URL="${ROOT_URL}assets/liblzma-streaming-worker.js?v=${CACHE_BUSTER}"
+        LEPTOS_JS_URL="${ROOT_URL}${EXPECTED_LEPTOS_JS}?cb=${CACHE_BUSTER}"
+        LEPTOS_WASM_URL="${ROOT_URL}${EXPECTED_LEPTOS_WASM}?cb=${CACHE_BUSTER}"
+        LEPTOS_CSS_URL="${ROOT_URL}${EXPECTED_LEPTOS_CSS}?cb=${CACHE_BUSTER}"
+
+        echo "Waiting for GitHub Pages to serve the freshly built site..."
+        echo "Root URL: ${ROOT_URL}"
+        echo "Expected JS: ${EXPECTED_LEPTOS_JS}"
+        echo "Expected WASM: ${EXPECTED_LEPTOS_WASM}"
+        echo "Expected CSS: ${EXPECTED_LEPTOS_CSS}"
+
+        for attempt in {1..30}; do
+          root_html="$(curl -fsSL "${ROOT_URL_BUSTED}" || true)"
+          worker_source="$(curl -fsSL "${WORKER_URL}" || true)"
+
+          root_ok=0
+          worker_ok=0
+          js_ok=0
+          wasm_ok=0
+          css_ok=0
+
+          if [[ "${root_html}" == *'RCA Tool'* \
+             && "${root_html}" == *"${EXPECTED_LEPTOS_JS}"* \
+             && "${root_html}" == *"${EXPECTED_LEPTOS_WASM}"* \
+             && "${root_html}" == *"${EXPECTED_LEPTOS_CSS}"* ]]; then
+            root_ok=1
+          fi
+          # Check that the bundled worker asset is present and contains expected
+          # sentinel strings: versionedAsset (from worker.js) and parsers/services
+          # (from services.js, bundled into liblzma-streaming-worker.js).
+          if [[ "${worker_source}" == *'versionedAsset'* \
+             && "${worker_source}" == *'parsers/services'* ]]; then
+            worker_ok=1
+          fi
+          if curl -fsI "${LEPTOS_JS_URL}" >/dev/null; then
+            js_ok=1
+          fi
+          if curl -fsI "${LEPTOS_WASM_URL}" >/dev/null; then
+            wasm_ok=1
+          fi
+          if curl -fsI "${LEPTOS_CSS_URL}" >/dev/null; then
+            css_ok=1
+          fi
+
+          echo "Attempt ${attempt}/30: root=${root_ok} worker=${worker_ok} js=${js_ok} wasm=${wasm_ok} css=${css_ok}"
+
+          if [[ ${root_ok} -eq 1 && ${worker_ok} -eq 1 && ${js_ok} -eq 1 && ${wasm_ok} -eq 1 && ${css_ok} -eq 1 ]]; then
+            echo "Deployment is ready."
+            break
+          fi
+
+          if [[ ${attempt} -eq 30 ]]; then
+            echo "Deployment did not become ready in time."
+            echo "--- Root preview ---"
+            printf '%s\n' "${root_html}" | head -n 40 || true
+            echo "--- Worker preview ---"
+            printf '%s\n' "${worker_source}" | sed -n '1,40p' || true
+            exit 1
+          fi
+
+          sleep 10
+        done
+
+    - name: Run post-deployment tests against Leptos
+      env:
+        DEPLOYED_URL: ${{ needs.deploy.outputs.page_url }}
+        CACHE_BUSTER: ${{ github.run_id }}-${{ github.sha }}
+      run: |
+        echo "Testing deployed Leptos UI at ${DEPLOYED_URL} (cache buster: ${CACHE_BUSTER})"
+        npx playwright test --config=playwright.leptos.config.js --project=deployed-leptos --reporter=list
+      working-directory: rca-tool/tests
+
+    - name: Upload post-deployment test results
+      if: always()
+      uses: actions/upload-artifact@v7
+      with:
+        name: post-deploy-test-results
+        path: |
+          rca-tool/tests/playwright-report*/
+          rca-tool/tests/test-results/
+        retention-days: 30
+
+    - name: Upload post-deployment coverage report
+      if: always()
+      uses: actions/upload-artifact@v7
+      with:
+        name: post-deploy-coverage-report
+        path: rca-tool/tests/coverage-report*/
+        retention-days: 30