Test notebook courses - #3697
Draft
Andrew Casey (amcasey) wants to merge 1 commit into
Draft
Conversation
Dhairya Patel (HABER7789)
approved these changes
Sep 9, 2026
Dhairya Patel (HABER7789)
left a comment
Dhairya Patel (HABER7789)
left a comment
Contributor
There was a problem hiding this comment.
Ran all the thirteen tests. The skip-test tag is a nice addition for the slow cells! and the orbital values also match as expected.
Member
Author
|
This will need to be rebased on top of #3700. Edit: done |
Andrew Casey (amcasey)
force-pushed
the
amcasey/NotebookTest
branch
from
September 9, 2026 20:45
be5d0a3 to
285f947
Compare
Andrew Casey (amcasey)
changed the base branch from
main
to
chemistry-qpe-2.2
September 9, 2026 20:51
Andrew Casey (amcasey)
added this pull request to stack #3701
September 9, 2026 20:51
Andrew Casey (amcasey)
force-pushed
the
amcasey/NotebookTest
branch
from
September 9, 2026 20:55
285f947 to
1cdd2d7
Compare
Andrew Casey (amcasey)
marked this pull request as ready for review
September 9, 2026 20:56
Andrew Casey (amcasey)
requested review from
Bill Ticehurst (billti),
Ian Davis (idavis) and
Stefan J. Wernli (swernli)
as code owners
September 9, 2026 20:56
Member
Author
|
Can you please give it another test now that I've rebased, Dhairya Patel (@HABER7789)? |
Code cells should run without exceptions, except those tagged `exercise`, which should fail with `ExerciseError` (not having been completed). Some cells are very slow - we tag those `skip-test`.
Bill Ticehurst (billti)
force-pushed
the
amcasey/NotebookTest
branch
from
September 9, 2026 21:07
1cdd2d7 to
20270b4
Compare
| with: | ||
| python-version: ${{ env.PYTHON_VERSION }} | ||
| architecture: ${{ matrix.arch }} | ||
| - uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 |
Member
Author
There was a problem hiding this comment.
I'm not convinced we need/want this. I assume it was based on the caching used for cargo above. Can you please have a look, Ian Davis (@idavis)?
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The isolation fixture derives the course root from a fixed notebook depth despite supporting recursive discovery.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Adds automated execution testing for QDK course notebooks.
Changes:
- Adds notebook execution and policy validation.
- Runs Chemistry QPE notebooks across four CI architectures.
- Introduces
skip-testhandling and concise exercise tracebacks.
File summaries
| File | Description |
|---|---|
.github/workflows/ci.yml |
Adds conditional multi-platform notebook tests. |
source/vscode/test/course-notebooks/README.md |
Documents setup and cell tags. |
source/vscode/test/course-notebooks/conftest.py |
Discovers and isolates course notebooks. |
source/vscode/test/course-notebooks/notebook_runner.py |
Executes notebooks and reports policy failures. |
source/vscode/test/course-notebooks/requirements.txt |
Declares test dependencies. |
source/vscode/test/course-notebooks/test_course_notebooks.py |
Tests discovered course notebooks. |
source/vscode/test/course-notebooks/test_notebook_runner.py |
Tests cell-policy handling. |
source/vscode/src/learning/notebookExercises.ts |
Removes test-only tags from learner copies. |
source/vscode/resources/qdk-learning/utils/chemistry-qpe/rst_to_notebook.py |
Generates skipped test cells. |
source/vscode/resources/qdk-learning/courses/chemistry-qpe/06-iterative-phase-estimation/iterative_phase_estimation.ipynb |
Skips the expensive workflow cell in tests. |
source/vscode/resources/qdk-learning/courses/chemistry-qpe/_course_lib.py |
Suppresses exercise traceback rendering. |
Review details
- Files reviewed: 11/11 changed files
- Comments generated: 1
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+36
to
+43
| @pytest.fixture | ||
| def isolated_course_notebook( | ||
| course_notebook: Path, | ||
| tmp_path: Path, | ||
| ) -> tuple[Path, Path]: | ||
| course_dir = course_notebook.parents[1] | ||
| copied_course_dir = tmp_path / course_dir.name | ||
| shutil.copytree(course_dir, copied_course_dir) |
Andrew Casey (amcasey)
marked this pull request as draft
September 12, 2026 00:35
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Code cells should run without exceptions, except those tagged
exercise, which should fail withExerciseError(not having been completed).Some cells are very slow - we tag those
skip-test.