%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2011-2016. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%
-module(alarm_handler_SUITE).
-include_lib("common_test/include/ct.hrl").
%%-----------------------------------------------------------------
%% We will add an own alarm handler in order to verify that the
%% alarm_handler deliver the expected events.
%%-----------------------------------------------------------------
-export([init_per_suite/1, end_per_suite/1, all/0,groups/0,
init_per_group/2,end_per_group/2,
set_alarm/1, clear_alarm/1, swap/1]).
-export([init/1, handle_event/2, handle_call/2, handle_info/2,
terminate/2]).
init_per_suite(Config) ->
application:start(sasl),
Config.
end_per_suite(_Config) ->
ok.
all() ->
[set_alarm, clear_alarm, swap].
groups() ->
[].
init_per_group(_GroupName, Config) ->
Config.
end_per_group(_GroupName, Config) ->
Config.
%%-----------------------------------------------------------------
set_alarm(Config) when is_list(Config) ->
gen_event:add_handler(alarm_handler, ?MODULE, self()),
Alarm1 = {alarm1, "this is the alarm"},
Alarm2 = {"alarm2", this_is_the_alarm},
Alarm3 = {{alarm3}, {this_is,"the_alarm"}},
ok = alarm_handler:set_alarm(Alarm1),
reported(set_alarm, Alarm1),
ok = alarm_handler:set_alarm(Alarm2),
reported(set_alarm, Alarm2),
ok = alarm_handler:set_alarm(Alarm3),
reported(set_alarm, Alarm3),
[Alarm3,Alarm2,Alarm1] = alarm_handler:get_alarms(),
alarm_handler:clear_alarm(alarm1),
alarm_handler:clear_alarm("alarm2"),
alarm_handler:clear_alarm({alarm3}),
[] = alarm_handler:get_alarms(),
test_server:messages_get(),
my_yes = gen_event:delete_handler(alarm_handler, ?MODULE, []),
ok.
%%-----------------------------------------------------------------
clear_alarm(Config) when is_list(Config) ->
gen_event:add_handler(alarm_handler, ?MODULE, self()),
Alarm1 = {alarm1, "this is the alarm"},
Alarm2 = {"alarm2", this_is_the_alarm},
Alarm3 = {{alarm3}, {this_is,"the_alarm"}},
alarm_handler:set_alarm(Alarm1),
alarm_handler:set_alarm(Alarm2),
alarm_handler:set_alarm(Alarm3),
test_server:messages_get(),
ok = alarm_handler:clear_alarm(alarm1),
reported(clear_alarm, alarm1),
ok = alarm_handler:clear_alarm("alarm2"),
reported(clear_alarm, "alarm2"),
ok = alarm_handler:clear_alarm({alarm3}),
reported(clear_alarm, {alarm3}),
[] = alarm_handler:get_alarms(),
my_yes = gen_event:delete_handler(alarm_handler, ?MODULE, []),
ok.
%%-----------------------------------------------------------------
swap(Config) when is_list(Config) ->
Alarm1 = {alarm1, "this is the alarm"},
Alarm2 = {"alarm2", this_is_the_alarm},
Alarm3 = {{alarm3}, {this_is,"the_alarm"}},
alarm_handler:set_alarm(Alarm1),
alarm_handler:set_alarm(Alarm2),
alarm_handler:set_alarm(Alarm3),
case gen_event:which_handlers(alarm_handler) of
[alarm_handler] ->
ok = gen_event:swap_handler(alarm_handler,
{alarm_handler, swap},
{?MODULE, self()}),
[?MODULE] = gen_event:which_handlers(alarm_handler),
Alarms = [Alarm3, Alarm2, Alarm1],
reported(swap_alarms, Alarms),
%% get_alarms is only valid with the default handler installed.
{error, _} = alarm_handler:get_alarms(),
my_yes = gen_event:delete_handler(alarm_handler,
?MODULE, []),
gen_event:add_handler(alarm_handler, alarm_handler, []),
ok;
_ ->
alarm_handler:clear_alarm(alarm1),
alarm_handler:clear_alarm("alarm2"),
alarm_handler:clear_alarm({alarm3}),
ok
end.
%%-----------------------------------------------------------------
%% Check that the alarm has been received.
%%-----------------------------------------------------------------
reported(Tag, Data) ->
receive
{Tag, Data} ->
test_server:messages_get(),
ok
after 1000 ->
test_server:fail(no_alarm_received)
end.
%%-----------------------------------------------------------------
%% The error_logger handler (gen_event behaviour).
%% Sends a notification to the Tester process about the events
%% generated by the Tester process.
%%-----------------------------------------------------------------
init(Tester) when is_pid(Tester) ->
{ok, Tester};
init({Tester, {alarm_handler,Alarms}}) -> % Swap from default handler.
Tester ! {swap_alarms, Alarms},
{ok, Tester}.
handle_event({set_alarm, Alarm}, Tester) ->
Tester ! {set_alarm, Alarm},
{ok, Tester};
handle_event({clear_alarm, AlarmId}, Tester) ->
Tester ! {clear_alarm, AlarmId},
{ok, Tester};
handle_event(_Event, Tester) ->
{ok, Tester}.
handle_info(_, Tester) ->
{ok, Tester}.
handle_call(_Query, Tester) -> {ok, {error, bad_query}, Tester}.
terminate(_Reason, _Tester) ->
my_yes.
