Allow running doctests via rust.doctest() #13933
Open
Conversation
This file contains 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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -42,7 +42,7 @@ | |||
| from .backend.backends import Backend | |||
| from .compilers import Compiler | |||
| from .interpreter.interpreter import SourceOutputs, Interpreter | |||
| from .interpreter.interpreterobjects import Test | |||
| from .interpreter.interpreterobjects import Test, Doctest | |||
Check failure
Code scanning / CodeQL
Module-level cyclic import
| @@ -42,7 +42,7 @@ | |||
| from .backend.backends import Backend | |||
| from .compilers import Compiler | |||
| from .interpreter.interpreter import SourceOutputs, Interpreter | |||
| from .interpreter.interpreterobjects import Test | |||
| from .interpreter.interpreterobjects import Test, Doctest | |||
Check failure
Code scanning / CodeQL
Module-level cyclic import
bonzini
force-pushed
the
rustdoc
branch
4 times, most recently
from
06d0967 to
625e503
Compare
dcbaker
reviewed
Nov 20, 2024
bonzini
force-pushed
the
rustdoc
branch
8 times, most recently
from
3817dbd to
7b380be
Compare
|
As much to help me keep track of things: patches 1-5 (remove cratetype variable) are r-b |
dcbaker
requested changes
Dec 19, 2024
dcbaker
requested changes
Jan 31, 2025
dcbaker
requested changes
Feb 1, 2025
bonzini
force-pushed
the
rustdoc
branch
3 times, most recently
from
cef6179 to
defbf2b
Compare
Same. Let's push these preliminary fixups now: b825fae...d34c37f |
eli-schwartz
reviewed
Feb 4, 2025
Allow reusing the code for doctests. In particular, the sources are shared between the two cases. Signed-off-by: Paolo Bonzini <[email protected]>
This will be used by rustdoc tests because the Test objects takes a single string for the command and everything else goes in the args. But apart from this, the need to split the executable from the arguments is common so create new methods to do it. While at it, fix brokenness in the handling of the zig compiler, which is checking against "zig" but failing to detect e.g. "/usr/bin/zig". Signed-off-by: Paolo Bonzini <[email protected]>
A doctest target is a separate build target (with its own linker arguments, including dependencies) that is built and added as a unit test whenever the parent target is built. The doctest's target is not accessible via ninja. Signed-off-by: Paolo Bonzini <[email protected]>
Adjust get_rust_compiler_args() to accept the crate-type externally, because rustdoc tests are an executable but are compiled with the parent target's --crate-type. Apart from that, the rustdoc arguments are very similar to the parent target, and are handled by the same functions that were split out of generate_rust_target. This concludes the backend implementation of doctests, only leaving the implementation of a doctest() function in the rust module. Signed-off-by: Paolo Bonzini <[email protected]>
rust.doctest() will have to typecheck that to a list of strings, no other argument types are allowed. Extract the field out of BaseTest, placing it in FuncBenchmark and the rust modules's FuncTest. Signed-off-by: Paolo Bonzini <[email protected]>
Signed-off-by: Paolo Bonzini <[email protected]>
Signed-off-by: Paolo Bonzini <[email protected]>
Signed-off-by: Paolo Bonzini <[email protected]>
QEMU needs it in its integration tests (in order to run global constructors),
and therefore in rust.doctest too. With this change I could do:
# Rust executables do not support objects, so add an intermediate step.
rust_qemu_api_objs = static_library(
'rust_qemu_api_objs',
objects: [libqom.extract_all_objects(recursive: false),
libhwcore.extract_all_objects(recursive: false)])
rust.doctest('rust-qemu-api-doc', _qemu_api_rs,
dependencies: [qemu_api, qemu_api_macros],
link_with: libqemuutil,
link_whole: [rust_qemu_api_objs],
suite: ['doc', 'rust'])
followed by "meson test --suite doc".
For completeness, add it to rust.test as well.
Signed-off-by: Paolo Bonzini <[email protected]>
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.
Most of the series is refactoring that avoids duplicating the code that creates arguments to rustc. The integration with build.BuildTarget is a bit rust-specific, so I am willing to change things if you guys don't like it.