I’ve been working on the following RFC off and on for a while now after running into a case where I really wanted a build script to be run for test code generation. The idea is pulled whole-sale from @alexcrichton’s comments on cargo issue #1581.
- Feature Name:
- Start Date: 2017-07-15
- RFC PR: (leave this empty)
- Rust Issue: (leave this empty)
This RFC proposes a development build script that would be run before tests, examples, and benchmarks are compiled.
Build scripts are currently only run when doing a standard debug or release build, but there are many cases where it would be useful to have a build script run for tests, examples, or benchmarks as well. One common case is code generation only for tests.
[package] # ... dev-build = "build/test-gen.rs" [dev-build-dependencies] foo = "0.1"
dev-build manifest entry similar to the
build entry allowing a build
script to be specified will be added. The dev-build script will be written in
Rust, built as an executable, and will only be built and run before tests,
examples, and benchmarks. This will be in addition to the normal build script,
if one exists. The default name for the dev-build script would be
and if this file was found in the root directory of the crate it would be
assumed to be a dev-build script. This parallels how
build.rs is assumed to be
a build script if found in the root directory of a crate.
In addition, a new top-level dependencies array,
be added to the manifest, paralleling
build-dependencies. Only those
dependencies listed under
dev-build-dependencies will be linked to the
How We Teach This
The in-tree documentation for the manifest, specifying dependencies, and build
scripts will be updated to include information on
dev-build- dependencies. This documentation will closely follow what already exists for
In addition, this feature should be called out in the release notes for the version that it is made stable so as to make it known to existing users.
dev-build-dependencies adds additional complexity to
the manifest, the build process, and cargo.
A single development build script may not be granular enough if some but not all tests, examples, or benchmarks require a build script. This would add build time to all tests, examples, and benchmarks where only one item may require the additional work.
The existing build script could be built with
--bench flags before each respective build. This would utilize the current
build script mechanism and manifest entries, but some existing build scripts are
written assuming they are run only once per compilation and this would break
those. In addition, the build script would always be linked dependencies that it
might only need for test runs, increasing the number of things needed to be
built for any single build, and by extension extending build times.
Are there any additional drawbacks to the proposal?
Should there be a way to override development build scripts, such as what is done with normal build scripts?