Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running an osmo-hlr |
| 2 | # |
| 3 | # Copyright (C) 2016-2017 by sysmocom - s.f.m.c. GmbH |
| 4 | # |
| 5 | # Author: Neels Hofmeyr <neels@hofmeyr.de> |
| 6 | # |
| 7 | # This program is free software: you can redistribute it and/or modify |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 8 | # it under the terms of the GNU General Public License as |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 9 | # published by the Free Software Foundation, either version 3 of the |
| 10 | # License, or (at your option) any later version. |
| 11 | # |
| 12 | # This program is distributed in the hope that it will be useful, |
| 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 15 | # GNU General Public License for more details. |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 16 | # |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 17 | # You should have received a copy of the GNU General Public License |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
| 20 | import os |
| 21 | import re |
| 22 | import pprint |
Pau Espin Pedrol | 6610dfe | 2017-08-23 17:02:38 +0200 | [diff] [blame] | 23 | import sqlite3 |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 24 | |
| 25 | from . import log, util, config, template, process, osmo_ctrl, pcap_recorder |
| 26 | |
| 27 | class OsmoHlr(log.Origin): |
| 28 | suite_run = None |
| 29 | ip_address = None |
| 30 | run_dir = None |
| 31 | config_file = None |
| 32 | process = None |
| 33 | next_subscriber_id = 1 |
| 34 | |
| 35 | def __init__(self, suite_run, ip_address): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 36 | super().__init__(log.C_RUN, 'osmo-hlr_%s' % ip_address.get('addr')) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 37 | self.suite_run = suite_run |
| 38 | self.ip_address = ip_address |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 39 | self.bts = [] |
| 40 | |
| 41 | def start(self): |
| 42 | self.log('Starting osmo-hlr') |
Pau Espin Pedrol | d091233 | 2017-06-14 13:27:08 +0200 | [diff] [blame] | 43 | self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name())) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 44 | self.configure() |
| 45 | |
| 46 | inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst('osmo-hlr'))) |
| 47 | |
| 48 | binary = inst.child('bin', 'osmo-hlr') |
| 49 | if not os.path.isfile(binary): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 50 | raise log.Error('Binary missing:', binary) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 51 | lib = inst.child('lib') |
| 52 | if not os.path.isdir(lib): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 53 | raise log.Error('No lib/ in', inst) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 54 | |
| 55 | # bootstrap an empty hlr.db |
| 56 | self.db_file = self.run_dir.new_file('hlr.db') |
| 57 | sql_input = inst.child('share/doc/osmo-hlr/hlr.sql') |
| 58 | if not os.path.isfile(sql_input): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 59 | raise log.Error('hlr.sql missing:', sql_input) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 60 | self.run_local('create_hlr_db', ('/bin/sh', '-c', 'sqlite3 %r < %r' % (self.db_file, sql_input))) |
| 61 | |
Pau Espin Pedrol | 9cc1d08 | 2017-11-20 17:40:25 +0100 | [diff] [blame] | 62 | pcap_recorder.PcapRecorder(self.suite_run, self.run_dir.new_dir('pcap'), None, |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 63 | 'host %s' % self.addr()) |
| 64 | |
| 65 | env = { 'LD_LIBRARY_PATH': util.prepend_library_path(lib) } |
| 66 | |
| 67 | self.dbg(run_dir=self.run_dir, binary=binary, env=env) |
| 68 | self.process = process.Process(self.name(), self.run_dir, |
| 69 | (binary, |
| 70 | '-c', os.path.abspath(self.config_file), |
| 71 | '--database', self.db_file), |
| 72 | env=env) |
| 73 | self.suite_run.remember_to_stop(self.process) |
| 74 | self.process.launch() |
| 75 | |
| 76 | def configure(self): |
| 77 | self.config_file = self.run_dir.new_file('osmo-hlr.cfg') |
| 78 | self.dbg(config_file=self.config_file) |
| 79 | |
| 80 | values = dict(hlr=config.get_defaults('hlr')) |
| 81 | config.overlay(values, self.suite_run.config()) |
| 82 | config.overlay(values, dict(hlr=dict(ip_address=self.ip_address))) |
| 83 | |
| 84 | self.dbg('HLR CONFIG:\n' + pprint.pformat(values)) |
| 85 | |
| 86 | with open(self.config_file, 'w') as f: |
| 87 | r = template.render('osmo-hlr.cfg', values) |
| 88 | self.dbg(r) |
| 89 | f.write(r) |
| 90 | |
| 91 | def addr(self): |
| 92 | return self.ip_address.get('addr') |
| 93 | |
| 94 | def running(self): |
| 95 | return not self.process.terminated() |
| 96 | |
| 97 | def run_local(self, name, popen_args): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 98 | run_dir = self.run_dir.new_dir(name) |
| 99 | proc = process.Process(name, run_dir, popen_args) |
| 100 | proc.launch() |
| 101 | proc.wait() |
| 102 | if proc.result != 0: |
| 103 | log.ctx(proc) |
| 104 | raise log.Error('Exited in error') |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 105 | |
Neels Hofmeyr | 0af893c | 2017-12-14 15:18:05 +0100 | [diff] [blame] | 106 | def subscriber_add(self, modem, msisdn=None, algo_str=None): |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 107 | if msisdn is None: |
| 108 | msisdn = self.suite_run.resources_pool.next_msisdn(modem) |
| 109 | modem.set_msisdn(msisdn) |
| 110 | subscriber_id = self.next_subscriber_id |
| 111 | self.next_subscriber_id += 1 |
Pau Espin Pedrol | 713ce2c | 2017-08-24 16:57:17 +0200 | [diff] [blame] | 112 | |
Neels Hofmeyr | 0af893c | 2017-12-14 15:18:05 +0100 | [diff] [blame] | 113 | if algo_str is None: |
| 114 | algo_str = modem.auth_algo() or util.OSMO_AUTH_ALGO_NONE |
Pau Espin Pedrol | 713ce2c | 2017-08-24 16:57:17 +0200 | [diff] [blame] | 115 | |
Neels Hofmeyr | 0af893c | 2017-12-14 15:18:05 +0100 | [diff] [blame] | 116 | if algo_str != util.OSMO_AUTH_ALGO_NONE and not modem.ki(): |
| 117 | raise log.Error("Auth algo %r selected but no KI specified" % algo_str) |
| 118 | |
| 119 | algo = util.osmo_auth_algo_by_name(algo_str) |
| 120 | |
| 121 | self.log('Add subscriber', msisdn=msisdn, imsi=modem.imsi(), subscriber_id=subscriber_id, |
| 122 | algo_str=algo_str, algo=algo) |
Pau Espin Pedrol | 6610dfe | 2017-08-23 17:02:38 +0200 | [diff] [blame] | 123 | conn = sqlite3.connect(self.db_file) |
| 124 | try: |
| 125 | c = conn.cursor() |
| 126 | c.execute('insert into subscriber (id, imsi, msisdn) values (?, ?, ?)', |
| 127 | (subscriber_id, modem.imsi(), modem.msisdn,)) |
| 128 | c.execute('insert into auc_2g (subscriber_id, algo_id_2g, ki) values (?, ?, ?)', |
| 129 | (subscriber_id, algo, modem.ki(),)) |
| 130 | conn.commit() |
| 131 | finally: |
| 132 | conn.close() |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 133 | return subscriber_id |
| 134 | |
Pau Espin Pedrol | 0755cdb | 2017-08-23 17:03:48 +0200 | [diff] [blame] | 135 | def subscriber_delete(self, modem): |
| 136 | self.log('Add subscriber', imsi=modem.imsi()) |
| 137 | conn = sqlite3.connect(self.db_file) |
| 138 | try: |
| 139 | c = conn.cursor() |
| 140 | c.execute('select id from subscriber where imsi = ?', (modem.imsi(),)) |
| 141 | subscriber_id = c.fetchone()[0] |
| 142 | c.execute('delete from subscriber where id = ?', (subscriber_id,)) |
| 143 | c.execute('delete from auc_2g where subscriber_id = ?', (subscriber_id,)) |
| 144 | conn.commit() |
| 145 | finally: |
| 146 | conn.close() |
| 147 | |
Pau Espin Pedrol | 5bbb300 | 2017-11-23 11:07:02 +0100 | [diff] [blame] | 148 | def conf_for_client(self): |
Neels Hofmeyr | 7b02ed0 | 2017-06-08 23:08:59 +0200 | [diff] [blame] | 149 | return dict(hlr=dict(ip_address=self.ip_address)) |
| 150 | |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 151 | # vim: expandtab tabstop=4 shiftwidth=4 |