Skip to content

Commit

Permalink
Test event Occurrence serialization (#1839)
Browse files Browse the repository at this point in the history
* add a failing test

* add a check for objects that are not able to be adapted to IContentListing

* changelog

* run black

* run flake8

* test that Ocurrence serialization returns correct data

* changelog

* conditional tests

* lint

* restore

* changelog

* restore

* rename changelog file
  • Loading branch information
erral authored Nov 19, 2024
1 parent 4f3bb4f commit 96d60bf
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 0 deletions.
2 changes: 2 additions & 0 deletions news/1809.internal
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Test that recurrence serialization provides correct data
[erral]
74 changes: 74 additions & 0 deletions src/plone/restapi/tests/test_serializer_summary.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,31 @@
from datetime import datetime
from datetime import timedelta
from DateTime import DateTime
from plone.app.contentlisting.interfaces import IContentListingObject
from plone.app.event.dx.traverser import OccurrenceTraverser
from plone.app.testing import popGlobalRegistry
from plone.app.testing import pushGlobalRegistry
from plone.dexterity.utils import createContentInContainer
from plone.event.interfaces import IEvent
from plone.event.interfaces import IEventRecurrence
from plone.restapi.interfaces import ISerializeToJsonSummary
from plone.restapi.testing import PLONE_RESTAPI_DX_INTEGRATION_TESTING
from plone.restapi.testing import register_static_uuid_utility
from Products.CMFCore.utils import getToolByName
from zope.component import getMultiAdapter
from zope.component.hooks import getSite
from zope.interface import alsoProvides

import Missing
import unittest


try:
from plone.app.event.adapters import OccurrenceContentListingObject
except ImportError:
OccurrenceContentListingObject = None


class TestSummarySerializers(unittest.TestCase):
layer = PLONE_RESTAPI_DX_INTEGRATION_TESTING

Expand Down Expand Up @@ -203,3 +215,65 @@ def test_dx_type_summary(self):
},
summary,
)


class TestSummarySerializerswithRecurrenceObjects(unittest.TestCase):
layer = PLONE_RESTAPI_DX_INTEGRATION_TESTING

def setUp(self):
self.portal = self.layer["portal"]
self.request = self.layer["request"]

pushGlobalRegistry(getSite())
register_static_uuid_utility(prefix="c6dcbd55ab2746e199cd4ed458")

behaviors = self.portal.portal_types.DXTestDocument.behaviors
behaviors = behaviors + (
"plone.eventbasic",
"plone.eventrecurrence",
)
self.portal.portal_types.DXTestDocument.behaviors = behaviors

self.event = createContentInContainer(
self.portal,
"DXTestDocument",
id="doc1",
title="Lorem Ipsum event",
description="Description event",
start=datetime.now(),
end=datetime.now() + timedelta(hours=1),
recurrence="RRULE:FREQ=DAILY;COUNT=3", # see https://github.com/plone/plone.app.event/blob/master/plone/app/event/tests/base_setup.py
)

alsoProvides(self.event, IEvent)
alsoProvides(self.event, IEventRecurrence)

def tearDown(self):
popGlobalRegistry(getSite())

@unittest.skipIf(
OccurrenceContentListingObject is not None,
"this test needs a plone.app.event version that does not include a IContentListingObject adapter",
)
def test_dx_event_with_recurrence_old_version(self):
tomorrow = datetime.now() + timedelta(days=1)
tomorrow_str = tomorrow.strftime("%Y-%m-%d")
ot = OccurrenceTraverser(self.event, self.request)
ocurrence = ot.publishTraverse(self.request, tomorrow_str)

with self.assertRaises(TypeError):
getMultiAdapter((ocurrence, self.request), ISerializeToJsonSummary)()

@unittest.skipIf(
OccurrenceContentListingObject is None,
"this test needs a plone.app.event version that includes a IContentListingObject adapter",
)
def test_dx_event_with_recurrence_new_version(self):
tomorrow = datetime.now() + timedelta(days=1)
tomorrow_str = tomorrow.strftime("%Y-%m-%d")
ot = OccurrenceTraverser(self.event, self.request)
ocurrence = ot.publishTraverse(self.request, tomorrow_str)
summary = getMultiAdapter((ocurrence, self.request), ISerializeToJsonSummary)()

self.assertEqual(summary["start"], tomorrow_str)
self.assertEqual(summary["Title"], ocurrence.Title())

0 comments on commit 96d60bf

Please sign in to comment.