def _searchItems(self, req):
"""
Search items with data of req parameter
"""
responseHolder = searchItemsResponse()
response = SOAPView(self.portal, req).searchItemsRequest(req, responseHolder)
return deserialize(response)
def test_ws_searchItemsMeetingUID(self):
"""Test search param meeting_uid."""
self.changeUser('pmManager')
meeting = self._createMeetingWithItems()
req = searchItemsRequest()
responseHolder = searchItemsResponse()
# unknown meeting UID
self.changeUser('pmCreator1')
req._meeting_uid = 'unknown_uid'
result = SOAPView(self.portal,
req).searchItemsRequest(req, responseHolder)
self.assertEqual(len(result._itemInfo), 0)
req._meeting_uid = meeting.UID()
result = SOAPView(self.portal,
req).searchItemsRequest(req, responseHolder)
# only get items user may view
self.assertEqual(len(result._itemInfo), 2)
self.changeUser('pmManager')
result = SOAPView(self.portal,
req).searchItemsRequest(req, responseHolder)
self.assertEqual(len(result._itemInfo), 5)
def test_ws_searchItemsRequest(self):
"""
Test that searching with given parameters returns valuable informations
"""
# by default no item exists
self.changeUser('pmCreator1')
self.assertEqual(
len(self.portal.portal_catalog(portal_type='MeetingItemPga')), 0)
# prepare data for a default item
req = self._prepareCreationData()
req._creationData._externalIdentifier = 'my_external_app_identifier'
# use the SOAP service to create one
newItem, response = self._createItem(req)
# make sure created enough in the past or sort_on 'created' returns random result
newItem.setCreationDate(DateTime() - 5)
newItem.reindexObject()
newItemUID = newItem.UID()
# externalIdentifier is actually set
self.assertEqual(newItem.externalIdentifier,
'my_external_app_identifier')
# now an item exists, get informations about it
req = searchItemsRequest()
req._Title = 'item'
req._getCategory = 'development'
# Serialize the request so it can be easily tested
request = serializeRequest(req)
# This is what the sent enveloppe should looks like
expected = """<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" """ \
"""xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" """ \
"""xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" """ \
"""xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">""" \
"""<SOAP-ENV:Header></SOAP-ENV:Header>""" \
"""<SOAP-ENV:Body xmlns:ns1="http://ws4pm.imio.be"><ns1:searchItemsRequest>""" \
"""<Title>%s</Title><getCategory>%s</getCategory></ns1:searchItemsRequest>""" \
"""</SOAP-ENV:Body></SOAP-ENV:Envelope>""" % (req._Title, req._getCategory)
result = """%s""" % request
self.assertEqual(expected, result)
# now really use the SOAP method to get informations about the item
resp = self._searchItems(req)
# the item is not in a meeting so the meeting date is 1950-01-01
expected = """<ns1:searchItemsResponse xmlns:ns1="http://ws4pm.imio.be" """ \
"""xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" """ \
"""xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" """ \
"""xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" """ \
"""xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<itemInfo xsi:type="ns1:ItemInfo">
<UID>{0}</UID>
<id>my-new-item-title</id>
<title>My new item title</title>
<creator>pmCreator1</creator>
<creation_date>{1}</creation_date>
<modification_date>{2}</modification_date>
<category>development</category>
<description><p>Description</p></description>
<detailedDescription><p>Detailed description</p></detailedDescription>
<decision><p>Décision</p></decision>
<preferredMeeting/>
<preferred_meeting_date>1950-01-01T00:00:00.006Z</preferred_meeting_date>
<review_state>itemcreated</review_state>
<meeting_date>1950-01-01T00:00:00.006Z</meeting_date>
<absolute_url>http://nohost/plone/Members/pmCreator1/mymeetings/plonegov-assembly/my-new-item-title</absolute_url>
<externalIdentifier>my_external_app_identifier</externalIdentifier>
<extraInfos/>
</itemInfo>
</ns1:searchItemsResponse>
""".format(newItemUID,
gDateTime.get_formatted_content(gDateTime(), localtime(newItem.created())),
gDateTime.get_formatted_content(gDateTime(), localtime(newItem.modified())))
self.assertEqual(expected, resp)
# if the item is in a meeting, the result is a bit different because
# we have valid informations about the meeting_date
# use the 'plonegov-assembly' MeetingConfig that use real categories,
# not useGroupsAsCategories
self.changeUser('pmManager')
meeting = self._createMeetingWithItems()
itemInMeeting = meeting.get_items(ordered=True)[0]
# by default, PloneMeeting creates item without title/description/decision...
itemInMeeting.setTitle('My new item title')
itemInMeeting.setDescription('<p>Description</p>',
mimetype='text/x-html-safe')
itemInMeeting.setDecision('<p>Décision</p>',
mimetype='text/x-html-safe')
itemInMeeting.reindexObject()
req._Title = 'item title'
req._getCategory = ''
resp = self._searchItems(req)
itemInMeetingUID = itemInMeeting.UID()
meetingDate = gDateTime.get_formatted_content(
gDateTime(), meeting.date.utctimetuple())
# searching for items can returns several items
# for example here, searching for 'item title' in existing items title will returns 2 items...
expected = """<ns1:searchItemsResponse xmlns:ns1="http://ws4pm.imio.be" """ \
"""xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" """ \
"""xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" """ \
"""xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" """ \
"""xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<itemInfo xsi:type="ns1:ItemInfo">
<UID>{0}</UID>
<id>my-new-item-title</id>
<title>My new item title</title>
<creator>pmCreator1</creator>
<creation_date>{1}</creation_date>
<modification_date>{2}</modification_date>
<category>development</category>
<description><p>Description</p></description>
<detailedDescription><p>Detailed description</p></detailedDescription>
<decision><p>Décision</p></decision>
<preferredMeeting/>
<preferred_meeting_date>1950-01-01T00:00:00.006Z</preferred_meeting_date>
<review_state>itemcreated</review_state>
<meeting_date>1950-01-01T00:00:00.006Z</meeting_date>
<absolute_url>http://nohost/plone/Members/pmCreator1/mymeetings/plonegov-assembly/my-new-item-title</absolute_url>
<externalIdentifier>my_external_app_identifier</externalIdentifier>
<extraInfos/>
</itemInfo>
<itemInfo xsi:type="ns1:ItemInfo">
<UID>{3}</UID>
<id>item-2</id>
<title>My new item title</title>
<creator>pmManager</creator>
<creation_date>{4}</creation_date>
<modification_date>{5}</modification_date>
<category>development</category>
<description><p>Description</p></description>
<detailedDescription/>
<decision><p>Décision</p></decision>
<preferredMeeting/>
<preferred_meeting_date>1950-01-01T00:00:00.006Z</preferred_meeting_date>
<review_state>presented</review_state>
<meeting>{6}</meeting>
<meeting_date>{7}</meeting_date>
<absolute_url>http://nohost/plone/Members/pmManager/mymeetings/plonegov-assembly/item-2</absolute_url>
<externalIdentifier/>
<extraInfos/>
</itemInfo>
</ns1:searchItemsResponse>
""".format(newItemUID,
gDateTime.get_formatted_content(gDateTime(), localtime(newItem.created())),
gDateTime.get_formatted_content(gDateTime(), localtime(newItem.modified())),
itemInMeetingUID,
gDateTime.get_formatted_content(gDateTime(), localtime(itemInMeeting.created())),
gDateTime.get_formatted_content(gDateTime(), localtime(itemInMeeting.modified())),
meeting.UID(),
meetingDate)
self.assertEqual(expected, resp)
# if the search params do not return an existing UID, the response is empty
req._Title = 'aWrongTitle'
resp = self._searchItems(req)
expected = """<ns1:searchItemsResponse xmlns:ns1="http://ws4pm.imio.be" """ \
"""xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" """ \
"""xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" """ \
"""xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" """ \
"""xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
"""
self.assertEqual(resp, expected)
# if not search params is pass, a ZSI.Fault is raised
req._Title = ''
responseHolder = searchItemsResponse()
with self.assertRaises(ZSI.Fault) as cm:
SOAPView(self.portal, req).searchItemsRequest(req, responseHolder)
self.assertEqual(cm.exception.string,
'Define at least one search parameter!')
# if a 'meetingConfigId' is passed, items of this meetingConfig are taken into account
# create an item for 'plonemeeting-assembly' with same data as one created for 'plonegov-assembly' here above
req = self._prepareCreationData()
req._meetingConfigId = 'plonemeeting-assembly'
# in 'plonemeeting-assembly', the category is not used, useGroupsAsCategories is True
req._creationData._category = ''
newItem, response = self._createItem(req)
pmItem = self.portal.portal_catalog(UID=response._UID)[0].getObject()
pmItemUID = pmItem.UID()
# searching items with Title like 'item title' returns the 3 created elements
req = searchItemsRequest()
req._Title = 'item title'
responseHolder = searchItemsResponse()
response = SOAPView(self.portal,
req).searchItemsRequest(req, responseHolder)
resp = deserialize(response)
self.failUnless(itemInMeetingUID in resp and newItemUID in resp
and pmItemUID in resp)
req._meetingConfigId = 'plonemeeting-assembly'
response = SOAPView(self.portal,
req).searchItemsRequest(req, responseHolder)
resp = deserialize(response)
self.failUnless(itemInMeetingUID not in resp and newItemUID not in resp
and pmItemUID in resp)
# passing a wrong meetingConfigId will raise a ZSI.Fault
req._meetingConfigId = 'wrongMeetingConfigId'
with self.assertRaises(ZSI.Fault) as cm:
SOAPView(self.portal, req).searchItemsRequest(req, responseHolder)
self.assertEqual(cm.exception.string,
"Unknown meetingConfigId : 'wrongMeetingConfigId'!")
def test_ws_searchItemsInTheNameOf(self):
"""
Test that searching items inTheNameOf antother user works
Create 2 items, one by 'pmCreator1', member of the 'developers' group
and one by 'pmCreator2', member of the 'vendors' group
Item 1 will be viewable :
- by 'pmManager' and 'pmCreator1'
Item 1 will NOT be viewable :
- while getting informations in the name of 'pmCreator2'
that is not in the 'developers' group
Item 2 will be viewable :
- by 'pmManager' and 'pmCreator2'
Item 2 will NOT be viewable :
- while getting informations in the name of 'pmCreator1'
that is not in the 'vendors' group
"""
# put pmManager in the 'vendors_creators' so he can have
# access to itemcreated items of 'pmCreator2'
self.portal.portal_groups.addPrincipalToGroup('pmManager',
self.vendors_creators)
SAME_TITLE = 'sameTitleForBothItems'
# create an item by 'pmCreator1'
self.changeUser('pmCreator1')
item1 = self.create('MeetingItem')
item1.setTitle(SAME_TITLE)
item1.reindexObject(idxs=[
'Title',
])
# create an item by 'pmCreator2'
self.changeUser('pmCreator2')
item2 = self.create('MeetingItem')
item2.setTitle(SAME_TITLE)
item2.reindexObject(idxs=[
'Title',
])
req = searchItemsRequest()
req._inTheNameOf = None
req._Title = SAME_TITLE
responseHolder = searchItemsResponse()
# 'pmCreator1' can get infos about item1
self.changeUser('pmCreator1')
result = SOAPView(self.portal,
req).searchItemsRequest(req, responseHolder)
# only one result and about item1
self.assertEqual(result._itemInfo[0].UID, item1.UID())
self.assertEqual(len(result._itemInfo), 1)
# 'pmCreator2' can get infos about item2
self.changeUser('pmCreator2')
cleanRamCacheFor('Products.PloneMeeting.ToolPloneMeeting.userIsAmong')
result = SOAPView(self.portal,
req).searchItemsRequest(req, responseHolder)
# only one result and about item2
self.assertEqual(result._itemInfo[0].UID, item2.UID())
self.assertEqual(len(result._itemInfo), 1)
# None of 'pmCreatorx' can searchItems inTheNameOf
req._inTheNameOf = 'pmCreator1'
self.changeUser('pmCreator1')
cleanRamCacheFor('Products.PloneMeeting.ToolPloneMeeting.userIsAmong')
with self.assertRaises(ZSI.Fault) as cm:
SOAPView(self.portal, req).searchItemsRequest(req, responseHolder)
self.assertEqual(
cm.exception.string,
"You need to be 'Manager' or 'MeetingManager' to get item informations 'inTheNameOf'!"
)
req._inTheNameOf = 'pmCreator2'
self.changeUser('pmCreator2')
cleanRamCacheFor('Products.PloneMeeting.ToolPloneMeeting.userIsAmong')
with self.assertRaises(ZSI.Fault) as cm:
SOAPView(self.portal, req).searchItemsRequest(req, responseHolder)
self.assertEqual(
cm.exception.string,
"You need to be 'Manager' or 'MeetingManager' to get item informations 'inTheNameOf'!"
)
# now working examples with a 'Manager'
self.changeUser('pmManager')
req._inTheNameOf = None
cleanRamCacheFor('Products.PloneMeeting.ToolPloneMeeting.userIsAmong')
result = SOAPView(self.portal,
req).searchItemsRequest(req, responseHolder)
# both items are returned
self.assertEqual(len(result._itemInfo), 2)
# returned items are item1 and item2
createdItemsUids = set((item1.UID(), item2.UID()))
resultUids = set((result._itemInfo[0].UID, result._itemInfo[1].UID))
self.assertEqual(createdItemsUids, resultUids)
# as we switch user while using inTheNameOf, make sure we have
# falled back to original user
self.assertEqual(
self.portal.portal_membership.getAuthenticatedMember().getId(),
'pmManager')
# now searchItems inTheNameOf 'pmCreator1'
req._inTheNameOf = 'pmCreator1'
cleanRamCacheFor('Products.PloneMeeting.ToolPloneMeeting.userIsAmong')
result = SOAPView(self.portal,
req).getItemInfosRequest(req, responseHolder)
self.assertEqual(len(result._itemInfo), 1)
self.assertEqual(result._itemInfo[0].UID, item1.UID())
# now searchItems inTheNameOf 'pmCreator2'
req._inTheNameOf = 'pmCreator2'
cleanRamCacheFor('Products.PloneMeeting.ToolPloneMeeting.userIsAmong')
result = SOAPView(self.portal,
req).getItemInfosRequest(req, responseHolder)
self.assertEqual(len(result._itemInfo), 1)
self.assertEqual(result._itemInfo[0].UID, item2.UID())
