From 2058250a21df9fe2b30ba05635fe64b12cbad01e Mon Sep 17 00:00:00 2001
From: Aron Roberts <aron@socrates.berkeley.edu>
Date: Mon, 10 Sep 2012 16:20:26 -0700
Subject: [PATCH] CSPACE-5520: Corrected XmlReplay-based tests of structured
 objects to create parent/child relationships with each create request. As
 Richard observed, when sending a relations-common-list payload with a record
 to be created, that payload must only include relations where that record is
 either a subject or object of the relationship.

---
 .../collectionobject-hierarchy.xml            | 81 +++++++------------
 ...ollectionobjects-with-relations-create.xml | 79 +++---------------
 .../res/show-siblings-top-level.res.xml       |  7 +-
 3 files changed, 42 insertions(+), 125 deletions(-)

diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/collectionobject-hierarchy.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/collectionobject-hierarchy.xml
index c68322b37..253074284 100644
--- a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/collectionobject-hierarchy.xml
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/collectionobject-hierarchy.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <xmlReplay>
     
-    <testGroup ID="CreateUpdateReadStructuredObjects" autoDeletePOSTS="false">
+    <testGroup ID="CreateUpdateReadStructuredObjects" autoDeletePOSTS="true">
         
         <!-- Create a set of CollectionObjects -->
         
@@ -32,13 +32,14 @@
         </test>
         
         <!-- Chess board -->
-        <!-- (child of chess set box, sibling of bags of white and black chess pieces) --> 
+        <!-- (child of chess set box, sibling of bags of white and black chess pieces) -->
         <test ID="CreateChessBoard" auth="admin@core.collectionspace.org">
             <method>POST</method>
             <uri>/cspace-services/collectionobjects</uri>
-            <filename>collectionobject/hierarchy/1-collectionobject.xml</filename>
+            <filename>collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml</filename>
             <vars>
                 <var ID="objectNumber">CSPACE-5518-ChessBoard</var>
+                <var ID="parentCSID">${CreateChessSetBox.CSID}</var>
             </vars>
             <expectedCodes>201</expectedCodes>
         </test>
@@ -50,12 +51,14 @@
         
         <!-- Bags of white and black chess pieces -->
         <!-- (child of chess set box, sibling of chess board, parents of chess pieces) --> 
+        
         <test ID="CreateBagOfWhiteChessPieces">
             <method>POST</method>
             <uri>/cspace-services/collectionobjects</uri>
-            <filename>collectionobject/hierarchy/1-collectionobject.xml</filename>
+            <filename>collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml</filename>
             <vars>
                 <var ID="objectNumber">CSPACE-5518-BagOfWhiteChessPieces</var>
+                <var ID="parentCSID">${CreateChessSetBox.CSID}</var>
             </vars>
             <expectedCodes>201</expectedCodes>
         </test>
@@ -68,9 +71,10 @@
         <test ID="CreateBagOfBlackChessPieces">
             <method>POST</method>
             <uri>/cspace-services/collectionobjects</uri>
-            <filename>collectionobject/hierarchy/1-collectionobject.xml</filename>
+            <filename>collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml</filename>
             <vars>
                 <var ID="objectNumber">CSPACE-5518-BagOfBlackChessPieces</var>
+                <var ID="parentCSID">${CreateChessSetBox.CSID}</var>
             </vars>
         </test>
         <test ID="ReadBagOfBlackChessPieces" auth="admin@core.collectionspace.org">
@@ -80,13 +84,15 @@
         </test>
         
         <!-- Individual chess pieces in those bags -->
+        
         <test ID="CreateWhiteRook">
             <method>POST</method>
             <uri>/cspace-services/collectionobjects</uri>
-            <filename>collectionobject/hierarchy/1-collectionobject.xml</filename>
+            <filename>collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml</filename>
             <vars>
                 <var ID="objectNumber">CSPACE-5518-WhiteRook</var>
-            </vars>
+                 <var ID="parentCSID">${CreateBagOfWhiteChessPieces.CSID}</var>
+           </vars>
             <expectedCodes>201</expectedCodes>
         </test>
         <test ID="ReadWhiteRook" auth="admin@core.collectionspace.org">
