Skip to content

transpile: tests: Run test_translator.py from cargo nextest with the currently built transpiler path #1731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chiragdhawan24 wants to merge 7 commits into
base: master
Choose a base branch
from
Open

transpile: tests: Run test_translator.py from cargo nextest with the currently built transpiler path #1731

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a7542ec
Allow test_translator.py to use an explicit transpiler path of the c2…
chiragdhawan24 Apr 4, 2026
99d6bab
Addressed feedbacks and comments
chiragdhawan24 Apr 9, 2026
6db274d
Addressed feedbacks and comments. Whitespace changes also addressed.
chiragdhawan24 Apr 9, 2026
55ccd9d
Addressed feedbacks and comments. All whitespace changes finally addr…
chiragdhawan24 Apr 9, 2026
49b4237
Suggested changes to test_translator.rs done.
chiragdhawan24 Apr 10, 2026
92c3e84
README Comments added as well
chiragdhawan24 Apr 22, 2026
7cce002
Comments changed
chiragdhawan24 May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions c2rust/tests/test_translator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
use std::process::Command;

#[test]
fn test_translator() {
let transpile_path = env!("CARGO_BIN_EXE_c2rust-transpile");

let mut cmd = Command::new("../scripts/test_translator.py");
cmd.args(["../tests/unit", "--transpiler", transpile_path]);

// `test_translator.py` needs to be able to re-select the toolchain for different editions.
cmd.env_remove("RUSTUP_TOOLCHAIN");

Comment thread
kkysen marked this conversation as resolved.
let status = cmd
.status()
.unwrap_or_else(|e| panic!("{cmd:?} failed: {e}"));

assert!(status.success(), "{cmd:?} failed with {status}");
}
2 changes: 2 additions & 0 deletions docs/README-developers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ More details about tests can be found in the [tests folder](../tests/).
*Note*: These run integration tests that invoke `c2rust transpile`.
`cargo test` only runs unit tests and doc tests as of now.

*Note*: The tests executed by `test_translator.py` can also be invoked simply by running `cargo nextest run` in the main c2rust workspace. `cargo nextest run` even ensures that the repo tests use the latest version of `c2rust-transpile` binary.

@kkysen kkysen Apr 22, 2026

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.

Suggested change
*Note*: The tests executed by `test_translator.py` can also be invoked simply by running `cargo nextest run` in the main c2rust workspace. `cargo nextest run` even ensures that the repo tests use the latest version of `c2rust-transpile` binary.
Most tests are found in the [`tests`](../tests/) folder.
Most tests can also be run with
```sh
cargo nextest run

which includes running the tests/unit tests.
The tests/unit tests can also be run manually using

./scripts/test_translator.py tests/unit

which also allows you to run with other options.

The tests/integration tests
aren't run automatically by cargo nextest run.
To run them, run

# Needs to be run from `tests/integration/` (or further inside)
# to correctly load the `pyproject.toml`.
cargo build --release
(export PATH=$PWD/target/release:$PATH && export C2RUST_DIR=$PWD && cd tests/integration && ./test.py curl json-c lua nginx zstd li
bxml2 python2 libmcs)

@chiragdhawan24 chiragdhawan24 May 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I have changed the docs/README-developers.md as per the said changes in the latest commit.

Kindly re-review the same. Would really appreciate if this could now be merged into the master branch.


## Documentation

Local documentation can be built with the normal `cargo doc` and `cargo doc --open`.
Expand Down
2 changes: 2 additions & 0 deletions scripts/run_ci_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ test() {
cargo test --release --workspace
}

# The tests executed by `test_translator.py` can also be invoked simply by running `cargo nextest run` in the main c2rust workspace.
# `cargo nextest run` even ensures that the repo tests use the latest version of `c2rust-transpile` binary
# `test_translator.py` compiles translated code,
# which has tons of warnings.
# `RUSTFLAGS="-D warnings"` would be inherited by that,
Expand Down
8 changes: 8 additions & 0 deletions scripts/test_translator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -654,6 +654,10 @@ def main() -> None:
desc = 'run regression / unit / feature tests.'
parser = argparse.ArgumentParser(description=desc)
parser.add_argument('directory', type=readable_directory)
parser.add_argument(
'--transpiler', dest='transpiler',
default=None, help='Override the path to the c2rust transpiler binary'
)
parser.add_argument(
'--only-files', dest='regex_files', type=regex,
default='.*', help="Regular expression to filter which tests to run"
Expand Down Expand Up @@ -681,6 +685,10 @@ def main() -> None:

args = parser.parse_args()
c.update_args(args)

if args.transpiler is not None:
c.TRANSPILER = args.transpiler

test_directories = get_testdirectories(args.directory,
args.regex_files,
args.keep,
Expand Down
2 changes: 2 additions & 0 deletions tests/unit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ $ ./scripts/test_translator.py --keep=all tests/unit
$ ./scripts/test_translator.py --help
```

*Note*: The tests executed by `test_translator.py` can also be invoked simply by running `cargo nextest run` in the main c2rust workspace. `cargo nextest run` even ensures that the repo tests use the latest version of `c2rust-transpile` binary

## What happens under the hood

This `tests/unit` directory contains regression, feature, and unit tests. A test directory goes through the following set of steps:
Expand Down
Loading