test/test-service.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (C) 2004 Red Hat Inc. <http://www.redhat.com/>
   4 # Copyright (C) 2005, 2006 Collabora Ltd. <http://www.collabora.co.uk/>
   5 #
   6 # Licensed under the Academic Free License version 2.1
   7 #
   8 # This program is free software; you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 2 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21
  22 import sys
  23 import os
  24 import logging
  25
  26 builddir = os.path.normpath(os.environ["DBUS_TOP_BUILDDIR"])
  27 pydir = os.path.normpath(os.environ["DBUS_TOP_SRCDIR"])
  28
  29 import dbus
  30
  31 if not dbus.__file__.startswith(pydir):
  32     raise Exception("DBus modules are not being picked up from the package")
  33
  34 import dbus.service
  35 import dbus.glib
  36 import gobject
  37 import random
  38
  39 from dbus.gobject_service import ExportedGObject
  40
  41
  42 logging.basicConfig(filename=builddir + '/test/test-service.log', filemode='w')
  43 logging.getLogger().setLevel(1)
  44 logger = logging.getLogger('test-service')
  45
  46
  47 NAME = "org.freedesktop.DBus.TestSuitePythonService"
  48 IFACE = "org.freedesktop.DBus.TestSuiteInterface"
  49 OBJECT = "/org/freedesktop/DBus/TestSuitePythonObject"
  50
  51 class TestGObject(ExportedGObject):
  52     def __init__(self, bus_name, object_path=OBJECT + '/GObject'):
  53         super(TestGObject, self).__init__(bus_name, object_path)
  54
  55     @dbus.service.method(IFACE)
  56     def Echo(self, arg):
  57         return arg
  58
  59 class TestInterface(dbus.service.Interface):
  60     @dbus.service.method(IFACE, in_signature='', out_signature='b')
  61     def CheckInheritance(self):
  62         return False
  63
  64 class TestObject(dbus.service.Object, TestInterface):
  65     def __init__(self, bus_name, object_path=OBJECT):
  66         dbus.service.Object.__init__(self, bus_name, object_path)
  67
  68     """ Echo whatever is sent
  69     """
  70     @dbus.service.method(IFACE)
  71     def Echo(self, arg):
  72         return arg
  73
  74     @dbus.service.method(IFACE, in_signature='s', out_signature='s')
  75     def AcceptUnicodeString(self, foo):
  76         assert isinstance(foo, unicode), (foo, foo.__class__.__mro__)
  77         return foo
  78
  79     @dbus.service.method(IFACE, in_signature='s', out_signature='s', utf8_strings=True)
  80     def AcceptUTF8String(self, foo):
  81         assert isinstance(foo, str), (foo, foo.__class__.__mro__)
  82         return foo
  83
  84     @dbus.service.method(IFACE, in_signature='', out_signature='soss',
  85             sender_keyword='sender', path_keyword='path',
  86             destination_keyword='dest', message_keyword='msg')
  87     def MethodExtraInfoKeywords(self, sender=None, path=None, dest=None,
  88             msg=None):
  89         return (sender, path, dest,
  90                 msg.__class__.__module__ + '.' + msg.__class__.__name__)
  91
  92     @dbus.service.method(IFACE, in_signature='ay', out_signature='ay')
  93     def AcceptListOfByte(self, foo):
  94         assert isinstance(foo, list), (foo, foo.__class__.__mro__)
  95         return foo
  96
  97     @dbus.service.method(IFACE, in_signature='ay', out_signature='ay', byte_arrays=True)
  98     def AcceptByteArray(self, foo):
  99         assert isinstance(foo, str), (foo, foo.__class__.__mro__)
 100         return foo
 101
 102     @dbus.service.method(IFACE)
 103     def GetComplexArray(self):
 104         ret = []
 105         for i in range(0,100):
 106             ret.append((random.randint(0,100), random.randint(0,100), str(random.randint(0,100))))
 107
 108         return dbus.Array(ret, signature="(uus)")
 109
 110     def returnValue(self, test):
 111         if test == 0:
 112             return ""
 113         elif test == 1:
 114             return "",""
 115         elif test == 2:
 116             return "","",""
 117         elif test == 3:
 118             return []
 119         elif test == 4:
 120             return {}
 121         elif test == 5:
 122             return ["",""]
 123         elif test == 6:
 124             return ["","",""]
 125
 126     @dbus.service.method(IFACE, in_signature='u', out_signature='s')
 127     def ReturnOneString(self, test):
 128         return self.returnValue(test)
 129
 130     @dbus.service.method(IFACE, in_signature='u', out_signature='ss')
 131     def ReturnTwoStrings(self, test):
 132         return self.returnValue(test)
 133
 134     @dbus.service.method(IFACE, in_signature='u', out_signature='(ss)')
 135     def ReturnStruct(self, test):
 136         logger.info('ReturnStruct(%r) -> %r', test, self.returnValue(test))
 137         return self.returnValue(test)
 138
 139     @dbus.service.method(IFACE, in_signature='u', out_signature='as')
 140     def ReturnArray(self, test):
 141         return self.returnValue(test)
 142
 143     @dbus.service.method(IFACE, in_signature='u', out_signature='a{ss}')
 144     def ReturnDict(self, test):
 145         return self.returnValue(test)
 146
 147     @dbus.service.signal(IFACE, signature='s')
 148     def SignalOneString(self, test):
 149         logger.info('SignalOneString(%r)', test)
 150
 151     @dbus.service.signal(IFACE, signature='ss')
 152     def SignalTwoStrings(self, test, test2):
 153         logger.info('SignalTwoStrings(%r, %r)', test, test2)
 154
 155     @dbus.service.signal(IFACE, signature='(ss)')
 156     def SignalStruct(self, test):
 157         logger.info('SignalStruct(%r)', test)
 158
 159     @dbus.service.signal(IFACE, signature='as')
 160     def SignalArray(self, test):
 161         pass
 162
 163     @dbus.service.signal(IFACE, signature='a{ss}')
 164     def SignalDict(self, test):
 165         pass
 166
 167     @dbus.service.method(IFACE, in_signature='su', out_signature='')
 168     def EmitSignal(self, signal, value):
 169         sig = getattr(self, str(signal), None)
 170         assert(sig != None)
 171
 172         val = self.returnValue(value)
 173         # make two string case work by passing arguments in by tuple
 174         if (signal == 'SignalTwoStrings' and (value == 1 or value == 5)):
 175             val = tuple(val)
 176         else:
 177             val = tuple([val])
 178
 179         logger.info('Emitting %s with %r', signal, val)
 180         sig(*val)
 181
 182     def CheckInheritance(self):
 183         return True
 184
 185     @dbus.service.method(IFACE, in_signature='', out_signature='b')
 186     def TestListExportedChildObjects(self):
 187         objs_root = session_bus.list_exported_child_objects('/')
 188         assert objs_root == ['org'], objs_root
 189         objs_org = session_bus.list_exported_child_objects('/org')
 190         assert objs_org == ['freedesktop'], objs_org
 191         return True
 192
 193     @dbus.service.method(IFACE, in_signature='bbv', out_signature='v', async_callbacks=('return_cb', 'error_cb'))
 194     def AsynchronousMethod(self, async, fail, variant, return_cb, error_cb):
 195         try:
 196             if async:
 197                 gobject.timeout_add(500, self.AsynchronousMethod, False, fail, variant, return_cb, error_cb)
 198                 return
 199             else:
 200                 if fail:
 201                     raise RuntimeError
 202                 else:
 203                     return_cb(variant)
 204
 205                 return False # do not run again
 206         except Exception, e:
 207             error_cb(e)
 208
 209     @dbus.service.method(IFACE, in_signature='', out_signature='s', sender_keyword='sender')
 210     def WhoAmI(self, sender):
 211         return sender
 212
 213     @dbus.service.method(IFACE)
 214     def MultipleReturnWithoutSignature(self):
 215         # https://bugs.freedesktop.org/show_bug.cgi?id=10174
 216         return dbus.String('abc'), dbus.Int32(123)
 217
 218 session_bus = dbus.SessionBus()
 219 name = dbus.service.BusName(NAME, bus=session_bus)
 220 object = TestObject(name)
 221 g_object = TestGObject(name)
 222 loop = gobject.MainLoop()
 223 loop.run()