From eaefe6b5331ef304bb31fe69face2cb51d339f3c Mon Sep 17 00:00:00 2001
From: Pau Espin Pedrol <pespin@sysmocom.de>
Date: Mon, 20 Apr 2020 13:29:59 +0200
Subject: [PATCH] suites/4g: Introduce sample handover test

This test currently only works with AmarisoftENB and srsUE, because:
* srsENB has no handover support yet
* AmarisoftUE doesn't provide any known way to verify handovers.

As a result, it usually runs with following filters and modifiers:
amarisoftenb-rftype@uhd+srsue-rftype@uhd+mod-enb-ncells@2+mod-enb-meas-enable

The get_counter() API may change in the future based on information
available from other implementations.

Change-Id: I0dff4af7e3a89804a03842ad4a4d697bca3a9773
---
 src/osmo_gsm_tester/obj/ms.py               |  3 +
 src/osmo_gsm_tester/obj/ms_srs.py           | 14 +++++
 sysmocom/scenarios/mod-enb-meas-enable.conf |  3 +
 sysmocom/suites/4g/handover.py              | 61 +++++++++++++++++++++
 4 files changed, 81 insertions(+)
 create mode 100644 sysmocom/scenarios/mod-enb-meas-enable.conf
 create mode 100755 sysmocom/suites/4g/handover.py

diff --git a/src/osmo_gsm_tester/obj/ms.py b/src/osmo_gsm_tester/obj/ms.py
index 2774debe..e74377d6 100644
--- a/src/osmo_gsm_tester/obj/ms.py
+++ b/src/osmo_gsm_tester/obj/ms.py
@@ -97,3 +97,6 @@ class MS(log.Origin, metaclass=ABCMeta):
 
     def msisdn(self):
         return self.msisdn
+
+    def get_counter(self, counter_name):
+        raise log.Error('get_counter() not implemented!')
diff --git a/src/osmo_gsm_tester/obj/ms_srs.py b/src/osmo_gsm_tester/obj/ms_srs.py
index 106502d3..cb29f065 100644
--- a/src/osmo_gsm_tester/obj/ms_srs.py
+++ b/src/osmo_gsm_tester/obj/ms_srs.py
@@ -327,6 +327,20 @@ class srsUE(MS):
         proc.launch_sync()
         return proc
 
+    def _get_counter_handover_success(self):
+        # Match against sample line: "HO success"
+        n = 0
+        stdout_lines = (self.process.get_stdout() or '').splitlines()
+        for l in stdout_lines:
+            if l == 'HO successful':
+                n += 1
+        return n
+
+    def get_counter(self, counter_name):
+        if counter_name == 'handover_success':
+            return self._get_counter_handover_success()
+        raise log.Error('counter %s not implemented!' % counter_name)
+
     def verify_metric(self, value, operation='avg', metric='dl_brate', criterion='gt'):
         # file is not properly flushed until the process has stopped.
         if self.running():
diff --git a/sysmocom/scenarios/mod-enb-meas-enable.conf b/sysmocom/scenarios/mod-enb-meas-enable.conf
new file mode 100644
index 00000000..e3e841ec
--- /dev/null
+++ b/sysmocom/scenarios/mod-enb-meas-enable.conf
@@ -0,0 +1,3 @@
+modifiers:
+  enb:
+  - enable_measurements: true
diff --git a/sysmocom/suites/4g/handover.py b/sysmocom/suites/4g/handover.py
new file mode 100755
index 00000000..25b424bb
--- /dev/null
+++ b/sysmocom/suites/4g/handover.py
@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+from osmo_gsm_tester.testenv import *
+
+epc = suite.epc()
+enb = suite.enb()
+ue = suite.modem()
+iperf3srv = suite.iperf3srv({'addr': epc.tun_addr()})
+iperf3srv.set_run_node(epc.run_node())
+iperf3cli = iperf3srv.create_client()
+iperf3cli.set_run_node(ue.run_node())
+
+epc.subscriber_add(ue)
+epc.start()
+enb.ue_add(ue)
+enb.start(epc)
+
+print('waiting for ENB to connect to EPC...')
+wait(epc.enb_is_connected, enb)
+print('ENB is connected to EPC')
+
+ue.connect(enb)
+
+iperf3srv.start()
+proc = iperf3cli.prepare_test_proc(False, ue.netns(), 30)
+
+print('waiting for UE to attach...')
+wait(ue.is_connected, None)
+print('UE is attached')
+
+rfemu_cell1 = enb.get_rfemu(0)
+rfemu_cell2 = enb.get_rfemu(1)
+
+# attenuation from 0 to 10, then back to 0
+cell1_att_li = list(range(0, 11, 1)) + list(range(9, -1, -1))
+# attenuation from 10 to 0, then back to 10
+cell2_att_li = list(range(10, 0, -1)) + list(range(0, 11, 1))
+
+try:
+    proc.launch()
+    step = 0
+    while step < len(cell1_att_li):
+        rfemu_cell1.set_attenuation(cell1_att_li[step])
+        rfemu_cell2.set_attenuation(cell2_att_li[step])
+        step += 1
+        sleep(1)
+    num_handovers = ue.get_counter('handover_success')
+    if num_handovers != 2:
+        raise Exception('Wrong number of handovers %d vs expected 2' % num_handovers)
+except Exception as e:
+    try:
+        proc.terminate() # make sure we always terminate the process
+    except Exception:
+            print("Exception while terminating process %r" % repr(process))
+    raise e
+
+rest_str = 'Got %d successful handovers' % num_handovers
+print(res_str)
+test.set_report_stdout(res_str)
+proc.terminate()
+proc.wait()
+print("Done")