Merge pull request #28 from unt-libraries/presentation/premisEventXML…

…ToObject-tests

Tests for premisEventXMLToObject

tests/__init__.py

@@ -7,3 +7,5 @@
 TEST_DATA_DIR = os.path.join(TESTS_DIR, 'test_data')
 
 AppEventTestXml = partial(open, os.path.join(TEST_DATA_DIR, 'app_event.xml'))
+
+EventTestXml = partial(open, os.path.join(TEST_DATA_DIR, 'event.xml'))

tests/factories.py

@@ -68,11 +68,11 @@ class Meta:
     linking_agent_role = ''
 
     @factory.post_generation
-    def linking_objects(self, create, extracted, linking_objects_count=1, **kwargs):
+    def linking_objects(self, create, extracted, count=1, **kwargs):
         """Post generation hook to add related LinkObject instances.
 
         Pass `linking_objects=True` to the create function to activate.
         """
         if create and extracted:
-            linking_objects = LinkObjectFactory.create_batch(linking_objects_count)
+            linking_objects = LinkObjectFactory.create_batch(count)
             self.linking_objects.add(*linking_objects)

tests/test_data/event.xml

@@ -0,0 +1,27 @@
+<premis:event xmlns:premis="info:lc/xmlns/premis-v2">
+    <premis:eventDetail>XeeGtJpGxkDD</premis:eventDetail>
+    <premis:eventOutcomeInformation>
+        <premis:eventOutcomeDetail>NBFmyLCRkhvE</premis:eventOutcomeDetail>
+        <premis:eventOutcome>http://purl.org/net/untl/vocabularies/eventOutcomes/#failure</premis:eventOutcome>
+    </premis:eventOutcomeInformation>
+    <premis:eventType>http://purl.org/net/untl/vocabularies/preservationEvents/#fixityCheck</premis:eventType>
+    <premis:linkingAgentIdentifier>
+        <premis:linkingAgentIdentifierValue>http://example.com/agent/codavalidation</premis:linkingAgentIdentifierValue>
+        <premis:linkingAgentIdentifierType>http://purl.org/net/untl/vocabularies/identifier-qualifiers/#UUID</premis:linkingAgentIdentifierType>
+    </premis:linkingAgentIdentifier>
+    <premis:eventIdentifier>
+        <premis:eventIdentifierValue>{identifier}</premis:eventIdentifierValue>
+        <premis:eventIdentifierType>http://purl.org/net/untl/vocabularies/identifier-qualifiers/#UUID</premis:eventIdentifierType>
+    </premis:eventIdentifier>
+    <premis:eventDateTime>2015-10-02 19:59:21</premis:eventDateTime>
+    <premis:linkingObjectIdentifier>
+        <premis:linkingObjectIdentifierType>http://purl.org/net/untl/vocabularies/identifier-qualifiers/#ARK</premis:linkingObjectIdentifierType>
+        <premis:linkingObjectIdentifierValue>ark:/00001/coda4</premis:linkingObjectIdentifierValue>
+        <premis:linkingObjectRole/>
+    </premis:linkingObjectIdentifier>
+    <premis:linkingObjectIdentifier>
+        <premis:linkingObjectIdentifierType>http://purl.org/net/untl/vocabularies/identifier-qualifiers/#ARK</premis:linkingObjectIdentifierType>
+        <premis:linkingObjectIdentifierValue>ark:/00001/coda5</premis:linkingObjectIdentifierValue>
+        <premis:linkingObjectRole/>
+    </premis:linkingObjectIdentifier>
+</premis:event>

tests/test_presentation.py

