39ea1bb9b7
# Objective - Run examples in WASM in CI - Fix #4817 ## Solution - on feature `bevy_ci_testing` - add an extra log message before exiting - when building for wasm, read CI config file at compile time - add a simple [playwright](https://playwright.dev) test script that opens the browser then waits for the success log, and takes a screenshot - add a CI job that runs the playwright test for Chromium and Firefox on one example (lighting) and save the screenshots - Firefox screenshot is good (with some clusters visible) - Chromium screenshot is gray, I don't know why but it's logging `GPU stall due to ReadPixels` - Webkit is not enabled for now, to revisit once https://bugs.webkit.org/show_bug.cgi?id=234926 is fixed or worked around - the CI job only runs on bors validation example run: https://github.com/mockersf/bevy/actions/runs/2361673465. The screenshots can be downloaded
53 lines
1.8 KiB
Rust
53 lines
1.8 KiB
Rust
use crate::{app::AppExit, App};
|
|
use serde::Deserialize;
|
|
|
|
use bevy_utils::tracing::info;
|
|
|
|
/// A configuration struct for automated CI testing.
|
|
///
|
|
/// It gets used when the `bevy_ci_testing` feature is enabled to automatically
|
|
/// exit a Bevy app when run through the CI. This is needed because otherwise
|
|
/// Bevy apps would be stuck in the game loop and wouldn't allow the CI to progress.
|
|
#[derive(Deserialize)]
|
|
pub struct CiTestingConfig {
|
|
/// The number of frames after which Bevy should exit.
|
|
pub exit_after: Option<u32>,
|
|
}
|
|
|
|
fn ci_testing_exit_after(
|
|
mut current_frame: bevy_ecs::prelude::Local<u32>,
|
|
ci_testing_config: bevy_ecs::prelude::Res<CiTestingConfig>,
|
|
mut app_exit_events: bevy_ecs::event::EventWriter<AppExit>,
|
|
) {
|
|
if let Some(exit_after) = ci_testing_config.exit_after {
|
|
if *current_frame > exit_after {
|
|
app_exit_events.send(AppExit);
|
|
info!("Exiting after {} frames. Test successful!", exit_after);
|
|
}
|
|
}
|
|
*current_frame += 1;
|
|
}
|
|
|
|
pub(crate) fn setup_app(app: &mut App) -> &mut App {
|
|
#[cfg(not(target_arch = "wasm32"))]
|
|
let config: CiTestingConfig = {
|
|
let filename = std::env::var("CI_TESTING_CONFIG")
|
|
.unwrap_or_else(|_| "ci_testing_config.ron".to_string());
|
|
ron::from_str(
|
|
&std::fs::read_to_string(filename)
|
|
.expect("error reading CI testing configuration file"),
|
|
)
|
|
.expect("error deserializing CI testing configuration file")
|
|
};
|
|
#[cfg(target_arch = "wasm32")]
|
|
let config: CiTestingConfig = {
|
|
let config = include_str!("../../../ci_testing_config.ron");
|
|
ron::from_str(config).expect("error deserializing CI testing configuration file")
|
|
};
|
|
|
|
app.insert_resource(config)
|
|
.add_system(ci_testing_exit_after);
|
|
|
|
app
|
|
}
|