Pau Espin Pedrol | 2f89547 | 2017-11-28 20:08:17 +0100 | [diff] [blame] | 1 | #!/usr/bin/env python2 |
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 |
| 32 | |
Max | 310b730 | 2017-05-02 16:10:07 +0200 | [diff] [blame] | 33 | # add $top_srcdir/contrib to find ipa.py |
| 34 | sys.path.append(os.path.join(sys.path[0], '..', 'contrib')) |
| 35 | |
| 36 | from ipa import Ctrl, IPA |
| 37 | |
Neels Hofmeyr | 476c4bb | 2017-02-24 17:55:11 +0100 | [diff] [blame] | 38 | # to be able to find $top_srcdir/doc/... |
| 39 | confpath = os.path.join(sys.path[0], '..') |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 40 | verbose = False |
| 41 | |
| 42 | class TestCtrlBase(unittest.TestCase): |
| 43 | |
| 44 | def ctrl_command(self): |
| 45 | raise Exception("Needs to be implemented by a subclass") |
| 46 | |
| 47 | def ctrl_app(self): |
| 48 | raise Exception("Needs to be implemented by a subclass") |
| 49 | |
| 50 | def setUp(self): |
| 51 | osmo_ctrl_cmd = self.ctrl_command()[:] |
| 52 | config_index = osmo_ctrl_cmd.index('-c') |
| 53 | if config_index: |
| 54 | cfi = config_index + 1 |
| 55 | osmo_ctrl_cmd[cfi] = os.path.join(confpath, osmo_ctrl_cmd[cfi]) |
| 56 | |
| 57 | try: |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 58 | self.proc = osmoutil.popen_devnull(osmo_ctrl_cmd) |
| 59 | except OSError: |
| 60 | print >> sys.stderr, "Current directory: %s" % os.getcwd() |
| 61 | print >> sys.stderr, "Consider setting -b" |
| 62 | time.sleep(2) |
| 63 | |
| 64 | appstring = self.ctrl_app()[2] |
| 65 | appport = self.ctrl_app()[0] |
| 66 | self.connect("127.0.0.1", appport) |
| 67 | self.next_id = 1000 |
| 68 | |
| 69 | def tearDown(self): |
| 70 | self.disconnect() |
| 71 | osmoutil.end_proc(self.proc) |
| 72 | |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 73 | def disconnect(self): |
| 74 | if not (self.sock is None): |
| 75 | self.sock.close() |
| 76 | |
| 77 | def connect(self, host, port): |
| 78 | if verbose: |
| 79 | print "Connecting to host %s:%i" % (host, port) |
| 80 | |
Neels Hofmeyr | acc6e83 | 2017-02-27 02:01:37 +0100 | [diff] [blame] | 81 | retries = 30 |
| 82 | while True: |
| 83 | try: |
| 84 | sck = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
| 85 | sck.setblocking(1) |
| 86 | sck.connect((host, port)) |
| 87 | except IOError: |
| 88 | retries -= 1 |
| 89 | if retries <= 0: |
| 90 | raise |
| 91 | time.sleep(.1) |
| 92 | continue |
| 93 | break |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 94 | self.sock = sck |
| 95 | return sck |
| 96 | |
| 97 | def send(self, data): |
| 98 | if verbose: |
| 99 | print "Sending \"%s\"" %(data) |
Max | 310b730 | 2017-05-02 16:10:07 +0200 | [diff] [blame] | 100 | data = Ctrl().add_header(data) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 101 | return self.sock.send(data) == len(data) |
| 102 | |
| 103 | def send_set(self, var, value, id): |
| 104 | setmsg = "SET %s %s %s" %(id, var, value) |
| 105 | return self.send(setmsg) |
| 106 | |
| 107 | def send_get(self, var, id): |
| 108 | getmsg = "GET %s %s" %(id, var) |
| 109 | return self.send(getmsg) |
| 110 | |
| 111 | def do_set(self, var, value): |
| 112 | id = self.next_id |
| 113 | self.next_id += 1 |
| 114 | self.send_set(var, value, id) |
| 115 | return self.recv_msgs()[id] |
| 116 | |
| 117 | def do_get(self, var): |
| 118 | id = self.next_id |
| 119 | self.next_id += 1 |
| 120 | self.send_get(var, id) |
| 121 | return self.recv_msgs()[id] |
| 122 | |
| 123 | def recv_msgs(self): |
| 124 | responses = {} |
| 125 | data = self.sock.recv(4096) |
| 126 | while (len(data)>0): |
Max | 310b730 | 2017-05-02 16:10:07 +0200 | [diff] [blame] | 127 | (head, data) = IPA().split_combined(data) |
| 128 | answer = Ctrl().rem_header(head) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 129 | if verbose: |
| 130 | print "Got message:", answer |
| 131 | (mtype, id, msg) = answer.split(None, 2) |
| 132 | id = int(id) |
| 133 | rsp = {'mtype': mtype, 'id': id} |
| 134 | if mtype == "ERROR": |
| 135 | rsp['error'] = msg |
| 136 | else: |
Holger Hans Peter Freyther | 4ecc687 | 2014-03-04 15:38:00 +0100 | [diff] [blame] | 137 | split = msg.split(None, 1) |
| 138 | rsp['var'] = split[0] |
| 139 | if len(split) > 1: |
| 140 | rsp['value'] = split[1] |
| 141 | else: |
| 142 | rsp['value'] = None |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 143 | responses[id] = rsp |
| 144 | |
| 145 | if verbose: |
| 146 | print "Decoded replies: ", responses |
| 147 | |
| 148 | return responses |
| 149 | |
Holger Hans Peter Freyther | a273030 | 2014-03-23 18:08:26 +0100 | [diff] [blame] | 150 | class TestCtrlSGSN(TestCtrlBase): |
| 151 | def ctrl_command(self): |
| 152 | return ["./src/gprs/osmo-sgsn", "-c", |
| 153 | "doc/examples/osmo-sgsn/osmo-sgsn.cfg"] |
| 154 | |
| 155 | def ctrl_app(self): |
| 156 | return (4251, "./src/gprs/osmo-sgsn", "OsmoSGSN", "sgsn") |
| 157 | |
| 158 | def testListSubscribers(self): |
| 159 | # TODO. Add command to mark a subscriber as active |
| 160 | r = self.do_get('subscriber-list-active-v1') |
| 161 | self.assertEquals(r['mtype'], 'GET_REPLY') |
| 162 | self.assertEquals(r['var'], 'subscriber-list-active-v1') |
| 163 | self.assertEquals(r['value'], None) |
| 164 | |
Holger Hans Peter Freyther | a273030 | 2014-03-23 18:08:26 +0100 | [diff] [blame] | 165 | def add_sgsn_test(suite, workdir): |
| 166 | if not os.path.isfile(os.path.join(workdir, "src/gprs/osmo-sgsn")): |
| 167 | print("Skipping the SGSN test") |
| 168 | return |
| 169 | test = unittest.TestLoader().loadTestsFromTestCase(TestCtrlSGSN) |
| 170 | suite.addTest(test) |
| 171 | |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 172 | if __name__ == '__main__': |
| 173 | import argparse |
| 174 | import sys |
| 175 | |
| 176 | workdir = '.' |
| 177 | |
| 178 | parser = argparse.ArgumentParser() |
| 179 | parser.add_argument("-v", "--verbose", dest="verbose", |
| 180 | action="store_true", help="verbose mode") |
| 181 | parser.add_argument("-p", "--pythonconfpath", dest="p", |
| 182 | help="searchpath for config") |
| 183 | parser.add_argument("-w", "--workdir", dest="w", |
| 184 | help="Working directory") |
| 185 | args = parser.parse_args() |
| 186 | |
| 187 | verbose_level = 1 |
| 188 | if args.verbose: |
| 189 | verbose_level = 2 |
| 190 | verbose = True |
| 191 | |
| 192 | if args.w: |
| 193 | workdir = args.w |
| 194 | |
| 195 | if args.p: |
| 196 | confpath = args.p |
| 197 | |
| 198 | print "confpath %s, workdir %s" % (confpath, workdir) |
| 199 | os.chdir(workdir) |
| 200 | print "Running tests for specific control commands" |
| 201 | suite = unittest.TestSuite() |
Holger Hans Peter Freyther | a273030 | 2014-03-23 18:08:26 +0100 | [diff] [blame] | 202 | add_sgsn_test(suite, workdir) |
Jacob Erlbeck | 0760a83 | 2013-09-16 11:20:28 +0200 | [diff] [blame] | 203 | res = unittest.TextTestRunner(verbosity=verbose_level).run(suite) |
| 204 | sys.exit(len(res.errors) + len(res.failures)) |