validate-downstream.yml

on:
  pull_request:

name: Check pyQuil Compatibility

jobs:
  check-pyquil:
    name: Check compatibility with pyQuil
    runs-on: ubuntu-latest
    steps:
      - name: Checkout quil-rs Repository
        uses: actions/checkout@v4
        with:
          path: quil-rs

      - name: Checkout pyQuil Repository
        uses: actions/checkout@v4
        with:
          repository: "rigetti/pyquil"
          path: pyquil

      - name: Install Rust Toolchain
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
          override: true

      - name: Restore Python Virtual Environment
        uses: syphar/restore-virtualenv@v1

      - name: Setup pyQuil Repository
        run: |
          pip uninstall -y -r <(pip freeze) || true
          pip install "./pyquil[latex]" maturin mypy ruff pytest pytest-mock
          maturin develop -m quil-rs/quil-py/Cargo.toml

      - name: Run mypy
        id: mypy
        continue-on-error: true
        working-directory: ./pyquil
        run: |
          mypy pyquil

      - name: Run ruff
        id: ruff
        continue-on-error: true
        working-directory: ./pyquil
        run: |
          ruff check pyquil

      - name: Run pytest
        id: pytest
        continue-on-error: true
        working-directory: ./pyquil
        run: |
          pytest test/unit -x

      - name: Post PR Comment and Fail if Necessary
        uses: actions/github-script@v6
        with:
          script: |
            const mypyFailed = '${{ steps.mypy.outcome }}' === 'failure';
            const ruffFailed = '${{ steps.ruff.outcome }}' === 'failure';
            const pytestFailed = '${{ steps.pytest.outcome }}' === 'failure';

            const constructLogURL = (stepId) => {
              return `https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}/jobs/${{ job.id }}/steps/${stepId}/logs`;
            };

            if (mypyFailed || ruffFailed || pytestFailed) {
              let body = `⚠️ **pyQuil Compatibility Checks Failed**:\n\n| Tool   | Status  | Logs |\n|--------|---------|------|\n`;

              if (mypyFailed) {
                body += `| mypy   | ❌ Failed | [View Logs](${constructLogURL('mypy')}) |\n`;
              }
              if (ruffFailed) {
                body += `| ruff   | ❌ Failed | [View Logs](${constructLogURL('ruff')}) |\n`;
              }
              if (pytestFailed) {
                body += `| pytest | ❌ Failed | [View Logs](${constructLogURL('pytest')}) |\n`;
              }

              body += `\n**Note**: These warnings don't block the PR but may require your attention.\n\n`;

              // Post the failure comment
              await github.rest.issues.createComment({
                issue_number: context.issue.number,
                owner: context.repo.owner,
                repo: context.repo.repo,
                body: body
              });

              // Fail the job to show a red X
              core.setFailed("One or more pyQuil checks failed.");
            } else {
              let body = `✅ **pyQuil Compatibility Checks Passed** on Python \`${{ matrix.python-version }}\`. Great job!`;

              // Post the success comment
              await github.rest.issues.createComment({
                issue_number: context.issue.number,
                owner: context.repo.owner,
                repo: context.repo.repo,
                body: body
              });
            }