From 7d8a1f8b944d6734d9419f184c441899a48c11a3 Mon Sep 17 00:00:00 2001 From: rzezeski Date: Sun, 22 May 2011 14:25:17 -0400 Subject: Add a proplist() type Recently I was adding specs to an API and found that there is no canonical proplist() type defined. --- lib/common_test/src/ct_hooks.erl | 6 ++---- lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl | 7 +++---- 2 files changed, 5 insertions(+), 8 deletions(-) (limited to 'lib/common_test') diff --git a/lib/common_test/src/ct_hooks.erl b/lib/common_test/src/ct_hooks.erl index 984e04b90f..ece592e320 100644 --- a/lib/common_test/src/ct_hooks.erl +++ b/lib/common_test/src/ct_hooks.erl @@ -31,8 +31,6 @@ -export([on_tc_skip/2]). -export([on_tc_fail/2]). --type proplist() :: [{atom(),term()}]. - %% If you change this, remember to update ct_util:look -> stop clause as well. -define(config_name, ct_hooks). @@ -59,7 +57,7 @@ terminate(Hooks) -> %% @doc Called as each test case is started. This includes all configuration %% tests. -spec init_tc(Mod :: atom(), Func :: atom(), Args :: list()) -> - NewConfig :: proplist() | + NewConfig :: proplists:proplist() | {skip, Reason :: term()} | {auto_skip, Reason :: term()} | {fail, Reason :: term()}. @@ -92,7 +90,7 @@ init_tc(_Mod, TC, Config) -> Args :: list(), Result :: term(), Resturn :: term()) -> - NewConfig :: proplist() | + NewConfig :: proplists:proplist() | {skip, Reason :: term()} | {auto_skip, Reason :: term()} | {fail, Reason :: term()} | diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl index ebebfd18a9..71ed61b4c0 100644 --- a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl +++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl @@ -59,8 +59,7 @@ -include_lib("common_test/src/ct_util.hrl"). -include_lib("common_test/include/ct_event.hrl"). --type proplist() :: list({atom(),term()}). --type config() :: proplist(). +-type config() :: proplists:proplist(). -type reason() :: term(). -type skip_or_fail() :: {skip, reason()} | {auto_skip, reason()} | @@ -71,7 +70,7 @@ %% @doc Always called before any other callback function. Use this to initiate %% any common state. It should return an state for this CTH. --spec init(Id :: term(), Opts :: proplist()) -> +-spec init(Id :: term(), Opts :: proplists:proplist()) -> State :: #state{}. init(Id, Opts) -> gen_event:notify(?CT_EVMGR_REF, #event{ name = cth, node = node(), @@ -81,7 +80,7 @@ init(Id, Opts) -> %% @doc The ID is used to uniquly identify an CTH instance, if two CTH's %% return the same ID the seconds CTH is ignored. This function should NOT %% have any side effects as it might be called multiple times by common test. --spec id(Opts :: proplist()) -> +-spec id(Opts :: proplists:proplist()) -> Id :: term(). id(Opts) -> gen_event:notify(?CT_EVMGR_REF, #event{ name = cth, node = node(), -- cgit v1.2.3