1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2012-2015. 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%
%%
%%
%% Tests of the disconnect_cb configuration.
%%
-module(diameter_dpr_SUITE).
-export([suite/0,
all/0,
groups/0,
init_per_group/2,
end_per_group/2]).
%% testcases
-export([start/1,
connect/1,
send_dpr/1,
remove_transport/1,
stop_service/1,
check/1,
stop/1]).
%% disconnect_cb
-export([disconnect/5]).
-include("diameter.hrl").
-include("diameter_gen_base_rfc6733.hrl").
%% ===========================================================================
-define(util, diameter_util).
-define(ADDR, {127,0,0,1}).
-define(CLIENT, "CLIENT").
-define(SERVER, "SERVER").
%% Config for diameter:start_service/2.
-define(SERVICE(Host),
[{'Origin-Host', Host},
{'Origin-Realm', "erlang.org"},
{'Host-IP-Address', [?ADDR]},
{'Vendor-Id', hd(Host)}, %% match this in disconnect/5
{'Product-Name', "OTP/diameter"},
{'Acct-Application-Id', [0]},
{restrict_connections, false},
{application, [{dictionary, diameter_gen_base_rfc6733},
{alias, common},
{module, #diameter_callback{_ = false}}]}]).
%% Disconnect reasons that diameter passes as the first argument of a
%% function configured as disconnect_cb.
-define(REASONS, [transport, service, application]).
%% Valid values for Disconnect-Cause.
-define(CAUSES, [0, rebooting, 1, busy, 2, goaway]).
%% Establish one client connection for each element of this list,
%% configured with disconnect/5, disconnect_cb returning the specified
%% value.
-define(RETURNS,
[[close, {dpr, [{cause, invalid}]}],
[ignore, close],
[]]
++ [[{dpr, [{timeout, 5000}, {cause, T}]}] || T <- ?CAUSES]).
%% ===========================================================================
suite() ->
[{timetrap, {seconds, 60}}].
all() ->
[start, send_dpr, stop | [{group, R} || R <- ?REASONS]].
%% The group determines how transports are terminated: by remove_transport,
%% stop_service or application stop.
groups() ->
Ts = tc(),
[{R, [], Ts} || R <- ?REASONS].
init_per_group(Name, Config) ->
[{group, Name} | Config].
end_per_group(_, _) ->
ok.
tc() ->
[start, connect, remove_transport, stop_service, check, stop].
%% ===========================================================================
%% start/stop testcases
start(_Config) ->
ok = diameter:start(),
ok = diameter:start_service(?SERVER, ?SERVICE(?SERVER)),
ok = diameter:start_service(?CLIENT, ?SERVICE(?CLIENT)).
send_dpr(_Config) ->
LRef = ?util:listen(?SERVER, tcp),
Ref = ?util:connect(?CLIENT, tcp, LRef, [{dpa_timeout, 10000}]),
#diameter_base_DPA{'Result-Code' = 2001}
= diameter:call(?CLIENT,
common,
['DPR', {'Origin-Host', "CLIENT.erlang.org"},
{'Origin-Realm', "erlang.org"},
{'Disconnect-Cause', 0}]),
ok = receive %% endure the transport dies on DPA
#diameter_event{service = ?CLIENT, info = {down, Ref, _, _}} ->
ok
after 5000 ->
erlang:process_info(self(), messages)
end.
connect(Config) ->
Pid = spawn(fun init/0), %% process for disconnect_cb to bang
Grp = group(Config),
LRef = ?util:listen(?SERVER, tcp),
Refs = [?util:connect(?CLIENT, tcp, LRef, opts(RCs, {Grp, Pid}))
|| RCs <- ?RETURNS],
?util:write_priv(Config, config, [Pid | Refs]).
%% Remove all the client transports only in the transport group.
remove_transport(Config) ->
transport == group(Config)
andalso (ok = diameter:remove_transport(?CLIENT, true)).
%% Stop the service only in the service group.
stop_service(Config) ->
service == group(Config)
andalso (ok = diameter:stop_service(?CLIENT)).
%% Check for callbacks before diameter:stop/0, not the other way around
%% for the timing reason explained below.
check(Config) ->
Grp = group(Config),
[Pid | Refs] = ?util:read_priv(Config, config),
Pid ! self(), %% ask for dictionary
Dict = receive {Pid, D} -> D end, %% get it
check(Refs, ?RETURNS, Grp, Dict). %% check for callbacks
stop(_Config) ->
ok = diameter:stop().
%% Whether or not there are callbacks after diameter:stop() depends on
%% timing as long as the server runs on the same node: a server
%% transport could close the connection before the client has chance
%% to apply its callback. Therefore, just check that there haven't
%% been any callbacks yet.
check(_, _, application, Dict) ->
[] = dict:to_list(Dict);
check([], [], _, _) ->
ok;
check([Ref | Refs], CBs, Grp, Dict) ->
check1(Ref, hd(CBs), Grp, Dict),
check(Refs, tl(CBs), Grp, Dict).
check1(Ref, [ignore | RCs], Reason, Dict) ->
check1(Ref, RCs, Reason, Dict);
check1(Ref, [_|_], Reason, Dict) ->
{ok, Reason} = dict:find(Ref, Dict); %% callback with expected reason
check1(Ref, [], _, Dict) ->
error = dict:find(Ref, Dict). %% no callback
%% ----------------------------------------
group(Config) ->
{group, Grp} = lists:keyfind(group, 1, Config),
Grp.
%% Configure the callback with the group name (= disconnect reason) as
%% extra argument.
opts(RCs, T) ->
[{disconnect_cb, {?MODULE, disconnect, [T, RC]}} || RC <- RCs].
%% Match the group name with the disconnect reason to ensure the
%% callback is being called as expected.
disconnect(Reason, Ref, Peer, {Reason, Pid}, RC) ->
io:format("disconnect: ~p ~p~n", [Ref, Reason]),
{_, #diameter_caps{vendor_id = {$C,$S}}} = Peer,
Pid ! {Reason, Ref},
RC.
init() ->
exit(recv(dict:new())).
recv(Dict) ->
receive
Pid when is_pid(Pid) ->
Pid ! {self(), Dict};
{Reason, Ref} ->
recv(dict:store(Ref, Reason, Dict))
end.
|
