Struct TestDescription 

pub struct TestDescription<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> {

    pub test_config: HotShotConfig<TYPES>,
    pub skip_late: bool,
    pub overall_safety_properties: OverallSafetyPropertiesDescription,
    pub spinning_properties: SpinningTaskDescription,
    pub txn_description: TxnTaskDescription,
    pub completion_task_description: CompletionTaskDescription,
    pub timing_data: TimingData,
    pub unreliable_network: Option<Box<dyn NetworkReliability>>,
    pub view_sync_properties: ViewSyncTaskDescription,
    pub builders: Vec1<BuilderDescription>,
    pub fallback_builder: BuilderDescription,
    pub solver: FakeSolverApiDescription,
    pub behaviour: Rc<dyn Fn(u64) -> Behaviour<TYPES, I, V>>,
    pub async_delay_config: HashMap<u64, DelayConfig>,
    pub upgrade_view: Option<u64>,
    pub start_solver: bool,
    pub validate_transactions: TransactionValidator,
    pub node_stakes: TestNodeStakes,
}

metadata describing a test

Fields

test_config: HotShotConfig<TYPES>

HotShotConfig used for setting up the test infrastructure.

Note: this is not the same as the HotShotConfig passed to test nodes for SystemContext::init; those configs are instead provided by the resource generators in the test launcher.

skip_late: bool

Whether to skip initializing nodes that will start late, which will catch up later with HotShotInitializer::from_reload in the spinning task.

overall_safety_properties: OverallSafetyPropertiesDescription

overall safety property description

spinning_properties: SpinningTaskDescription

spinning properties

txn_description: TxnTaskDescription

txns timing

completion_task_description: CompletionTaskDescription

completion task

timing_data: TimingData

timing data

unreliable_network: Option<Box<dyn NetworkReliability>>

unrelabile networking metadata

view_sync_properties: ViewSyncTaskDescription

view sync check task

builders: Vec1<BuilderDescription>

description of builders to run

fallback_builder: BuilderDescription

description of fallback builder to run

solver: FakeSolverApiDescription

description of the solver to run

behaviour: Rc<dyn Fn(u64) -> Behaviour<TYPES, I, V>>

nodes with byzantine behaviour

async_delay_config: HashMap<u64, DelayConfig>

Delay config if any to add delays to asynchronous calls

upgrade_view: Option<u64>

view in which to propose an upgrade

start_solver: bool

whether to initialize the solver on startup

validate_transactions: TransactionValidator

boxed closure used to validate the resulting transactions

node_stakes: TestNodeStakes

stake to apply to particular nodes. Nodes not included will have a stake of 1.

Implementations

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> TestDescription<TYPES, I, V>

pub fn default_stress() -> Self

the default metadata for a stress test

pub fn default_multiple_rounds() -> Self

the default metadata for multiple rounds

pub fn default_more_nodes() -> Self

Default setting with 20 nodes and 8 views of successful views.

pub fn default_more_nodes_with_stake(node_stakes: TestNodeStakes) -> Self

pub fn set_num_nodes(self, num_nodes: u64, num_da_nodes: u64) -> Self

pub fn build_node_key_map(&self) -> Arc<TestNodeKeyMap>

pub fn default_with_stake(node_stakes: TestNodeStakes) -> Self

impl<TYPES: NodeType<InstanceState = TestInstanceState>, I, V: Versions> TestDescription<TYPES, I, V>

where I: NodeImplementation<TYPES> + TestableNodeImplementation<TYPES>,

pub fn gen_launcher(self) -> TestLauncher<TYPES, I, V>

turn a description of a test (e.g. a TestDescription) into a TestLauncher that can be used to launch the test.

Panics

if some of the configuration values are zero

pub fn gen_launcher_with_tasks( self, additional_test_tasks: Vec<Box<dyn TestTaskStateSeed<TYPES, I, V>>>, ) -> TestLauncher<TYPES, I, V>

turn a description of a test (e.g. a TestDescription) into a TestLauncher that can be used to launch the test, with additional testing tasks to run in test harness

Panics

if some of the configuration values are zero

Trait Implementations

impl<TYPES: Clone + NodeType, I: Clone + NodeImplementation<TYPES>, V: Clone + Versions> Clone for TestDescription<TYPES, I, V>

fn clone(&self) -> TestDescription<TYPES, I, V>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> Default for TestDescription<TYPES, I, V>

fn default() -> Self

by default, just a single round