Struct IntegrationTestInput 

pub struct IntegrationTestInput {
    pub id: NodeId,
    pub name: Option<String>,
    pub description: Option<String>,
    pub args: Option<String>,
    pub env: Option<BTreeMap<String, EnvValue>>,
    pub outputs: BTreeSet<DataId>,
    pub inputs: BTreeMap<DataId, Input>,
    pub send_stdout_as: Option<String>,
    pub events: Vec<TimedIncomingEvent>,
    pub recording_status: Option<Box<RecordingStatus>>,
}

Defines the input data and events for integration testing a node.

Most of the fields are similar to the fields defined in the Node struct, which is used to define nodes in a dataflow YAML file.

For integration testing, the most important field is the events field, which specifies the events that should be sent to the node during the test.

Fields

id: NodeId

Unique node identifier. Must not contain / characters.

Node IDs can be arbitrary strings with the following limitations:

• They must not contain any / characters (slashes).
• We do not recommend using whitespace characters (e.g. spaces) in IDs

Each node must have an ID field.

Example

nodes:
  - id: camera_node
  - id: some_other_node

name: Option<String>

Human-readable node name for documentation.

This optional field can be used to define a more descriptive name in addition to a short id.

Example

nodes:
  - id: camera_node
    name: "Camera Input Handler"

description: Option<String>

Detailed description of the node’s functionality.

Example

nodes:
  - id: camera_node
    description: "Captures video frames from webcam"

args: Option<String>

Command-line arguments passed to the executable.

The command-line arguments that should be passed to the executable/script specified in path. The arguments should be separated by space. This field is optional and defaults to an empty argument list.

Example

nodes:
  - id: example
    path: example-node
    args: -v --some-flag foo

env: Option<BTreeMap<String, EnvValue>>

Environment variables for node builds and execution.

Key-value map of environment variables that should be set for both the build operation and the node execution (i.e. when the node is spawned through path).

Supports strings, numbers, and booleans.

Example

nodes:
  - id: example-node
    path: path/to/node
    env:
      DEBUG: true
      PORT: 8080
      API_KEY: "secret-key"

outputs: BTreeSet<DataId>

Output data identifiers produced by this node.

List of output identifiers that the node sends. Must contain all output_id values that the node uses when sending output, e.g. through the send_output function.

Example

nodes:
  - id: example-node
    outputs:
      - processed_image
      - metadata

inputs: BTreeMap<DataId, Input>

Input data connections from other nodes.

Defines the inputs that this node is subscribing to.

The inputs field should be a key-value map of the following format:

input_id: source_node_id/source_node_output_id

The components are defined as follows:

• input_id is the local identifier that should be used for this input.

  This will map to the id field of Event::Input events sent to the node event loop.

• source_node_id should be the id field of the node that sends the output that we want to subscribe to

• source_node_output_id should be the identifier of the output that that we want to subscribe to

Example

nodes:
  - id: example-node
    outputs:
      - one
      - two
  - id: receiver
    inputs:
        my_input: example-node/two

send_stdout_as: Option<String>

Redirect stdout/stderr to a data output.

This field can be used to send all stdout and stderr output of the node as a Dora output. Each output line is sent as a separate message.

Example

nodes:
  - id: example
    send_stdout_as: stdout_output
  - id: logger
    inputs:
        example_output: example/stdout_output

events: Vec<TimedIncomingEvent>

List of incoming events for the integration test.

The node event stream will yield these events during the test. Once the list is exhausted, the event stream will close itself.

recording_status: Option<Box<RecordingStatus>>

Status of the recording that produced this file. Emitted by the DORA_WRITE_EVENTS_TO recorder; None for files produced by older versions of dora (before #1857) or hand-authored fixtures.

Consumers should refuse to replay (or at minimum warn loudly) when this is Some(RecordingStatus::Poisoned { .. }), because the events array is incomplete relative to the original run.

Boxed so the (large) RecordingStatus::Poisoned variant doesn’t inflate IntegrationTestInput’s size for the common-case Clean-or-None recording. This also avoids large_enum_variant lints on TestingInput::Input(...) (32 call sites; widening that enum would be intrusive).

Implementations

impl IntegrationTestInput

pub fn new(id: NodeId, events: Vec<TimedIncomingEvent>) -> IntegrationTestInput

Trait Implementations

impl Debug for IntegrationTestInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IntegrationTestInput

fn deserialize<__D>( __deserializer: __D, ) -> Result<IntegrationTestInput, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IntegrationTestInput

fn eq(&self, other: &IntegrationTestInput) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for IntegrationTestInput

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IntegrationTestInput