Run the Rust test suite in CI and cover the large-register code paths

Open
  • Is something wrong?
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
github-actions, numpy, python, rust
Domain
ci-cd, performance, testing

Research direction

Start by reading .github/workflows/release.yml and CONTRIBUTING.md, then inspect the referenced tests in src/backend.rs, src/circuit.rs, src/pauli.rs, and src/engine.rs. Add a separate CI test job for Linux, Windows, and macOS that runs the requested Cargo checks, and add a Python test comparing 16–18-qubit results with a NumPy reference. Done means the CI covers the listed Rust paths and both parallel kernel branches, while GPU behavior on macOS arm64 is checked and documented.

Written by the indexing model from the issue text.

Description

enhancement
What you want to do

Make sure releases are checked. .github/workflows/release.yml only runs pytest, and the Python
tests use at most 5 qubits. So CI never runs:

  • the backend conformance suite (src/backend.rs, conformance);
  • the test that compares fused and gate-by-gate results (src/circuit.rs);
  • the Pauli unit tests (src/pauli.rs);
  • the parallel branch of the CPU kernel for high target qubits, stride >= 2^14 (src/engine.rs:91);
  • any GPU test (runners have no usable GPU, so they are skipped).
Implementation notes
  • cargo test --release (debug is about 20× slower) on Linux, Windows and macOS.
  • cargo test --no-default-features too, so the build without the GPU feature keeps compiling.
  • cargo clippy -- -D warnings and cargo fmt --check.
  • Add a Python test on 16–18 qubits against a NumPy reference, so both parallel kernel branches run
    from Python as well.
  • GPU: check whether the macOS arm64 runners expose a Metal adapter to wgpu. If they do, the GPU
    tests run there for free; otherwise document that GPU tests run only locally.
What it could look like
A `test` job that runs on every push and pull request, separate from the release job.
Contributing
  • I would like to open a pull request for this (see CONTRIBUTING.md).
Dominant language
Rust
Stars
1
Forks
0
Avg merge
12m
Merged PRs (30d)
4

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from kaiwave/qsengine

All issues in kaiwave/qsengine

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.