-
Notifications
You must be signed in to change notification settings - Fork 51
/
integration.erl
422 lines (402 loc) · 13.5 KB
/
integration.erl
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
%% The contents of this file are subject to the Common Public Attribution
%% License Version 1.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://opensource.org/licenses/cpal_1.0. The License is based on the
%% Mozilla Public License Version 1.1 but Sections 14 and 15 have been
%% added to cover use of software over a computer network and provide for
%% limited attribution for the Original Developer. In addition, Exhibit A
%% has been modified to be consistent with Exhibit B.
%%
%% Software distributed under the License is distributed on an “AS IS”
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
%% License for the specific language governing rights and limitations
%% under the License.
%%
%% The Original Code is OpenACD.
%%
%% The Initial Developers of the Original Code is
%% Andrew Thompson and Micah Warren.
%%
%% All portions of the code written by the Initial Developers are Copyright
%% (c) 2008-2009 SpiceCSM.
%% All Rights Reserved.
%%
%% Contributor(s):
%%
%% Andrew Thompson <andrew at hijacked dot us>
%% Micah Warren <micahw at lordnull dot com>
%%
%% @doc Helper module to facilitate speaking to an integration gen_server. The
%% integration server is assumed to have already been started with the name of
%% `integration'. If it has not, the functions will return
%% `{error, nointegration}'.
%%
%% This tries to enforce valid returns from the integration server. If it
%% detects an invalid reply, it will throw an exection with a tuple; the first
%% element being `badreturn'.
%%
%% A module attempting to act as an integration point MUST respond properly
%% to handle_call, otherwise it might as well not event run.
%% <table border="1">
%% <tr>
%% <th>Message</th>
%% <th>Reply</th>
%% </tr>
%% <tr>
%% <td>`{agent_exists, LoginName :: string()}'</td>
%% <td>`true | false'</td>
%% </tr>
%% <tr>
%% <td>`{agent_auth, LoginName :: string(), PlainPassword :: string(), Extended :: [any()]}'</td>
%% <td>`deny | destroy | {ok, Id :: string(), Profile :: string(), agent | admin | supervisor, Extended :: [any()]}'</td>
%% </tr>
%% <tr>
%% <td>`{client_exists, id, Id :: string()}'</td>
%% <td>`true | false'</td>
%% </tr>
%% <tr>
%% <td>`{client_exists, label, Label :: string()}'</td>
%% <td>`true | false'</td>
%% </tr>
%% <tr>
%% <td>`{get_client, id, Id :: string()}'</td>
%% <td>`none | {ok, Id :: string(), Label :: string(), Options :: [any()]}'</td>
%% </tr>
%% <tr>
%% <td>`{get_client, label, Label :: string()}'</td>
%% <td>`none | {ok, Id :: string(), Label :: string(), Options :: [any()]}'</td>
%% </tr>
%% <tr>
%% <td>`{get_queue, Queue :: string()}'</td>
%% <td>`none | {ok, Name :: string(), Weight :: non_neg_integer(), Skills :: [skill()], HoldMusic :: string() | undefined, Group :: string()}'</td>
%% </tr>
%% <tr>
%% <td>`{get_queue_group, QueueGroup :: string()}'</td>
%% <td>`none | {ok, Name :: string(), Recipe :: recipe(), Skills :: [skill()], Sort :: non_neg_integer(), Protected :: boolean()}'</td>
%% </tr>
%% <tr>
%% <td>`{get_skill, Skill :: atom()}'</td>
%% <td>`none | {ok, SkillAtom :: atom(), Name :: string(), Protected :: boolean(), Desc :: string(), Group :: string()}'</td>
%% </tr>
%% <tr>
%% <td>`{get_profile, Name :: string()}'</td>
%% <td>`none | {ok, Name :: string(), Id :: string(), Order :: non_neg_integer(), Skills :: [skill()]}'</td>
%% </tr>
%% </table>
-module(integration).
-author(micahw).
-include("log.hrl").
-include("queue.hrl").
-ifdef(TEST).
-include_lib("eunit/include/eunit.hrl").
-endif.
-export([
agent_exists/1,
agent_auth/3,
client_exists/1,
client_exists/2,
get_client/2,
get_queue/1,
get_queue_group/1,
get_skill/1,
get_profile/1
]).
%% @doc Returns `true' if an agent with the loging `Agent' exists, `false'
%% otherwise.
-spec(agent_exists/1 :: (Agent :: string()) -> boolean()).
agent_exists(Agent) ->
Out = do_call({agent_exists, Agent}),
Test = fun(In) ->
is_boolean(In)
end,
check_return(Out, Test).
%% @doc Attempts to authenticate `Agent' with plaintext password `Password'.
-type(profile() :: string()).
-type(skill() :: atom() | {atom(), any()}).
-type(skill_list() :: [skill()]).
-type(profile_data() :: {profile(), skill_list()} | profile() | skill_list()).
-type(security() :: 'admin' | 'agent' | 'supervisor').
-spec(agent_auth/3 :: (Agent :: string(), Password :: string(), Extended :: [{atom(), any()}]) -> {ok, string(), profile_data(), security(), [{atom(),any()}]} | 'deny' | 'destroy' | {'error', 'nointegration'}).
agent_auth(Agent, Password, Extended) ->
Out = do_call({agent_auth, Agent, Password, Extended}),
Test = fun
({ok, _Id, _Profile, Security, _Extended}) ->
case Security of
Lvl when Lvl =:= admin; Lvl =:= agent; Lvl =:= supervisor ->
true;
_Else ->
false
end;
(deny) ->
true;
(destroy) ->
true;
(_Else) ->
false
end,
check_return(Out, Test).
%% @doc Same as `client_exists(label, Label)'.
-spec(client_exists/1 :: (Label :: string()) -> boolean()).
client_exists(Label) ->
client_exists(label, Label).
%% @doc `true' or `false' based on the existance of a client who's `Key' is `Value'.
-type(client_key() :: 'label' | 'id').
-spec(client_exists/2 :: (Key :: client_key(), Value :: string()) -> boolean()).
client_exists(Key, Value) ->
Out = do_call({client_exists, Key, Value}),
Test = fun(In) ->
is_boolean(In)
end,
check_return(Out, Test).
%% @doc Retrieve a client who's unique Attribute (label or comboid) is Value.
-type(label() :: string()).
-type(client_id() :: string()).
-type(url_option() :: {url_pop, string()}).
-type(client_option() :: url_option()).
-type(client_options() :: [client_option()]).
-spec(get_client/2 :: (Key :: client_key(), Value :: string()) -> 'none' | {ok, client_id(), label(), client_options()} | {'error', 'nointegration'}).
get_client(Key, Value) ->
Out = do_call({get_client, Key, Value}),
Test = fun
(none) ->
true;
({ok, _Id, _Label, _Options}) ->
true;
(_Else) ->
false
end,
check_return(Out, Test).
%% @doc Retrieve a queue by name
-spec(get_queue/1 :: (Name :: string()) -> 'none' | {ok, string(), non_neg_integer(), [atom()], recipe() | undefined, string()} | {error, nointegration}).
get_queue(Queue) ->
Out = do_call({get_queue, Queue}),
Test = fun
(none) ->
true;
({ok, _Name, _Weight, _Skills, _Recipe, _HoldMusic, _Group}) ->
true;
(_Else) ->
false
end,
check_return(Out, Test).
%% @doc Retrieve a queue by name
-spec(get_queue_group/1 :: (Name :: string()) -> 'none' | {ok, string(), recipe(), [atom()], boolean()} | {error, nointegration}).
get_queue_group(QueueGroup) ->
Out = do_call({get_queue_group, QueueGroup}),
Test = fun
(none) ->
true;
({ok, _Name, _Recipe, _Skills, _Sort, _Protected}) ->
true;
(_Else) ->
false
end,
check_return(Out, Test).
%% @doc Retrieve a skill
-spec(get_skill/1 :: (Atom :: atom()) -> 'none' | {ok, atom(), string(), boolean(), string(), string()}).
get_skill(Skill) ->
Out = do_call({get_skill, Skill}),
Test = fun
(none) ->
true;
({ok, _Skillatom, _Skillname, _Skillprotected, _Skilldesc, _Skillgroup}) ->
true;
(_Else) ->
false
end,
check_return(Out, Test).
%% @doc Retrieve a profile (agent group)
get_profile(Profile) ->
Out = do_call({get_profile, Profile}),
Test = fun
(none) ->
true;
({ok, _Name, _Id, _Order, _Options, _Skills}) ->
true;
(_Else) ->
false
end,
check_return(Out, Test).
do_call(Message) ->
try gen_server:call(integration, Message, 4000) of
Reply ->
Reply
catch
exit:{noproc, {gen_server, call, _Requestargs}} ->
{error, nointegration};
exit:{timeout, {gen_server, call, _Requestargs}} ->
timeout
end.
check_return({error, nointegration} = O, _Test) ->
O;
check_return(Out, Test) when is_function(Test)->
case Test(Out) of
true ->
Out;
false ->
throw({badreturn, Out})
end.
-ifdef(TEST).
no_integration_test_() ->
[?_assertEqual({error, nointegration}, do_call("a message")),
?_assertEqual({error, nointegration}, get_client(label, "a_client")),
?_assertEqual({error, nointegration}, client_exists(comboid, "00010001")),
?_assertEqual({error, nointegration}, agent_auth("agent", "password", [])),
?_assertEqual({error, nointegration}, agent_exists("agent")),
?_assertEqual({error, nointegration}, get_queue("queue")),
?_assertEqual({error, nointegration}, get_queue_group("queuegroup")),
?_assertEqual({error, nointegration}, get_skill("skill"))].
bad_integration_test_() ->
{foreach,
fun() ->
{ok, Mock} = gen_server_mock:named({local, integration}),
gen_server_mock:expect_call(Mock, fun(_Whatever, _From, State) -> {ok, gooberpants, State} end),
Mock
end,
fun(Mock) ->
unregister(integration),
gen_server_mock:stop(Mock)
end,
[?_assertThrow({badreturn, gooberpants}, get_client(label, "a_client")),
?_assertThrow({badreturn, gooberpants}, client_exists(label, "a_client")),
?_assertThrow({badreturn, gooberpants}, agent_auth("agent", "password", [])),
?_assertThrow({badreturn, gooberpants}, agent_exists("agent")),
?_assertThrow({badreturn, gooberpants}, get_queue("queue")),
?_assertThrow({badreturn, gooberpants}, get_queue_group("queuegroup")),
?_assertThrow({badreturn, gooberpants}, get_skill("skill")),
?_assertThrow({badreturn, gooberpants}, get_profile("profile")),
fun(Mock) ->
{"integration hits timeout",
fun() ->
gen_server:call(Mock, "clearing useless expect"),
gen_server_mock:expect_call(Mock, fun(_Whatever, _From, State) ->
timer:sleep(4500),
{ok, gooberpants, State}
end),
?assertThrow({badreturn, timeout}, client_exists(label, "a_client"))
end}
end]}.
good_integration_test_() ->
{foreach,
fun() ->
{ok, Mock} = gen_server_mock:named({local, integration}),
Mock
end,
fun(Mock) ->
unregister(integration),
gen_server_mock:stop(Mock)
end,
[fun(Mock) ->
{"agent exists",
fun() ->
gen_server_mock:expect_call(Mock, fun({agent_exists, "agent"}, _, State) -> {ok, true, State} end),
?assertEqual(true, agent_exists("agent"))
end}
end,
fun(Mock) ->
{"agent doesn't exist",
fun() ->
gen_server_mock:expect_call(Mock, fun({agent_exists, "agent"}, _, State) -> {ok, false, State} end),
?assertEqual(false, agent_exists("agent"))
end}
end,
fun(Mock) ->
{"agent auth success",
fun() ->
gen_server_mock:expect_call(Mock, fun({agent_auth, "agent", "password", []}, _, State) -> {ok, {ok, "testid", "Default", agent, []}, State} end),
?assertEqual({ok, "testid", "Default", agent, []}, agent_auth("agent", "password", []))
end}
end,
fun(Mock) ->
{"agent auth fail",
fun() ->
gen_server_mock:expect_call(Mock, fun({agent_auth, "agent", "password", []}, _, State) -> {ok, deny, State} end),
?assertEqual(deny, agent_auth("agent", "password", []))
end}
end,
fun(Mock) ->
{"client exists",
fun() ->
gen_server_mock:expect_call(Mock, fun({client_exists, label, "client"}, _, State) -> {ok, true, State} end),
?assertEqual(true, client_exists(label, "client"))
end}
end,
fun(Mock) ->
{"client doesn't exist",
fun() ->
gen_server_mock:expect_call(Mock, fun({client_exists, label, "client"}, _, State) -> {ok, false, State} end),
?assertEqual(false, client_exists(label, "client"))
end}
end,
fun(Mock) ->
{"can get client",
fun() ->
gen_server_mock:expect_call(Mock, fun({get_client, label, "client"}, _, State) -> {ok, {ok, "00010001", "client", []}, State} end),
?assertEqual({ok, "00010001", "client", []}, get_client(label, "client"))
end}
end,
fun(Mock) ->
{"can't get the client",
fun() ->
gen_server_mock:expect_call(Mock, fun({get_client, label, "client"}, _, State) -> {ok, none, State} end),
?assertEqual(none, get_client(label, "client"))
end}
end,
fun(Mock) ->
{"can get queue",
fun() ->
gen_server_mock:expect_call(Mock, fun({get_queue, "queue"}, _, State) -> {ok, {ok, "name", 10, [], [], undefined, "group"}, State} end),
?assertEqual({ok, "name", 10, [], [], undefined, "group"}, get_queue("queue"))
end}
end,
fun(Mock) ->
{"can't get queue",
fun() ->
gen_server_mock:expect_call(Mock, fun({get_queue, "queue"}, _, State) -> {ok, none, State} end),
?assertEqual(none, get_queue("queue"))
end}
end,
fun(Mock) ->
{"can get queue group",
fun() ->
gen_server_mock:expect_call(Mock, fun({get_queue_group, "queuegroup"}, _, State) -> {ok, {ok, "queuegroup", [], [], 10, true}, State} end),
?assertEqual({ok, "queuegroup", [], [], 10, true}, get_queue_group("queuegroup"))
end}
end,
fun(Mock) ->
{"can't get queue group",
fun() ->
gen_server_mock:expect_call(Mock, fun({get_queue_group, "queuegroup"}, _, State) -> {ok, none, State} end),
?assertEqual(none, get_queue_group("queuegroup"))
end}
end,
fun(Mock) ->
{"can get skill",
fun() ->
gen_server_mock:expect_call(Mock, fun({get_skill, skill}, _, State) -> {ok, {ok, skill, "skill", true, "desc", "misc"}, State} end),
?assertEqual({ok, skill, "skill", true, "desc", "misc"}, get_skill(skill))
end}
end,
fun(Mock) ->
{"can't get skill",
fun() ->
gen_server_mock:expect_call(Mock, fun({get_skill, skill}, _, State) -> {ok, none, State} end),
?assertEqual(none, get_skill(skill))
end}
end,
fun(Mock) ->
{"can get profile",
fun() ->
gen_server_mock:expect_call(Mock, fun({get_profile, "profile"}, _, State) -> {ok, {ok, "profile", "id", 10, [{option, a}], [skill]}, State} end),
?assertEqual({ok, "profile", "id", 10, [{option, a}], [skill]}, get_profile("profile"))
end}
end,
fun(Mock) ->
{"can't get profile",
fun() ->
gen_server_mock:expect_call(Mock, fun({get_profile, profile}, _, State) -> {ok, none, State} end),
?assertEqual(none, get_profile(profile))
end}
end
]}.
-endif.