ctool

ctool is a library application that contains utility functions for logging, monitoring and testing. It is used across Onedata components as a rebar dependency.

Most important elements of ctool are:

• logging.hrl - logging macros that must be used instead of direct lager calls as they introduce additional logic layer required to customize logging.
• performance.hrl - macros for performance and stress tests creation
• assertions.hrl - assertions for ct tests (based on assertions provided by eunit).
• test_utils.erl - functions for mocking in ct
• test_node_starter.erl - functions for environment setting/teardown. tests.
• tracer.erl - utility functions for debugging.

There are 2 performance macros:

• ALL - to show which test should be started during performance tests,
• PERFORMANCE - to provide additional parameters to test.

Sample usage in ct test file:

all() ->
    ?ALL([t1, t2], [t2, t3]).

sample_test(Config) ->
    ?PERFORMANCE(Config, [
            {repeats, ?REPEATS},
            {success_rate, ?SUCCESS_RATE},
            {parameters, [
                [{name, p1}, {value, 10}, {description, "Param 1"}],
                [{name, p2}, {value, 3}, {description, "Param 2"}]
            ]},
            {description, "Test description"},
            {config, [{name, performance config},
                {parameters, [
                    [{name, p1}, {value, 100}],
                    [{name, p2}, {value, 50}]
                ]},
                {description, "Basic performance config for test"}
            ]}
        ]).
sample_test_base(Config) ->
	1 = 1.

For example above use ct_run script:

• Use ./ct_run to execute tests t1 and t2.
• Use ./ct_run --performance to execute tests t2 and t3.