@@ -94,12 +100,14 @@
             <uri>/cspace-services/collectionobjects/${CreateWhiteRook.CSID}</uri>
             <expectedCodes>200</expectedCodes>
         </test>
+        
         <test ID="CreateWhiteBishop">
             <method>POST</method>
             <uri>/cspace-services/collectionobjects</uri>
-            <filename>collectionobject/hierarchy/1-collectionobject.xml</filename>
+            <filename>collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml</filename>
             <vars>
                 <var ID="objectNumber">CSPACE-5518-WhiteBishop</var>
+                <var ID="parentCSID">${CreateBagOfWhiteChessPieces.CSID}</var>
             </vars>
             <expectedCodes>201</expectedCodes>
         </test>
@@ -108,12 +116,14 @@
             <uri>/cspace-services/collectionobjects/${CreateWhiteBishop.CSID}</uri>
             <expectedCodes>200</expectedCodes>
         </test>
+        
         <test ID="CreateBlackQueen">
             <method>POST</method>
             <uri>/cspace-services/collectionobjects</uri>
-            <filename>collectionobject/hierarchy/1-collectionobject.xml</filename>
+            <filename>collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml</filename>
             <vars>
                 <var ID="objectNumber">CSPACE-5518-BlackQueen</var>
+                <var ID="parentCSID">${CreateBagOfBlackChessPieces.CSID}</var>
             </vars>
             <expectedCodes>201</expectedCodes>
         </test>
@@ -122,51 +132,20 @@
             <uri>/cspace-services/collectionobjects/${CreateBlackQueen.CSID}</uri>
             <expectedCodes>200</expectedCodes>
         </test>
-        
-        <!--
-        <test ID="CreateBlackRookWithRelations">
-            <method>POST</method>
-            <uri>/cspace-services/collectionobjects</uri>
-            <filename>collectionobject/hierarchy/1-collectionobject.xml</filename>
-            <vars>
-                <var ID="objectNumber">CSPACE-5518-BlackRook</var>
-            </vars>
-            <expectedCodes>201</expectedCodes>
-        </test>
-        <test ID="ReadBlackRook" auth="admin@core.collectionspace.org">
-            <method>GET</method>
-            <uri>/cspace-services/collectionobjects/${CreateBlackRookWithRelations.CSID}</uri>
-            <expectedCodes>200</expectedCodes>
-        </test>
-        -->
        
-        <!-- Create a new chess piece, and include in the create payload -->
-        <!-- a list of hierarchical relationships to be created between -->
-        <!-- the various CollectionObjects previously created, in tests above -->
-       
-        <!-- Note also that it *might* not be necessary to set these variables; the original -->
-        <!-- values of CSIDs saved from previous posts, e.g. {CreateChessSetBox.CSID} -->
-        <!-- might still be available for use in request payloads. -->
-       
-        <test ID="CreateBlackRookWithRelations">
+        <test ID="CreateBlackRook">
             <method>POST</method>
             <uri>/cspace-services/collectionobjects</uri>
             <filename>collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml</filename>
             <vars>
                 <var ID="objectNumber">CSPACE-5518-BlackRook</var>
-                <var ID="chessSetBoxCSID">${CreateChessSetBox.CSID}</var>
-                <var ID="chessBoardCSID">${CreateChessBoard.CSID}</var>
-                <var ID="bagOfWhiteChessPiecesCSID">${CreateBagOfWhiteChessPieces.CSID}</var>
-                <var ID="bagOfBlackChessPiecesCSID">${CreateBagOfBlackChessPieces.CSID}</var>
-                <var ID="whiteRookCSID">${CreateWhiteRook.CSID}</var>
-                <var ID="whiteBishopCSID">${CreateWhiteBishop.CSID}</var>
-                <var ID="blackQueenCSID">${CreateBlackQueen.CSID}</var>
+                <var ID="parentCSID">${CreateBagOfBlackChessPieces.CSID}</var>
             </vars>
             <expectedCodes>201</expectedCodes>
         </test>
         <test ID="ReadBlackRook" auth="admin@core.collectionspace.org">
             <method>GET</method>
