Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-12-22 11:03:06 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/crates/bevy_ecs/compile_fail/tests/ui
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
..
entity_ref_mut_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
entity_ref_mut_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_exact_sized_iterator_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_exact_sized_iterator_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_iter_combinations_mut_iterator_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_iter_combinations_mut_iterator_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_iter_many_mut_iterator_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_iter_many_mut_iterator_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_to_readonly.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_to_readonly.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_transmute_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
query_transmute_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_param_derive_readonly.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_param_derive_readonly.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_get_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_get_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_get_many_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_get_many_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_get_many_mut_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_get_many_mut_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_iter_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_iter_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_iter_many_mut_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_iter_many_mut_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_set_get_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_set_get_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_set_iter_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_query_set_iter_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_state_get_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_state_get_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_state_iter_lifetime_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_state_iter_lifetime_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_state_iter_mut_overlap_safety.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
system_state_iter_mut_overlap_safety.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
world_query_derive.rs Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00
world_query_derive.stderr Move compile fail tests (#13196) 2024-05-03 13:35:21 +00:00