Merge lp:~charlesk/python-dbusmock/add-upower-device-set-properties into lp:python-dbusmock

[Charles Kerr]

Add support for changing upower device properties.

Add support for changing upower device properties.

[Martin Pitt (pitti)]

Looks good to me, with one little nitpick. Thanks!

review: Approve

[Martin Pitt (pitti)]

Hm, this causes a test failure:

======================================================================
FAIL: test_one_ac (test_upower.TestUPower)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/martin/upstream/python-dbusmock/tests/test_upower.py", line 107, in test_one_ac
    self.assertRegex(out, 'device changed:\s+' + path)
AssertionError: Regex didn't match: 'device changed:\\s+/org/freedesktop/UPower/devices/mock_AC' not found in 'Monitoring activity from the power daemon. Press Ctrl+C to cancel.\n'

----------------------------------------------------------------------
Ran 95 tests in 14.349s

[Martin Pitt (pitti)]

So this is genuinely broken for upower 0.99 and needs further investigation.

review: Needs Fixing

[Charles Kerr (charlesk)]

Okay so the issue is that the spawned template in the unit tests is always mocking the UPower 0 API, even when UPower 0.99 is installed, so there's a disconnect between the signals that the installed "dbus --monitor" is expecting and what the dbusmock is sending.

This worked before because the signal is emitted from the unit test code (which knows the installed upower version) instead of the template (which is mocking UPower 0).

When using "dbus --monitor" to sniff for events, we need to mock the installed version of upower. So I changed the test to pass the installed version as the 'DaemonVersion' parameter when spawning the template.

This caused a couple of side-effects, test_suspend() and test_no_display_device() both fail on 0.99 since Suspend was removed and DisplayDevice was added. :)

So, I've moved these (and the other test_09_properties()) methods out into a TestUPower0 class as a sibling to the existing TestUPower1 class for testing UPower 0-specific behavior.

[lp:~charlesk/python-dbusmock/add-upower-device-set-properties]

223. By Charles Kerr on 2015-01-16

if a test relies on the installed version of upower, make sure to mock the installed version.

224. By Charles Kerr on 2015-01-16

fix upower.SetDeviceProperties' input argument signature

[lp:~charlesk/python-dbusmock/add-upower-device-set-properties]

225. By Charles Kerr on 2015-01-16

silence a flake8 'too many blank lines' warning

[Martin Pitt (pitti)]

Indeed, thanks for fixing this! I committed this to trunk: https://gitorious.org/python-dbusmock/python-dbusmock/commit/3f55ea9876fa

Closing MP manually as the LP branch is only a bzr mirror of the upstream git for PPA recipe purposes.

review: Approve

[Martin Pitt (pitti)]

I did an upstream 0.12 release with this. Will upload to Debian experimental and then sync into vivid.

review: Approve

=== modified file 'dbusmock/templates/upower.py'
--- dbusmock/templates/upower.py	2014-09-22 08:23:08 +0000
+++ dbusmock/templates/upower.py	2015-01-16 21:21:16 +0000
@@ -24,11 +24,13 @@
 import dbus
 
 from dbusmock import MOCK_IFACE, mockobject
+import dbusmock
 
 BUS_NAME = 'org.freedesktop.UPower'
 MAIN_OBJ = '/org/freedesktop/UPower'
 MAIN_IFACE = 'org.freedesktop.UPower'
 SYSTEM_BUS = True
+DEVICE_IFACE = 'org.freedesktop.UPower.Device'
 
 
 def load(mock, parameters):
