✨ add continuous testing workflow for running against the latest Qiskit main branch

Signed-off-by: burgholzer <burgholzer@me.com>

Author: burgholzer

.github/workflows/upstream.yml

@@ -0,0 +1,111 @@
+name: Qiskit Upstream Tests
+on:
+  schedule:
+    # Run every Monday at 00:00 UTC
+    - cron: "0 0 * * 1"
+  pull_request:
+    paths:
+      - ".github/workflows/upstream.yml"
+  workflow_dispatch: # Allow manual triggering
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  issues: write # Needed to create/update issues
+
+jobs:
+  qiskit-upstream-tests:
+    name: 🐍⚛️
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-15, windows-2025]
+    uses: cda-tum/mqt-workflows/.github/workflows/reusable-qiskit-upstream.yml@v1.7
+    with:
+      runs-on: ${{ matrix.os }}
+      setup-z3: true
+
+  create-issue-on-failure:
+    name: Create issue on failure
+    if: ${{ always() }}
+    needs: qiskit-upstream-tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get latest Qiskit commit
+        id: qiskit-commit
+        run: |
+          QISKIT_COMMIT=$(curl -s https://api.github.com/repos/Qiskit/qiskit/commits/main | jq -r '.sha')
+          QISKIT_COMMIT_URL="https://github.com/Qiskit/qiskit/commit/${QISKIT_COMMIT}"
+          QISKIT_COMMIT_DATE=$(curl -s https://api.github.com/repos/Qiskit/qiskit/commits/${QISKIT_COMMIT} | jq -r '.commit.author.date')
+          echo "url=${QISKIT_COMMIT_URL}" >> $GITHUB_OUTPUT
+          echo "date=${QISKIT_COMMIT_DATE}" >> $GITHUB_OUTPUT
+
+      - name: Create or update issue
+        if: ${{ needs.qiskit-upstream-tests.result != 'success' }}
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ github.token }}
+          script: |
+            const runId = context.runId;
+            const workflowRunUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${runId}`;
+            const testResult = '${{ needs.qiskit-upstream-tests.result }}';
+            const qiskitCommitUrl = '${{ steps.qiskit-commit.outputs.url }}';
+            const qiskitCommitDate = '${{ steps.qiskit-commit.outputs.date }}';
+
+            // Search for existing open issues with a specific title pattern
+            const issueTitle = "❌ Qiskit Upstream Tests Failure";
+
+            const issues = await github.rest.issues.listForRepo({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open',
+            });
+
+            // Find matching issues
+            const matchingIssue = issues.data.find(issue => issue.title === issueTitle);
+
+            const today = new Date().toISOString().split('T')[0];
+            const body = `## Qiskit Upstream Tests Failed on ${today}
+
+            The weekly Qiskit upstream test has failed.
+
+            ### Workflow Details
+
+            - **Workflow Run**: [View Logs and Details](${workflowRunUrl})
+            - **Result**: \`${testResult}\`
+            - **Triggered by**: ${context.eventName}
+            - **Qiskit Commit Tested**: ${qiskitCommitUrl} (${qiskitCommitDate})
+
+            Please investigate and fix this issue to ensure compatibility with the latest version of Qiskit.
+
+            > This issue was automatically generated by a GitHub Action.
+            `;
+
+            // If we found an existing issue, update it, otherwise create a new one
+            if (matchingIssue) {
+              // Add a comment with the new failure
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: matchingIssue.number,
+                body: `New failure detected on ${today}.
+                - [View workflow run](${workflowRunUrl})
+                - **Qiskit Commit Tested**: ${qiskitCommitUrl} (${qiskitCommitDate})`
+              });
+
+              console.log(`Updated existing issue #${matchingIssue.number}`);
+            } else {
+              // Create a new issue
+              const newIssue = await github.rest.issues.create({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                title: issueTitle,
+                body: body,
+                labels: ['bug', 'python', 'dependencies']
+              });
+
+              console.log(`Created new issue #${newIssue.data.number}`);
+            }

noxfile.py

@@ -37,7 +37,8 @@ def _run_tests(
     session: nox.Session,
     *,
     install_args: Sequence[str] = (),
-    run_args: Sequence[str] = (),
+    extra_command: Sequence[str] = (),
+    pytest_run_args: Sequence[str] = (),
 ) -> None:
     env = {"UV_PROJECT_ENVIRONMENT": session.virtualenv.location}
     if os.environ.get("CI", None) and sys.platform == "win32":
@@ -57,7 +58,6 @@ def _run_tests(
         "build",
         "--only-group",
         "test",
-        "--verbose",
         # Build mqt-core from source to work around pybind believing that two
         # compiled extensions might not be binary compatible.
         # This will be fixed in a new pybind11 release that includes https://github.com/pybind/pybind11/pull/5439.
@@ -73,14 +73,23 @@ def _run_tests(
     )
     session.run(
         "uv",
-        "run",
+        "sync",
+        "--inexact",
         "--no-dev",  # do not auto-install dev dependencies
         "--no-build-isolation-package",
         "mqt-qmap",  # build the project without isolation
-        "--verbose",
+        *install_args,
+        env=env,
+    )
+    if extra_command:
+        session.run(*extra_command, env=env)
+    session.run(
+        "uv",
+        "run",
+        "--no-sync",  # do not sync as everything is already installed
         *install_args,
         "pytest",
-        *run_args,
+        *pytest_run_args,
         *session.posargs,
         "--cov-config=pyproject.toml",
         env=env,
@@ -99,13 +108,24 @@ def minimums(session: nox.Session) -> None:
     _run_tests(
         session,
         install_args=["--resolution=lowest-direct"],
-        run_args=["-Wdefault"],
+        pytest_run_args=["-Wdefault"],
     )
     env = {"UV_PROJECT_ENVIRONMENT": session.virtualenv.location}
     session.run("uv", "tree", "--frozen", env=env)
     session.run("uv", "lock", "--refresh", env=env)
 
 
+@nox.session(reuse_venv=True, venv_backend="uv", python=PYTHON_ALL_VERSIONS)
+def qiskit(session: nox.Session) -> None:
+    """Tests against the latest version of Qiskit."""
+    _run_tests(
+        session,
+        extra_command=["uv", "pip", "install", "qiskit[qasm3-import] @ git+https://github.com/Qiskit/qiskit.git"],
+    )
+    env = {"UV_PROJECT_ENVIRONMENT": session.virtualenv.location}
+    session.run("uv", "pip", "show", "qiskit", env=env)
+
+
 @nox.session(reuse_venv=True)
 def docs(session: nox.Session) -> None:
     """Build the docs. Use "--non-interactive" to avoid serving. Pass "-b linkcheck" to check links."""