Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 1 | # osmo_gsm_tester: base classes to share code among BTS subclasses. |
| 2 | # |
| 3 | # Copyright (C) 2016-2017 by sysmocom - s.f.m.c. GmbH |
| 4 | # |
| 5 | # Author: Pau Espin Pedrol <pespin@sysmocom.de> |
| 6 | # |
| 7 | # This program is free software: you can redistribute it and/or modify |
| 8 | # it under the terms of the GNU General Public License as |
| 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 |
| 15 | # GNU General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU General Public License |
| 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
| 20 | import os |
| 21 | import pprint |
| 22 | import tempfile |
| 23 | from abc import ABCMeta, abstractmethod |
Pau Espin Pedrol | 9a4631c | 2018-03-28 19:17:34 +0200 | [diff] [blame] | 24 | from . import log, config, util, template, process, bts, pcu_osmo |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 25 | |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 26 | class OsmoBts(bts.Bts, metaclass=ABCMeta): |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 27 | proc_bts = None |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 28 | _pcu = None |
| 29 | |
| 30 | ############## |
| 31 | # PROTECTED |
| 32 | ############## |
Pau Espin Pedrol | e519462 | 2018-05-07 13:36:58 +0200 | [diff] [blame^] | 33 | def __init__(self, suite_run, conf, name, defaults_cfg_name): |
| 34 | super().__init__(suite_run, conf, name, defaults_cfg_name) |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 35 | if len(self.pcu_socket_path().encode()) > 107: |
| 36 | raise log.Error('Path for pcu socket is longer than max allowed len for unix socket path (107):', self.pcu_socket_path()) |
| 37 | |
Pau Espin Pedrol | e519462 | 2018-05-07 13:36:58 +0200 | [diff] [blame^] | 38 | def conf_for_bsc_prepare(self): |
Pau Espin Pedrol | 530681f | 2018-05-07 02:26:18 +0200 | [diff] [blame] | 39 | values = config.get_defaults('bsc_bts') |
Pau Espin Pedrol | e519462 | 2018-05-07 13:36:58 +0200 | [diff] [blame^] | 40 | config.overlay(values, config.get_defaults(self.defaults_cfg_name)) |
Pau Espin Pedrol | 530681f | 2018-05-07 02:26:18 +0200 | [diff] [blame] | 41 | if self.lac is not None: |
| 42 | config.overlay(values, { 'location_area_code': self.lac }) |
| 43 | if self.rac is not None: |
| 44 | config.overlay(values, { 'routing_area_code': self.rac }) |
| 45 | if self.cellid is not None: |
| 46 | config.overlay(values, { 'cell_identity': self.cellid }) |
| 47 | if self.bvci is not None: |
| 48 | config.overlay(values, { 'bvci': self.bvci }) |
| 49 | config.overlay(values, self.conf) |
| 50 | |
| 51 | sgsn_conf = {} if self.sgsn is None else self.sgsn.conf_for_client() |
| 52 | config.overlay(values, sgsn_conf) |
| 53 | return values |
| 54 | |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 55 | ######################## |
| 56 | # PUBLIC - INTERNAL API |
| 57 | ######################## |
| 58 | @abstractmethod |
| 59 | def conf_for_bsc(self): |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 60 | # coming from bts.Bts, we forward the implementation to children. |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 61 | pass |
| 62 | |
| 63 | @abstractmethod |
| 64 | def pcu_socket_path(self): |
| 65 | 'Used by pcu objects to get path to socket.' |
| 66 | pass |
| 67 | |
| 68 | @abstractmethod |
| 69 | def create_pcu(self): |
| 70 | 'Used by base class. Subclass can create different pcu implementations.' |
| 71 | pass |
| 72 | |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 73 | ################### |
| 74 | # PUBLIC (test API included) |
| 75 | ################### |
| 76 | @abstractmethod |
| 77 | def start(self): |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 78 | # coming from bts.Bts, we forward the implementation to children. |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 79 | pass |
| 80 | |
Pau Espin Pedrol | 4fbdc35 | 2018-03-08 17:47:35 +0100 | [diff] [blame] | 81 | def ready_for_pcu(self): |
| 82 | if not self.proc_bts or not self.proc_bts.is_running: |
| 83 | return False |
| 84 | return 'BTS is up' in (self.proc_bts.get_stderr() or '') |
| 85 | |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 86 | def pcu(self): |
| 87 | if self._pcu is None: |
Pau Espin Pedrol | c1b3278 | 2017-12-15 11:49:01 +0100 | [diff] [blame] | 88 | self._pcu = self.create_pcu() |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 89 | return self._pcu |
| 90 | |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 91 | class OsmoBtsMainUnit(OsmoBts, metaclass=ABCMeta): |
| 92 | ############## |
| 93 | # PROTECTED |
| 94 | ############## |
| 95 | pcu_sk_tmp_dir = None |
| 96 | |
Pau Espin Pedrol | e519462 | 2018-05-07 13:36:58 +0200 | [diff] [blame^] | 97 | def __init__(self, suite_run, conf, name, defaults_cfg_name): |
| 98 | super().__init__(suite_run, conf, name, defaults_cfg_name) |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 99 | |
| 100 | ######################## |
| 101 | # PUBLIC - INTERNAL API |
| 102 | ######################## |
| 103 | @abstractmethod |
| 104 | def conf_for_bsc(self): |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 105 | # coming from bts.Bts, we forward the implementation to children. |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 106 | pass |
| 107 | |
| 108 | def cleanup(self): |
| 109 | if self.pcu_sk_tmp_dir: |
| 110 | try: |
| 111 | os.remove(self.pcu_socket_path()) |
| 112 | except OSError: |
| 113 | pass |
| 114 | os.rmdir(self.pcu_sk_tmp_dir) |
| 115 | |
| 116 | def create_pcu(self): |
| 117 | return pcu_osmo.OsmoPcu(self.suite_run, self, self.conf) |
| 118 | |
| 119 | def pcu_socket_path(self): |
| 120 | if self.pcu_sk_tmp_dir is None: |
| 121 | self.pcu_sk_tmp_dir = tempfile.mkdtemp('', 'ogtpcusk') |
| 122 | return os.path.join(self.pcu_sk_tmp_dir, 'pcu_bts') |
| 123 | |
| 124 | ################### |
| 125 | # PUBLIC (test API included) |
| 126 | ################### |
| 127 | @abstractmethod |
| 128 | def start(self): |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 129 | # coming from bts.Bts, we forward the implementation to children. |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 130 | pass |