@@ -0,0 +1,199 @@
+from datetime import datetime
+import uuid
+
+from lxml import etree, objectify
+import pytest
+
+from django.http import HttpResponse
+
+from premis_event_service import presentation, models
+from . import EventTestXml, factories
+
+
+@pytest.fixture
+def event_xml():
+    with EventTestXml() as f:
+        xml = f.read()
+
+    identifier = '7bea513bbe554f21854c5fd251822b3a'
+    return identifier, xml.format(identifier=identifier)
+
+
+def etree_to_objectify(tree):
+    """Test helper to convert an etree object to an objectify object."""
+    return objectify.fromstring(etree.tostring(tree))
+
+
+def objectify_to_etree(obj):
+    """Test helper to convert an objectify object to an etree object."""
+    return etree.fromstring(etree.tostring(obj))
+
+
+@pytest.mark.django_db
+class TestPremisEventXMLToObject:
+
+    def test_returns_event(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+        assert isinstance(event, models.Event)
+
+    def test_sets_event_type(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+
+        xml_obj = etree_to_objectify(tree)
+        assert event.event_type == xml_obj.eventType
+
+    def test_sets_identifier_type(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+
+        xml_obj = etree_to_objectify(tree)
+        assert event.event_identifier_type == xml_obj.eventIdentifier.eventIdentifierType
+
+    def test_sets_event_date_time(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+
+        xml_obj = etree_to_objectify(tree)
+        assert str(event.event_date_time) == xml_obj.eventDateTime
+        assert isinstance(event.event_date_time, datetime)
+
+    def test_sets_event_detail(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+
+        xml_obj = etree_to_objectify(tree)
+        assert event.event_detail == xml_obj.eventDetail
+
+    def test_sets_event_outcome(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+
+        xml_obj = etree_to_objectify(tree)
+        assert event.event_outcome == xml_obj.eventOutcomeInformation.eventOutcome
+
+    def test_sets_event_outcome_detail(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+
+        xml_obj = etree_to_objectify(tree)
+        assert event.event_outcome_detail == xml_obj.eventOutcomeInformation.eventOutcomeDetail
+
+    def test_sets_linking_agent_identifier_type(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+
+        xml_obj = etree_to_objectify(tree)
+        assert event.linking_agent_identifier_type == (xml_obj
+                                                       .linkingAgentIdentifier
+                                                       .linkingAgentIdentifierType)
+
+    def test_sets_linking_agent_identifier_value(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+
+        xml_obj = etree_to_objectify(tree)
+        assert event.linking_agent_identifier_value == (xml_obj
+                                                        .linkingAgentIdentifier
+                                                        .linkingAgentIdentifierValue)
+
+    def test_linking_objects_added(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+
+        xml_obj = etree_to_objectify(tree)
+        linking_objects = list(xml_obj.linkingObjectIdentifier)
+
+        assert len(linking_objects) == event.linking_objects.count()
+
+    def test_linking_objects_attributes(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+        event = presentation.premisEventXMLToObject(tree)
+
+        xml_obj = etree_to_objectify(tree)
+        xml_linking_object_id = xml_obj.linkingObjectIdentifier.linkingObjectIdentifierValue.text
+        xml_linking_object_type = xml_obj.linkingObjectIdentifier.linkingObjectIdentifierType.text
+
+        # Get the newly created LinkObject from the database.
+        linking_object = event.linking_objects.get(object_identifier=xml_linking_object_id)
+
+        # Assert that the database version matches the values defined in the XML.
+        assert xml_linking_object_id == linking_object.object_identifier
+        assert xml_linking_object_type == linking_object.object_type
+
+    @pytest.mark.xfail(reason='Try block always catches a NameError before able to return.')
+    def test_existing_event_identifier_results_in_HttpResponse(self, event_xml):
+        identifier, xml = event_xml
+        tree = etree.fromstring(xml)
+
+        factories.EventFactory.create(event_identifier=identifier)
+        event_or_response = presentation.premisEventXMLToObject(tree)
+
+        assert isinstance(event_or_response, HttpResponse)
+
+    def test_new_identifier_created_if_not_valid_uuid4(self, event_xml):
+        _, xml = event_xml
+
+        # Replace the existing hex identifier with a non-hex identifier.
+        invalid_identifier = 'invalid-hex'
+        xml_obj = objectify.fromstring(xml)
+        xml_obj.eventIdentifier.eventIdentifierValue = invalid_identifier
+
+        tree = objectify_to_etree(xml_obj)
+
+        # Create an Event with the same non-hex identifier.
+        factories.EventFactory.create(event_identifier=invalid_identifier)
+        event = presentation.premisEventXMLToObject(tree)
+
+        # Make sure the returned Event is given a new hex identifier.
+        assert event.event_identifier != invalid_identifier
+        assert uuid.UUID(event.event_identifier, version=4)
+
+    @pytest.mark.xfail(reason='Validation error is raised on save(). The exception '
+                              'this function tests will never be raised.')
+    def test_invalid_datetime_string_raises_exception(self, event_xml):
+        _, xml = event_xml
+
+        # Replace the datetime string with an invalid datetime string.
+        xml_obj = objectify.fromstring(xml)
+        xml_obj.eventDateTime = 'invalid-datetime'
+
+        tree = objectify_to_etree(xml_obj)
+
+        with pytest.raises(Exception) as e:
+            presentation.premisEventXMLToObject(tree)
+
+        # Since the base Exception is raised from the function, we want to make
+        # sure it is the correct Exception, so now check the error message and
+        # see if it matches the expected message.
+        assert 'Unable to parse' in str(e)
+        assert 'into datetime object' in str(e)
+
+    def test_datetime_that_has_decimal_seconds(self, event_xml):
+        """Test that a datetime string that contains a decimal second is properly
+        converted to a datetime object.
+        """
+        _, xml = event_xml
+
+        # Replace the datetime string with a valid datetime string that
+        # contains a decimal second field.
+        date_string = '1997-07-16T19:20:30.45+01:00'
+        xml_obj = objectify.fromstring(xml)
+        xml_obj.eventDateTime = date_string
+
+        tree = objectify_to_etree(xml_obj)
+        event = presentation.premisEventXMLToObject(tree)
+
+        assert isinstance(event.event_date_time, datetime)