-            <uri>/cspace-services/collectionobjects/${CreateBlackRookWithRelations.CSID}</uri>
+            <uri>/cspace-services/collectionobjects/${CreateBlackRook.CSID}</uri>
             <expectedCodes>200</expectedCodes>
         </test>
         
@@ -193,12 +172,12 @@
         
         <test ID="UpdateBlackRootWithRelations">
             <method>PUT</method>
-            <uri>/cspace-services/collectionobjects/${CreateBlackRookWithRelations.CSID}</uri>
+            <uri>/cspace-services/collectionobjects/${CreateBlackRook.CSID}</uri>
             <filename>collectionobject/hierarchy/3-collectionobjects-with-relations-update.xml</filename>
             <vars>
                 <var ID="distinguishingFeatures">This rook has two light brown striations on part of its base.</var>
+                <var ID="blackRookCSID">${CreateBlackRook.CSID}</var>
                 <var ID="bagOfBlackChessPiecesCSID">${CreateBagOfBlackChessPieces.CSID}</var>
-                <var ID="blackRookCSID">${CreateBlackRookWithRelations.CSID}</var>
             </vars>
             <expectedCodes>200</expectedCodes>
         </test>
@@ -237,7 +216,7 @@
                     <var ID="chessSetBoxCSID">${CreateChessSetBox.CSID}</var>
                     <var ID="bagOfBlackChessPiecesCSID">${CreateBagOfBlackChessPieces.CSID}</var>
                     <var ID="blackQueenCSID">${CreateBlackQueen.CSID}</var>
