[telepathy-mission-control/master] dispatcher/capture-bundle.py: Add a regression test for capturing bundles by ID
Simon McVittie
simon.mcvittie at collabora.co.uk
Mon May 11 08:07:09 PDT 2009
This is use-case dis5a from telepathy-spec's doc/dispatch.txt.
---
test/twisted/Makefile.am | 1 +
test/twisted/dispatcher/capture-bundle.py | 309 +++++++++++++++++++++++++++++
2 files changed, 310 insertions(+), 0 deletions(-)
create mode 100644 test/twisted/dispatcher/capture-bundle.py
diff --git a/test/twisted/Makefile.am b/test/twisted/Makefile.am
index f594681..3e983a6 100644
--- a/test/twisted/Makefile.am
+++ b/test/twisted/Makefile.am
@@ -13,6 +13,7 @@ TWISTED_BASIC_TESTS = \
dispatcher/already-has-channel.py \
dispatcher/bypass-approval.py \
dispatcher/cancel.py \
+ dispatcher/capture-bundle.py \
dispatcher/create-text.py \
dispatcher/dispatch-text.py \
dispatcher/exploding-bundles.py \
diff --git a/test/twisted/dispatcher/capture-bundle.py b/test/twisted/dispatcher/capture-bundle.py
new file mode 100644
index 0000000..261f51d
--- /dev/null
+++ b/test/twisted/dispatcher/capture-bundle.py
@@ -0,0 +1,309 @@
+"""Feature test for a VoIP UI stealing closely-related Text channels as
+described in the telepathy-spec rationale.
+"""
+
+import dbus
+import dbus.service
+
+from servicetest import EventPattern, tp_name_prefix, tp_path_prefix, \
+ call_async
+from mctest import exec_test, SimulatedConnection, SimulatedClient, \
+ create_fakecm_account, enable_fakecm_account, SimulatedChannel
+import constants as cs
+
+def test(q, bus, mc):
+ params = dbus.Dictionary({"account": "someguy at example.com",
+ "password": "secrecy"}, signature='sv')
+ cm_name_ref, account = create_fakecm_account(q, bus, mc, params)
+ conn = enable_fakecm_account(q, bus, mc, account, params)
+
+ text_fixed_properties = dbus.Dictionary({
+ cs.CHANNEL + '.TargetHandleType': cs.HT_CONTACT,
+ cs.CHANNEL + '.ChannelType': cs.CHANNEL_TYPE_TEXT,
+ }, signature='sv')
+ voip_fixed_properties = dbus.Dictionary({
+ cs.CHANNEL + '.TargetHandleType': cs.HT_CONTACT,
+ cs.CHANNEL + '.ChannelType': cs.CHANNEL_TYPE_STREAMED_MEDIA,
+ }, signature='sv')
+
+ # Two clients want to observe, approve and handle text and VoIP channels.
+ empathy = SimulatedClient(q, bus, 'Empathy',
+ observe=[text_fixed_properties, voip_fixed_properties],
+ approve=[text_fixed_properties, voip_fixed_properties],
+ handle=[text_fixed_properties, voip_fixed_properties],
+ bypass_approval=False)
+ kopete = SimulatedClient(q, bus, 'Kopete',
+ observe=[text_fixed_properties, voip_fixed_properties],
+ approve=[text_fixed_properties, voip_fixed_properties],
+ handle=[text_fixed_properties, voip_fixed_properties],
+ bypass_approval=False)
+
+ # wait for MC to download the properties
+ q.expect_many(
+ EventPattern('dbus-method-call',
+ interface=cs.PROPERTIES_IFACE, method='Get',
+ args=[cs.CLIENT, 'Interfaces'],
+ path=empathy.object_path),
+ EventPattern('dbus-method-call',
+ interface=cs.PROPERTIES_IFACE, method='Get',
+ args=[cs.APPROVER, 'ApproverChannelFilter'],
+ path=empathy.object_path),
+ EventPattern('dbus-method-call',
+ interface=cs.PROPERTIES_IFACE, method='Get',
+ args=[cs.HANDLER, 'HandlerChannelFilter'],
+ path=empathy.object_path),
+ EventPattern('dbus-method-call',
+ interface=cs.PROPERTIES_IFACE, method='Get',
+ args=[cs.OBSERVER, 'ObserverChannelFilter'],
+ path=empathy.object_path),
+
+ EventPattern('dbus-method-call',
+ interface=cs.PROPERTIES_IFACE, method='Get',
+ args=[cs.CLIENT, 'Interfaces'],
+ path=kopete.object_path),
+ EventPattern('dbus-method-call',
+ interface=cs.PROPERTIES_IFACE, method='Get',
+ args=[cs.APPROVER, 'ApproverChannelFilter'],
+ path=kopete.object_path),
+ EventPattern('dbus-method-call',
+ interface=cs.PROPERTIES_IFACE, method='Get',
+ args=[cs.HANDLER, 'HandlerChannelFilter'],
+ path=kopete.object_path),
+ EventPattern('dbus-method-call',
+ interface=cs.PROPERTIES_IFACE, method='Get',
+ args=[cs.OBSERVER, 'ObserverChannelFilter'],
+ path=kopete.object_path),
+ )
+
+ # subscribe to the OperationList interface (MC assumes that until this
+ # property has been retrieved once, nobody cares)
+
+ cd = bus.get_object(cs.CD, cs.CD_PATH)
+ cd_props = dbus.Interface(cd, cs.PROPERTIES_IFACE)
+ assert cd_props.Get(cs.CD_IFACE_OP_LIST, 'DispatchOperations') == []
+
+ # First, a VoIP channel is created
+
+ BUNDLE = '/8de0d29d-83e1-40f5-b24f-748c0aa86c82'
+
+ channel_properties = dbus.Dictionary(voip_fixed_properties,
+ signature='sv')
+ channel_properties[cs.CHANNEL + '.TargetID'] = 'juliet'
+ channel_properties[cs.CHANNEL + '.TargetHandle'] = \
+ conn.ensure_handle(cs.HT_CONTACT, 'juliet')
+ channel_properties[cs.CHANNEL + '.InitiatorID'] = 'juliet'
+ channel_properties[cs.CHANNEL + '.InitiatorHandle'] = \
+ conn.ensure_handle(cs.HT_CONTACT, 'juliet')
+ channel_properties[cs.CHANNEL + '.Requested'] = False
+ channel_properties[cs.CHANNEL + '.Interfaces'] = dbus.Array(signature='s')
+ channel_properties[cs.CHANNEL + '.FUTURE.Bundle'] = BUNDLE
+
+ chan = SimulatedChannel(conn, channel_properties)
+ chan.announce()
+
+ # A channel dispatch operation is created
+
+ e = q.expect('dbus-signal',
+ path=cs.CD_PATH,
+ interface=cs.CD_IFACE_OP_LIST,
+ signal='NewDispatchOperation')
+
+ cdo_path = e.args[0]
+ cdo_properties = e.args[1]
+
+ assert cdo_properties[cs.CDO + '.Account'] == account.object_path
+ assert cdo_properties[cs.CDO + '.Connection'] == conn.object_path
+ assert cs.CDO + '.Interfaces' in cdo_properties
+
+ handlers = cdo_properties[cs.CDO + '.PossibleHandlers'][:]
+ handlers.sort()
+ assert handlers == [cs.tp_name_prefix + '.Client.Empathy',
+ cs.tp_name_prefix + '.Client.Kopete'], handlers
+
+ assert cs.CD_IFACE_OP_LIST in cd_props.Get(cs.CD, 'Interfaces')
+ assert cd_props.Get(cs.CD_IFACE_OP_LIST, 'DispatchOperations') ==\
+ [(cdo_path, cdo_properties)]
+
+ cdo = bus.get_object(cs.CD, cdo_path)
+ cdo_iface = dbus.Interface(cdo, cs.CDO)
+
+ # Both Observers are told about the new channel
+
+ e, k = q.expect_many(
+ EventPattern('dbus-method-call',
+ path=empathy.object_path,
+ interface=cs.OBSERVER, method='ObserveChannels',
+ handled=False),
+ EventPattern('dbus-method-call',
+ path=kopete.object_path,
+ interface=cs.OBSERVER, method='ObserveChannels',
+ handled=False),
+ )
+ assert e.args[0] == account.object_path, e.args
+ assert e.args[1] == conn.object_path, e.args
+ assert e.args[3] == cdo_path, e.args
+ assert e.args[4] == [], e.args # no requests satisfied
+ channels = e.args[2]
+ assert len(channels) == 1, channels
+ assert channels[0][0] == chan.object_path, channels
+ assert channels[0][1] == channel_properties, channels
+
+ assert k.args == e.args
+
+ # Both Observers indicate that they are ready to proceed
+ q.dbus_return(k.message, signature='')
+ q.dbus_return(e.message, signature='')
+
+ # The Approvers are next
+
+ e, k = q.expect_many(
+ EventPattern('dbus-method-call',
+ path=empathy.object_path,
+ interface=cs.APPROVER, method='AddDispatchOperation',
+ handled=False),
+ EventPattern('dbus-method-call',
+ path=kopete.object_path,
+ interface=cs.APPROVER, method='AddDispatchOperation',
+ handled=False),
+ )
+
+ assert e.args == [[(chan.object_path, channel_properties)],
+ cdo_path, cdo_properties]
+ assert k.args == e.args
+
+ q.dbus_return(e.message, signature='')
+ q.dbus_return(k.message, signature='')
+
+ # Both Approvers now have a flashing icon or something, trying to get the
+ # user's attention
+
+ # The user responds to Empathy first
+ call_async(q, cdo_iface, 'HandleWith',
+ cs.tp_name_prefix + '.Client.Empathy')
+
+ # Empathy is asked to handle the channels
+ e = q.expect('dbus-method-call',
+ path=empathy.object_path,
+ interface=cs.HANDLER, method='HandleChannels',
+ handled=False)
+
+ # Empathy accepts the channels
+ q.dbus_return(e.message, signature='')
+
+ # FIXME: this shouldn't happen until after HandleChannels has succeeded,
+ # but MC currently does this as soon as HandleWith is called (fd.o #21003)
+ #q.expect('dbus-signal', path=cdo_path, signal='Finished')
+ #q.expect('dbus-signal', path=cs.CD_PATH,
+ # signal='DispatchOperationFinished', args=[cdo_path])
+
+ # HandleWith succeeds
+ q.expect('dbus-return', method='HandleWith')
+
+ # Now there are no more active channel dispatch operations
+ assert cd_props.Get(cs.CD_IFACE_OP_LIST, 'DispatchOperations') == []
+
+ # Now that Empathy has the VoIP channel, it wants to steal incoming Text
+ # channels from the same bundle
+
+ same_bundle_properties = dbus.Dictionary(text_fixed_properties,
+ signature='sv')
+ same_bundle_properties[cs.CHANNEL + '.FUTURE.Bundle'] = BUNDLE
+
+ bypass = SimulatedClient(q, bus, 'Empathy._1_42.Window2',
+ observe=[],
+ approve=[],
+ handle=[same_bundle_properties],
+ bypass_approval=True)
+
+ # wait for MC to download the properties
+ q.expect_many(
+ EventPattern('dbus-method-call',
+ interface=cs.PROPERTIES_IFACE, method='Get',
+ args=[cs.CLIENT, 'Interfaces'],
+ path=bypass.object_path),
+ EventPattern('dbus-method-call',
+ interface=cs.PROPERTIES_IFACE, method='Get',
+ args=[cs.HANDLER, 'HandlerChannelFilter'],
+ path=bypass.object_path),
+ )
+
+ # From now on, this test must fail if we're asked to approve anything
+ approval = [
+ EventPattern('dbus-method-call', method='AddDispatchOperation'),
+ ]
+ q.forbid_events(approval)
+
+ channel_properties = dbus.Dictionary(text_fixed_properties,
+ signature='sv')
+ channel_properties[cs.CHANNEL + '.TargetHandleType'] = cs.HT_CONTACT
+ channel_properties[cs.CHANNEL + '.TargetID'] = 'juliet'
+ channel_properties[cs.CHANNEL + '.TargetHandle'] = \
+ conn.ensure_handle(cs.HT_CONTACT, 'juliet')
+ channel_properties[cs.CHANNEL + '.InitiatorID'] = 'juliet'
+ channel_properties[cs.CHANNEL + '.InitiatorHandle'] = \
+ conn.ensure_handle(cs.HT_CONTACT, 'juliet')
+ channel_properties[cs.CHANNEL + '.Requested'] = False
+ channel_properties[cs.CHANNEL + '.FUTURE.Bundle'] = BUNDLE
+ channel_properties[cs.CHANNEL + '.Interfaces'] = dbus.Array(signature='s')
+
+ chan = SimulatedChannel(conn, channel_properties)
+ chan.announce()
+
+ # Again, there's a CDO
+
+ e = q.expect('dbus-signal',
+ path=cs.CD_PATH,
+ interface=cs.CD_IFACE_OP_LIST,
+ signal='NewDispatchOperation')
+
+ cdo_path = e.args[0]
+ cdo_properties = e.args[1]
+
+ assert cdo_properties[cs.CDO + '.Account'] == account.object_path
+ assert cdo_properties[cs.CDO + '.Connection'] == conn.object_path
+ assert cs.CDO + '.Interfaces' in cdo_properties
+
+ handlers = cdo_properties[cs.CDO + '.PossibleHandlers'][:]
+ # The handler with BypassApproval is first
+ assert handlers[0] == bypass.bus_name
+ # The other two handlers are still possibilities
+ assert len(handlers) == 3
+
+ # Observers are invoked as usual
+
+ e, k = q.expect_many(
+ EventPattern('dbus-method-call',
+ path=empathy.object_path,
+ interface=cs.OBSERVER, method='ObserveChannels',
+ handled=False),
+ EventPattern('dbus-method-call',
+ path=kopete.object_path,
+ interface=cs.OBSERVER, method='ObserveChannels',
+ handled=False),
+ )
+ assert e.args[0] == account.object_path, e.args
+ assert e.args[1] == conn.object_path, e.args
+ assert e.args[3] == cdo_path, e.args
+ assert e.args[4] == [], e.args # no requests satisfied
+ channels = e.args[2]
+ assert len(channels) == 1, channels
+ assert channels[0][0] == chan.object_path, channels
+ assert channels[0][1] == channel_properties, channels
+
+ assert k.args == e.args
+
+ # Both Observers indicate that they are ready to proceed
+ q.dbus_return(k.message, signature='')
+ q.dbus_return(e.message, signature='')
+
+ # Empathy's BypassApproval part is asked to handle the channels
+ e = q.expect('dbus-method-call',
+ path=bypass.object_path,
+ interface=cs.HANDLER, method='HandleChannels',
+ handled=False)
+ # Empathy accepts the channels
+ q.dbus_return(e.message, signature='')
+
+if __name__ == '__main__':
+ exec_test(test, {})
+
--
1.5.6.5
More information about the telepathy-commits
mailing list