User's Guide
Reference Manual
Release Notes
PDF
Top

Common Test
Reference Manual
Version 1.12

Expand All
Contract All

Table of Contents

common_test
ct_run
ct
- Top of manual page
- abort_current_testcase/1
- add_config/2
- break/1
- break/2
- capture_get/0
- capture_get/1
- capture_start/0
- capture_stop/0
- comment/1
- comment/2
- continue/0
- continue/1
- decrypt_config_file/2
- decrypt_config_file/3
- encrypt_config_file/2
- encrypt_config_file/3
- fail/1
- fail/2
- get_config/1
- get_config/2
- get_config/3
- get_event_mgr_ref/0
- get_status/0
- get_target_name/1
- get_testspec_terms/0
- get_testspec_terms/1
- get_timetrap_info/0
- install/1
- listenv/1
- log/1
- log/2
- log/3
- log/4
- log/5
- make_priv_dir/0
- notify/2
- pal/1
- pal/2
- pal/3
- pal/4
- parse_table/1
- print/1
- print/2
- print/3
- print/4
- reload_config/1
- remove_config/2
- require/1
- require/2
- run/1
- run/2
- run/3
- run_test/1
- run_testspec/1
- sleep/1
- start_interactive/0
- step/3
- step/4
- stop_interactive/0
- sync_notify/2
- testcases/2
- timetrap/1
- userdata/2
- userdata/3
ct_master
- Top of manual page
- abort/0
- abort/1
- basic_html/1
- get_event_mgr_ref/0
- progress/0
- run/1
- run/3
- run/4
- run_on_node/2
- run_on_node/3
- run_test/2
ct_cover
ct_ftp
- Top of manual page
- cd/2
- close/1
- delete/2
- get/3
- ls/2
- open/1
- put/3
- recv/2
- recv/3
- send/2
- send/3
- type/2
ct_ssh
- Top of manual page
- apread/4
- apread/5
- apwrite/4
- apwrite/5
- aread/3
- aread/4
- awrite/3
- awrite/4
- close/2
- close/3
- connect/1
- connect/2
- connect/3
- del_dir/2
- del_dir/3
- delete/2
- delete/3
- disconnect/1
- exec/2
- exec/3
- exec/4
- get_file_info/2
- get_file_info/3
- list_dir/2
- list_dir/3
- make_dir/2
- make_dir/3
- make_symlink/3
- make_symlink/4
- open/3
- open/4
- opendir/2
- opendir/3
- position/3
- position/4
- pread/4
- pread/5
- pwrite/4
- pwrite/5
- read/3
- read/4
- read_file/2
- read_file/3
- read_file_info/2
- read_file_info/3
- read_link/2
- read_link/3
- read_link_info/2
- read_link_info/3
- receive_response/2
- receive_response/3
- receive_response/4
- rename/3
- rename/4
- send/3
- send/4
- send/5
- send_and_receive/3
- send_and_receive/4
- send_and_receive/5
- send_and_receive/6
- session_close/2
- session_open/1
- session_open/2
- sftp_connect/1
- subsystem/3
- subsystem/4
- write/3
- write/4
- write_file/3
- write_file/4
- write_file_info/3
- write_file_info/4
ct_netconfc
ct_rpc
- Top of manual page
- app_node/2
- app_node/3
- app_node/4
- call/4
- call/5
- call/6
- cast/4
- cast/5
ct_snmp
ct_telnet
- Top of manual page
- close/1
- cmd/2
- cmd/3
- cmdf/3
- cmdf/4
- expect/2
- expect/3
- get_data/1
- open/1
- open/2
- open/3
- open/4
- send/2
- send/3
- sendf/3
- sendf/4
unix_telnet
ct_slave
- Top of manual page
- start/1
- start/2
- start/3
- stop/1
- stop/2
ct_hooks
ct_property_test

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

Adds nodes to current cover test. Notice that this only works if cover support is active.

To have effect, this function is to be called from init_per_suite/1 (see common_test) before any tests are performed.

cross_cover_analyse(Level, Tests) -> ok

Types:

Level = overview | details

Tests = [{Tag, Dir}]

Tag = atom()

Dir = string()

Accumulates cover results over multiple tests. See section Cross Cover Analysis in the Users's Guide.

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

Types:

Nodes = [atom()]

Reason = cover_not_running | not_main_node

Removes nodes from the current cover test.

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