Enum vector::components::validation::TestEvent

pub enum TestEvent {
    Passthrough(Event),
    FailWithAlternateEncoder(Event),
    FailWithExternalResource(Event),
}

An event used in a test case. It is important to have created the event with all fields, immediately after deserializing from the test case definition yaml file. This ensures that the event data we are using in the expected/actual metrics collection is based on the same event. Namely, one issue that can arise from creating the event from the event data twice (once for the expected and once for actual), it can result in a timestamp in the event which may or may not have the same millisecond precision as it’s counterpart.

For transforms and sinks, generally, the only way to cause an error is if the event itself is malformed in some way, which can be achieved without this test event variant.

Variants

Passthrough(Event)

The event is used, as-is, without modification.

FailWithAlternateEncoder(Event)

The event is encoded using an encoding that differs from the component’s configured encoding, which should cause an error when the event is decoded.

FailWithExternalResource(Event)

The event encodes successfully but when the external resource receives that event, it should throw a failure.

Implementations

impl TestEvent

pub fn into_event(self) -> Event

pub fn get_event(&mut self) -> &mut Event

pub fn get(self) -> (bool, Event)

(should_fail, event)

pub const fn should_fail(&self) -> bool

True if the event should fail, false otherwise.

pub const fn should_reject(&self) -> bool

True if the event should be rejected by the external resource in order to trigger a failure path.

Trait Implementations

impl Clone for TestEvent

fn clone(&self) -> TestEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TestEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TestEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.