<p>Holger Freyther <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/10686">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Pau Espin Pedrol: Looks good to me, approved
Jenkins Builder: Verified
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Create a "ms_driver" stub for the testsuite<br><br>All config parameters are hardcoded for now and it should push<br>subscribers into the test (which should be a base class but not<br>a specific test).<br><br>Change-Id: I586b6d532c6e6395b4e6f2cf2128372237d05a7d<br>---<br>A src/osmo_gsm_tester/ms_driver.py<br>M src/osmo_gsm_tester/suite.py<br>2 files changed, 137 insertions(+), 1 deletion(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/osmo_gsm_tester/ms_driver.py b/src/osmo_gsm_tester/ms_driver.py</span><br><span>new file mode 100644</span><br><span>index 0000000..808989e</span><br><span>--- /dev/null</span><br><span>+++ b/src/osmo_gsm_tester/ms_driver.py</span><br><span>@@ -0,0 +1,131 @@</span><br><span style="color: hsl(120, 100%, 40%);">+# ms_driver: Launch OsmocomBB mobile's virtually connected to a BTS</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# Copyright (C) 2018 by Holger Hans Peter Freyther</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# This program is free software: you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+# it under the terms of the GNU General Public License as</span><br><span style="color: hsl(120, 100%, 40%);">+# published by the Free Software Foundation, either version 3 of the</span><br><span style="color: hsl(120, 100%, 40%);">+# License, or (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+# but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+# GNU General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# You should have received a copy of the GNU General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+# along with this program. If not, see <http://www.gnu.org/licenses/>.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+from datetime import timedelta</span><br><span style="color: hsl(120, 100%, 40%);">+from . import log</span><br><span style="color: hsl(120, 100%, 40%);">+from osmo_ms_driver.cdf import cdfs</span><br><span style="color: hsl(120, 100%, 40%);">+from osmo_ms_driver.event_server import EventServer</span><br><span style="color: hsl(120, 100%, 40%);">+from osmo_ms_driver.simple_loop import SimpleLoop</span><br><span style="color: hsl(120, 100%, 40%);">+from osmo_ms_driver.location_update_test import MassUpdateLocationTest</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+import os.path</span><br><span style="color: hsl(120, 100%, 40%);">+import shutil</span><br><span style="color: hsl(120, 100%, 40%);">+import tempfile</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+class Subscriber(log.Origin):</span><br><span style="color: hsl(120, 100%, 40%);">+ def __init__(self, imsi, ki):</span><br><span style="color: hsl(120, 100%, 40%);">+ super().__init__(log.C_RUN, 'subscriber')</span><br><span style="color: hsl(120, 100%, 40%);">+ self._imsi = imsi</span><br><span style="color: hsl(120, 100%, 40%);">+ self._ki = ki</span><br><span style="color: hsl(120, 100%, 40%);">+ self._auth_algo = "comp128v1"</span><br><span style="color: hsl(120, 100%, 40%);">+ self._msisdn = None</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def msisdn(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ return self._msisdn</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def set_msisdn(self, msisdn):</span><br><span style="color: hsl(120, 100%, 40%);">+ self._msisdn = msisdn</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def imsi(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ return self._imsi</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def ki(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ return self._ki</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def auth_algo(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ return self._auth_algo</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+class MsDriver(log.Origin):</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def __init__(self, suite_run):</span><br><span style="color: hsl(120, 100%, 40%);">+ super().__init__(log.C_RUN, 'ms-driver')</span><br><span style="color: hsl(120, 100%, 40%);">+ self._suite_run = suite_run</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # TODO: take config out of the test scenario</span><br><span style="color: hsl(120, 100%, 40%);">+ self._num_ms = 10</span><br><span style="color: hsl(120, 100%, 40%);">+ self._time_start = timedelta(seconds=60)</span><br><span style="color: hsl(120, 100%, 40%);">+ self._time_step = timedelta(milliseconds=100)</span><br><span style="color: hsl(120, 100%, 40%);">+ self._test_duration = timedelta(seconds=120)</span><br><span style="color: hsl(120, 100%, 40%);">+ self._cdf = cdfs["ease_in_out"](self._time_start, self._time_step)</span><br><span style="color: hsl(120, 100%, 40%);">+ self._loop = SimpleLoop()</span><br><span style="color: hsl(120, 100%, 40%);">+ self._suite_run.remember_to_stop(self)</span><br><span style="color: hsl(120, 100%, 40%);">+ self._test_case = None</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if len(self.event_server_path().encode()) > 107:</span><br><span style="color: hsl(120, 100%, 40%);">+ raise log.Error('Path for event_server socket is longer than max allowed len for unix socket path (107):', self.event_server_path())</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def event_server_path(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ if self.event_server_sk_tmp_dir is None:</span><br><span style="color: hsl(120, 100%, 40%);">+ self.event_server_sk_tmp_dir = tempfile.mkdtemp('', 'ogteventserversk')</span><br><span style="color: hsl(120, 100%, 40%);">+ return os.path.join(self.event_server_sk_tmp_dir, 'osmo_ms_driver.unix')</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def configure(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Configures the subscribers, tests and registration server. Needs to be</span><br><span style="color: hsl(120, 100%, 40%);">+ called after the complete configuration of this driver.</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ event_server_path = self.event_server_path()</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ self._ev_server = EventServer("ev_server", event_server_path)</span><br><span style="color: hsl(120, 100%, 40%);">+ self._ev_server.listen(self._loop)</span><br><span style="color: hsl(120, 100%, 40%);">+ self._test_case = MassUpdateLocationTest("mass", self._num_ms, self._cdf, self._ev_server, self.event_server_sk_tmp_dir)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # TODO: We should pass subscribers down to the test and not get it from</span><br><span style="color: hsl(120, 100%, 40%);">+ # there.</span><br><span style="color: hsl(120, 100%, 40%);">+ self._subs = [Subscriber(imsi=mob.imsi(), ki=mob.ki()) for mob in self._test_case.mobiles()]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def ms_subscribers(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Returns a list of 'subscribers' that were configured in the</span><br><span style="color: hsl(120, 100%, 40%);">+ current scenario.</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ if not hasattr(self, '_subs'):</span><br><span style="color: hsl(120, 100%, 40%);">+ self.configure()</span><br><span style="color: hsl(120, 100%, 40%);">+ return self._subs</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def run_test(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Runs the configured tests by starting the configured amount of mobile</span><br><span style="color: hsl(120, 100%, 40%);">+ devices according to their schedule. Returns once all tests succeeded</span><br><span style="color: hsl(120, 100%, 40%);">+ or the configured timeout has passed.</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ if not hasattr(self, '_subs'):</span><br><span style="color: hsl(120, 100%, 40%);">+ self.configure()</span><br><span style="color: hsl(120, 100%, 40%);">+ self._test_case.run_test(self._loop, self._test_duration)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def print_stats(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Prints statistics about the test run.</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ self._test_case.print_stats()</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def cleanup(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Stops the testcase and all launched processes. Called by the</span><br><span style="color: hsl(120, 100%, 40%);">+ suite.</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Clean-up the temporary directory.</span><br><span style="color: hsl(120, 100%, 40%);">+ if self.event_server_sk_tmp_dir:</span><br><span style="color: hsl(120, 100%, 40%);">+ shutil.rmtree(path=self.event_server_sk_tmp_dir)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if not self._test_case:</span><br><span style="color: hsl(120, 100%, 40%);">+ return</span><br><span style="color: hsl(120, 100%, 40%);">+ self._test_case.stop_all()</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# vim: expandtab tabstop=4 shiftwidth=4</span><br><span>diff --git a/src/osmo_gsm_tester/suite.py b/src/osmo_gsm_tester/suite.py</span><br><span>index 932a6ab..22a47a2 100644</span><br><span>--- a/src/osmo_gsm_tester/suite.py</span><br><span>+++ b/src/osmo_gsm_tester/suite.py</span><br><span>@@ -23,7 +23,7 @@</span><br><span> import pprint</span><br><span> from . import config, log, util, resource, test</span><br><span> from .event_loop import MainLoop</span><br><span style="color: hsl(0, 100%, 40%);">-from . import osmo_nitb, osmo_hlr, osmo_mgcpgw, osmo_mgw, osmo_msc, osmo_bsc, osmo_stp, osmo_ggsn, osmo_sgsn, modem, esme, osmocon</span><br><span style="color: hsl(120, 100%, 40%);">+from . import osmo_nitb, osmo_hlr, osmo_mgcpgw, osmo_mgw, osmo_msc, osmo_bsc, osmo_stp, osmo_ggsn, osmo_sgsn, modem, esme, osmocon, ms_driver</span><br><span> </span><br><span> class Timeout(Exception):</span><br><span> pass</span><br><span>@@ -311,6 +311,11 @@</span><br><span> ip_address = self.ip_address()</span><br><span> return osmo_stp.OsmoStp(self, ip_address)</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ def ms_driver(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ ms = ms_driver.MsDriver(self)</span><br><span style="color: hsl(120, 100%, 40%);">+ self.register_for_cleanup(ms)</span><br><span style="color: hsl(120, 100%, 40%);">+ return ms</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> def bts(self, specifics=None):</span><br><span> bts = bts_obj(self, self.reserved_resources.get(resource.R_BTS, specifics=specifics))</span><br><span> bts.set_lac(self.lac())</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/10686">change 10686</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/10686"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-gsm-tester </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I586b6d532c6e6395b4e6f2cf2128372237d05a7d </div>
<div style="display:none"> Gerrit-Change-Number: 10686 </div>
<div style="display:none"> Gerrit-PatchSet: 7 </div>
<div style="display:none"> Gerrit-Owner: Holger Freyther <holger@freyther.de> </div>
<div style="display:none"> Gerrit-Reviewer: Holger Freyther <holger@freyther.de> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>
<div style="display:none"> Gerrit-Reviewer: Pau Espin Pedrol <pespin@sysmocom.de> </div>