mirror of https://github.com/bevyengine/bevy synced 2024-11-22 12:43:34 +00:00

History

BD103 bdb4899978 Move compile fail tests (#13196 ) # Objective - Follow-up of #13184 :) - We use `ui_test` to test compiler errors for our custom macros. - There are four crates related to compile fail tests - `bevy_ecs_compile_fail_tests`, `bevy_macros_compile_fail_tests`, and `bevy_reflect_compile_fail_tests`, which actually test the macros. - [`bevy_compile_test_utils`](`64c1c65783/crates/bevy_compile_test_utils`), which provides helpers and common patterns for these tests. - All of these crates reside within the `crates` directory. - This can be confusing, especially for newcomers. All of the other folders in `crates` are actual published libraries, except for these 4. ## Solution - Move all compile fail tests to a `compile_fail` folder under their corresponding crate. - E.g. `crates/bevy_ecs_compile_fail_tests` would be moved to `crates/bevy_ecs/compile_fail`. - Move `bevy_compile_test_utils` to `tools/compile_fail_utils`. There are a few benefits to this approach: 1. An internal testing detail is less intrusive (and confusing) for those who just want to browse the public Bevy interface. 2. Follows a pre-existing approach of organizing related crates inside a larger crate's folder. - See `bevy_gizmos/macros` for an example. 4. Makes consistent the terms `compile_test`, `compile_fail`, and `compile_fail_test` in code. It's all just `compile_fail` now, because we are specifically testing the error messages on compiler failures. - To be clear it can still be referred to by these terms in comments and speech, just the names of the crates and the CI command are now consistent. ## Testing Run the compile fail CI command: ```shell cargo run -p ci -- compile-fail ``` If it still passes, then my refactor was successful.		2024-05-03 13:35:21 +00:00
..
src	Move compile fail tests (#13196 )	2024-05-03 13:35:21 +00:00
tests	Move compile fail tests (#13196 )	2024-05-03 13:35:21 +00:00
.gitignore	Move compile fail tests (#13196 )	2024-05-03 13:35:21 +00:00
Cargo.toml	Move compile fail tests (#13196 )	2024-05-03 13:35:21 +00:00
README.md	Move compile fail tests (#13196 )	2024-05-03 13:35:21 +00:00

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.