Skip to content

Change behavior of --exact doc-tests #147653

@IoaNNUwU

Description

@IoaNNUwU

Problem

I have this code:

#[test]
fn foo() {}

#[test]
fn foo_more() {}

/// ```
/// let foo = 10;
/// ```
fn doc_foo() {}

/// ```
/// let foo_more = 10;
/// ```
fn doc_foo_more() {}

Command cargo test foo runs both (non-doc) tests. Command cargo test foo -- --exact runs 1 test named foo.

Command cargo test --doc doc_foo runs both doc tests. Command cargo test --doc doc_foo -- --exact doesn't run any tests, but I expect it to run 1 doc test named doc_foo.

cargo test -- --list shows this 4 tests:

foo: test
foo_more: test

src\lib.rs - doc_foo (line 7): test
src\lib.rs - doc_foo_more (line 12): test

I am able to run specific doc test named doc_foo using cargo test --doc 'doc_foo\ (line\ 7)' thanks to this issue on rust-lang.org.

This solution is not ideal imo because of the need for escape sequences and line number. I think its very hard to use this in complex cases such as doctests in structs or inline modules, basically places with namespace nesting.

This issue originates from my issue in rust-analyzer but the more I think about it, the more I feel like this problem is not about rust-analyzer. It's too tedious to run specific doc test even manually in a shell.

Proposed Solution

Change behavior of --exact flag to match only the name of the test in doc tests by default as it does in non-doc tests.

  • This solution still allows to run specific test if you modify test name to match 'test_name\ (line\ 4)'
  • Currently existing scripts will remain unchanged

Notes

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-doctestsArea: Documentation tests, run by rustdocA-libtestArea: `#[test]` / the `test` libraryC-discussionCategory: Discussion or questions that doesn't represent real issues.T-testing-devexRelevant to the testing devex team (testing DX), which will review and decide on the PR/issue.

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions