mod.rs

//! Utilities for testing in CI environments.

mod config;
mod systems;

use crate::EasyCameraMovementPlugin;
#[cfg(feature = "screenrecording")]
use crate::EasyScreenRecordPlugin;

pub use self::config::*;

use bevy_app::prelude::*;
use bevy_ecs::prelude::*;
use bevy_render::view::screenshot::trigger_screenshots;
use bevy_time::TimeUpdateStrategy;
use core::time::Duration;

/// A plugin that instruments continuous integration testing by automatically executing user-defined actions.
///
/// This plugin reads a [`ron`] file specified with the `CI_TESTING_CONFIG` environmental variable
/// (`ci_testing_config.ron` by default) and executes its specified actions. For a reference of the
/// allowed configuration, see [`CiTestingConfig`].
///
/// This plugin is included within `DefaultPlugins` and `MinimalPlugins`
/// when the `bevy_ci_testing` feature is enabled.
/// It is recommended to only used this plugin during testing (manual or
/// automatic), and disable it during regular development and for production builds.
#[derive(Default)]
pub struct CiTestingPlugin;

impl Plugin for CiTestingPlugin {
    fn build(&self, app: &mut App) {
        let config = if !app.world().is_resource_added::<CiTestingConfig>() {
            // Load configuration from file if not already setup
            #[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());
                std::fs::read_to_string(filename)
                    .map(|content| {
                        ron::from_str(&content)
                            .expect("error deserializing CI testing configuration file")
                    })
                    .unwrap_or_default()
            };

            #[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")
            };

            config
        } else {
            app.world().resource::<CiTestingConfig>().clone()
        };

        // Add the `EasyCameraMovementPlugin` to the app if it's not already added.
        // To configure the movement speed, add the plugin first.
        if !app.is_plugin_added::<EasyCameraMovementPlugin>() {
            app.add_plugins(EasyCameraMovementPlugin::default());
        }
        // Add the `EasyScreenRecordPlugin` to the app if it's not already added and one of the event is starting screenrecording.
        // To configure the recording quality, add the plugin first.
        #[cfg(feature = "screenrecording")]
        if !app.is_plugin_added::<EasyScreenRecordPlugin>()
            && config
                .events
                .iter()
                .any(|e| matches!(e.1, CiTestingEvent::StartScreenRecording))
        {
            app.add_plugins(EasyScreenRecordPlugin::default());
        }

        // Configure a fixed frame time if specified.
        if let Some(fixed_frame_time) = config.setup.fixed_frame_time {
            app.insert_resource(TimeUpdateStrategy::ManualDuration(Duration::from_secs_f32(
                fixed_frame_time,
            )));
        }
        app.add_message::<CiTestingCustomEvent>()
            .insert_resource(config)
            .add_systems(
                Update,
                systems::send_events
                    .before(trigger_screenshots)
                    .before(bevy_window::close_when_requested)
                    .in_set(EventSenderSystems)
                    .ambiguous_with_all(),
            );

        // The offending system does not exist in the wasm32 target.
        // As a result, we must conditionally order the two systems using a system set.
        #[cfg(any(unix, windows))]
        app.configure_sets(
            Update,
            EventSenderSystems.before(bevy_app::TerminalCtrlCHandlerPlugin::exit_on_flag),
        );
    }
}

#[derive(SystemSet, Debug, Clone, PartialEq, Eq, Hash)]
struct EventSenderSystems;