src/storage/stress-tests/utils/environment.rs

// Copyright 2021 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use {
    crate::{actor::ActorConfig, instance::InstanceUnderTest},
    async_trait::async_trait,
    std::fmt::Debug,
};

/// Every stress test must implement this trait exactly once and pass it
/// to run_test(). The test loop uses these methods to drive the stress test.
///
/// The environment is responsible for:
/// * creating actors that run during the stress test
/// * creating a new instance when an actor requests one
/// * specifying success criteria for the test (num operations or timeout)
#[async_trait]
pub trait Environment<I: InstanceUnderTest>: 'static + Send + Sync + Debug {
    /// Returns the target number of operations to complete before exiting
    fn target_operations(&self) -> Option<u64>;

    /// Returns the number of seconds to wait before exiting
    fn timeout_seconds(&self) -> Option<u64>;

    /// Returns a list of actors that will run during this test
    async fn actors(&mut self) -> Vec<ActorConfig<I>>;

    /// Returns a new instance-under-test that actors can use
    async fn new_instance(&mut self) -> I;
}