From cbf3983e500c2cf8b397d26865a8a938cfd1220c Mon Sep 17 00:00:00 2001
From: Aron Roberts <aron@socrates.berkeley.edu>
Date: Thu, 21 Mar 2013 14:21:21 -0700
Subject: [PATCH] CSPACE-5940: Fix bug that resulted in 'bare' ampersands being
 present in collectionspace_core:refName values, when copying those values
 from refName fields in authority term (item) records.

---
 .../import-locationitem-varexpansion.xml      | 23 ++++++++
 .../test-data/xmlreplay/imports/imports.xml   | 57 ++++++++++++++++++-
 .../res/import-locationauthority.res.xml      |  2 +-
 .../import-locationitem-varexpansion.res.xml  | 28 +++++++++
 .../imports/res/import-locationitem.res.xml   |  9 +++
 .../services/imports/TemplateExpander.java    |  2 +-
 6 files changed, 117 insertions(+), 4 deletions(-)
 create mode 100644 services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/import-locationitem-varexpansion.xml
 create mode 100644 services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem-varexpansion.res.xml
 create mode 100644 services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem.res.xml

diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/import-locationitem-varexpansion.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/import-locationitem-varexpansion.xml
new file mode 100644
index 000000000..245260973
--- /dev/null
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/import-locationitem-varexpansion.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<imports>
+    <import service="Locations" type="Locationitem" CSID="${recordCSID}">
+        <schema xmlns:locations_common="http://collectionspace.org/services/location" 
+                name="locations_common">
+            <!--
+            Values containing Ampersand character entities are hard-coded
+            here in this file, rather than being passed in as values from
+            the XmlReplay control file, because in the control file it
+            appears we needed to double-encode them as '&amp;amp;',
+            which would complicate testing of CSPACE-5940.
+            -->
+            <locTermGroupList>
+                <locTermGroup>
+                    <termDisplayName>Wattford &amp; Gump Outbuilding</termDisplayName>
+                </locTermGroup>
+            </locTermGroupList>
+            <shortIdentifier>${shortIdentifierValue}</shortIdentifier>
+            <refName>urn:cspace:core.collectionspace.org:locationauthorities:name(${importLocationAuthorityWithVarExpansion.shortIdentifierValue})'Wattford &amp; Gump Outbuilding'</refName>
+            <inAuthority>${inAuthorityValue}</inAuthority>
+        </schema>
+    </import>
+</imports>
diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/imports.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/imports.xml
index 716a6961d..81187b2c8 100644
--- a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/imports.xml
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/imports.xml
@@ -179,7 +179,8 @@
         
                 
         <!-- Verify that a refName value provided in the body of an authority record -->
-        <!-- and is present, as well, in the collectionspace_core part's refName field. -->
+        <!-- is copied to and is present, as well, in the collectionspace_core part's -->
+        <!-- refName field. -->
         <test ID="importLocationAuthorityWithVarExpansion">
             <expectedCodes>200</expectedCodes>
             <method>POST</method>
@@ -224,6 +225,57 @@
             <method>DELETE</method>
             <uri>/cspace-services/locationauthorities/${importLocationAuthorityWithVarExpansion.recordCSID}</uri>
         </test>
+                
+        <!--
+            Verify that a refName value provided in the body of an authority
+            term (item) record is copied to and is present, as well, in the
+            collectionspace_core part's refName field.
+            
+            This also tests proper handling of entity-encoded ampersands
+            contained within display name values in refNames. 9See CSPACE-5940.)
+        -->
+<test ID="importLocationItemWithVarExpansion">
+            <expectedCodes>200</expectedCodes>
+            <method>POST</method>
+            <uri>/cspace-services/imports</uri>
+            <filename>imports/import-locationitem-varexpansion.xml</filename>
+            <vars>
+                <var ID="recordCSID">5c45cdf7-f1bd-4ff3-844d-59f40ffc5b29</var>
+                <var ID="shortIdentifierValue">wattfordandgumpoutbuilding</var>
+                <var ID="inAuthorityValue">${importLocationAuthorityWithVarExpansion.recordCSID}</var>
+            </vars>
+            <response>
+                <expected level="TEXT" />
+                <filename>imports/res/import-locationitem.res.xml</filename>
+            </response>
+        </test>
+        <test ID="verifyLocationItemWithVarExpansion">
+            <expectedCodes>200</expectedCodes>
+            <method>GET</method>
+            <uri>/cspace-services/locationauthorities/${importLocationAuthorityWithVarExpansion.recordCSID}/items/${importLocationItemWithVarExpansion.recordCSID}</uri>
+            <response>
+                <filename>imports/res/import-locationitem-varexpansion.res.xml</filename>
+                <expected level="ADDOK" />
+                <parts>
+                    <part>
+                        <label>collectionspace_core</label>
+                    </part>
+                    <part>
+                        <label>locations_common</label>
+                    </part>
+                </parts>
+                <vars>
+                    <var ID="shortIdentifierValue">${importLocationItemWithVarExpansion.shortIdentifierValue}</var>
+                    <var ID="inAuthorityValue">${importLocationItemWithVarExpansion.inAuthorityValue}</var>
+                    <var ID="uriValue">/locationauthorities/${importLocationAuthorityWithVarExpansion.recordCSID}/items/${importLocationItemWithVarExpansion.recordCSID}</var>
+                </vars>
+            </response>
+        </test>
+        <test ID="deleteLocationItemWithVarExpansion">
+            <expectedCodes>200</expectedCodes>
+            <method>DELETE</method>
+            <uri>/cspace-services/locationauthorities/${importLocationAuthorityWithVarExpansion.recordCSID}/items/${importLocationItemWithVarExpansion.recordCSID}</uri>
+        </test>        
         
         <!-- Verify that a refName value is correctly generated for an authority -->
         <!-- record, when that value is not provided in the imported record, and -->
