History

BD103 20277006ce Add benchmarks and `compile_fail` tests back to workspace (#16858 ) # Objective - Our benchmarks and `compile_fail` tests lag behind the rest of the engine because they are not in the Cargo workspace, so not checked by CI. - Fixes #16801, please see it for further context! ## Solution - Add benchmarks and `compile_fail` tests to the Cargo workspace. - Fix any leftover formatting issues and documentation. ## Testing - I think CI should catch most things! ## Questions <details> <summary>Outdated issue I was having with function reflection being optional</summary> The `reflection_types` example is failing in Rust-Analyzer for me, but not a normal check. ```rust error[E0004]: non-exhaustive patterns: `ReflectRef::Function(_)` not covered --> examples/reflection/reflection_types.rs:81:11 \| 81 \| match value.reflect_ref() { \| ^^^^^^^^^^^^^^^^^^^ pattern `ReflectRef::Function(_)` not covered \| note: `ReflectRef<'_>` defined here --> /Users/bdeep/dev/bevy/bevy/crates/bevy_reflect/src/kind.rs:178:1 \| 178 \| pub enum ReflectRef<'a> { \| ^^^^^^^^^^^^^^^^^^^^^^^ ... 188 \| Function(&'a dyn Function), \| -------- not covered = note: the matched value is of type `ReflectRef<'_>` help: ensure that all possible cases are being handled by adding a match arm with a wildcard pattern or an explicit pattern as shown \| 126 ~ ReflectRef::Opaque(_) => {}, 127 + ReflectRef::Function(_) => todo!() \| ``` I think it is because the following line is feature-gated: `cc0f6a8db4/examples/reflection/reflection_types.rs (L117-L122)` My theory for why this is happening is because the benchmarks enabled `bevy_reflect`'s `function` feature, which gets merged with the rest of the features when RA checks the workspace, but the `#[cfg(...)]` gate in the example isn't detecting it: `cc0f6a8db4/benches/Cargo.toml (L19)` Any thoughts on how to fix this? It's not blocking, since the example still compiles as normal, but it's just RA and the command `cargo check --workspace --all-targets` appears to fail. </summary>		2024-12-21 22:30:29 +00:00
..
src
tests	Add benchmarks and `compile_fail` tests back to workspace (#16858 )	2024-12-21 22:30:29 +00:00
.gitignore
Cargo.toml
README.md

README.md

Compile fail tests for Bevy macros

This crate is not part of the Bevy workspace in order to not fail crater tests for Bevy. The tests assert on the exact compiler errors and can easily fail for new Rust versions due to updated compiler errors (e.g. changes in spans).

The CI workflow executes these tests on the stable rust toolchain (see tools/ci).

For information on writing tests see compile_fail_utils/README.md.