Module traces_for_tests

This module gathers all the code that allows to lighten the trace macros for (Myriad) applications.

Description

This module gathers all the code that allows to lighten the trace macros for (Myriad) applications.

Data Types

aggregator_pid()

aggregator_pid() = class_TraceAggregator:aggregator_pid()

module_name()

module_name() = basic_utils:module_name()

Function Index

test_immediate_stop/2Stops specified test immediately, not waiting for any trace supervisor, stopping the trace aggregator, and finishing on the shell.
test_start/2Starts the specified test.
test_stop/3Stops the specified test, waiting for the trace supervisor if requested.
test_stop_on_shell/2Stops specified test, stopping the trace aggregator and finishing on the shell.

Function Details

test_immediate_stop/2

test_immediate_stop(ModuleName::module_name(), TraceAggregatorPid::aggregator_pid()) -> no_return()

Stops specified test immediately, not waiting for any trace supervisor, stopping the trace aggregator, and finishing on the shell.

To be called from the counterpart macro.

test_start/2

test_start(ModuleName::module_name(), InitTraceSupervisor::class_TraceAggregator:initialise_supervision()) -> aggregator_pid()

Starts the specified test.

To be called from the counterpart macro.

The trace supervisor can be requested to be initialized now or not at all, or later (typically only once the desired filename for the traces file will be known for good, i.e. at its first renaming).

Here we disable explicitly the trapping of EXIT signals, as a function run through "erl -eval" (like our apps) or through "erl -run" will be executed in a process that will silently trap EXIT signals, which would mean that the crash of any process created from the app, even thanks to spawn_link, would most probably remain unnoticed (just leading to an EXIT message happily sitting in the mailbox of the app process).

test_stop/3

test_stop(ModuleName::module_name(), TraceAggregatorPid::aggregator_pid(), WaitForTraceSupervisor::boolean()) -> no_return()

Stops the specified test, waiting for the trace supervisor if requested.

To be called from the counterpart macro.

test_stop_on_shell/2

test_stop_on_shell(ModuleName::module_name(), TraceAggregatorPid::aggregator_pid()) -> no_return()

Stops specified test, stopping the trace aggregator and finishing on the shell.

To be called from the counterpart macro, directly or not.


Generated by EDoc