View Source Membrane.Testing.Assertions (Membrane Core v1.1.2)
This module contains a set of assertion functions and macros.
These assertions will work ONLY in conjunction with
Membrane.Testing.Pipeline
and ONLY when pid of tested pipeline is provided
as an argument to these assertions.
Link to this section Summary
Functions
Asserts that Membrane.Testing.Pipeline
child with name child
removed or is going to
remove it's pad with ref pad
within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Pipeline
executed or will execute callback handle_child_playing/3
for a specific child within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Pipeline
executed or will execute callback handle_child_setup_completed/3
for a specific child within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Pipeline
executed or will execute callback handle_child_terminated/3
for a specific child within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Pipeline
received or is going to receive end_of_stream
notification about from the element with a name element_name
within the timeout
period
specified in milliseconds.
Asserts that a crash group within pipeline will be down within the timeout
period specified in
milliseconds.
Asserts that pipeline received or will receive a notification from the element
with name element_name
within the timeout
period specified in milliseconds.
Asserts that pipeline received or will receive a message matching
message_pattern
from another process within the timeout
period specified
in milliseconds.
Asserts that Membrane.Testing.MockResourceGuard
was requested to cleanup a given tag.
Asserts that a cleanup function was registered in Membrane.Testing.MockResourceGuard
.
Asserts that a tag was unregistered in Membrane.Testing.MockResourceGuard
.
Asserts that Membrane.Testing.Sink
with name sink_name
received or will
receive a buffer matching pattern
within the timeout
period specified in
milliseconds.
Asserts that Membrane.Testing.Sink
with name sink_name
received or will
receive an event within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Sink
with name sink_name
entered the playing
playback.
Asserts that Membrane.Testing.Sink
with name sink_name
received or will
receive stream format matching pattern
within the timeout
period specified in
milliseconds.
Asserts that Membrane.Testing.Pipeline
received or is going to receive start_of_stream
notification from the element with a name element_name
within the timeout
period
specified in milliseconds.
Asserts that Membrane.Testing.Pipeline
won't execute callback handle_child_playing/3
for
a specific child within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Pipeline
won't execute callback handle_child_setup_completed/3
for
a specific child within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Pipeline
won't execute callback handle_child_terminated/3
for
a specific child within the timeout
period specified in milliseconds.
Asserts that a crash group within pipeline won't be down within the timeout
period specified in
milliseconds.
Refutes that pipeline received or will receive a notification from the element
with name element_name
within the timeout
period specified in milliseconds.
Asserts that pipeline has not received and will not receive a message from
another process matching message_pattern
within the timeout
period
specified in milliseconds.
Asserts that Membrane.Testing.Sink
with name sink_name
has not received
and will not receive a buffer matching buffer_pattern
within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Sink
has not received and will not receive
event matching provided pattern within the timeout
period specified in
milliseconds.
Asserts that Membrane.Testing.Sink
with name sink_name
didn't enter the playing
playback.
Asserts that Membrane.Testing.Sink
with name sink_name
has not received
and will not receive stream format matching stream_format_pattern
within the timeout
period specified in milliseconds.
Link to this section Functions
assert_child_pad_removed(pipeline, child, pad, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Pipeline
child with name child
removed or is going to
remove it's pad with ref pad
within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Pipeline
executed or will execute callback handle_child_playing/3
for a specific child within the timeout
period specified in milliseconds.
assert_child_setup_completed(pipeline, child, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Pipeline
executed or will execute callback handle_child_setup_completed/3
for a specific child within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Pipeline
executed or will execute callback handle_child_terminated/3
for a specific child within the timeout
period specified in milliseconds.
assert_end_of_stream(pipeline, element_name, pad \\ :input, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Pipeline
received or is going to receive end_of_stream
notification about from the element with a name element_name
within the timeout
period
specified in milliseconds.
assert_end_of_stream(pipeline, :an_element)
assert_pipeline_crash_group_down(pipeline, group_name, timeout \\ 2000)
View Source (macro)Asserts that a crash group within pipeline will be down within the timeout
period specified in
milliseconds.
Usage example:
assert_pipeline_crash_group_down(pipeline, :group_1)
assert_pipeline_notified(pipeline, element_name, notification_pattern, timeout \\ 2000)
View Source (macro)Asserts that pipeline received or will receive a notification from the element
with name element_name
within the timeout
period specified in milliseconds.
The notification_pattern
must be a match pattern.
assert_pipeline_notified(pipeline, :element_name, :hi)
assert_pipeline_receive(pipeline, message_pattern, timeout \\ 2000)
View Source (macro)Asserts that pipeline received or will receive a message matching
message_pattern
from another process within the timeout
period specified
in milliseconds.
The message_pattern
must be a match pattern.
assert_pipeline_receive(pid, :tick)
Such call would flunk if the message :tick
has not been handled by
c:Membrane.Parent.handle_info/3
within the timeout
.
assert_resource_guard_cleanup(mock_guard, tag, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.MockResourceGuard
was requested to cleanup a given tag.
assert_resource_guard_register(mock_guard, function, tag, timeout \\ 2000)
View Source (macro)Asserts that a cleanup function was registered in Membrane.Testing.MockResourceGuard
.
assert_resource_guard_unregister(mock_guard, tag, timeout \\ 2000)
View Source (macro)Asserts that a tag was unregistered in Membrane.Testing.MockResourceGuard
.
assert_sink_buffer(pipeline, sink_name, pattern, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Sink
with name sink_name
received or will
receive a buffer matching pattern
within the timeout
period specified in
milliseconds.
When the Membrane.Testing.Sink
is a part of Membrane.Testing.Pipeline
you
can assert whether it received a buffer matching provided pattern.
import Membrane.ChildrenSpec
spec = [
...
|> child(:the_sink, %Membrane.Testing.Sink{}) |>
...
]
{:ok, pid} = Membrane.Testing.Pipeline.start_link(
spec: spec,
)
You can match for exact value:
assert_sink_buffer(pid, :the_sink ,%Membrane.Buffer{payload: ^specific_payload})
You can also use pattern to extract data from the buffer:
assert_sink_buffer(pid, :sink, %Buffer{payload: <<data::16>> <> <<255>>})
do_something(data)
assert_sink_event(pipeline, sink_name, event, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Sink
with name sink_name
received or will
receive an event within the timeout
period specified in milliseconds.
When a Membrane.Testing.Sink
is part of Membrane.Testing.Pipeline
you can
assert whether it received an event matching a provided pattern.
assert_sink_event(pid, :the_sink, %Discontinuity{})
Asserts that Membrane.Testing.Sink
with name sink_name
entered the playing
playback.
assert_sink_stream_format(pipeline, element_name, stream_format_pattern, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Sink
with name sink_name
received or will
receive stream format matching pattern
within the timeout
period specified in
milliseconds.
When the Membrane.Testing.Sink
is a part of Membrane.Testing.Pipeline
you
can assert whether it received stream format matching provided pattern.
import Membrane.ChildrenSpec
children = [
...,
child(:the_sink, %Membrane.Testing.Sink{})
]
{:ok, pid} = Membrane.Testing.Pipeline.start_link(
spec: children,
)
You can match for exact value:
assert_sink_stream_format(pid, :the_sink , %StreamFormat{prop: ^value})
You can also use pattern to extract data from the stream_format:
assert_sink_stream_format(pid, :the_sink , %StreamFormat{prop: value})
do_something(value)
assert_start_of_stream(pipeline, element_name, pad \\ :input, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Pipeline
received or is going to receive start_of_stream
notification from the element with a name element_name
within the timeout
period
specified in milliseconds.
assert_start_of_stream(pipeline, :an_element)
Asserts that Membrane.Testing.Pipeline
won't execute callback handle_child_playing/3
for
a specific child within the timeout
period specified in milliseconds.
refute_child_setup_completed(pipeline, child, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Pipeline
won't execute callback handle_child_setup_completed/3
for
a specific child within the timeout
period specified in milliseconds.
Asserts that Membrane.Testing.Pipeline
won't execute callback handle_child_terminated/3
for
a specific child within the timeout
period specified in milliseconds.
refute_pipeline_crash_group_down(pipeline, group_name, timeout \\ 2000)
View Source (macro)Asserts that a crash group within pipeline won't be down within the timeout
period specified in
milliseconds.
Usage example:
refute_pipeline_crash_group_down(pipeline, :group_1)
refute_pipeline_notified(pipeline, element_name, notification_pattern, timeout \\ 2000)
View Source (macro)Refutes that pipeline received or will receive a notification from the element
with name element_name
within the timeout
period specified in milliseconds.
The notification_pattern
must be a match pattern.
refute_pipeline_notified(pipeline, :element_name, :hi)
refute_pipeline_receive(pipeline, message_pattern, timeout \\ 2000)
View Source (macro)Asserts that pipeline has not received and will not receive a message from
another process matching message_pattern
within the timeout
period
specified in milliseconds.
The message_pattern
must be a match pattern.
refute_pipeline_receive(pid, :tick)
Such call would flunk if the message :tick
has been handled by
c:Membrane.Parent.handle_info/3
.
refute_sink_buffer(pipeline, sink_name, pattern, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Sink
with name sink_name
has not received
and will not receive a buffer matching buffer_pattern
within the timeout
period specified in milliseconds.
Similarly as in the assert_sink_buffer/4
the_sink
needs to be part of a
Membrane.Testing.Pipeline
.
refute_sink_buffer(pipeline, :the_sink, %Buffer{payload: <<0xA1, 0xB2>>})
Such expression will flunk if the_sink
received or will receive a buffer
with payload <<0xA1, 0xB2>>
.
refute_sink_event(pipeline, sink_name, event, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Sink
has not received and will not receive
event matching provided pattern within the timeout
period specified in
milliseconds.
refute_sink_event(pid, :the_sink, %Discontinuity{})
Asserts that Membrane.Testing.Sink
with name sink_name
didn't enter the playing
playback.
refute_sink_stream_format(pipeline, element_name, stream_format_pattern, timeout \\ 2000)
View Source (macro)Asserts that Membrane.Testing.Sink
with name sink_name
has not received
and will not receive stream format matching stream_format_pattern
within the timeout
period specified in milliseconds.
Similarly as in the assert_sink_stream_format/4
the_sink
needs to be part of a
Membrane.Testing.Pipeline
.
refute_sink_stream_format(pipeline, :the_sink, %StreamFormat{prop: ^val})
Such expression will flunk if the_sink
received or will receive stream_format with
property equal to value of val
variable.