Oliver Smith | 6dbdf14 | 2019-12-10 13:21:11 +0100 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 2 | |
| 3 | # (C) 2013 by Jacob Erlbeck <jerlbeck@sysmocom.de> |
Holger Hans Peter Freyther | 3adb772 | 2014-03-04 17:16:58 +0100 | [diff] [blame] | 4 | # (C) 2014 by Holger Hans Peter Freyther |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 5 | # based on vty_test_runner.py: |
| 6 | # (C) 2013 by Katerina Barone-Adesi <kat.obsc@gmail.com> |
| 7 | # (C) 2013 by Holger Hans Peter Freyther |
| 8 | # based on bsc_control.py. |
| 9 | |
| 10 | # This program is free software: you can redistribute it and/or modify |
| 11 | # it under the terms of the GNU General Public License as published by |
| 12 | # the Free Software Foundation, either version 3 of the License, or |
| 13 | # (at your option) any later version. |
| 14 | |
| 15 | # This program is distributed in the hope that it will be useful, |
| 16 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 18 | # GNU General Public License for more details. |
| 19 | |
| 20 | # You should have received a copy of the GNU General Public License |
| 21 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 22 | |
| 23 | import os |
| 24 | import time |
| 25 | import unittest |
| 26 | import socket |
| 27 | import sys |
| 28 | import struct |
| 29 | |
| 30 | import osmopy.obscvty as obscvty |
| 31 | import osmopy.osmoutil as osmoutil |
Max | 60383a1 | 2017-11-23 16:33:33 +0100 | [diff] [blame] | 32 | from osmopy.osmo_ipa import Ctrl, IPA |
Max | 310b730 | 2017-05-02 16:10:07 +0200 | [diff] [blame] | 33 | |
Neels Hofmeyr | 476c4bb | 2017-02-24 17:55:11 +0100 | [diff] [blame] | 34 | # to be able to find $top_srcdir/doc/... |
| 35 | confpath = os.path.join(sys.path[0], '..') |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 36 | verbose = False |
| 37 | |
| 38 | class TestCtrlBase(unittest.TestCase): |
| 39 | |
| 40 | def ctrl_command(self): |
| 41 | raise Exception("Needs to be implemented by a subclass") |
| 42 | |
| 43 | def ctrl_app(self): |
| 44 | raise Exception("Needs to be implemented by a subclass") |
| 45 | |
| 46 | def setUp(self): |
| 47 | osmo_ctrl_cmd = self.ctrl_command()[:] |
| 48 | config_index = osmo_ctrl_cmd.index('-c') |
| 49 | if config_index: |
| 50 | cfi = config_index + 1 |
| 51 | osmo_ctrl_cmd[cfi] = os.path.join(confpath, osmo_ctrl_cmd[cfi]) |
| 52 | |
| 53 | try: |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 54 | self.proc = osmoutil.popen_devnull(osmo_ctrl_cmd) |
| 55 | except OSError: |
Oliver Smith | 6dbdf14 | 2019-12-10 13:21:11 +0100 | [diff] [blame] | 56 | print("Current directory: %s" % os.getcwd(), file=sys.stderr) |
| 57 | print("Consider setting -b", file=sys.stderr) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 58 | time.sleep(2) |
| 59 | |
| 60 | appstring = self.ctrl_app()[2] |
| 61 | appport = self.ctrl_app()[0] |
| 62 | self.connect("127.0.0.1", appport) |
| 63 | self.next_id = 1000 |
| 64 | |
| 65 | def tearDown(self): |
| 66 | self.disconnect() |
Vadim Yanitskiy | d3abcab | 2023-06-01 20:06:51 +0700 | [diff] [blame] | 67 | rc = osmoutil.end_proc(self.proc) |
| 68 | if rc is not None and rc != 0: |
| 69 | raise Exception("Process returned %d" % rc) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 70 | |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 71 | def disconnect(self): |
| 72 | if not (self.sock is None): |
| 73 | self.sock.close() |
| 74 | |
| 75 | def connect(self, host, port): |
| 76 | if verbose: |
Oliver Smith | 6dbdf14 | 2019-12-10 13:21:11 +0100 | [diff] [blame] | 77 | print("Connecting to host %s:%i" % (host, port)) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 78 | |
Neels Hofmeyr | acc6e83 | 2017-02-27 02:01:37 +0100 | [diff] [blame] | 79 | retries = 30 |
| 80 | while True: |
| 81 | try: |
| 82 | sck = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
| 83 | sck.setblocking(1) |
| 84 | sck.connect((host, port)) |
| 85 | except IOError: |
| 86 | retries -= 1 |
| 87 | if retries <= 0: |
| 88 | raise |
| 89 | time.sleep(.1) |
| 90 | continue |
| 91 | break |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 92 | self.sock = sck |
| 93 | return sck |
| 94 | |
| 95 | def send(self, data): |
| 96 | if verbose: |
Oliver Smith | 6dbdf14 | 2019-12-10 13:21:11 +0100 | [diff] [blame] | 97 | print("Sending \"%s\"" %(data)) |
Max | 310b730 | 2017-05-02 16:10:07 +0200 | [diff] [blame] | 98 | data = Ctrl().add_header(data) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 99 | return self.sock.send(data) == len(data) |
| 100 | |
| 101 | def send_set(self, var, value, id): |
| 102 | setmsg = "SET %s %s %s" %(id, var, value) |
| 103 | return self.send(setmsg) |
| 104 | |
| 105 | def send_get(self, var, id): |
| 106 | getmsg = "GET %s %s" %(id, var) |
| 107 | return self.send(getmsg) |
| 108 | |
| 109 | def do_set(self, var, value): |
| 110 | id = self.next_id |
| 111 | self.next_id += 1 |
| 112 | self.send_set(var, value, id) |
| 113 | return self.recv_msgs()[id] |
| 114 | |
| 115 | def do_get(self, var): |
| 116 | id = self.next_id |
| 117 | self.next_id += 1 |
| 118 | self.send_get(var, id) |
| 119 | return self.recv_msgs()[id] |
| 120 | |
| 121 | def recv_msgs(self): |
| 122 | responses = {} |
| 123 | data = self.sock.recv(4096) |
| 124 | while (len(data)>0): |
Max | 310b730 | 2017-05-02 16:10:07 +0200 | [diff] [blame] | 125 | (head, data) = IPA().split_combined(data) |
| 126 | answer = Ctrl().rem_header(head) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 127 | if verbose: |
Oliver Smith | 6dbdf14 | 2019-12-10 13:21:11 +0100 | [diff] [blame] | 128 | print("Got message:", answer) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 129 | (mtype, id, msg) = answer.split(None, 2) |
| 130 | id = int(id) |
| 131 | rsp = {'mtype': mtype, 'id': id} |
| 132 | if mtype == "ERROR": |
| 133 | rsp['error'] = msg |
| 134 | else: |
Holger Hans Peter Freyther | 4ecc687 | 2014-03-04 15:38:00 +0100 | [diff] [blame] | 135 | split = msg.split(None, 1) |
| 136 | rsp['var'] = split[0] |
| 137 | if len(split) > 1: |
| 138 | rsp['value'] = split[1] |
| 139 | else: |
| 140 | rsp['value'] = None |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 141 | responses[id] = rsp |
| 142 | |
| 143 | if verbose: |
Oliver Smith | 6dbdf14 | 2019-12-10 13:21:11 +0100 | [diff] [blame] | 144 | print("Decoded replies: ", responses) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 145 | |
| 146 | return responses |
| 147 | |
| 148 | |
Max | abb24a2 | 2017-11-29 15:09:04 +0100 | [diff] [blame] | 149 | class TestCtrlMSC(TestCtrlBase): |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 150 | def ctrl_command(self): |
Max | abb24a2 | 2017-11-29 15:09:04 +0100 | [diff] [blame] | 151 | return ["./src/osmo-msc/osmo-msc", "-c", |
| 152 | "doc/examples/osmo-msc/osmo-msc.cfg"] |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 153 | |
| 154 | def ctrl_app(self): |
Max | abb24a2 | 2017-11-29 15:09:04 +0100 | [diff] [blame] | 155 | return (4255, "./src/osmo-msc/osmo-msc", "OsmoMSC", "msc") |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 156 | |
Max | abb24a2 | 2017-11-29 15:09:04 +0100 | [diff] [blame] | 157 | def testRateCounters(self): |
| 158 | r = self.do_get('rate_ctr.*') |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 159 | |
Max | abb24a2 | 2017-11-29 15:09:04 +0100 | [diff] [blame] | 160 | # FIXME: add MSC-specific CTRL test in here |
Holger Hans Peter Freyther | a273030 | 2014-03-23 18:08:26 +0100 | [diff] [blame] | 161 | |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 162 | if __name__ == '__main__': |
| 163 | import argparse |
| 164 | import sys |
| 165 | |
| 166 | workdir = '.' |
| 167 | |
| 168 | parser = argparse.ArgumentParser() |
| 169 | parser.add_argument("-v", "--verbose", dest="verbose", |
| 170 | action="store_true", help="verbose mode") |
| 171 | parser.add_argument("-p", "--pythonconfpath", dest="p", |
| 172 | help="searchpath for config") |
| 173 | parser.add_argument("-w", "--workdir", dest="w", |
| 174 | help="Working directory") |
| 175 | args = parser.parse_args() |
| 176 | |
| 177 | verbose_level = 1 |
| 178 | if args.verbose: |
| 179 | verbose_level = 2 |
| 180 | verbose = True |
| 181 | |
| 182 | if args.w: |
| 183 | workdir = args.w |
| 184 | |
| 185 | if args.p: |
| 186 | confpath = args.p |
| 187 | |
Oliver Smith | 6dbdf14 | 2019-12-10 13:21:11 +0100 | [diff] [blame] | 188 | print("confpath %s, workdir %s" % (confpath, workdir)) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 189 | os.chdir(workdir) |
Oliver Smith | 6dbdf14 | 2019-12-10 13:21:11 +0100 | [diff] [blame] | 190 | print("Running tests for specific control commands") |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 191 | suite = unittest.TestSuite() |
Max | abb24a2 | 2017-11-29 15:09:04 +0100 | [diff] [blame] | 192 | suite.addTest(unittest.TestLoader().loadTestsFromTestCase(TestCtrlMSC)) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 193 | res = unittest.TextTestRunner(verbosity=verbose_level).run(suite) |
| 194 | sys.exit(len(res.errors) + len(res.failures)) |