Allow the tests/ directory to be included in the published tarball
#154
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
`cargo package` (and thus, `cargo publish`) verifies `Cargo.toml` against the packaged tarball This means extracting the tarball and trying to verify the `Cargo.toml` In the past, we relied on auto-discovery of files under `tests` to run integration tests When we added the `examples` feature, we ended up putting some tests behind that feature In order to make that work, the tests were added as targets in `Cargo.toml` with explicit `required-features` entries However, because these tests were now explicitly defined in `Cargo.toml` instead of implicitly by directory structure, Cargo required those test files to be present in order for the manifest to be valid Because we were excluding `tests/` from the packaging, this was causing the `package` validation to fail (while not causing problems in development because the `tests/` directory was present in `git checkout`) Thus, this issue did not present itself until we tried to publish `lace` The simple solution is just to include the required test `.rs` files in the package; they are small in size, and it is not required that they pass to publish
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.
cargo package(and thus,cargo publish) verifiesCargo.tomlagainst the packaged tarball This means extracting the tarball and trying to verify theCargo.tomlIn the past, we relied on auto-discovery of files underteststo run integration tests When we added theexamplesfeature, we ended up putting some tests behind that feature In order to make that work, the tests were added as targets inCargo.tomlwith explicitrequired-featuresentries However, because these tests were now explicitly defined inCargo.tomlinstead of implicitly by directory structure,Cargo required those test files to be present in order for the manifest to be valid
Because we were excluding
tests/from the packaging, this was causing thepackagevalidation to fail(while not causing problems in development because the
tests/directory was present ingit checkout)Thus, this issue did not present itself until we tried to publish
laceThe simple solution is just to include the required test.rsfiles in the package;they are small in size, and it is not required that they pass to publish