Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 1 | # osmo_gsm_tester: validate dict structures |
| 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 | 3531a19 | 2017-03-28 14:30:28 +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 | 3531a19 | 2017-03-28 14:30:28 +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 | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
| 20 | import re |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 21 | import os |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 22 | |
| 23 | from . import log |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 24 | from . import util |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 25 | |
Pau Espin Pedrol | e0b8990 | 2020-05-06 16:28:01 +0200 | [diff] [blame] | 26 | KEY_RE = re.compile('[a-zA-Z0-9][a-zA-Z0-9_]*') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 27 | IPV4_RE = re.compile('([0-9]{1,3}.){3}[0-9]{1,3}') |
| 28 | HWADDR_RE = re.compile('([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}') |
| 29 | IMSI_RE = re.compile('[0-9]{6,15}') |
| 30 | KI_RE = re.compile('[0-9a-fA-F]{32}') |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 31 | OPC_RE = re.compile('[0-9a-fA-F]{32}') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 32 | MSISDN_RE = re.compile('[0-9]{1,15}') |
| 33 | |
| 34 | def match_re(name, regex, val): |
| 35 | while True: |
| 36 | if not isinstance(val, str): |
| 37 | break; |
| 38 | if not regex.fullmatch(val): |
| 39 | break; |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 40 | return True |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 41 | raise ValueError('Invalid %s: %r' % (name, val)) |
| 42 | |
| 43 | def band(val): |
Pau Espin Pedrol | 05a838e | 2018-03-27 19:15:41 +0200 | [diff] [blame] | 44 | if val in ('GSM-900', 'GSM-1800', 'GSM-1900'): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 45 | return True |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 46 | raise ValueError('Unknown GSM band: %r' % val) |
| 47 | |
| 48 | def ipv4(val): |
| 49 | match_re('IPv4 address', IPV4_RE, val) |
| 50 | els = [int(el) for el in val.split('.')] |
| 51 | if not all([el >= 0 and el <= 255 for el in els]): |
| 52 | raise ValueError('Invalid IPv4 address: %r' % val) |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 53 | return True |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 54 | |
| 55 | def hwaddr(val): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 56 | return match_re('hardware address', HWADDR_RE, val) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 57 | |
| 58 | def imsi(val): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 59 | return match_re('IMSI', IMSI_RE, val) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 60 | |
| 61 | def ki(val): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 62 | return match_re('KI', KI_RE, val) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 63 | |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 64 | def opc(val): |
| 65 | return match_re('OPC', OPC_RE, val) |
| 66 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 67 | def msisdn(val): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 68 | return match_re('MSISDN', MSISDN_RE, val) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 69 | |
Pau Espin Pedrol | 713ce2c | 2017-08-24 16:57:17 +0200 | [diff] [blame] | 70 | def auth_algo(val): |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 71 | if val not in util.ENUM_OSMO_AUTH_ALGO: |
Neels Hofmeyr | 0af893c | 2017-12-14 15:18:05 +0100 | [diff] [blame] | 72 | raise ValueError('Unknown Authentication Algorithm: %r' % val) |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 73 | return True |
Pau Espin Pedrol | 713ce2c | 2017-08-24 16:57:17 +0200 | [diff] [blame] | 74 | |
Pau Espin Pedrol | fa9a6d3 | 2017-09-12 15:13:21 +0200 | [diff] [blame] | 75 | def uint(val): |
| 76 | n = int(val) |
| 77 | if n < 0: |
| 78 | raise ValueError('Positive value expected instead of %d' % n) |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 79 | return True |
Pau Espin Pedrol | fa9a6d3 | 2017-09-12 15:13:21 +0200 | [diff] [blame] | 80 | |
Pau Espin Pedrol | 8a3a7b5 | 2017-11-28 15:50:02 +0100 | [diff] [blame] | 81 | def uint8(val): |
| 82 | n = int(val) |
| 83 | if n < 0: |
| 84 | raise ValueError('Positive value expected instead of %d' % n) |
| 85 | if n > 255: # 2^8 - 1 |
| 86 | raise ValueError('Value %d too big, max value is 255' % n) |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 87 | return True |
Pau Espin Pedrol | 8a3a7b5 | 2017-11-28 15:50:02 +0100 | [diff] [blame] | 88 | |
Pau Espin Pedrol | 5e0c251 | 2017-11-06 18:40:23 +0100 | [diff] [blame] | 89 | def uint16(val): |
| 90 | n = int(val) |
| 91 | if n < 0: |
| 92 | raise ValueError('Positive value expected instead of %d' % n) |
| 93 | if n > 65535: # 2^16 - 1 |
| 94 | raise ValueError('Value %d too big, max value is 65535' % n) |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 95 | return True |
| 96 | |
| 97 | def bool_str(val): |
| 98 | # str2bool will raise an exception if unable to parse it |
| 99 | util.str2bool(val) |
| 100 | return True |
Pau Espin Pedrol | 5e0c251 | 2017-11-06 18:40:23 +0100 | [diff] [blame] | 101 | |
Pau Espin Pedrol | ead79ac | 2017-09-12 15:19:18 +0200 | [diff] [blame] | 102 | def times(val): |
| 103 | n = int(val) |
| 104 | if n < 1: |
| 105 | raise ValueError('Positive value >0 expected instead of %d' % n) |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 106 | return True |
Pau Espin Pedrol | ead79ac | 2017-09-12 15:19:18 +0200 | [diff] [blame] | 107 | |
Nils Fürste | a818015 | 2020-12-03 14:14:31 +0100 | [diff] [blame] | 108 | def cipher_2g(val): |
Pau Espin Pedrol | 57497a6 | 2017-08-28 14:21:15 +0200 | [diff] [blame] | 109 | if val in ('a5_0', 'a5_1', 'a5_2', 'a5_3', 'a5_4', 'a5_5', 'a5_6', 'a5_7'): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 110 | return True |
Pau Espin Pedrol | 57497a6 | 2017-08-28 14:21:15 +0200 | [diff] [blame] | 111 | raise ValueError('Unknown Cipher value: %r' % val) |
| 112 | |
Nils Fürste | a818015 | 2020-12-03 14:14:31 +0100 | [diff] [blame] | 113 | def cipher_4g(val): |
| 114 | if val.lower() in ('eea0', 'eea1', 'eea2'): |
| 115 | return True |
| 116 | raise ValueError('Unknown 4G cipher value: %r' % val) |
| 117 | |
| 118 | def integrity_4g(val): |
| 119 | if val.lower() in ('eia0', 'eia1', 'eia2'): |
| 120 | # srsENB |
| 121 | return True |
| 122 | raise ValueError('Unknown 4G integrity value %r' % val) |
| 123 | |
Pau Espin Pedrol | ac18fd3 | 2017-08-31 18:49:47 +0200 | [diff] [blame] | 124 | def modem_feature(val): |
Andre Puschmann | fd4c0ee | 2021-03-23 22:42:17 +0100 | [diff] [blame] | 125 | if val in ('sms', 'gprs', 'voice', 'ussd', 'sim', '2g', '3g', '4g', '5g', 'dl_qam256', 'ul_qam64', 'qc_diag'): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 126 | return True |
Pau Espin Pedrol | ac18fd3 | 2017-08-31 18:49:47 +0200 | [diff] [blame] | 127 | raise ValueError('Unknown Modem Feature: %r' % val) |
| 128 | |
Pau Espin Pedrol | c9b6376 | 2018-05-07 01:57:01 +0200 | [diff] [blame] | 129 | def phy_channel_config(val): |
| 130 | if val in ('CCCH', 'CCCH+SDCCH4', 'TCH/F', 'TCH/H', 'SDCCH8', 'PDCH', |
| 131 | 'TCH/F_PDCH', 'CCCH+SDCCH4+CBCH', 'SDCCH8+CBCH','TCH/F_TCH/H_PDCH'): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 132 | return True |
Pau Espin Pedrol | c9b6376 | 2018-05-07 01:57:01 +0200 | [diff] [blame] | 133 | raise ValueError('Unknown Physical channel config: %r' % val) |
| 134 | |
Pau Espin Pedrol | 722e94e | 2018-08-22 11:01:32 +0200 | [diff] [blame] | 135 | def channel_allocator(val): |
| 136 | if val in ('ascending', 'descending'): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 137 | return True |
Pau Espin Pedrol | 722e94e | 2018-08-22 11:01:32 +0200 | [diff] [blame] | 138 | raise ValueError('Unknown Channel Allocator Policy %r' % val) |
| 139 | |
Pau Espin Pedrol | 4f23ab5 | 2018-10-29 11:30:00 +0100 | [diff] [blame] | 140 | def gprs_mode(val): |
| 141 | if val in ('none', 'gprs', 'egprs'): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 142 | return True |
Pau Espin Pedrol | 4f23ab5 | 2018-10-29 11:30:00 +0100 | [diff] [blame] | 143 | raise ValueError('Unknown GPRS mode %r' % val) |
| 144 | |
Pau Espin Pedrol | 5dc2459 | 2018-08-27 12:53:41 +0200 | [diff] [blame] | 145 | def codec(val): |
| 146 | if val in ('hr1', 'hr2', 'hr3', 'fr1', 'fr2', 'fr3'): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 147 | return True |
Pau Espin Pedrol | 5dc2459 | 2018-08-27 12:53:41 +0200 | [diff] [blame] | 148 | raise ValueError('Unknown Codec value: %r' % val) |
| 149 | |
Pau Espin Pedrol | 0d45504 | 2018-08-27 17:07:41 +0200 | [diff] [blame] | 150 | def osmo_trx_clock_ref(val): |
| 151 | if val in ('internal', 'external', 'gspdo'): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 152 | return True |
Pau Espin Pedrol | 0d45504 | 2018-08-27 17:07:41 +0200 | [diff] [blame] | 153 | raise ValueError('Unknown OsmoTRX clock reference value: %r' % val) |
| 154 | |
Pau Espin Pedrol | b693771 | 2020-02-27 18:02:20 +0100 | [diff] [blame] | 155 | def lte_transmission_mode(val): |
| 156 | n = int(val) |
| 157 | if n <= 4: |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 158 | return True |
Pau Espin Pedrol | b693771 | 2020-02-27 18:02:20 +0100 | [diff] [blame] | 159 | raise ValueError('LTE Transmission Mode %d not in expected range' % n) |
| 160 | |
Andre Puschmann | 2dcc431 | 2020-03-28 15:34:00 +0100 | [diff] [blame] | 161 | def duration(val): |
| 162 | if val.isdecimal() or val.endswith('m') or val.endswith('h'): |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 163 | return True |
Andre Puschmann | 2dcc431 | 2020-03-28 15:34:00 +0100 | [diff] [blame] | 164 | raise ValueError('Invalid duration value: %r' % val) |
| 165 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 166 | INT = 'int' |
| 167 | STR = 'str' |
Pau Espin Pedrol | fa9a6d3 | 2017-09-12 15:13:21 +0200 | [diff] [blame] | 168 | UINT = 'uint' |
Pau Espin Pedrol | 404e150 | 2017-08-22 11:17:43 +0200 | [diff] [blame] | 169 | BOOL_STR = 'bool_str' |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 170 | BAND = 'band' |
| 171 | IPV4 = 'ipv4' |
| 172 | HWADDR = 'hwaddr' |
| 173 | IMSI = 'imsi' |
| 174 | KI = 'ki' |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 175 | OPC = 'opc' |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 176 | MSISDN = 'msisdn' |
Pau Espin Pedrol | 713ce2c | 2017-08-24 16:57:17 +0200 | [diff] [blame] | 177 | AUTH_ALGO = 'auth_algo' |
Pau Espin Pedrol | ead79ac | 2017-09-12 15:19:18 +0200 | [diff] [blame] | 178 | TIMES='times' |
Nils Fürste | a818015 | 2020-12-03 14:14:31 +0100 | [diff] [blame] | 179 | CIPHER_2G = 'cipher_2g' |
| 180 | CIPHER_4G = 'cipher_4g' |
| 181 | INTEGRITY_4G = 'integrity_4g' |
Pau Espin Pedrol | ac18fd3 | 2017-08-31 18:49:47 +0200 | [diff] [blame] | 182 | MODEM_FEATURE = 'modem_feature' |
Pau Espin Pedrol | c9b6376 | 2018-05-07 01:57:01 +0200 | [diff] [blame] | 183 | PHY_CHAN = 'chan' |
Pau Espin Pedrol | 722e94e | 2018-08-22 11:01:32 +0200 | [diff] [blame] | 184 | CHAN_ALLOCATOR = 'chan_allocator' |
Pau Espin Pedrol | 4f23ab5 | 2018-10-29 11:30:00 +0100 | [diff] [blame] | 185 | GPRS_MODE = 'gprs_mode' |
Pau Espin Pedrol | 5dc2459 | 2018-08-27 12:53:41 +0200 | [diff] [blame] | 186 | CODEC = 'codec' |
Pau Espin Pedrol | 0d45504 | 2018-08-27 17:07:41 +0200 | [diff] [blame] | 187 | OSMO_TRX_CLOCK_REF = 'osmo_trx_clock_ref' |
Pau Espin Pedrol | b693771 | 2020-02-27 18:02:20 +0100 | [diff] [blame] | 188 | LTE_TRANSMISSION_MODE = 'lte_transmission_mode' |
Andre Puschmann | 2dcc431 | 2020-03-28 15:34:00 +0100 | [diff] [blame] | 189 | DURATION = 'duration' |
Pau Espin Pedrol | ac18fd3 | 2017-08-31 18:49:47 +0200 | [diff] [blame] | 190 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 191 | SCHEMA_TYPES = { |
| 192 | INT: int, |
| 193 | STR: str, |
Pau Espin Pedrol | fa9a6d3 | 2017-09-12 15:13:21 +0200 | [diff] [blame] | 194 | UINT: uint, |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 195 | BOOL_STR: bool_str, |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 196 | BAND: band, |
| 197 | IPV4: ipv4, |
| 198 | HWADDR: hwaddr, |
| 199 | IMSI: imsi, |
| 200 | KI: ki, |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 201 | OPC: opc, |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 202 | MSISDN: msisdn, |
Pau Espin Pedrol | 713ce2c | 2017-08-24 16:57:17 +0200 | [diff] [blame] | 203 | AUTH_ALGO: auth_algo, |
Pau Espin Pedrol | ead79ac | 2017-09-12 15:19:18 +0200 | [diff] [blame] | 204 | TIMES: times, |
Nils Fürste | a818015 | 2020-12-03 14:14:31 +0100 | [diff] [blame] | 205 | CIPHER_2G: cipher_2g, |
| 206 | CIPHER_4G: cipher_4g, |
Pau Espin Pedrol | ac18fd3 | 2017-08-31 18:49:47 +0200 | [diff] [blame] | 207 | MODEM_FEATURE: modem_feature, |
Pau Espin Pedrol | c9b6376 | 2018-05-07 01:57:01 +0200 | [diff] [blame] | 208 | PHY_CHAN: phy_channel_config, |
Pau Espin Pedrol | 722e94e | 2018-08-22 11:01:32 +0200 | [diff] [blame] | 209 | CHAN_ALLOCATOR: channel_allocator, |
Pau Espin Pedrol | 4f23ab5 | 2018-10-29 11:30:00 +0100 | [diff] [blame] | 210 | GPRS_MODE: gprs_mode, |
Pau Espin Pedrol | 5dc2459 | 2018-08-27 12:53:41 +0200 | [diff] [blame] | 211 | CODEC: codec, |
Pau Espin Pedrol | 0d45504 | 2018-08-27 17:07:41 +0200 | [diff] [blame] | 212 | OSMO_TRX_CLOCK_REF: osmo_trx_clock_ref, |
Pau Espin Pedrol | b693771 | 2020-02-27 18:02:20 +0100 | [diff] [blame] | 213 | LTE_TRANSMISSION_MODE: lte_transmission_mode, |
Andre Puschmann | 2dcc431 | 2020-03-28 15:34:00 +0100 | [diff] [blame] | 214 | DURATION: duration, |
Nils Fürste | a818015 | 2020-12-03 14:14:31 +0100 | [diff] [blame] | 215 | INTEGRITY_4G: integrity_4g, |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 216 | } |
| 217 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 218 | def add(dest, src): |
| 219 | if util.is_dict(dest): |
| 220 | if not util.is_dict(src): |
| 221 | raise ValueError('cannot add to dict a value of type: %r' % type(src)) |
| 222 | |
| 223 | for key, val in src.items(): |
| 224 | dest_val = dest.get(key) |
| 225 | if dest_val is None: |
| 226 | dest[key] = val |
| 227 | else: |
| 228 | log.ctx(key=key) |
| 229 | add(dest_val, val) |
| 230 | return |
| 231 | if util.is_list(dest): |
| 232 | if not util.is_list(src): |
| 233 | raise ValueError('cannot add to list a value of type: %r' % type(src)) |
| 234 | dest.extend(src) |
| 235 | return |
| 236 | if dest == src: |
| 237 | return |
| 238 | raise ValueError('cannot add dicts, conflicting items (values %r and %r)' |
| 239 | % (dest, src)) |
| 240 | |
| 241 | def combine(dest, src): |
| 242 | if util.is_dict(dest): |
| 243 | if not util.is_dict(src): |
| 244 | raise ValueError('cannot combine dict with a value of type: %r' % type(src)) |
| 245 | |
| 246 | for key, val in src.items(): |
| 247 | log.ctx(key=key) |
| 248 | dest_val = dest.get(key) |
| 249 | if dest_val is None: |
| 250 | dest[key] = val |
| 251 | else: |
| 252 | combine(dest_val, val) |
| 253 | return |
| 254 | if util.is_list(dest): |
| 255 | if not util.is_list(src): |
| 256 | raise ValueError('cannot combine list with a value of type: %r' % type(src)) |
| 257 | # Validate that all elements in both lists are of the same type: |
| 258 | t = util.list_validate_same_elem_type(src + dest) |
| 259 | if t is None: |
| 260 | return # both lists are empty, return |
| 261 | # For lists of complex objects, we expect them to be sorted lists: |
| 262 | if t in (dict, list, tuple): |
| 263 | for i in range(len(dest)): |
| 264 | log.ctx(idx=i) |
| 265 | src_it = src[i] if i < len(src) else util.empty_instance_type(t) |
| 266 | combine(dest[i], src_it) |
| 267 | for i in range(len(dest), len(src)): |
| 268 | log.ctx(idx=i) |
| 269 | dest.append(src[i]) |
| 270 | else: # for lists of basic elements, we handle them as unsorted sets: |
| 271 | for elem in src: |
| 272 | if elem not in dest: |
| 273 | dest.append(elem) |
| 274 | return |
| 275 | if dest == src: |
| 276 | return |
| 277 | raise ValueError('cannot combine dicts, conflicting items (values %r and %r)' |
| 278 | % (dest, src)) |
| 279 | |
| 280 | def replicate_times(d): |
| 281 | ''' |
| 282 | replicate items that have a "times" > 1 |
| 283 | |
| 284 | 'd' is a dict matching WANT_SCHEMA, which is the same as |
| 285 | the RESOURCES_SCHEMA, except each entity that can be reserved has a 'times' |
| 286 | field added, to indicate how many of those should be reserved. |
| 287 | ''' |
| 288 | d = copy.deepcopy(d) |
| 289 | for key, item_list in d.items(): |
| 290 | idx = 0 |
| 291 | while idx < len(item_list): |
| 292 | item = item_list[idx] |
| 293 | times = int(item.pop('times', 1)) |
| 294 | for j in range(1, times): |
| 295 | item_list.insert(idx + j, copy.deepcopy(item)) |
| 296 | idx += times |
| 297 | return d |
| 298 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 299 | def validate(config, schema): |
| 300 | '''Make sure the given config dict adheres to the schema. |
| 301 | The schema is a dict of 'dict paths' in dot-notation with permitted |
| 302 | value type. All leaf nodes are validated, nesting dicts are implicit. |
| 303 | |
| 304 | validate( { 'a': 123, 'b': { 'b1': 'foo', 'b2': [ 1, 2, 3 ] } }, |
| 305 | { 'a': int, |
| 306 | 'b.b1': str, |
| 307 | 'b.b2[]': int } ) |
| 308 | |
| 309 | Raise a ValueError in case the schema is violated. |
| 310 | ''' |
| 311 | |
| 312 | def validate_item(path, value, schema): |
| 313 | want_type = schema.get(path) |
| 314 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 315 | if util.is_list(value): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 316 | if want_type: |
| 317 | raise ValueError('config item is a list, should be %r: %r' % (want_type, path)) |
| 318 | path = path + '[]' |
| 319 | want_type = schema.get(path) |
| 320 | |
| 321 | if not want_type: |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 322 | if util.is_dict(value): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 323 | nest(path, value, schema) |
| 324 | return |
Andre Puschmann | 635edb3 | 2020-11-11 16:58:35 +0100 | [diff] [blame] | 325 | if util.is_list(value): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 326 | for list_v in value: |
| 327 | validate_item(path, list_v, schema) |
| 328 | return |
| 329 | raise ValueError('config item not known: %r' % path) |
| 330 | |
| 331 | if want_type not in SCHEMA_TYPES: |
| 332 | raise ValueError('unknown type %r at %r' % (want_type, path)) |
| 333 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 334 | if util.is_dict(value): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 335 | raise ValueError('config item is dict but should be a leaf node of type %r: %r' |
| 336 | % (want_type, path)) |
| 337 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 338 | if util.is_list(value): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 339 | for list_v in value: |
| 340 | validate_item(path, list_v, schema) |
| 341 | return |
| 342 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 343 | log.ctx(path) |
| 344 | type_validator = SCHEMA_TYPES.get(want_type) |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 345 | valid = type_validator(value) |
| 346 | if not valid: |
| 347 | raise ValueError('Invalid value %r for schema type \'%s\' (validator: %s)' % (value, want_type, type_validator.__name__)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 348 | |
| 349 | def nest(parent_path, config, schema): |
| 350 | if parent_path: |
| 351 | parent_path = parent_path + '.' |
| 352 | else: |
| 353 | parent_path = '' |
| 354 | for k,v in config.items(): |
| 355 | if not KEY_RE.fullmatch(k): |
| 356 | raise ValueError('invalid config key: %r' % k) |
| 357 | path = parent_path + k |
| 358 | validate_item(path, v, schema) |
| 359 | |
| 360 | nest(None, config, schema) |
| 361 | |
Pau Espin Pedrol | 3063730 | 2020-05-06 21:11:02 +0200 | [diff] [blame] | 362 | def config_to_schema_def(src, key_prefix): |
| 363 | 'Converts a yaml parsed config into a schema dictionary used by validate()' |
| 364 | if util.is_dict(src): |
| 365 | out_dict = {} |
| 366 | for key, val in src.items(): |
| 367 | list_token = '' |
| 368 | dict_token = '' |
| 369 | if util.is_list(val): |
| 370 | list_token = '[]' |
| 371 | assert len(val) == 1 |
| 372 | val = val[0] |
| 373 | if util.is_dict(val): |
| 374 | dict_token = '.' |
| 375 | tmp_out = config_to_schema_def(val, "%s%s%s%s" %(key_prefix, key, list_token, dict_token)) |
| 376 | out_dict = {**out_dict, **tmp_out} |
| 377 | return out_dict |
| 378 | |
| 379 | # base case: string |
| 380 | return {key_prefix: str(src)} |
| 381 | |
| 382 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 383 | def generate_schemas(): |
| 384 | "Generate supported schemas dynamically from objects" |
| 385 | obj_dir = '%s/../obj/' % os.path.dirname(os.path.abspath(__file__)) |
| 386 | for filename in os.listdir(obj_dir): |
| 387 | if not filename.endswith(".py"): |
| 388 | continue |
| 389 | module_name = 'osmo_gsm_tester.obj.%s' % filename[:-3] |
| 390 | util.run_python_file_method(module_name, 'on_register_schemas', False) |
| 391 | |
| 392 | |
Neels Hofmeyr | ecce402 | 2020-11-28 19:54:43 +0100 | [diff] [blame] | 393 | _RESOURCE_TYPES = ['ip_address',] |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 394 | |
| 395 | _RESOURCES_SCHEMA = { |
| 396 | 'ip_address[].addr': IPV4, |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 397 | } |
| 398 | |
| 399 | _CONFIG_SCHEMA = {} |
| 400 | |
| 401 | _WANT_SCHEMA = None |
| 402 | _ALL_SCHEMA = None |
| 403 | |
Pau Espin Pedrol | d79e719 | 2020-05-21 15:40:57 +0200 | [diff] [blame] | 404 | def register_schema_types(schema_type_attr): |
| 405 | """Register schema types to be used by schema attributes. |
| 406 | For instance: register_resource_schema_attributes({ 'fruit': lambda val: val in ('banana', 'apple') }) |
| 407 | """ |
| 408 | global SCHEMA_TYPES |
| 409 | combine(SCHEMA_TYPES, schema_type_attr) |
| 410 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 411 | def register_resource_schema(obj_class_str, obj_attr_dict): |
| 412 | """Register schema attributes for a resource type. |
| 413 | For instance: register_resource_schema_attributes('modem', {'type': schema.STR, 'ki': schema.KI}) |
| 414 | """ |
| 415 | global _RESOURCES_SCHEMA |
| 416 | global _RESOURCE_TYPES |
| 417 | tmpdict = {} |
| 418 | for key, val in obj_attr_dict.items(): |
| 419 | new_key = '%s[].%s' % (obj_class_str, key) |
| 420 | tmpdict[new_key] = val |
| 421 | combine(_RESOURCES_SCHEMA, tmpdict) |
| 422 | if obj_class_str not in _RESOURCE_TYPES: |
| 423 | _RESOURCE_TYPES.append(obj_class_str) |
| 424 | |
| 425 | def register_config_schema(obj_class_str, obj_attr_dict): |
| 426 | """Register schema attributes to configure all instances of an object class. |
| 427 | For instance: register_resource_schema_attributes('bsc', {'net.codec_list[]': schema.CODEC}) |
| 428 | """ |
Pau Espin Pedrol | 3063730 | 2020-05-06 21:11:02 +0200 | [diff] [blame] | 429 | global _CONFIG_SCHEMA, _ALL_SCHEMA |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 430 | tmpdict = {} |
| 431 | for key, val in obj_attr_dict.items(): |
| 432 | new_key = '%s.%s' % (obj_class_str, key) |
| 433 | tmpdict[new_key] = val |
| 434 | combine(_CONFIG_SCHEMA, tmpdict) |
Pau Espin Pedrol | 3063730 | 2020-05-06 21:11:02 +0200 | [diff] [blame] | 435 | _ALL_SCHEMA = None # reset _ALL_SCHEMA so it is re-generated next time it's requested. |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 436 | |
| 437 | def get_resources_schema(): |
| 438 | return _RESOURCES_SCHEMA; |
| 439 | |
| 440 | def get_want_schema(): |
| 441 | global _WANT_SCHEMA |
| 442 | if _WANT_SCHEMA is None: |
| 443 | _WANT_SCHEMA = util.dict_add( |
| 444 | dict([('%s[].times' % r, TIMES) for r in _RESOURCE_TYPES]), |
| 445 | get_resources_schema()) |
| 446 | return _WANT_SCHEMA |
| 447 | |
| 448 | def get_all_schema(): |
| 449 | global _ALL_SCHEMA |
| 450 | if _ALL_SCHEMA is None: |
| 451 | want_schema = get_want_schema() |
Pau Espin Pedrol | 8cfb5d0 | 2020-06-12 16:12:40 +0200 | [diff] [blame] | 452 | _ALL_SCHEMA = util.dict_add( |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 453 | dict([('config.%s' % key, val) for key, val in _CONFIG_SCHEMA.items()]), |
| 454 | dict([('resources.%s' % key, val) for key, val in want_schema.items()]), |
| 455 | dict([('modifiers.%s' % key, val) for key, val in want_schema.items()])) |
| 456 | return _ALL_SCHEMA |
| 457 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 458 | # vim: expandtab tabstop=4 shiftwidth=4 |