Holger Hans Peter Freyther | 574e62f | 2018-06-20 09:15:15 +0100 | [diff] [blame] | 1 | # osmo_ms_driver: Test helpers and base classes |
| 2 | # |
| 3 | # Copyright (C) 2018 by Holger Hans Peter Freyther |
| 4 | # |
| 5 | # This program is free software: you can redistribute it and/or modify |
| 6 | # it under the terms of the GNU General Public License as |
| 7 | # published by the Free Software Foundation, either version 3 of the |
| 8 | # License, or (at your option) any later version. |
| 9 | # |
| 10 | # This program is distributed in the hope that it will be useful, |
| 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | # GNU General Public License for more details. |
| 14 | # |
| 15 | # You should have received a copy of the GNU General Public License |
| 16 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 17 | |
Holger Hans Peter Freyther | 75c9cc7 | 2019-04-30 15:38:51 +0100 | [diff] [blame] | 18 | from abc import ABCMeta |
Holger Hans Peter Freyther | 574e62f | 2018-06-20 09:15:15 +0100 | [diff] [blame] | 19 | from osmo_gsm_tester import log |
| 20 | |
Holger Hans Peter Freyther | 2e7e843 | 2019-04-30 18:55:59 +0100 | [diff] [blame] | 21 | import time |
| 22 | |
Holger Hans Peter Freyther | 574e62f | 2018-06-20 09:15:15 +0100 | [diff] [blame] | 23 | def imsi_ki_gen(): |
| 24 | """ |
| 25 | Generate IMSIs and KIs to be used by test. |
| 26 | """ |
| 27 | n = 1010000000000 |
| 28 | while True: |
| 29 | yield ("%.15d" % n, "00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00") |
| 30 | n += 1 |
| 31 | |
Holger Hans Peter Freyther | 61f2877 | 2019-04-27 14:25:22 +0100 | [diff] [blame] | 32 | class ResultStore(log.Origin): |
Holger Hans Peter Freyther | 574e62f | 2018-06-20 09:15:15 +0100 | [diff] [blame] | 33 | """ |
Holger Hans Peter Freyther | 61f2877 | 2019-04-27 14:25:22 +0100 | [diff] [blame] | 34 | The class for results. There should be one result class per test subject. |
| 35 | Specific tests can use add_result to add their outcome to this object. |
Holger Hans Peter Freyther | 574e62f | 2018-06-20 09:15:15 +0100 | [diff] [blame] | 36 | """ |
| 37 | |
| 38 | def __init__(self, name): |
| 39 | super().__init__(log.C_RUN, name) |
| 40 | self._time_of_registration = None |
| 41 | self._time_of_launch = None |
Holger Hans Peter Freyther | 61f2877 | 2019-04-27 14:25:22 +0100 | [diff] [blame] | 42 | self._results = {} |
Holger Hans Peter Freyther | 574e62f | 2018-06-20 09:15:15 +0100 | [diff] [blame] | 43 | |
| 44 | def set_start_time(self, time): |
| 45 | assert self._time_of_registration is None |
| 46 | self._time_of_registration = time |
| 47 | |
| 48 | def set_launch_time(self, time): |
| 49 | assert self._time_of_launch is None |
| 50 | self._time_of_launch = time |
| 51 | |
| 52 | def start_time(self): |
| 53 | return self._time_of_registration or 0 |
| 54 | |
| 55 | def launch_time(self): |
| 56 | return self._time_of_launch or 0 |
Holger Hans Peter Freyther | 61f2877 | 2019-04-27 14:25:22 +0100 | [diff] [blame] | 57 | |
| 58 | def set_result(self, key, value): |
| 59 | """Sets a result with the given key and value.""" |
| 60 | self._results[key] = value |
| 61 | |
| 62 | def get_result(self, key, default=None): |
| 63 | """Returns the result for the given key or default.""" |
| 64 | return self._results.get(key, default) |
| 65 | |
| 66 | def has_result(self, key): |
| 67 | """Returns true if there is a value for the key.""" |
| 68 | return self._results.get(key) is not None |
Holger Hans Peter Freyther | 75c9cc7 | 2019-04-30 15:38:51 +0100 | [diff] [blame] | 69 | |
| 70 | |
| 71 | class TestBase(log.Origin, metaclass=ABCMeta): |
| 72 | """Base class for all mass test cases.""" |
| 73 | |
| 74 | def __init__(self, name, event_server, results): |
| 75 | super().__init__(log.C_RUN, name) |
| 76 | self._event_server = event_server |
| 77 | self._results = results |
| 78 | |
Holger Hans Peter Freyther | dbb16e8 | 2019-04-30 22:03:12 +0100 | [diff] [blame] | 79 | def configure(self, subscribers, mobiles): |
| 80 | """ |
| 81 | Configures the test given the subscribers. |
| 82 | |
| 83 | The subscriber at index _i_ belongs to the mobile at the |
| 84 | same index. subscribers[i] == mobiles[i].subscriber(). |
| 85 | """ |
Holger Hans Peter Freyther | 75c9cc7 | 2019-04-30 15:38:51 +0100 | [diff] [blame] | 86 | pass |
| 87 | |
| 88 | def before_start(self): |
| 89 | """Prepares the test for starting.""" |
| 90 | pass |
| 91 | |
| 92 | def after_start(self): |
| 93 | """Finishes the test after starting.""" |
| 94 | pass |
| 95 | |
| 96 | def has_completed(self): |
| 97 | """Returns true if the test has completed.""" |
| 98 | pass |
| 99 | |
| 100 | def print_stats(self): |
| 101 | """Prints statistics/results of the test.""" |
| 102 | pass |
Holger Hans Peter Freyther | 2e7e843 | 2019-04-30 18:55:59 +0100 | [diff] [blame] | 103 | |
| 104 | |
| 105 | class TestExecutor(log.Origin): |
| 106 | """Execute/Wait for a list of tests to complete.""" |
| 107 | |
| 108 | def __init__(self): |
| 109 | super().__init__(log.C_RUN, "executor") |
| 110 | self._tests = [] |
| 111 | |
| 112 | def add_test(self, test): |
| 113 | self._tests.append(test) |
| 114 | |
Holger Hans Peter Freyther | dbb16e8 | 2019-04-30 22:03:12 +0100 | [diff] [blame] | 115 | def configure(self, subscribers, mobiles): |
Holger Hans Peter Freyther | 2e7e843 | 2019-04-30 18:55:59 +0100 | [diff] [blame] | 116 | for test in self._tests: |
Holger Hans Peter Freyther | dbb16e8 | 2019-04-30 22:03:12 +0100 | [diff] [blame] | 117 | test.configure(subscribers, mobiles) |
Holger Hans Peter Freyther | 2e7e843 | 2019-04-30 18:55:59 +0100 | [diff] [blame] | 118 | |
| 119 | def before_start(self): |
| 120 | for test in self._tests: |
| 121 | test.before_start() |
| 122 | |
| 123 | def after_start(self): |
| 124 | for test in self._tests: |
| 125 | test.after_start() |
| 126 | |
| 127 | def print_stats(self): |
| 128 | """Prints statistics/results of the test.""" |
| 129 | for test in self._tests: |
| 130 | test.print_stats() |
| 131 | |
| 132 | def all_tests_completed(self): |
| 133 | """Returns true if all tests completed.""" |
| 134 | for test in self._tests: |
| 135 | if not test.has_completed(): |
| 136 | return False |
| 137 | return True |
| 138 | |
| 139 | def wait_for_test(self, loop, deadline): |
| 140 | """Waits up to the absolute deadline for all tests to complete.""" |
| 141 | while not self.all_tests_completed(): |
| 142 | now_time = time.clock_gettime(time.CLOCK_MONOTONIC) |
| 143 | sleep_time = deadline - now_time |
| 144 | if sleep_time < 0: |
| 145 | break |
| 146 | loop.schedule_timeout(sleep_time) |
| 147 | loop.select() |