report_step

typhoon.test.reporting.messages.report_step(message)

Adds message in allure report, like typhoon.test.reporting.messages.report_message function, but, in contrast to it, this function should be used to organize more functions and report messages in one logical group. It can be viewed as tool for better report organization.

Parameters:

message (string) – Message to be logged for the report step which unifies all the functions and messages called inside of it, in context manager manner.

Return type:

None

Examples

>>> from typhoon.test.signals import pandas_sine
>>> from typhoon.test.rms import window_rms
>>> from typhoon.test.reporting.messages import *
>>> # add report step for creating sinusoidal reference and computing its rms value
>>> with report_step("Create sinusoidal reference and calculate its rms value:"):
>>>     with report_step("Create reference:"):
>>>         reference = pandas_sine(amplitude=100, frequency=50, phase=0, Ts=1e-6)
>>>     with report_step("Calculate rms:"):
>>>         rms = window_rms(reference, window_length=1/50, assume_previous_data=True)

See also

typhoon.test.reporting.messages.report_message