-                    <var ID="blackRookCSID">${CreateBlackRookWithRelations.CSID}</var>
+                    <var ID="blackRookCSID">${CreateBlackRook.CSID}</var>
                 </vars>
                 <startElement>/document/*[local-name()='relations-common-list']</startElement>
             </response>
@@ -246,13 +225,13 @@
         
         <test ID="ReadHierarchyForBottomLevelItem">
             <method>GET</method>
-            <uri>/cspace-services/collectionobjects/${CreateBlackRookWithRelations.CSID}?showRelations=true</uri>
+            <uri>/cspace-services/collectionobjects/${CreateBlackRook.CSID}?showRelations=true</uri>
             <response>
                 <expected level="ADDOK" />
                 <filename>collectionobject/hierarchy/res/show-relations-bottom-level.res.xml</filename>
                 <vars>
                     <var ID="bagOfBlackChessPiecesCSID">${CreateBagOfBlackChessPieces.CSID}</var>
-                    <var ID="blackRookCSID">${CreateBlackRookWithRelations.CSID}</var>
+                    <var ID="blackRookCSID">${CreateBlackRook.CSID}</var>
                 </vars>
                 <startElement>/document/*[local-name()='relations-common-list']</startElement>
             </response>
@@ -264,7 +243,7 @@
 
         <test ID="ReadSiblingsForTopLevelItem">
             <method>GET</method>
-            <uri>/cspace-services/collectionobjects/${CreateBagOfBlackChessPieces.CSID}?showSiblings=true</uri>
+            <uri>/cspace-services/collectionobjects/${CreateChessSetBox.CSID}?showSiblings=true</uri>
             <expectedCodes>200</expectedCodes>
             <response>
                 <expected level="ADDOK" />
@@ -291,7 +270,7 @@
         
         <test ID="ReadSiblingsForBottomLevelItem">
             <method>GET</method>
-            <uri>/cspace-services/collectionobjects/${CreateBlackRookWithRelations.CSID}?showSiblings=true</uri>
+            <uri>/cspace-services/collectionobjects/${CreateBlackRook.CSID}?showSiblings=true</uri>
             <expectedCodes>200</expectedCodes>
             <response>
                 <expected level="ADDOK" />
@@ -370,7 +349,7 @@
         <!--
         <test ID="DeleteBlackRook" auth="admin@core.collectionspace.org">
             <method>DELETE</method>
-            <uri>/cspace-services/collectionobjects/${CreateBlackRookWithRelations.CSID}</uri>
+            <uri>/cspace-services/collectionobjects/${CreateBlackRook.CSID}</uri>
         </test>
         <test ID="DeleteBlackQueen" auth="admin@core.collectionspace.org">
             <method>DELETE</method>
diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml
index 24773151f..a7a875090 100644
--- a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/hierarchy/2-collectionobjects-with-relations-create.xml
@@ -13,86 +13,27 @@
         <!-- and its three children: the chess board, and the bags of white -->
         <!-- and black chess pieces -->
         
-        <relation-list-item>
-            <predicate>hasBroader</predicate>
-            <subject>
-                <csid>${chessBoardCSID}</csid>
-                <documentType>CollectionObject</documentType>
-            </subject>
-            <object>
-                <csid>${chessSetBoxCSID}</csid>
-                <documentType>CollectionObject</documentType>
-            </object>
-        </relation-list-item>
-        
-        <relation-list-item>
-            <predicate>hasBroader</predicate>
-            <subject>
-                <csid>${bagOfWhiteChessPiecesCSID}</csid>
-                <documentType>CollectionObject</documentType>
-           </subject>
-            <object>
-                <csid>${chessSetBoxCSID}</csid>
-                <documentType>CollectionObject</documentType>
-           </object>
-        </relation-list-item>
-        
-        <relation-list-item>
-            <predicate>hasBroader</predicate>
-            <subject>
-                <csid>${bagOfBlackChessPiecesCSID}</csid>
-                <documentType>CollectionObject</documentType>
-            </subject>
-            <object>
-                <csid>${chessSetBoxCSID}</csid>
-                <documentType>CollectionObject</documentType>
-            </object>
-        </relation-list-item>
-        
-        <!--
-            Create hierarchical relationships between the bags of white 
-            and black chess pieces, and the pieces they contain.
+        <!-- 
+             ${itemCSID} is a convention understood by the Relations service,
+             which is replaced by the CSID of the item being created.  (This
+             applies to all items, including object and procedural records,
+             not just to authority item records).
+             
+             As such, ${itemCSID} does NOT get expanded by XmlReplay. 
+             It passes through, and then the service deals with it.
         -->
-        
-        <relation-list-item>
-            <predicate>hasBroader</predicate>
-            <subject>
-                <csid>${whiteRookCSID}</csid>
-                <documentType>CollectionObject</documentType>
-           </subject>
-            <object>
-                <csid>${bagOfWhiteChessPiecesCSID}</csid>
-                <documentType>CollectionObject</documentType>
-            </object>
-        </relation-list-item>
-
-        <relation-list-item>
-            <predicate>hasBroader</predicate>
-            <subject>
-                <csid>${whiteBishopCSID}</csid>
-                <documentType>CollectionObject</documentType>
-            </subject>
-            <object>
-                <csid>${bagOfWhiteChessPiecesCSID}</csid>
-                <documentType>CollectionObject</documentType>
-            </object>
-        </relation-list-item>
-
         <relation-list-item>
             <predicate>hasBroader</predicate>
             <subject>
-                <csid>${blackQueenCSID}</csid>
+                <csid>${itemCSID}</csid>
                 <documentType>CollectionObject</documentType>
             </subject>
             <object>
-                <csid>${bagOfBlackChessPiecesCSID}</csid>
+                <csid>${parentCSID}</csid>
                 <documentType>CollectionObject</documentType>
             </object>
         </relation-list-item>
         
-        <!-- The relationship between the bag of black pieces -->
-        <!-- and the black rook is set in a separate payload. -->
-        
     </ns3:relations-common-list>
 </document>
 
diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/hierarchy/res/show-siblings-top-level.res.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/hierarchy/res/show-siblings-top-level.res.xml
index 037092af7..5be49bd9a 100644
--- a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/hierarchy/res/show-siblings-top-level.res.xml
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/collectionobject/hierarchy/res/show-siblings-top-level.res.xml
@@ -7,10 +7,7 @@
         Siblings of the chess board box:
         (none)
     -->
-    <ns3:relations-common-list xmlns:ns3="http://collectionspace.org/services/relation" xmlns:ns2="http://collectionspace.org/services/jaxb">
-        <pageNum>0</pageNum>
-        <itemsInPage>0</itemsInPage>
-        <totalItems>0</totalItems>
-    </ns3:relations-common-list>
+    <!-- Note: the relations-common-list part is NOT returned -->
+    <!-- in calls to showSiblings when there are no matching items. -->
 </document>
 
-- 
2.47.3