Improve CI/CD logging and add missing dependencies

- Add detailed logging to GitHub Actions workflow with step-by-step output
- Add environment verification step to show Python version and packages
- Add test summary step that runs even if tests fail
- Enhance test_notebooks.py with detailed execution logging:
  - Show timestamp and duration for each notebook
  - Display progress with visual separators
  - Provide summary with pass/fail counts
  - Add better error reporting
- Add pytest and nbconvert to environment.yml (required for tests)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Author: splch

.github/workflows/test_notebooks.yml

@@ -26,18 +26,61 @@ jobs:
       - name: Prepare Conda environment
         shell: bash -l {0}
         run: |
+          echo "=================================================="
+          echo "Preparing Conda environment"
+          echo "=================================================="
           if conda env list | grep -q 'myenv'; then
-            echo "Environment 'myenv' already exists, updating environment"
+            echo "✓ Environment 'myenv' already exists, updating environment"
             conda env update --name myenv --file environment.yml --prune
           else
-            echo "Creating new environment 'myenv'"
+            echo "✓ Creating new environment 'myenv'"
             conda env create -f environment.yml
           fi
+          echo "✓ Conda environment ready"
+
+      - name: Verify environment
+        shell: bash -l {0}
+        run: |
+          echo "=================================================="
+          echo "Verifying environment setup"
+          echo "=================================================="
+          conda activate myenv
+          echo "✓ Python version:"
+          python --version
+          echo ""
+          echo "✓ Installed packages:"
+          conda list | grep -E "(jupyter|qiskit|cirq|pennylane|qbraid|requests)"
+          echo ""
+          echo "✓ IONQ_API_KEY status:"
+          if [ -n "$IONQ_API_KEY" ]; then
+            echo "  API key is set (length: ${#IONQ_API_KEY} characters)"
+          else
+            echo "  WARNING: API key is not set!"
+          fi
+        env:
+          IONQ_API_KEY: ${{ secrets.IONQ_API_KEY }}
 
       - name: Run notebook tests
         shell: bash -l {0}
         run: |
+          echo "=================================================="
+          echo "Running notebook tests"
+          echo "=================================================="
           conda activate myenv
           python tests/test_notebooks.py
         env:
           IONQ_API_KEY: ${{ secrets.IONQ_API_KEY }}
+          NBEXEC_TIMEOUT_SECONDS: 600
+
+      - name: Test summary
+        if: always()
+        shell: bash -l {0}
+        run: |
+          echo "=================================================="
+          echo "Test Execution Summary"
+          echo "=================================================="
+          if [ ${{ job.status }} == 'success' ]; then
+            echo "✓ All notebook tests passed successfully!"
+          else
+            echo "✗ Some tests failed. Check logs above for details."
+          fi

environment.yml

@@ -6,6 +6,8 @@ dependencies:
   - python=3.11
   - pip
   - jupyter
+  - pytest
+  - nbconvert
   # Add other dependencies here, for Conda packages.
   - pip:
       # Pip-only packages here, if any.

tests/test_notebooks.py

@@ -9,6 +9,7 @@
 import os
 import subprocess
 import sys
+import time
 
 import pytest
 
@@ -25,6 +26,13 @@ def _run_notebook(path: str) -> None:
     Raises:
         AssertionError: If the notebook execution fails.
     """
+    print(f"\n{'='*60}")
+    print(f"Executing: {path}")
+    print(f"Timeout: {NOTEBOOK_TIMEOUT_SECONDS}s")
+    print(f"{'='*60}")
+
+    start_time = time.time()
+
     cmd = [
         sys.executable,
         "-m",
@@ -36,19 +44,31 @@ def _run_notebook(path: str) -> None:
         f"--ExecutePreprocessor.timeout={NOTEBOOK_TIMEOUT_SECONDS}",
         path,
     ]
+
+    print(f"Running command: {' '.join(cmd)}")
+    print(f"Starting execution at {time.strftime('%Y-%m-%d %H:%M:%S')}")
+
     result = subprocess.run(
         cmd,
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
         text=True,
     )
 
+    elapsed_time = time.time() - start_time
+
     if result.returncode != 0:
+        print(f"✗ FAILED after {elapsed_time:.2f}s")
+        print(f"\nSTDOUT:\n{result.stdout}")
+        print(f"\nSTDERR:\n{result.stderr}")
         raise AssertionError(
-            f"Error executing notebook {path}.\n\n"
+            f"Error executing notebook {path} after {elapsed_time:.2f}s.\n\n"
             f"STDOUT:\n{result.stdout}\n\nSTDERR:\n{result.stderr}"
         )
 
+    print(f"✓ PASSED in {elapsed_time:.2f}s")
+    print(f"Completed at {time.strftime('%Y-%m-%d %H:%M:%S')}")
+
 
 @pytest.mark.skipif(
     not IONQ_API_KEY,
@@ -66,17 +86,56 @@ def test_notebooks() -> None:
     Raises:
         AssertionError: If no notebooks are found or if any notebook fails.
     """
-    notebooks = glob.glob("**/*.ipynb", recursive=True)
+    notebooks = sorted(glob.glob("**/*.ipynb", recursive=True))
+
+    print(f"\n{'='*60}")
+    print(f"Found {len(notebooks)} notebook(s) to test")
+    print(f"{'='*60}")
+    for i, nb in enumerate(notebooks, 1):
+        print(f"{i}. {nb}")
+
     assert notebooks, "No notebooks found to test."
 
+    total_start = time.time()
+    passed = 0
+    failed = 0
+
     for notebook in notebooks:
-        print(f"Testing {notebook}")
-        _run_notebook(notebook)
+        try:
+            _run_notebook(notebook)
+            passed += 1
+        except AssertionError as e:
+            failed += 1
+            if not os.getenv("PYTEST_CURRENT_TEST"):
+                # Only re-raise if not running under pytest
+                raise
+
+    total_elapsed = time.time() - total_start
+
+    print(f"\n{'='*60}")
+    print(f"Test Summary")
+    print(f"{'='*60}")
+    print(f"Total notebooks: {len(notebooks)}")
+    print(f"✓ Passed: {passed}")
+    print(f"✗ Failed: {failed}")
+    print(f"Total time: {total_elapsed:.2f}s")
+    print(f"{'='*60}\n")
+
+    if failed > 0:
+        raise AssertionError(f"{failed} notebook(s) failed to execute")
 
 
 if __name__ == "__main__":
+    print(f"\n{'='*60}")
+    print(f"Notebook Integration Test Runner")
+    print(f"{'='*60}")
+    print(f"Python version: {sys.version}")
+    print(f"Timeout per notebook: {NOTEBOOK_TIMEOUT_SECONDS}s")
+    print(f"API Key configured: {'Yes' if IONQ_API_KEY else 'No'}")
+    print(f"{'='*60}\n")
+
     if not IONQ_API_KEY:
-        print("IONQ_API_KEY not set; skipping notebook tests.")
+        print("⚠ IONQ_API_KEY not set; skipping notebook tests.")
         raise SystemExit(0)
 
     test_notebooks()