Revise eddystone scanner (Bugfix) (#2260)

* removed older beacontools

removed older beacontools

* revised eddystone scanner

revised eddystone scanner scripts for a bluetooth controller without extended advertising support

* update eddystone unit tests

update eddystone unit tests

* fix eddystone_scanner

fix eddystone_scanner

* fix coding style issue

fix coding style issue

Author: stanley31huang

checkbox-support/checkbox_support/scripts/eddystone_scanner.py

@@ -28,6 +28,7 @@
     EddystoneURLFrame,
 )
 from checkbox_support.helpers.timeout import timeout
+from checkbox_support.helpers.retry import retry
 from checkbox_support.interactive_cmd import InteractiveCommand
 
 
@@ -36,38 +37,50 @@ def init_bluetooth():
     with InteractiveCommand("bluetoothctl") as btctl:
         btctl.writeline("power on")
         time.sleep(3)
-        btctl.writeline("scan on")
-        time.sleep(3)
         btctl.writeline("exit")
         btctl.kill()
 
 
-def beacon_scan(hci_device):
-    TIMEOUT = 10
-
+@retry(3, delay=10)
+def beacon_scan(hci_device, debug=False):
+    TIMEOUT = 60
+    report_type = None
     beacon_mac = beacon_rssi = beacon_packet = ""
 
-    def callback(bt_addr, rssi, packet, additional_info):
-        nonlocal beacon_mac, beacon_rssi, beacon_packet
-        beacon_mac, beacon_rssi, beacon_packet = bt_addr, rssi, packet
+    def callback(sub_event, bt_addr, rssi, packet, additional_info):
+        nonlocal beacon_mac, beacon_rssi, beacon_packet, report_type
+        report_type, beacon_mac, beacon_rssi, beacon_packet = (
+            sub_event,
+            bt_addr,
+            rssi,
+            packet,
+        )
 
     scanner = BeaconScanner(
-        callback, bt_device_id=hci_device, packet_filter=EddystoneURLFrame
+        callback,
+        bt_device_id=hci_device,
+        packet_filter=EddystoneURLFrame,
+        debug=debug,
     )
 
     scanner.start()
     start = time.time()
     while not beacon_packet and time.time() - start < TIMEOUT:
-        time.sleep(1)
+        time.sleep(0.5)
     scanner.stop()
     if beacon_packet:
         print(
-            "Eddystone beacon detected: URL: {} <mac: {}> "
-            "<rssi: {}>".format(beacon_packet.url, beacon_mac, beacon_rssi)
+            "Eddystone beacon detected: [Adv Report Type: {}({})] "
+            "URL: {} <mac: {}> <rssi: {}>".format(
+                report_type.name,
+                report_type.value,
+                beacon_packet.url,
+                beacon_mac,
+                beacon_rssi,
+            )
         )
         return 0
-    print("No EddyStone URL advertisement detected!")
-    return 1
+    raise RuntimeError("No EddyStone URL advertisement detected!")
 
 
 @timeout(60 * 10)  # 10 minutes timeout
@@ -85,6 +98,11 @@ def main(argv=None):
         default="hci0",
         help="Select the hciX device to use " "(default hci0).",
     )
+    parser.add_argument(
+        "--debug",
+        action="store_true",
+        default=False,
+    )
     args = parser.parse_args(argv)
 
     try:
@@ -93,23 +111,7 @@ def main(argv=None):
         print("Bad device argument, defaulting to hci0")
         hci_device = 0
 
-    # Newer bluetooth controllers and bluez versions allow extended commands
-    # supported by newer versions of beacontools. But with older controllers,
-    # especially when running on bionic, core18, bluez < 5.51, etc. they
-    # only work correctly with legacy commands, and need an older version
-    # of beacontools to work properly.
-    # Try the newest one first, then the older one if that doesn't work
-    rc = beacon_scan(hci_device)
-    if rc:
-        print("Trying again with older beacontools version...")
-        global BeaconScanner, EddystoneURLFrame
-        from checkbox_support.vendor.beacontools_2_0_2 import (
-            BeaconScanner,
-            EddystoneURLFrame,
-        )
-
-        rc = beacon_scan(hci_device)
-    return rc
+    return beacon_scan(hci_device, args.debug)
 
 
 if __name__ == "__main__":

checkbox-support/checkbox_support/tests/test_eddystone_scanner.py

