Skip to content

scripts: Run OpenVMM doctests with unit tests - #131

Merged
Pedro Henrique Penna (ppenna) merged 1 commit into
devfrom
feat-openvmm-doctests
Sep 19, 2026
Merged

Pedro Henrique Penna (ppenna) merged 1 commit into
devfrom
feat-openvmm-doctests

Conversation

@ppenna

Copy link
Copy Markdown
Contributor

Summary

  • run OpenVMM workspace doctests after the cargo-nextest unit-test suite so Rust documentation examples are covered by the CI entry point
  • use Cargo's locked workspace mode with fail-fast disabled to report all doctest failures
  • extend command-construction coverage and update CLI usage documentation for the expanded behavior

Validation

  • cargo test --locked --doc --workspace --no-fail-fast on Windows/WHP (prometheus28)
  • cargo test --locked --doc --workspace --no-fail-fast on Linux/MSHV (prometheus30)
  • cargo test --locked --doc --workspace --no-fail-fast on Linux/KVM (prometheus32)

Extend test-openvmm-unit to run the workspace doctests after the
cargo-nextest suite. Use Cargo's locked workspace mode and disable
fail-fast so all doctest failures are reported.

Update command-construction coverage to verify both test phases while
preserving the existing package exclusions. Refresh the CLI help and
usage documentation to describe the expanded behavior.
Copilot AI balanced review requested due to automatic review settings September 19, 2026 20:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The implementation, tests, and documentation consistently cover the expanded test behavior.

Review effort: Balanced
Findings: None

What changed in this PR

Adds OpenVMM workspace doctests to the existing unit-test CI entry point.

Changes:

  • Runs locked workspace doctests after cargo-nextest.
  • Tests both generated commands.
  • Updates CLI help and usage documentation.
File Description
scripts/​nvx_tools/​ci.py Adds the Cargo doctest invocation.
scripts/​test_nvx_tools.py Verifies nextest and doctest commands.
scripts/​nvx.py Expands CLI help text.
doc/​usage.md Documents doctest execution.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@ppenna
Pedro Henrique Penna (ppenna) merged commit b2450fe into dev Sep 19, 2026
20 checks passed
@ppenna
Pedro Henrique Penna (ppenna) deleted the feat-openvmm-doctests branch September 19, 2026 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants