Show basic application integration testing (#2896) #7314
Closed
Conversation
This file contains hidden or 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
alice-i-cecile
added
C-Examples
| @@ -0,0 +1,113 @@ | |||
| use bevy::prelude::*; | |||
There was a problem hiding this comment.
Module level docs please :) Laying out a bit of an intro of "this is what we're testing and why" is really helpful.
tests/how_to_test_full_app.rs
Outdated
| app | ||
| } | ||
|
|
||
| fn add_game_systems(app: &mut App) { |
There was a problem hiding this comment.
This should use a plugin: it's extremely useful to refactor your game such that some plugins can be added directly to the test setup.
There was a problem hiding this comment.
Good point, I have changed it into a plugin.
|
Great to see this; this is something I've been asked about a lot. |
Wcubed
force-pushed
the
integration-test-examples
branch
from
7c25528 to
d27ee17
Compare
…dule level documentation.
Wcubed
force-pushed
the
integration-test-examples
branch
from
a0b7390 to
00c9492
Compare
|
Apologies for replacing the commit twice. Turns out if you do the |
tests/how_to_test_full_app.rs
Outdated
| @@ -0,0 +1,132 @@ | |||
| //! This module serves as an example, and test-case, for how to automatically test full bevy apps. | |||
| //! | |||
| //! The way it works, is by substituting the [`DefaultPlugins`] with [`MinimalPlugins`], which | |||
There was a problem hiding this comment.
Suggested change
| //! The way it works, is by substituting the [`DefaultPlugins`] with [`MinimalPlugins`], which | |
| By substituting [`DefaultPlugins`] with [`MinimalPlugins`], Bevy can run completely headless. | |
| Then, the app can be advanced one tick at a time with [`App::update`]. |
tests/how_to_test_full_app.rs
Outdated
| //! This module serves as an example, and test-case, for how to automatically test full bevy apps. | ||
| //! | ||
| //! The way it works, is by substituting the [`DefaultPlugins`] with [`MinimalPlugins`], which | ||
| //! allows bevy to run completely headless. |
There was a problem hiding this comment.
Suggested change
| //! allows bevy to run completely headless. |
tests/how_to_test_full_app.rs
Outdated
| //! | ||
| //! The list of minimal plugins does not include things like window or input handling. | ||
| //! This has as downside that the resources / entities associated with those systems | ||
| //! (for example: `Input::<KeyCode>`) need to be manually added. |
There was a problem hiding this comment.
Suggested change
| //! (for example: `Input::<KeyCode>`) need to be manually added. | |
| //! (for example: `Input::<KeyCode>`) need to be manually added, either directly or via e.g. [`InputPlugin`]. |
tests/how_to_test_full_app.rs
Outdated
| //! The upside however, is that the test has complete control over these resources, meaning | ||
| //! we can fake user input, fake the window being moved around, and more. | ||
| //! | ||
| //! The benefit of having this set of example tests be run by the CI system, is that we ensure |
There was a problem hiding this comment.
I'd remove these sentences.
alice-i-cecile
requested changes
Jan 22, 2023
alice-i-cecile
approved these changes
Jan 22, 2023
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 24, 2024
# Objective This older PR from `Wcubed` seemed well worth saving, adopted from #7314. See also tracking issue #2896 for ongoing discussion of Bevy testability. Thanks `Wcubed`! ## Solution - Updated for 0.15 - Added the `expected`/`actual` pattern - Switched to function plugin - Tweaked a bit of description ## Testing Green. --------- Co-authored-by: Wybe Westra <[email protected]> Co-authored-by: Wybe Westra <[email protected]>
ecoskey
pushed a commit
to ecoskey/bevy
that referenced
this pull request
Dec 2, 2024
# Objective This older PR from `Wcubed` seemed well worth saving, adopted from bevyengine#7314. See also tracking issue bevyengine#2896 for ongoing discussion of Bevy testability. Thanks `Wcubed`! ## Solution - Updated for 0.15 - Added the `expected`/`actual` pattern - Switched to function plugin - Tweaked a bit of description ## Testing Green. --------- Co-authored-by: Wybe Westra <[email protected]> Co-authored-by: Wybe Westra <[email protected]>
ecoskey
pushed a commit
to ecoskey/bevy
that referenced
this pull request
Jan 6, 2025
# Objective This older PR from `Wcubed` seemed well worth saving, adopted from bevyengine#7314. See also tracking issue bevyengine#2896 for ongoing discussion of Bevy testability. Thanks `Wcubed`! ## Solution - Updated for 0.15 - Added the `expected`/`actual` pattern - Switched to function plugin - Tweaked a bit of description ## Testing Green. --------- Co-authored-by: Wybe Westra <[email protected]> Co-authored-by: Wybe Westra <[email protected]>
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.
Objective
Show an example of how the integration testing of a bevy application can be structured, for #2896.
I went for basic window interaction and user input for the examples, but there are certainly other areas that would be good to demonstrate, I just haven't worked with the engine enough to point them out. Suggestions are welcome :)