Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

Common Test
Reference Manual
Version 1.7


Expand All
Contract All

Table of Contents

ct_cover

MODULE

ct_cover

MODULE SUMMARY

Common Test Framework code coverage support module.

DESCRIPTION

Common Test Framework code coverage support module.

This module exports help functions for performing code coverage analysis.

EXPORTS

add_nodes(Nodes) -> {ok, StartedNodes} | {error, Reason}

Types:

Nodes = [atom()]
StartedNodes = [atom()]
Reason = cover_not_running | not_main_node

Add nodes to current cover test (only works if cover support is active!). To have effect, this function should be called from init_per_suite/1 before any actual tests are performed.

cross_cover_analyse(Level, Tests) -> ok

Types:

Level = overview | details
Tests = [{Tag, Dir}]
Tag = atom()
Dir = string()

Accumulate cover results over multiple tests. See the chapter about cross cover analysis in the users's guide.

remove_nodes(Nodes) -> ok | {error, Reason}

Types:

Nodes = [atom()]
Reason = cover_not_running | not_main_node

Remove nodes from current cover test. Call this function to stop cover test on nodes previously added with add_nodes/1. Results on the remote node are transferred to the Common Test node.