@@ -274,6 +326,7 @@
             <method>DELETE</method>
             <uri>/cspace-services/locationauthorities/${importLocationAuthorityWithGeneratedRefName.recordCSID}</uri>
         </test>
+        
                 
         <!--
             Import a record containing dollar sign and backslash character(s).
@@ -318,7 +371,7 @@
     <testGroup ID="importsTemporaryTestGroup" autoDeletePOSTS="false">
         
         <!-- Add new or changed tests here -->
-        
+                
     </testGroup>
     
     
diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationauthority.res.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationauthority.res.xml
index fa8c2619c..62b6431eb 100644
--- a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationauthority.res.xml
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationauthority.res.xml
@@ -2,7 +2,7 @@
 <import>
     <totalRecordsImported>1</totalRecordsImported>
     <numRecordsImported>
-        <docType>LocationAuthority</docType>
+        <docType>Locationauthority</docType>
         <numRecords>1</numRecords>
     </numRecordsImported>
 </import>
diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem-varexpansion.res.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem-varexpansion.res.xml
new file mode 100644
index 000000000..3fd8879fe
--- /dev/null
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem-varexpansion.res.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document name="locations">
+    <ns2:locations_common
+        xmlns:ns2="http://collectionspace.org/services/location">
+        <!--
+            Values containing Ampersand character entities are hard-coded
+            here in this file, rather than being passed in as values from
+            the XmlReplay control file, because in the control file it
+            appears we needed to double-encode them as '&amp;amp;',
+            which would complicate testing of CSPACE-5940.
+        -->
+        <locTermGroupList>
+            <locTermGroup>
+                <termDisplayName>Wattford &amp; Gump Outbuilding</termDisplayName>
+            </locTermGroup>
+        </locTermGroupList>
+        <shortIdentifier>${shortIdentifierValue}</shortIdentifier>
+        <inAuthority>${inAuthorityValue}</inAuthority>
+    </ns2:locations_common>
+    <ns2:collectionspace_core xmlns:ns2="http://collectionspace.org/collectionspace_core/"
+                              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+        <!-- Note: This test may fail if the identifier for the core tenant changes. -->
+        <tenantId>1</tenantId>
+        <uri>${uriValue}</uri>
+        <refName>urn:cspace:core.collectionspace.org:locationauthorities:name(${importLocationAuthorityWithVarExpansion.shortIdentifierValue})'Wattford &amp; Gump Outbuilding'</refName>
+    </ns2:collectionspace_core>
+</document>
+
diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem.res.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem.res.xml
new file mode 100644
index 000000000..6588688a9
--- /dev/null
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem.res.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<import>
+    <totalRecordsImported>1</totalRecordsImported>
+    <numRecordsImported>
+        <docType>Locationitem</docType>
+        <numRecords>1</numRecords>
+    </numRecordsImported>
+</import>
+
diff --git a/services/imports/service/src/main/java/org/collectionspace/services/imports/TemplateExpander.java b/services/imports/service/src/main/java/org/collectionspace/services/imports/TemplateExpander.java
index d172814d2..73c85e8d6 100644
--- a/services/imports/service/src/main/java/org/collectionspace/services/imports/TemplateExpander.java
+++ b/services/imports/service/src/main/java/org/collectionspace/services/imports/TemplateExpander.java
@@ -176,7 +176,7 @@ public class TemplateExpander {
         wrapperTmpl = Tools.searchAndReplace(wrapperTmpl, var("uri"),
                 getDocUri(tenantId, SERVICE_TYPE, docID, partTmpl));
         wrapperTmpl = Tools.searchAndReplace(wrapperTmpl, var("refName"),
-                getRefName(tenantId, SERVICE_TYPE, docID, partTmpl));
+                getRefName(tenantId, SERVICE_TYPE, docID, partTmpl).replace("&", "&amp;"));
 
 
         String serviceDir = outDir + '/' + docID;
-- 
2.47.3