Increase test coverage score of dbus_tools (ukBaz#311)

.github/workflows/python-app.yml

@@ -55,3 +55,4 @@ jobs:
         /usr/bin/python3 -m unittest -v tests.test_find_microbit_db_mock
         /usr/bin/python3 -m unittest -v tests.test_microbit_uart_db_mock
         /usr/bin/python3 -m unittest -v tests.test_peripheral_db_mock
+        /usr/bin/python3 -m unittest -v tests.test_dbus_tools_mock

bluezero/dbus_tools.py

@@ -387,8 +387,7 @@ def get(dbus_prop_obj, dbus_iface, prop_name, default=None):
     try:
         return dbus_prop_obj.Get(dbus_iface, prop_name)
     except dbus.exceptions.DBusException as dbus_exception:
-        dbus_invalid_args = 'org.freedesktop.DBus.Error.InvalidArgs'
-        if dbus_exception.get_dbus_name() == dbus_invalid_args:
+        if 'UnknownProperty' in dbus_exception.get_dbus_name():
             return default
         else:
             raise dbus_exception

run_local_tests.sh

@@ -19,6 +19,8 @@ coverage run --append -m unittest -v tests.test_device
 test1006=$?
 coverage run --append -m unittest -v tests.test_gatt
 test1007=$?
+coverage run --append -m unittest -v tests.test_dbus_tools_mock
+test1008=$?
 coverage run --append -m unittest -v tests.test_broadcaster
 test101=$?
 coverage run --append -m unittest -v tests.test_central
@@ -61,7 +63,8 @@ coverage report
 coverage html
 echo file://`pwd`/htmlcov/index.html
 # google-chrome `pwd`/htmlcov/index.html &
-group100=$((test1001 + test1002 + test1003 + test1004 + test1005 + test1006 + test1007))
+group100=$((test1001 + test1002 + test1003 + test1004 + test1005 + \
+            test1006 + test1007 + test1008))
 group10=$((test101 + test102 + test103))
 group1=$((test11 + test12 + test13))
 group_examples=$((test_example1 + test_example2 + test_example3 + test_example4 + \

tests/test_dbus_tools_mock.py

@@ -0,0 +1,127 @@
+import dbus
+import dbusmock
+import io
+from pathlib import Path
+import subprocess
+from unittest import mock
+from unittest.mock import patch
+from tests.mock_eventloop import MockAsync
+
+# Module under test
+from bluezero import dbus_tools
+
+
+class TestAdapterExample(dbusmock.DBusTestCase):
+    """
+    Test mocking bluetoothd
+    """
+
+    @classmethod
+    def setUpClass(cls):
+        here = Path(__file__).parent
+        template = str(here.joinpath('dbusmock_templates', 'bluez_scan.py'))
+        cls.start_system_bus()
+        cls.dbus_con = cls.get_dbus(True)
+        (cls.p_mock, cls.obj_bluez) = cls.spawn_server_template(
+            template, {}, stdout=subprocess.PIPE)
+
+    def setUp(self):
+        self.obj_bluez.Reset()
+        self.dbusmock = dbus.Interface(self.obj_bluez, dbusmock.MOCK_IFACE)
+        self.dbusmock_bluez = dbus.Interface(self.obj_bluez, 'org.bluez.Mock')
+
+
+    @classmethod
+    def tearDownClass(cls):
+        cls.stop_dbus(cls.system_bus_pid)
+        cls.p_mock.terminate()
+        cls.p_mock.wait()
+
+    def test_dbus_int64(self):
+        self.dbusmock_bluez.AddAdapter('hci0', 'My-Test-Device')
+
+        result = dbus_tools.dbus_to_python(dbus.Int64(12))
+        self.assertTrue(isinstance(result, int))
+
+    def test_dbus_read_value(self):
+        result = dbus_tools.dbus_to_python(dbus.Array([dbus.Byte(66),
+                                                       dbus.Byte(97),
+                                                       dbus.Byte(122)],
+                                                      signature=dbus.Signature('y')))
+        self.assertListEqual(result, [66, 97, 122])
+
+    def test_dbus_dict(self):
+        result = dbus_tools.dbus_to_python(dbus.Dictionary(
+            {dbus.String('device'): dbus.ObjectPath('/org/bluez/hci0/dev_67_63_13_0D_37_01', variant_level=1),
+             dbus.String('link'): dbus.String('LE', variant_level=1),
+             dbus.String('mtu'): dbus.UInt16(512, variant_level=1)},
+            signature=dbus.Signature('sv'))
+        )
+        self.assertDictEqual({'device': '/org/bluez/hci0/dev_67_63_13_0D_37_01',
+                              'link': 'LE', 'mtu': 512},
+                             result)
+
+    def test_dbus_bool(self):
+        result = dbus_tools.dbus_to_python(dbus.Boolean(True))
+        self.assertTrue(isinstance(result, bool))
+
+    def test_dbus_double(self):
+        result = dbus_tools.dbus_to_python(dbus.Double(12.3))
+        self.assertTrue(12.3, result)
+
+    def test_str_to_dbusarray(self):
+        expected = dbus.Array([dbus.Byte(70), dbus.Byte(111), dbus.Byte(120)],
+                              signature=dbus.Signature('y'))
+        result = dbus_tools.str_to_dbusarray('Fox')
+        self.assertEqual(expected, result)
+
+    def test_bytes_to_dbusarray(self):
+        expected = dbus.Array([dbus.Byte(70), dbus.Byte(111), dbus.Byte(120)],
+                              signature=dbus.Signature('y'))
+        result = dbus_tools.bytes_to_dbusarray(b'Fox')
+        self.assertEqual(expected, result)
+
+    def test_bytes_to_dbusarray2(self):
+        expected = dbus.Array([dbus.Byte(0), dbus.Byte(1), dbus.Byte(2)],
+                              signature=dbus.Signature('y'))
+        result = dbus_tools.bytes_to_dbusarray(b'\x00\x01\x02')
+        self.assertEqual(expected, result)
+
+    def test_get_service(self):
+        result = dbus_tools.get_services('some/rubbish')
+        self.assertListEqual([], result)
+
+    def test_interfaces_added(self):
+        with patch('logging.Logger.debug') as logger:
+            result = dbus_tools.interfaces_added('/org/bluez/hci1/dev_00_11_22_33_44_55',
+                                                 'org.bluez.Device1')
+            logger.assert_called_once()
+
+    def test_properties_changed(self):
+        with patch('logging.Logger.debug') as logger:
+            result = dbus_tools.properties_changed('org.bluez.Device1',
+                                                   {'Connected': True},
+                                                   {}, '/org/bluez/hci0')
+            print(result)
+            logger.assert_called_once()
+
+    def test_get_property(self):
+        self.dbusmock_bluez.AddAdapter('hci0', 'My-Test-Device')
+
+        path_obj = dbus_tools.get_dbus_obj('/org/bluez/hci0')
+        result = dbus_tools.get(path_obj, 'org.bluez.Adapter1', 'Address')
+        self.assertEqual('00:01:02:03:04:05', result)
+
+    def test_get_property_exception(self):
+        self.dbusmock_bluez.AddAdapter('hci0', 'My-Test-Device')
+
+        path_obj = dbus_tools.get_dbus_obj('/org/bluez/hci0')
+        with self.assertRaises(dbus.exceptions.DBusException):
+            result = dbus_tools.get(path_obj, 'org.bluez.AdapterXX', 'Address')
+
+    def test_get_property_default(self):
+        self.dbusmock_bluez.AddAdapter('hci0', 'My-Test-Device')
+
+        path_obj = dbus_tools.get_dbus_obj('/org/bluez/hci0')
+        result = dbus_tools.get(path_obj, 'org.bluez.Adapter1', 'address', 'xx')
+        self.assertEqual('xx', result)