Where should I put files that are used only in tests?

Question

In a Cargo project, where would you put files that exist solely to support testing?

For example, if you were writing a CSV parsing library, you might want example CSV files to parse in tests. Or if you were writing an image processor, you might want example images.

Ideally, users of the library would not be bothered with these, especially if they are large.

Answer 1

Wherever you want, there's no officially suggested place.

See also:

• How can I locate resources for testing with Cargo?

users of the library would not be bothered with these

That's what the package.exclude configuration is for.

As Sven Marnach points out

If you choose to ignore some test assets, consider writing the tests in a way that they also pass when the assets are missing. This allows Crater to test your crate successfully.

One way to accomplish this is to put additional tests behind a feature flag. Only enable that flag in your own CI.

See also:

• Run additional tests by using a feature flag to "cargo test"