def no_server_discovered(q, bus, conn, stream, server=None):
iq_event, disco_event = q.expect_many(
EventPattern('stream-iq',
to=None,
query_ns='vcard-temp',
query_name='vCard'),
EventPattern('stream-iq', to='localhost', query_ns=ns.DISCO_ITEMS))
acknowledge_iq(stream, iq_event.stanza)
# no search server has been discovered yet. The CreateChannel operation
# will fail once the disco process is finished.
call_create(q, conn, server=server)
# reply to IQ query. No search server is present
reply = make_result_iq(stream, disco_event.stanza)
stream.send(reply)
# creation of the channel failed
e = q.expect('dbus-error',
method='CreateChannel',
name=cs.INVALID_ARGUMENT)
# This server doesn't have a search server. We can't create Search channel
# without specifying a Server property
call_create(q, conn, server=server)
e = q.expect('dbus-error', method='CreateChannel')
assertEquals(cs.INVALID_ARGUMENT, e.error.get_dbus_name())
def do_one_search(q, bus, conn, stream, fields, expected_search_keys,
terms, results):
call_create(q, conn, server)
ret, nc_sig = answer_extended_field_query(q, stream, server, fields)
path, props = ret.value
props = unwrap(props)
assert props[cs.CONTACT_SEARCH_SERVER] == server, pformat(props)
assert sorted(props[cs.CONTACT_SEARCH_ASK]) == expected_search_keys, \
sorted(props[cs.CONTACT_SEARCH_ASK])
assert cs.CONTACT_SEARCH_STATE not in props, pformat(props)
c = make_channel_proxy(conn, path, 'Channel')
c_props = dbus.Interface(c, cs.PROPERTIES_IFACE)
c_search = dbus.Interface(c, cs.CHANNEL_TYPE_CONTACT_SEARCH)
state = c_props.Get(cs.CHANNEL_TYPE_CONTACT_SEARCH, 'SearchState')
assert state == cs.SEARCH_NOT_STARTED, state
# We make a search.
iq = make_search(q, c_search, c_props, server, terms)
query = iq.firstChildElement()
fields_sent = xpath.queryForNodes(
'/iq/query[@xmlns="%s"]/x[@xmlns="%s"][@type="submit"]/field'
% (ns.SEARCH, ns.X_DATA), iq)
assert fields_sent is not None
# check FORM_TYPE
f = fields_sent[0]
assert f['type'] == 'hidden'
assert f['var'] == 'FORM_TYPE'
value = f.firstChildElement()
assert value.name == 'value'
assert value.children[0] == ns.SEARCH
# extract search fields
search_fields = []
for f in fields_sent[1:]:
value = f.firstChildElement()
assert value.name == 'value'
search_fields.append((f['var'], value.children[0]))
# Server sends the results of the search.
send_results_extended(stream, iq, results, fields)
return search_fields, c, c_search, c_props
def disconnect_before_disco(q, bus, conn, stream, server=None):
iq_event, disco_event = q.expect_many(
EventPattern('stream-iq', to=None, query_ns='vcard-temp',
query_name='vCard'),
EventPattern('stream-iq', to='localhost', query_ns=ns.DISCO_ITEMS))
acknowledge_iq(stream, iq_event.stanza)
# try to create a channel before the disco process is completed.
# This creation will fail
call_create(q, conn, server=server)
# connection is disconnected. CreateChannel fails
disconnect_conn(q, conn, stream, [
EventPattern('dbus-error', method='CreateChannel', name=cs.DISCONNECTED)])
def cancelled_while_in_progress(q, bus, conn, stream, server):
call_create(q, conn, server)
ret, _ = answer_field_query(q, stream, server)
path, props = ret.value
c = make_channel_proxy(conn, path, 'Channel')
c_props = dbus.Interface(c, cs.PROPERTIES_IFACE)
c_search = dbus.Interface(c, cs.CHANNEL_TYPE_CONTACT_SEARCH)
iq = make_search(q, c_search, c_props, server, { 'x-n-family': 'Threepwood' })
# Before the server sends back the results, the client cancels the search.
call_async(q, c_search, 'Stop')
ret, ssc = q.expect_many(
EventPattern('dbus-return', method='Stop'),
EventPattern('dbus-signal', signal='SearchStateChanged'),
)
assert ssc.args[0] == cs.SEARCH_FAILED, ssc.args
assert ssc.args[1] == cs.CANCELLED, ssc.args
state = c_props.Get(cs.CHANNEL_TYPE_CONTACT_SEARCH, 'SearchState')
assert state == cs.SEARCH_FAILED, (state, cs.SEARCH_FAILED)
# Now the server sends us the results; SearchResultReceived shouldn't fire
search_result_received_event = EventPattern('dbus-signal', signal='SearchResultReceived')
q.forbid_events([search_result_received_event])
send_results(stream, iq, results.values())
# Make sure Gabble's received the results.
sync_stream(q, stream)
# Hooray! We survived. Now let's call Stop again; it should succeed but do
# nothing.
search_state_changed_event = EventPattern('dbus-signal', signal='SearchStateChanged')
q.forbid_events([search_state_changed_event])
call_async(q, c_search, 'Stop')
ssc = q.expect('dbus-return', method='Stop')
c.Close()
q.unforbid_events([search_result_received_event, search_state_changed_event])
def server_discovered(q, bus, conn, stream, server=None):
iq_event, disco_event = q.expect_many(
EventPattern('stream-iq',
to=None,
query_ns='vcard-temp',
query_name='vCard'),
EventPattern('stream-iq', to='localhost', query_ns=ns.DISCO_ITEMS))
acknowledge_iq(stream, iq_event.stanza)
# no search server has been discovered yet. The CreateChannel operation
# will be completed once the disco process is finished.
call_create(q, conn, server=server)
# reply to IQ query
reply = make_result_iq(stream, disco_event.stanza)
query = xpath.queryForNodes('/iq/query', reply)[0]
item = query.addElement((None, 'item'))
item['jid'] = JUD_SERVER
stream.send(reply)
# wait for the disco#info query
event = q.expect('stream-iq', to=JUD_SERVER, query_ns=ns.DISCO_INFO)
reply = elem_iq(stream, 'result', id=event.stanza['id'], from_=JUD_SERVER)(
elem(ns.DISCO_INFO, 'query')(elem('identity',
category='directory',
type='user',
name='vCard User Search')(),
elem('feature', var=ns.SEARCH)()))
stream.send(reply)
# JUD_SERVER is used as default, and shows up as the Server property on the
# resulting channel.
ret, _ = answer_field_query(q, stream, JUD_SERVER)
_, properties = ret.value
assertEquals(JUD_SERVER, properties[cs.CONTACT_SEARCH_SERVER])
# Now that the search server has been discovered, it is used right away.
call_create(q, conn, server=server)
ret, _ = answer_field_query(q, stream, JUD_SERVER)
_, properties = ret.value
assertEquals(JUD_SERVER, properties[cs.CONTACT_SEARCH_SERVER])
def disconnect_before_disco(q, bus, conn, stream, server=None):
iq_event, disco_event = q.expect_many(
EventPattern('stream-iq',
to=None,
query_ns='vcard-temp',
query_name='vCard'),
EventPattern('stream-iq', to='localhost', query_ns=ns.DISCO_ITEMS))
acknowledge_iq(stream, iq_event.stanza)
# try to create a channel before the disco process is completed.
# This creation will fail
call_create(q, conn, server=server)
# connection is disconnected. CreateChannel fails
disconnect_conn(q, conn, stream, [
EventPattern(
'dbus-error', method='CreateChannel', name=cs.DISCONNECTED)
])
def server_discovered(q, bus, conn, stream, server=None):
iq_event, disco_event = q.expect_many(
EventPattern('stream-iq', to=None, query_ns='vcard-temp',
query_name='vCard'),
EventPattern('stream-iq', to='localhost', query_ns=ns.DISCO_ITEMS))
acknowledge_iq(stream, iq_event.stanza)
# no search server has been discovered yet. The CreateChannel operation
# will be completed once the disco process is finished.
call_create(q, conn, server=server)
# reply to IQ query
reply = make_result_iq(stream, disco_event.stanza)
query = xpath.queryForNodes('/iq/query', reply)[0]
item = query.addElement((None, 'item'))
item['jid'] = JUD_SERVER
stream.send(reply)
# wait for the disco#info query
event = q.expect('stream-iq', to=JUD_SERVER, query_ns=ns.DISCO_INFO)
reply = elem_iq(stream, 'result', id=event.stanza['id'], from_=JUD_SERVER)(
elem(ns.DISCO_INFO, 'query')(
elem('identity', category='directory', type='user', name='vCard User Search')(),
elem('feature', var=ns.SEARCH)()))
stream.send(reply)
# JUD_SERVER is used as default, and shows up as the Server property on the
# resulting channel.
ret, _ = answer_field_query(q, stream, JUD_SERVER)
_, properties = ret.value
assertEquals(JUD_SERVER, properties[cs.CONTACT_SEARCH_SERVER])
# Now that the search server has been discovered, it is used right away.
call_create(q, conn, server=server)
ret, _ = answer_field_query(q, stream, JUD_SERVER)
_, properties = ret.value
assertEquals(JUD_SERVER, properties[cs.CONTACT_SEARCH_SERVER])
def no_x_in_reply(q, bus, conn, stream):
fields = [('nickname', 'text-single', 'NickName', []),
('nick', 'text-single', 'Nick', []),]
terms = { 'nickname': 'Badger' }
call_create(q, conn, server)
ret, nc_sig = answer_extended_field_query(q, stream, server, fields)
path, _ = ret.value
c = make_channel_proxy(conn, path, 'Channel')
c_props = dbus.Interface(c, cs.PROPERTIES_IFACE)
c_search = dbus.Interface(c, cs.CHANNEL_TYPE_CONTACT_SEARCH)
iq = make_search(q, c_search, c_props, server, terms)
# The server sends back an IQ with a <query/> but no <x/> inside the query.
acknowledge_iq(stream, iq)
# Gabble should tell us the query failed, and not crash.
event = q.expect('dbus-signal', signal='SearchStateChanged')
state = event.args[0]
assertEquals(cs.SEARCH_FAILED, state)
def no_server_discovered(q, bus, conn, stream, server=None):
iq_event, disco_event = q.expect_many(
EventPattern('stream-iq', to=None, query_ns='vcard-temp',
query_name='vCard'),
EventPattern('stream-iq', to='localhost', query_ns=ns.DISCO_ITEMS))
acknowledge_iq(stream, iq_event.stanza)
# no search server has been discovered yet. The CreateChannel operation
# will fail once the disco process is finished.
call_create(q, conn, server=server)
# reply to IQ query. No search server is present
reply = make_result_iq(stream, disco_event.stanza)
stream.send(reply)
# creation of the channel failed
e = q.expect('dbus-error', method='CreateChannel', name=cs.INVALID_ARGUMENT)
# This server doesn't have a search server. We can't create Search channel
# without specifying a Server property
call_create(q, conn, server=server)
e = q.expect('dbus-error', method='CreateChannel')
assertEquals(cs.INVALID_ARGUMENT, e.error.get_dbus_name())
def complete_search(q, bus, conn, stream, server):
call_create(q, conn, server)
# the channel is not yet in conn.Requests.Channels as it's not ready yet
channels = conn.Get(cs.CONN_IFACE_REQUESTS, 'Channels',
dbus_interface=cs.PROPERTIES_IFACE)
for path, props in channels:
assert props[cs.CHANNEL_TYPE] != cs.CHANNEL_TYPE_CONTACT_SEARCH
ret, nc_sig = answer_field_query(q, stream, server)
path, props = ret.value
props = unwrap(props)
expected_search_keys = ['email', 'nickname', 'x-n-family', 'x-n-given']
assert props[cs.CONTACT_SEARCH_SERVER] == server, pformat(props)
assert sorted(props[cs.CONTACT_SEARCH_ASK]) == expected_search_keys, \
pformat(props)
assert cs.CONTACT_SEARCH_STATE not in props, pformat(props)
# check that channel is listed in conn.Requests.Channels
channels = conn.Get(cs.CONN_IFACE_REQUESTS, 'Channels',
dbus_interface=cs.PROPERTIES_IFACE)
assert (path, props) in channels
c = make_channel_proxy(conn, path, 'Channel')
c_props = dbus.Interface(c, cs.PROPERTIES_IFACE)
c_search = dbus.Interface(c, cs.CHANNEL_TYPE_CONTACT_SEARCH)
state = c_props.Get(cs.CHANNEL_TYPE_CONTACT_SEARCH, 'SearchState')
assert state == cs.SEARCH_NOT_STARTED, state
# We make a search.
iq = make_search(q, c_search, c_props, server, { 'x-n-family': 'Threepwood' })
query = iq.firstChildElement()
i = 0
for field in query.elements():
assert field.name == 'last', field.toXml()
assert field.children[0] == u'Threepwood', field.children[0]
i += 1
assert i == 1, query
# Server sends the results of the search.
send_results(stream, iq, results.values())
r = q.expect('dbus-signal', signal='SearchResultReceived')
infos = r.args[0]
assertSameSets(results.keys(), infos.keys())
for id in results.keys():
i = infos[id]
r = results[id]
i_ = pformat(unwrap(i))
assert ("n", [], [r[2], r[1], "", "", ""]) in i, i_
assert ("nickname", [], [r[3]]) in i, i_
assert ("email", [], [r[0]]) in i, i_
assert ("x-n-family", [], [r[2]]) in i, i_
assert ("x-n-given", [], [r[1]]) in i, i_
assert len(i) == 5, i_
ssc = q.expect('dbus-signal', signal='SearchStateChanged')
assert ssc.args[0] == cs.SEARCH_COMPLETED, ssc.args
# We call Stop after the search has completed; it should succeed, but leave
# the channel in state Completed rather than changing it to Failed for
# reason Cancelled.
call_async(q, c_search, 'Stop')
event = q.expect('dbus-return', method='Stop')
state = c_props.Get(cs.CHANNEL_TYPE_CONTACT_SEARCH, 'SearchState')
assert state == cs.SEARCH_COMPLETED, (state, cs.SEARCH_COMPLETED)
c.Close()
q.expect_many(
EventPattern('dbus-signal', signal='Closed'),
EventPattern('dbus-signal', signal='ChannelClosed'),
)
