diff --git a/src/rt_harness.erl b/src/rt_harness.erl index cd573e9c4..2d1414760 100644 --- a/src/rt_harness.erl +++ b/src/rt_harness.erl @@ -17,6 +17,10 @@ %% under the License. %% %% ------------------------------------------------------------------- +%% @doc rt_harness provides a level of indirection between the modules +%% calling into the harness and the configured harness, resolving the call +%% to the configured harness. Calls such as 'rt_harness:start(Node)' will +%% be resolved to the configured harness. -module(rt_harness). -define(HARNESS_MODULE, (rt_config:get(rt_harness))). diff --git a/src/rt_harness_util.erl b/src/rt_harness_util.erl index 7963939c0..82c6a4abb 100644 --- a/src/rt_harness_util.erl +++ b/src/rt_harness_util.erl @@ -17,7 +17,8 @@ %% under the License. %% %% ------------------------------------------------------------------- - +%% @doc The purpose of rt_harness_util is to provide common functions +%% to harness modules implementing the test_harness behaviour. -module(rt_harness_util). -include_lib("eunit/include/eunit.hrl"). diff --git a/src/rtdev.erl b/src/rtdev.erl index fc504a543..375de6e47 100644 --- a/src/rtdev.erl +++ b/src/rtdev.erl @@ -25,26 +25,26 @@ deploy_clusters/1, clean_data_dir/2, spawn_cmd/1, - spawn_cmd/2, - cmd/1, - cmd/2, - setup_harness/2, - get_version/0, - get_backends/0, - set_backend/1, - whats_up/0, - get_ip/1, - node_id/1, - node_version/1, - admin/2, - riak/2, - attach/2, - attach_direct/2, - console/2, - update_app_config/2, - teardown/0, - set_conf/2, - set_advanced_conf/2]). + spawn_cmd/2, + cmd/1, + cmd/2, + setup_harness/2, + get_version/0, + get_backends/0, + set_backend/1, + whats_up/0, + get_ip/1, + node_id/1, + node_version/1, + admin/2, + riak/2, + attach/2, + attach_direct/2, + console/2, + update_app_config/2, + teardown/0, + set_conf/2, + set_advanced_conf/2]). -compile(export_all). -include_lib("eunit/include/eunit.hrl"). diff --git a/src/rtperf.erl b/src/rtperf.erl index ee109fffe..f0a68c65c 100644 --- a/src/rtperf.erl +++ b/src/rtperf.erl @@ -6,26 +6,26 @@ deploy_clusters/1, clean_data_dir/2, spawn_cmd/1, - spawn_cmd/2, - cmd/1, - cmd/2, - setup_harness/2, - get_version/0, - get_backends/0, - set_backend/1, - whats_up/0, - get_ip/1, - node_id/1, - node_version/1, - admin/2, - riak/2, - attach/2, - attach_direct/2, - console/2, - update_app_config/2, - teardown/0, - set_conf/2, - set_advanced_conf/2]). + spawn_cmd/2, + cmd/1, + cmd/2, + setup_harness/2, + get_version/0, + get_backends/0, + set_backend/1, + whats_up/0, + get_ip/1, + node_id/1, + node_version/1, + admin/2, + riak/2, + attach/2, + attach_direct/2, + console/2, + update_app_config/2, + teardown/0, + set_conf/2, + set_advanced_conf/2]). -compile(export_all). diff --git a/src/rtssh.erl b/src/rtssh.erl index 4cbe4851e..69d97bbeb 100644 --- a/src/rtssh.erl +++ b/src/rtssh.erl @@ -6,27 +6,27 @@ deploy_clusters/1, clean_data_dir/2, spawn_cmd/1, - spawn_cmd/2, - cmd/1, - cmd/2, - setup_harness/2, + spawn_cmd/2, + cmd/1, + cmd/2, + setup_harness/2, get_deps/0, - get_version/0, - get_backends/0, - set_backend/1, - whats_up/0, - get_ip/1, - node_id/1, - node_version/1, - admin/2, - riak/2, - attach/2, - attach_direct/2, - console/2, - update_app_config/2, - teardown/0, - set_conf/2, - set_advanced_conf/2]). + get_version/0, + get_backends/0, + set_backend/1, + whats_up/0, + get_ip/1, + node_id/1, + node_version/1, + admin/2, + riak/2, + attach/2, + attach_direct/2, + console/2, + update_app_config/2, + teardown/0, + set_conf/2, + set_advanced_conf/2]). -compile(export_all). -include_lib("eunit/include/eunit.hrl"). diff --git a/src/test_harness.erl b/src/test_harness.erl index 53474841c..11006372f 100644 --- a/src/test_harness.erl +++ b/src/test_harness.erl @@ -17,6 +17,7 @@ %% under the License. %% %% ------------------------------------------------------------------- +%% @doc behaviour for all test harnesses. -module(test_harness). -callback start(Node :: node()) -> 'ok'.