Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 1 | module Asterisk_Tests { |
| 2 | |
| 3 | /* Asterisk test suite in TTCN-3 |
| 4 | * (C) 2024 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de> |
| 5 | * All rights reserved. |
| 6 | * Author: Pau Espin Pedrol <pespin@sysmocom.de> |
| 7 | * |
| 8 | * Released under the terms of GNU General Public License, Version 2 or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * SPDX-License-Identifier: GPL-2.0-or-later |
| 12 | */ |
| 13 | |
Pau Espin Pedrol | 05eaa1a | 2024-04-02 12:56:26 +0200 | [diff] [blame] | 14 | import from TCCOpenSecurity_Functions all; |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 15 | import from General_Types all; |
| 16 | import from Osmocom_Types all; |
| 17 | import from Native_Functions all; |
| 18 | import from Misc_Helpers all; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 19 | import from TELNETasp_PortType all; |
| 20 | import from AMI_Functions all; |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 21 | |
| 22 | import from SDP_Types all; |
| 23 | import from SDP_Templates all; |
| 24 | |
| 25 | import from SIP_Emulation all; |
| 26 | import from SIPmsg_Types all; |
| 27 | import from SIP_Templates all; |
| 28 | |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 29 | import from SIP_ConnectionHandler all; |
Pau Espin Pedrol | ac8a054 | 2024-04-19 17:30:57 +0200 | [diff] [blame] | 30 | import from IMS_ConnectionHandler all; |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 31 | |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 32 | modulepar { |
| 33 | charstring mp_local_sip_host := "127.0.0.2"; |
| 34 | integer mp_local_sip_port := 5060; |
| 35 | charstring mp_remote_sip_host := "127.0.0.1"; |
| 36 | integer mp_remote_sip_port := 5060; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 37 | |
Pau Espin Pedrol | ac8a054 | 2024-04-19 17:30:57 +0200 | [diff] [blame] | 38 | charstring mp_local_ims_host := "127.0.0.3"; |
| 39 | integer mp_local_ims_port := 5060; |
| 40 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 41 | /* Asterisk AMI: */ |
| 42 | charstring mp_ami_user := "test_user"; |
| 43 | charstring mp_ami_secret := "1234"; |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 44 | } |
| 45 | |
| 46 | type component test_CT { |
Pau Espin Pedrol | ac8a054 | 2024-04-19 17:30:57 +0200 | [diff] [blame] | 47 | /* Manages all local VoIP users Asterisk is serving: */ |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 48 | var SIP_Emulation_CT vc_SIP; |
Pau Espin Pedrol | ac8a054 | 2024-04-19 17:30:57 +0200 | [diff] [blame] | 49 | /* Manages the IMS server Asterisk connects to: */ |
| 50 | var SIP_Emulation_CT vc_IMS; |
| 51 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 52 | /* Connection towards Asterisk AMI iface: */ |
| 53 | var AMI_Adapter_CT vc_AMI; |
| 54 | port AMI_Msg_PT AMI_CLIENT; |
Pau Espin Pedrol | ac8a054 | 2024-04-19 17:30:57 +0200 | [diff] [blame] | 55 | |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 56 | port Coord_PT COORD; |
Pau Espin Pedrol | ac8a054 | 2024-04-19 17:30:57 +0200 | [diff] [blame] | 57 | port IMSCoord_PT IMS_COORD; |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 58 | } |
| 59 | |
Pau Espin Pedrol | 32167d8 | 2024-04-10 13:14:51 +0200 | [diff] [blame] | 60 | const charstring broadcast_sip_extension := "0500"; |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 61 | |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 62 | function f_init_ConnHdlrPars(integer idx := 1) runs on test_CT return SIPConnHdlrPars { |
| 63 | var template (value) CallPars cp := t_CallPars(mp_local_sip_host, 1234 + 2*idx); |
| 64 | var template (value) SIPConnHdlrPars pars := t_Pars(mp_local_sip_host, |
| 65 | mp_local_sip_port, |
| 66 | mp_remote_sip_host, |
| 67 | mp_remote_sip_port, |
| 68 | "0" & int2str(str2int(broadcast_sip_extension) + idx), |
| 69 | cp := cp); |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 70 | return valueof(pars); |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 71 | } |
| 72 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 73 | /* Initialize connection towards Asterisk AMI */ |
| 74 | private function f_init_ami() runs on test_CT { |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 75 | var charstring id := "Asterisk_Tests_AMI_EMU"; |
| 76 | vc_AMI := AMI_Adapter_CT.create(id); |
| 77 | connect(self:AMI_CLIENT, vc_AMI:CLIENT); |
| 78 | vc_AMI.start(f_AMI_Adapter_main()); |
| 79 | |
| 80 | |
| 81 | f_ami_action_login(AMI_CLIENT, mp_ami_user, mp_ami_secret); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 82 | } |
| 83 | |
Pau Espin Pedrol | ac8a054 | 2024-04-19 17:30:57 +0200 | [diff] [blame] | 84 | /* Local SIP UAs */ |
| 85 | private function f_init_sip_local() runs on test_CT { |
| 86 | var charstring id := "Asterisk_Tests_LOCAL_SIP_EMU"; |
| 87 | f_init_sip(vc_SIP, id); |
| 88 | } |
| 89 | |
| 90 | /* IMS Server connection */ |
| 91 | private function f_init_sip_ims() runs on test_CT { |
| 92 | var charstring id := "Asterisk_Tests_IMS_SIP_EMU"; |
| 93 | f_init_sip(vc_IMS, id); |
| 94 | } |
| 95 | |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 96 | function f_init() runs on test_CT { |
Pau Espin Pedrol | ac8a054 | 2024-04-19 17:30:57 +0200 | [diff] [blame] | 97 | var charstring id; |
| 98 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 99 | f_init_ami(); |
Pau Espin Pedrol | ac8a054 | 2024-04-19 17:30:57 +0200 | [diff] [blame] | 100 | f_init_sip_local(); |
| 101 | f_init_sip_ims(); |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 102 | log("end of f_init"); |
| 103 | } |
| 104 | |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 105 | function f_start_handler(void_fn fn, SIPConnHdlrPars pars) |
| 106 | runs on test_CT return SIPConnHdlr { |
| 107 | var SIPConnHdlr vc_conn; |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 108 | var charstring id := testcasename() & "-ConnHdlr-" & pars.user; |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 109 | |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 110 | vc_conn := SIPConnHdlr.create(id) alive; |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 111 | |
| 112 | connect(vc_conn:SIP, vc_SIP:CLIENT); |
| 113 | connect(vc_conn:SIP_PROC, vc_SIP:CLIENT_PROC); |
| 114 | |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 115 | connect(vc_conn:COORD, self:COORD); |
| 116 | |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 117 | vc_conn.start(f_handler_init(fn, id, pars)); |
| 118 | return vc_conn; |
| 119 | } |
| 120 | |
Pau Espin Pedrol | 05eaa1a | 2024-04-02 12:56:26 +0200 | [diff] [blame] | 121 | /* Test SIP registration of local clients */ |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 122 | private function f_TC_internal_registration(charstring id) runs on SIPConnHdlr { |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 123 | |
| 124 | f_SIP_register(); |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 125 | // f_SIP_deregister(); |
| 126 | setverdict(pass); |
| 127 | } |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 128 | testcase TC_internal_registration() runs on test_CT { |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 129 | var SIPConnHdlrPars pars; |
| 130 | var SIPConnHdlr vc_conn; |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 131 | f_init(); |
| 132 | pars := f_init_ConnHdlrPars(); |
| 133 | vc_conn := f_start_handler(refers(f_TC_internal_registration), pars); |
| 134 | vc_conn.done; |
| 135 | } |
| 136 | |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 137 | /* Successful SIP MO-MT Call between local clients: */ |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 138 | private function f_TC_internal_call_mo(charstring id) runs on SIPConnHdlr { |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 139 | |
| 140 | f_SIP_register(); |
| 141 | COORD.send(COORD_CMD_REGISTERED); |
| 142 | |
| 143 | COORD.receive(COORD_CMD_START); |
| 144 | f_SIP_mo_call_setup(); |
| 145 | COORD.send(COORD_CMD_CALL_ESTABLISHED); |
| 146 | |
| 147 | COORD.receive(COORD_CMD_HANGUP); |
| 148 | f_SIP_do_call_hangup(); |
| 149 | |
| 150 | setverdict(pass); |
| 151 | } |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 152 | private function f_TC_internal_call_mt(charstring id) runs on SIPConnHdlr { |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 153 | |
| 154 | f_create_sip_expect(valueof(ts_SipUrl_from_Addr_Union(g_pars.cp.called.addr))); |
| 155 | |
| 156 | f_SIP_register(); |
| 157 | COORD.send(COORD_CMD_REGISTERED); |
| 158 | |
Pau Espin Pedrol | 32167d8 | 2024-04-10 13:14:51 +0200 | [diff] [blame] | 159 | if (g_pars.cp.mt.exp_cancel) { |
| 160 | as_SIP_mt_call_cancelled(); |
| 161 | COORD.send(COORD_CMD_CALL_CANCELLED); |
| 162 | setverdict(pass); |
| 163 | return; |
| 164 | } |
| 165 | |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 166 | as_SIP_mt_call_accept(); |
| 167 | COORD.send(COORD_CMD_CALL_ESTABLISHED); |
| 168 | |
| 169 | /* Once MO hangs up, Asterisk updates us to point RTP to it: */ |
| 170 | as_SIP_exp_call_update(g_pars.cp.sip_seq_nr + 1); |
| 171 | as_SIP_exp_call_hangup(g_pars.cp.sip_seq_nr + 1); |
| 172 | |
| 173 | setverdict(pass); |
| 174 | } |
| 175 | testcase TC_internal_call_momt() runs on test_CT { |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 176 | var SIPConnHdlrPars pars[2]; |
| 177 | var SIPConnHdlr vc_conn[2]; |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 178 | |
| 179 | f_init(); |
| 180 | |
| 181 | pars[0] := f_init_ConnHdlrPars(idx := 1); |
| 182 | pars[1] := f_init_ConnHdlrPars(idx := 2); |
| 183 | |
| 184 | pars[0].cp.calling := pars[0].registrar_sip_record; |
| 185 | pars[0].cp.called := pars[1].registrar_sip_record; |
| 186 | |
| 187 | pars[1].cp.calling := pars[0].registrar_sip_record; |
| 188 | pars[1].cp.called := pars[1].local_sip_record; |
| 189 | |
| 190 | vc_conn[0] := f_start_handler(refers(f_TC_internal_call_mo), pars[0]); |
| 191 | vc_conn[1] := f_start_handler(refers(f_TC_internal_call_mt), pars[1]); |
| 192 | |
| 193 | interleave { |
| 194 | [] COORD.receive(COORD_CMD_REGISTERED) from vc_conn[0]; |
| 195 | [] COORD.receive(COORD_CMD_REGISTERED) from vc_conn[1]; |
| 196 | } |
| 197 | |
| 198 | COORD.send(COORD_CMD_START) to vc_conn[0]; |
| 199 | |
| 200 | interleave { |
| 201 | [] COORD.receive(COORD_CMD_CALL_ESTABLISHED) from vc_conn[0]; |
| 202 | [] COORD.receive(COORD_CMD_CALL_ESTABLISHED) from vc_conn[1]; |
| 203 | } |
| 204 | |
Pau Espin Pedrol | 32167d8 | 2024-04-10 13:14:51 +0200 | [diff] [blame] | 205 | /* Call on-going */ |
| 206 | f_sleep(1.0); |
| 207 | |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 208 | COORD.send(COORD_CMD_HANGUP) to vc_conn[0]; |
| 209 | |
| 210 | |
| 211 | vc_conn[0].done; |
| 212 | vc_conn[1].done; |
| 213 | } |
| 214 | |
Pau Espin Pedrol | 32167d8 | 2024-04-10 13:14:51 +0200 | [diff] [blame] | 215 | /* One of the users calls (INVITE) shared extension, which makes all other user |
| 216 | * equipments ring (INVITE). The first one to pick up the call (OK 200) gets the |
| 217 | * call established (ACK), others get a CANCEL event. */ |
| 218 | private function TC_internal_call_all_Nregistered(integer num_conns := 2) runs on test_CT { |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 219 | var SIPConnHdlrList vc_conn_list := {}; |
Pau Espin Pedrol | 32167d8 | 2024-04-10 13:14:51 +0200 | [diff] [blame] | 220 | const integer vc_conn_mo_idx := 0; /* Index of MO leg in vc_conn_list */ |
| 221 | const integer vc_conn_mt_idx := 1; /* Index of MT leg in vc_conn_list, peer picking up first the call */ |
| 222 | var SipAddr broadcast_sip_record; |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 223 | var SIPConnHdlrPars pars_mo; |
Pau Espin Pedrol | 32167d8 | 2024-04-10 13:14:51 +0200 | [diff] [blame] | 224 | |
| 225 | f_init(); |
| 226 | |
| 227 | broadcast_sip_record := valueof(ts_SipAddr(ts_HostPort(mp_local_sip_host), |
| 228 | ts_UserInfo(broadcast_sip_extension))); |
| 229 | |
| 230 | for (var integer i := 0; i < num_conns; i := i + 1) { |
Pau Espin Pedrol | caf028d | 2024-04-18 13:47:07 +0200 | [diff] [blame] | 231 | var SIPConnHdlrPars pars; |
| 232 | var SIPConnHdlr vc_conn; |
Pau Espin Pedrol | 32167d8 | 2024-04-10 13:14:51 +0200 | [diff] [blame] | 233 | pars := f_init_ConnHdlrPars(idx := i + 1); |
| 234 | if (i == vc_conn_mo_idx) { /* MO */ |
| 235 | pars.cp.calling := pars.registrar_sip_record; |
| 236 | pars.cp.called := broadcast_sip_record; |
| 237 | vc_conn := f_start_handler(refers(f_TC_internal_call_mo), pars); |
| 238 | pars_mo := pars; |
| 239 | } else { /* MT */ |
| 240 | pars.cp.calling := pars_mo.registrar_sip_record; |
| 241 | pars.cp.called := pars.local_sip_record; |
| 242 | pars.cp.mt.wait_coord_cmd_pickup := true; |
| 243 | if (i != vc_conn_mt_idx) { |
| 244 | /* Only first MT picking up (OK 200 INVITE) will be ACKed, others CANCELed: */ |
| 245 | pars.cp.mt.exp_cancel := true; |
| 246 | } |
| 247 | vc_conn := f_start_handler(refers(f_TC_internal_call_mt), pars); |
| 248 | } |
| 249 | vc_conn_list := vc_conn_list & { vc_conn }; |
| 250 | } |
| 251 | |
| 252 | /* Wait all users are registered: */ |
| 253 | for (var integer i := 0; i < num_conns; i := i + 1) { |
| 254 | /* Note: "from vc_conn_list[i]" can't be used since they may arrive from components in any order: */ |
| 255 | COORD.receive(COORD_CMD_REGISTERED); |
| 256 | } |
| 257 | |
| 258 | /* Ask MO user to start the call: */ |
| 259 | COORD.send(COORD_CMD_START) to vc_conn_list[vc_conn_mo_idx]; |
| 260 | |
| 261 | /* Make sure the desired MT is the one picking up first the call: */ |
| 262 | COORD.send(COORD_CMD_PICKUP) to vc_conn_list[vc_conn_mt_idx]; |
| 263 | interleave { |
| 264 | [] COORD.receive(COORD_CMD_CALL_ESTABLISHED) from vc_conn_list[vc_conn_mo_idx]; |
| 265 | [] COORD.receive(COORD_CMD_CALL_ESTABLISHED) from vc_conn_list[vc_conn_mt_idx]; |
| 266 | } |
| 267 | |
| 268 | /* Pick up from other phone calls and expect CANCEL: */ |
| 269 | for (var integer i := 0; i < num_conns; i := i + 1) { |
| 270 | if (i != vc_conn_mo_idx and i != vc_conn_mt_idx) { |
| 271 | COORD.send(COORD_CMD_PICKUP) to vc_conn_list[i]; |
| 272 | COORD.receive(COORD_CMD_CALL_CANCELLED) from vc_conn_list[i]; |
| 273 | } |
| 274 | } |
| 275 | |
| 276 | /* Call on-going */ |
| 277 | f_sleep(1.0); |
| 278 | |
| 279 | COORD.send(COORD_CMD_HANGUP) to vc_conn_list[vc_conn_mo_idx]; |
| 280 | |
| 281 | for (var integer i := 0; i < num_conns; i := i + 1) { |
| 282 | vc_conn_list[i].done; |
| 283 | } |
| 284 | } |
| 285 | testcase TC_internal_call_all_2registered() runs on test_CT { |
| 286 | TC_internal_call_all_Nregistered(2); |
| 287 | } |
| 288 | testcase TC_internal_call_all_3registered() runs on test_CT { |
| 289 | TC_internal_call_all_Nregistered(3); |
| 290 | } |
| 291 | testcase TC_internal_call_all_4registered() runs on test_CT { |
| 292 | TC_internal_call_all_Nregistered(4); |
| 293 | } |
| 294 | |
Pau Espin Pedrol | 05eaa1a | 2024-04-02 12:56:26 +0200 | [diff] [blame] | 295 | testcase TC_selftest() runs on test_CT { |
| 296 | f_sip_digest_selftest(); |
| 297 | setverdict(pass); |
| 298 | } |
| 299 | |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 300 | control { |
| 301 | execute( TC_internal_registration() ); |
Pau Espin Pedrol | 7011bf4 | 2024-04-08 17:56:58 +0200 | [diff] [blame] | 302 | execute( TC_internal_call_momt() ); |
Pau Espin Pedrol | 32167d8 | 2024-04-10 13:14:51 +0200 | [diff] [blame] | 303 | execute( TC_internal_call_all_2registered() ); |
| 304 | execute( TC_internal_call_all_3registered() ); |
| 305 | execute( TC_internal_call_all_4registered() ); |
Pau Espin Pedrol | 37ee0ed | 2024-03-28 21:17:12 +0100 | [diff] [blame] | 306 | } |
| 307 | |
| 308 | } |