summaryrefslogtreecommitdiffstats
path: root/panels/power/power-panel-scenario-tester.py
blob: 59860f793d243842abed2ce9dced6a9e1ed8b81e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
#!/usr/bin/env python3

# Copyright (C) 2021 Red Hat Inc.
#
# Author: Bastien Nocera <hadess@hadess.net>
#
# SPDX-License-Identifier: GPL-2.0-or-later

import dbus
import dbusmock
import sys
import os
import fcntl
import gi
import subprocess
import time
from collections import OrderedDict
from dbusmock import DBusTestCase
from dbus.mainloop.glib import DBusGMainLoop
from consolemenu import *
from consolemenu.items import *

gi.require_version('UPowerGlib', '1.0')
gi.require_version('UMockdev', '1.0')

from gi.repository import Gio
from gi.repository import GLib
from gi.repository import UPowerGlib
from gi.repository import UMockdev

DBusGMainLoop(set_as_default=True)


def set_nonblock(fd):
    '''Set a file object to non-blocking'''
    flags = fcntl.fcntl(fd, fcntl.F_GETFL)
    fcntl.fcntl(fd, fcntl.F_SETFL, flags | os.O_NONBLOCK)

def get_templates_dir():
    return os.path.join(os.path.dirname(__file__), 'dbusmock-templates')

def get_template_path(template_name):
    return os.path.join(get_templates_dir(), template_name + '.py')