@@ -17,43 +17,69 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+import argparse
 import unittest
 from unittest.mock import patch, MagicMock
 
+from checkbox_support.helpers.timeout import mock_timeout
+from checkbox_support.helpers.retry import mock_retry
 from checkbox_support.scripts import eddystone_scanner
+from checkbox_support.vendor.beacontools.const import MetaEventReportTypeEnum
 
 
 class TestEddystoneScanner(unittest.TestCase):
+    @patch("builtins.print")
     @patch("checkbox_support.scripts.eddystone_scanner.BeaconScanner")
-    def test_beacon_scan_ok(self, mock_beacon_scanner):
+    def test_beacon_scan_ok(self, mock_beacon_scanner, mock_print):
         class BeaconScanner:
             def __init__(self, callback, *args, **kwargs):
                 self.callback = callback
 
             def start(self):
                 packet = MagicMock(url="packet_url")
-                self.callback("address", "rssi", packet, None)
+                self.callback(
+                    MetaEventReportTypeEnum.LE_ADVERTISING_REPORT,
+                    "address",
+                    "rssi",
+                    packet,
+                    None,
+                )
 
             def stop(self):
                 pass
 
         mock_beacon_scanner.side_effect = BeaconScanner
-        self.assertEqual(eddystone_scanner.beacon_scan("1"), 0)
+        self.assertEqual(eddystone_scanner.beacon_scan("1", True), 0)
+        call_args = mock_beacon_scanner.call_args
+        _, kwargs = call_args
+
+        self.assertEqual(kwargs["bt_device_id"], "1")
+        self.assertEqual(kwargs["debug"], True)
+        mock_print.assert_called_with(
+            (
+                "Eddystone beacon detected: [Adv Report Type: {}({})] "
+                "URL: packet_url <mac: address> <rssi: rssi>"
+            ).format(
+                MetaEventReportTypeEnum.LE_ADVERTISING_REPORT.name,
+                MetaEventReportTypeEnum.LE_ADVERTISING_REPORT.value,
+            )
+        )
 
+    @mock_retry()
     @patch("checkbox_support.scripts.eddystone_scanner.BeaconScanner")
     @patch("time.time")
-    @patch("time.sleep")
-    def test_beacon_scan_fail(
-        self, mock_sleep, mock_time, mock_beacon_scanner
-    ):
-        mock_time.side_effect = [0, 60 * 60 * 60]  # 60h, trigger timeout
-        self.assertEqual(eddystone_scanner.beacon_scan("1"), 1)
+    def test_beacon_scan_fail(self, mock_time, mock_beacon_scanner):
+        mock_time.side_effect = [0, 1, 60 * 60 * 60]  # 60h, trigger timeout
+        with self.assertRaises(RuntimeError):
+            eddystone_scanner.beacon_scan("1")
 
-    @patch("checkbox_support.scripts.eddystone_scanner.BeaconScanner")
-    @patch("checkbox_support.scripts.eddystone_scanner.InteractiveCommand")
-    @patch("time.sleep")
+    @mock_timeout()
+    @patch.object(argparse.ArgumentParser, "parse_args")
+    @patch.object(argparse.ArgumentParser, "add_argument")
+    @patch("checkbox_support.scripts.eddystone_scanner.beacon_scan")
+    @patch("checkbox_support.scripts.eddystone_scanner.init_bluetooth")
     def test_main_ok(
-        self, mock_sleep, mock_interactive_command, mock_beacon_scanner
+        self, mock_init, mock_beacon_scan, mock_add_arg, mock_parse_args
     ):
         class BeaconScanner:
             def __init__(self, callback, *args, **kwargs):
@@ -66,5 +92,16 @@ def start(self):
             def stop(self):
                 pass
 
-        mock_beacon_scanner.side_effect = BeaconScanner
-        self.assertEqual(eddystone_scanner.main(["--device", "hc1"]), 0)
+        mock_parse_args.return_value = argparse.Namespace(
+            device="hci1", debug=True
+        )
+        mock_beacon_scan.return_value = 0
+
+        input_args = ["--device", "hci1", "--debug"]
+        self.assertEqual(eddystone_scanner.main(input_args), 0)
+
+        mock_add_arg.assert_called_with(
+            "--debug", action="store_true", default=False
+        )
+        mock_init.assert_called_once_with()
+        mock_beacon_scan.assert_called_with(1, True)