@@ -59,7 +61,7 @@
         # add Display device; for defined properties, see
         # http://cgit.freedesktop.org/upower/tree/src/org.freedesktop.UPower.xml
         mock.AddObject(mock.p_display_dev,
-                       'org.freedesktop.UPower.Device',
+                       DEVICE_IFACE,
                        {
                            'Type': dbus.UInt32(0, variant_level=1),
                            'State': dbus.UInt32(0, variant_level=1),
@@ -109,7 +111,7 @@
     '''
     path = '/org/freedesktop/UPower/devices/' + device_name
     self.AddObject(path,
-                   'org.freedesktop.UPower.Device',
+                   DEVICE_IFACE,
                    {
                        'PowerSupply': dbus.Boolean(True, variant_level=1),
                        'Model': dbus.String(model_name, variant_level=1),
@@ -136,7 +138,7 @@
     '''
     path = '/org/freedesktop/UPower/devices/' + device_name
     self.AddObject(path,
-                   'org.freedesktop.UPower.Device',
+                   DEVICE_IFACE,
                    {
                        'PowerSupply': dbus.Boolean(True, variant_level=1),
                        'IsPresent': dbus.Boolean(True, variant_level=1),
@@ -171,7 +173,7 @@
     '''
     path = '/org/freedesktop/UPower/devices/' + device_name
     self.AddObject(path,
-                   'org.freedesktop.UPower.Device',
+                   DEVICE_IFACE,
                    {
                        'PowerSupply': dbus.Boolean(True, variant_level=1),
                        'IsPresent': dbus.Boolean(True, variant_level=1),
@@ -209,24 +211,55 @@
             'SetupDisplayDevice() can only be used with the 1.0 API')
 
     display_props = mockobject.objects[self.p_display_dev]
-    display_props.Set('org.freedesktop.UPower.Device', 'Type',
+    display_props.Set(DEVICE_IFACE, 'Type',
                       dbus.UInt32(type))
-    display_props.Set('org.freedesktop.UPower.Device', 'State',
+    display_props.Set(DEVICE_IFACE, 'State',
                       dbus.UInt32(state))
-    display_props.Set('org.freedesktop.UPower.Device', 'Percentage',
+    display_props.Set(DEVICE_IFACE, 'Percentage',
                       percentage)
-    display_props.Set('org.freedesktop.UPower.Device', 'Energy', energy)
-    display_props.Set('org.freedesktop.UPower.Device', 'EnergyFull',
+    display_props.Set(DEVICE_IFACE, 'Energy', energy)
+    display_props.Set(DEVICE_IFACE, 'EnergyFull',
                       energy_full)
-    display_props.Set('org.freedesktop.UPower.Device', 'EnergyRate',
+    display_props.Set(DEVICE_IFACE, 'EnergyRate',
                       energy_rate)
-    display_props.Set('org.freedesktop.UPower.Device', 'TimeToEmpty',
+    display_props.Set(DEVICE_IFACE, 'TimeToEmpty',
                       dbus.Int64(time_to_empty))
-    display_props.Set('org.freedesktop.UPower.Device', 'TimeToFull',
+    display_props.Set(DEVICE_IFACE, 'TimeToFull',
                       dbus.Int64(time_to_full))
-    display_props.Set('org.freedesktop.UPower.Device', 'IsPresent',
+    display_props.Set(DEVICE_IFACE, 'IsPresent',
                       is_present)
-    display_props.Set('org.freedesktop.UPower.Device', 'IconName',
+    display_props.Set(DEVICE_IFACE, 'IconName',
                       icon_name)
-    display_props.Set('org.freedesktop.UPower.Device', 'WarningLevel',
+    display_props.Set(DEVICE_IFACE, 'WarningLevel',
                       dbus.UInt32(warning_level))
+
+
[e-mail](MOCK_IFACE, in_signature='oa{sv}', out_signature='')
+def SetDeviceProperties(self, object_path, properties):
+    '''Convenience method to Set a device's properties.
+
+    object_path: the device to update
+    properties: dictionary of keys to dbus variants.
+
+    If the 1.0 API is being mocked, changing this property will trigger
+    the device's PropertiesChanged signal; otherwise, the older
+    org.freedesktop.UPower DeviceChanged signal will be emitted.
+    '''
+    device = dbusmock.get_object(object_path)
+
+    # set the properties
+    for key, value in properties.items():
+        device.Set(DEVICE_IFACE, key, value)
+
+    # notify the listeners
+    if self.api1:
+        device.EmitSignal(dbus.PROPERTIES_IFACE,
+                          'PropertiesChanged',
+                          'sa{sv}as',
+                          [
+                              DEVICE_IFACE,
+                              properties,
+                              []
+                          ])
+    else:
+        self.EmitSignal(MAIN_IFACE, 'DeviceChanged', 's', [object_path])

=== modified file 'tests/test_upower.py'
--- tests/test_upower.py	2014-09-22 08:23:08 +0000
+++ tests/test_upower.py	2015-01-16 21:21:16 +0000
@@ -55,7 +55,12 @@
 
     def setUp(self):
         (self.p_mock, self.obj_upower) = self.spawn_server_template(
-            'upower', {'OnBattery': True, 'HibernateAllowed': False}, stdout=subprocess.PIPE)
+            'upower', {
+                'OnBattery': True,
+                'HibernateAllowed': False,
+                'DaemonVersion': upower_client_version
+            },
+            stdout=subprocess.PIPE)
         # set log to nonblocking
         flags = fcntl.fcntl(self.p_mock.stdout, fcntl.F_GETFL)
         fcntl.fcntl(self.p_mock.stdout, fcntl.F_SETFL, flags | os.O_NONBLOCK)
@@ -80,7 +85,6 @@
     def test_one_ac(self):
         path = self.dbusmock.AddAC('mock_AC', 'Mock AC')
         self.assertEqual(path, '/org/freedesktop/UPower/devices/mock_AC')
-        ac_obj = self.dbus_con.get_object('org.freedesktop.UPower', path)
 
         self.assertRegex(self.p_mock.stdout.read(),
                          b'emit org.freedesktop.UPower.DeviceAdded '
@@ -100,16 +104,9 @@
                                universal_newlines=True)
 
         time.sleep(0.3)
-        if upower_client_version < '0.99':
-            # for 0.9 API
-            self.dbusmock.EmitSignal('', 'DeviceChanged', 's', [path])
-        else:
-            # for 1.0 API
-            ac_obj.EmitSignal(dbus.PROPERTIES_IFACE, 'PropertiesChanged', 'sa{sv}as',
-                              dbus.Array(['org.freedesktop.UPower.Device',
-                                          {'PowerSupply': dbus.Boolean(True, variant_level=1)},
-                                          dbus.Array([], signature='s')],
-                                         signature='v'))
+        self.dbusmock.SetDeviceProperties(path, {
+            'PowerSupply': dbus.Boolean(True, variant_level=1)
+        })
         time.sleep(0.2)
 
         mon.terminate()
@@ -157,12 +154,39 @@
         self.assertRegex(out, ' time to full:\s+20.0 min')
         self.assertRegex(out, ' state:\s+charging')
 
+
[e-mail](have_upower, 'upower not installed')
[e-mail](upower_client_version <= '0.99', 'pre-0.99 client API specific test')
+class TestUPower0(dbusmock.DBusTestCase):
+    '''Test mocking upowerd with 0.x API'''
+
+    @classmethod
+    def setUpClass(klass):
+        klass.start_system_bus()
+        klass.dbus_con = klass.get_dbus(True)
+
+    def setUp(self):
+        (self.p_mock, self.obj_upower) = self.spawn_server_template(
+            'upower', {
+                'OnBattery': True,
+                'HibernateAllowed': False,
+                'DaemonVersion': '0.9'
+            },
+            stdout=subprocess.PIPE)
+        # set log to nonblocking
+        flags = fcntl.fcntl(self.p_mock.stdout, fcntl.F_GETFL)
+        fcntl.fcntl(self.p_mock.stdout, fcntl.F_SETFL, flags | os.O_NONBLOCK)
+        self.dbusmock = dbus.Interface(self.obj_upower, dbusmock.MOCK_IFACE)
+
+    def tearDown(self):
+        self.p_mock.terminate()
+        self.p_mock.wait()
+
     def test_suspend(self):
+        '''0.9 API specific Suspend signal'''
         self.obj_upower.Suspend(dbus_interface='org.freedesktop.UPower')
         self.assertRegex(self.p_mock.stdout.readline(), b'^[0-9.]+ Suspend$')
 
-    @unittest.skipUnless(upower_client_version < '0.99',
-                         '0.9 client API specific test')
     def test_09_properties(self):
         '''0.9 API specific properties'''
 
@@ -174,6 +198,7 @@
         self.assertNotIn('critical-action:', out)
 
     def test_no_display_device(self):
+        '''0.9 API has no display device'''
         self.assertRaises(dbus.exceptions.DBusException,
                           self.obj_upower.GetDisplayDevice)