class GccDBusTestCase(DBusTestCase):
    @classmethod
    def setUpClass(klass):
        klass.mocks = OrderedDict()

        # Start system bus
        DBusTestCase.setUpClass()
        klass.test_bus = Gio.TestDBus.new(Gio.TestDBusFlags.NONE)
        klass.test_bus.up()
        os.environ['DBUS_SYSTEM_BUS_ADDRESS'] = klass.test_bus.get_bus_address()

        # Find upower
        if os.environ.get('UNDER_JHBUILD', False):
            jhbuild_prefix = os.environ['JHBUILD_PREFIX']
            klass.upowerd_path = os.path.join(jhbuild_prefix, 'libexec', 'upowerd')
            if not GLib.file_test(klass.upowerd_path, GLib.FileTest.IS_EXECUTABLE):
                klass.upowerd_path = None

        if not os.environ.get('UNDER_JHBUILD', False) or klass.upowerd_path == None:
            klass.upowerd_path = None
            with open('/usr/share/dbus-1/system-services/org.freedesktop.UPower.service') as f:
                for line in f:
                    if line.startswith('Exec='):
                        klass.upowerd_path = line.split('=', 1)[1].strip()
                        break
            assert klass.upowerd_path, 'could not determine daemon path from D-BUS .service file'

        # Start mock udev
        klass.testbed = UMockdev.Testbed.new()

        # Start ppd and logind
        klass.start_from_template('power_profiles_daemon')
        klass.start_from_template('logind')

        klass.system_bus = Gio.bus_get_sync(Gio.BusType.SYSTEM, None)

    @classmethod
    def tearDownClass(klass):
        for (mock_server, mock_obj) in reversed(klass.mocks.values()):
            mock_server.terminate()
            mock_server.wait()

        DBusTestCase.tearDownClass()

    @classmethod
    def start_from_template(klass, template, params={}):
        mock_server, mock_obj = \
            klass.spawn_server_template(template,
                                        params,
                                        stdout=subprocess.PIPE)
        set_nonblock(mock_server.stdout)

        mocks = (mock_server, mock_obj)
        assert klass.mocks.setdefault(template, mocks) == mocks
        return mocks

    def get_upower_property(self, name):
        '''Get property value from UPower D-Bus interface.'''

        proxy = Gio.DBusProxy.new_sync(
            self.system_bus, Gio.DBusProxyFlags.DO_NOT_AUTO_START, None, 'org.freedesktop.UPower',
            '/org/freedesktop/UPower', 'org.freedesktop.DBus.Properties', None)
        return proxy.Get('(ss)', 'org.freedesktop.UPower', name)

    def __init__(self):
        self.devices = {}
        self.ppd = self.mocks['power_profiles_daemon'][1]

        os.environ['UMOCKDEV_DIR'] = self.testbed.get_root_dir()
        # See https://github.com/systemd/systemd/pull/21761
        # os.environ['SYSTEMD_LOG_LEVEL'] = 'debug'
        self.upowerd = subprocess.Popen([ self.upowerd_path ],
                                        env=os.environ, stdout=None,
                                        stderr=subprocess.STDOUT)

        # wait until the daemon gets online
        timeout = 100
        while timeout > 0:
            time.sleep(0.1)
            timeout -= 1
            try:
                self.get_upower_property('DaemonVersion')
                break
            except GLib.GError:
                pass
        else:
            self.fail('daemon did not start in 10 seconds')

        # self.assertEqual(self.upowerd.poll(), None, 'daemon crashed')

    def toggle_devices(self, device_types):
        for _type in device_types:
            if _type not in self.devices:
                self.devices[_type] = self.add_device(_type)
                # print('added ' + _type)
            else:
                # print('removing ' + _type)
                devs = self.devices[_type]
                devs.reverse()
                for dev in devs:
                    self.testbed.uevent(dev, 'remove')
                    self.testbed.remove_device(dev)
                del self.devices[_type]

        # out = subprocess.check_output(['upower', '--dump'],
        #               universal_newlines=True)
        # print(out)

    def add_device(self, device):
        if device == 'battery':
            dev = self.testbed.add_device('power_supply', 'BAT0', None,
                    ['type', 'Battery',
                     'present', '1',
                     'status', 'Discharging',
                     'energy_full', '60000000',
                     'energy_full_design', '80000000',
                     'energy_now', '48000000',
                     'voltage_now', '12000000',
                     'cycle_count', '250'], [])
            return [ dev ]

        elif device == '2nd-battery':
            # Not charging or discharging
            # No cycle count available
            dev = self.testbed.add_device('power_supply', 'BAT1', None,
                    ['type', 'Battery',
                     'present', '1',
                     'status', 'Not charging',
                     'energy_full', '30000000',
                     'energy_full_design', '40000000',
                     'energy_now', '20000000',
                     'voltage_now', '12000000',
                     'cycle_count', '-1'], [])
            return [ dev ]

        elif device == 'ac':
            dev = self.testbed.add_device('power_supply', 'AC', None,
                    ['type', 'Mains', 'online', '0'], [])
            return [ dev ]

        elif device == 'keyboard':
            dev = self.testbed.add_device('bluetooth',
                    'usb2/bluetooth/hci0/hci0:1',
                    None,
                    [], [])
            devs = [ dev ]

            parent = dev
            devs.append(self.testbed.add_device(
                    'input',
                    'input3/event4',
                    parent,
                    [], ['DEVNAME', 'input/event4', 'ID_INPUT_KEYBOARD', '1']))

            devs.append(self.testbed.add_device(
                    'power_supply',
                    'power_supply/hid-00:22:33:44:55:66-battery',
                    parent,
                    ['type', 'Battery',
                        'scope', 'Device',
                        'present', '1',
                        'online', '1',
                        'status', 'Discharging',
                        'capacity', '40',
                        'model_name', 'Monster Typist'],
                    []))
            return devs

        elif device == 'mouse':
            dev = self.testbed.add_device('hid',
                    '/devices/pci0000:00/0000:00:14.0/usb3/3-10/3-10:1.2/0003:046D:C52B.0009/0003:046D:4101.000A',
                    None,
                    [], [])
            devs = [ dev ]

            parent = dev
            devs.append(self.testbed.add_device('input',
                    '/devices/pci0000:00/0000:00:14.0/usb3/3-10/3-10:1.2/0003:046D:C52B.0009/0003:046D:4101.000A/input/input22',
                    parent,
                    [], ['DEVNAME', 'input/mouse3', 'ID_INPUT_MOUSE', '1']))

            devs.append(self.testbed.add_device('power_supply',
                    '/devices/pci0000:00/0000:00:14.0/usb3/3-10/3-10:1.2/0003:046D:C52B.0009/0003:046D:4101.000A/power_supply/hidpp_battery_3',
                    parent,
                    ['type', 'Battery',
                     'scope', 'Device',
                     'present', '1',
                     'online', '1',
                     'status', 'Discharging',
                     'capacity', '30',
                     'serial_number', '123456',
                     'model_name', 'Fancy Mouse'],
                    []))
            return devs

        elif device == 'ups':
            dev = self.testbed.add_device('usb', 'hiddev0', None, [],
                    ['DEVNAME', 'null',
                     'UPOWER_VENDOR', 'APC',
                     'UPOWER_BATTERY_TYPE', 'ups',
                     'UPOWER_FAKE_DEVICE', '1',
                     'UPOWER_FAKE_HID_CHARGING', '0',
                     'UPOWER_FAKE_HID_PERCENTAGE', '70'])
            return [ dev ]

        print('Unhandled device')
        return None

    def cycle_degraded(self):
        perf = self.ppd.Get('net.hadess.PowerProfiles', 'PerformanceDegraded')
        if perf == '':
            perf = 'lap-detected'
        elif perf == 'lap-detected':
            perf = 'high-operating-temperature'
        elif perf == 'high-operating-temperature':
            perf = ''
        mock_iface = dbus.Interface(self.ppd, dbusmock.MOCK_IFACE)
        mock_iface.UpdateProperties('net.hadess.PowerProfiles', {
                'PerformanceDegraded': dbus.String(perf, variant_level=1)
        })

    def start_menu(self):
        menu = ConsoleMenu("Power Panel", "Scenario Tester", clear_screen = False)
        function_item = FunctionItem("Toggle Keyboard", self.toggle_devices, [["keyboard"]])
        menu.append_item(function_item)

        function_item = FunctionItem("Toggle Mouse", self.toggle_devices, [["mouse"]])
        menu.append_item(function_item)

        function_item = FunctionItem("Toggle UPS", self.toggle_devices, [["ups"]])
        menu.append_item(function_item)

        function_item = FunctionItem("Toggle laptop battery", self.toggle_devices, [['ac', 'battery']])
        menu.append_item(function_item)

        function_item = FunctionItem("Toggle 2nd battery", self.toggle_devices, [['2nd-battery']])
        menu.append_item(function_item)

        function_item = FunctionItem("Cycle degraded performance", self.cycle_degraded, [])
        menu.append_item(function_item)

        menu.start(show_exit_option=False)

    def wrap_call(self):
        os.environ['GSETTINGS_BACKEND'] = 'memory'

        wrapper = os.environ.get('META_DBUS_RUNNER_WRAPPER')
        args = ['gnome-control-center', 'power']
        if wrapper == 'gdb':
            args = ['gdb', '-ex', 'r', '-ex', 'bt full', '--args'] + args
        elif wrapper:
            args = wrapper.split(' ') + args

        p = subprocess.Popen(args, env=os.environ)
        p.wait()

if __name__ == '__main__':
    if 'umockdev' not in os.environ.get('LD_PRELOAD', ''):
        os.execvp('umockdev-wrapper', ['umockdev-wrapper'] + sys.argv)

    GccDBusTestCase.setUpClass()
    test_case = GccDBusTestCase()
    test_case.start_menu()
    try:
        test_case.wrap_call()
    finally:
        GccDBusTestCase.tearDownClass()