Please help me mock libnotify notifications

[mbridon]

I had originally opened #230, but then due to health issues I spent a few months without ever answering @martinpitt in that issue. 😞

So now I did manage to to get a machine id in my CI. 😉

Now what I need is to mock org.freedesktop.Notifications so the tests can send notifications while there is a dbus session service running to catch those.

I think I can do that as follows:

import dbus
import dbusmock
import subprocess


class TestMyProgram(dbusmock.DBusTestCase):
    @classmethod
    def setUpClass(cls):
        cls.start_session_bus()
        cls.dbus_con = cls.get_dbus(session_bus=True)

    def setUp(self):
        self.p_mock = self.spawn_server('org.freedesktop.Notification',
                                        '/org/freedesktop/Notification',
                                        'org.freedesktop.Notification',
                                        session_bus=True,
                                        stdout=subprocess.PIPE)

        # Get a proxy for the UPower object's Mock interface
        self.dbus_notification_mock = dbus.Interface(self.dbus_con.get_object(
            'org.freedesktop.Notification', '/org/freedesktop/Notification'),
            dbusmock.MOCK_IFACE)

        self.dbus_upower_mock.AddMethod('', 'Notify', '', '', '')

    def tearDown(self):
        self.p_mock.stdout.close()
        self.p_mock.terminate()
        self.p_mock.wait()

    def test_suspend_on_idle(self):
        # That's where I suppose I can run the tests which would send notifications, right? 🤔 

        # now check the log that we got one Suspend() call
        self.assertRegex(self.p_mock.stdout.readline(), b'^[0-9.]+ Suspend$')

Again, my apologies for not having given any sign of life, I'll try harder next time, I promise. 🙇

[martinpitt]

Sorry @mbridon now it's my turn to apologize for the late reply. This is just a hobby project of mine now.

This actually looks quite fine. Aside from the "upower" copy-pasta, you are missing a few auxiliary methods like GetCapabilities() and GetServerInformation() which libnotify calls. dbusmock ships a notification-daemon template which you can use very easily. See the template documentation and the template tests for a fully fleshed-out example how to use it. Where your code does

That's where I suppose I can run the tests which would send notifications, right? 🤔

the tests call notify-send, as that's more or less the reference implementation of what dbusmock has to convince.

[mbridon]

Sorry @mbridon now it's my turn to apologize for the late reply. This is just a hobby project of mine now.

Hi, no problem at all. 😊

This actually looks quite fine. Aside from the "upower" copy-pasta, you are missing a few auxiliary methods like GetCapabilities() and GetServerInformation() which libnotify calls. dbusmock ships a notification-daemon template which you can use very easily. See the template documentation and the template tests for a fully fleshed-out example how to use it.

Thank you for the pointers!

Here is my code right now: https://gitlab.freedesktop.org/cangjie/ibus-cangjie/-/blob/donations/src/ibus_cangjie/engine.py.in?ref_type=heads#L424-445

Those are the lines where I try to display a notification when the engine is running, asking for optional support from our users. I'm trying to avoid nagging them too much and only show the notification if 1. the checkbox is ticked to enable requesting support and 2. not show the notification more often than once a year https://gitlab.freedesktop.org/cangjie/ibus-cangjie/-/blob/donations/src/ibus_cangjie/engine.py.in?ref_type=heads#L61-67 (for now I show it always, but once this code will be released I will remove the last line which shows always for testing). 😉

Clicking the notification will take users to this page: https://cangjie.pages.freedesktop.org/donate.html

Where your code does

That's where I suppose I can run the tests which would send notifications, right? 🤔

the tests call notify-send, as that's more or less the reference implementation of what dbusmock has to convince.

At the moment, the tests don't use notify-send because as I linked to above, I implemented showing the notifications in Python.

So, how could I reuse your notification_daemon.py template from above? 🤔

My tests are run by meson test -C builddir, which runs what is here.

I suppose this would be where I would do something like the following:

from dbusmock.templates import notification_daemon

And then that's as far as I can understand using dbusmock. 😖

It seems to me I should maybe run a dbus service with dbusmock which would answer the notification events: showing them, and then having the tests virtually "click" them I guess? 🤔

Except I have no idea how to do any of that unfortunately. 😭

I guess my brain is not big/galaxy enough to make it work... 😝

Also, do not feel pressured to reply any time soon, this is also a hobby project for me, so I'm fine with waiting for an answer, just put it somewhere on your back-burner so you don't forget about it forever. 😉

Or if you could just confirm me whether I have the right ideas or not, then I can try and figure it out on my own. 😊