From: Jesse Martinez Date: Fri, 3 Oct 2014 01:17:55 +0000 (-0400) Subject: CSPACE-6236: Adding conditioncheck procedure. All unit tests pass X-Git-Url: https://git.aero2k.de/?a=commitdiff_plain;h=f8b60f9b6f64b5676811264c0992bc830a4f64d5;p=tmp%2Fjakarta-migration.git CSPACE-6236: Adding conditioncheck procedure. All unit tests pass --- diff --git a/services/JaxRsServiceProvider/pom.xml b/services/JaxRsServiceProvider/pom.xml index 842dbf7e2..533b2efd9 100644 --- a/services/JaxRsServiceProvider/pom.xml +++ b/services/JaxRsServiceProvider/pom.xml @@ -141,6 +141,11 @@ org.collectionspace.services.loanout.service ${project.version} + + org.collectionspace.services + org.collectionspace.services.conditioncheck.service + ${project.version} + org.collectionspace.services org.collectionspace.services.objectexit.service @@ -234,11 +239,11 @@ org.collectionspace.services org.collectionspace.services.person.service - ${project.version} - - - org.collectionspace.services - org.collectionspace.services.citation.service + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.citation.service ${project.version} diff --git a/services/JaxRsServiceProvider/src/main/java/org/collectionspace/services/jaxrs/CollectionSpaceJaxRsApplication.java b/services/JaxRsServiceProvider/src/main/java/org/collectionspace/services/jaxrs/CollectionSpaceJaxRsApplication.java index f9a1c656f..df6dad718 100644 --- a/services/JaxRsServiceProvider/src/main/java/org/collectionspace/services/jaxrs/CollectionSpaceJaxRsApplication.java +++ b/services/JaxRsServiceProvider/src/main/java/org/collectionspace/services/jaxrs/CollectionSpaceJaxRsApplication.java @@ -50,6 +50,7 @@ import org.collectionspace.services.vocabulary.VocabularyResource; import org.collectionspace.services.organization.OrgAuthorityResource; import org.collectionspace.services.person.PersonAuthorityResource; import org.collectionspace.services.citation.CitationAuthorityResource; +import org.collectionspace.services.conditioncheck.ConditioncheckResource; import javax.servlet.ServletContext; import javax.ws.rs.core.Application; @@ -115,6 +116,7 @@ public class CollectionSpaceJaxRsApplication extends Application addResourceToMapAndSingletons(new RelationResource()); addResourceToMapAndSingletons(new LoaninResource()); addResourceToMapAndSingletons(new LoanoutResource()); + addResourceToMapAndSingletons(new ConditioncheckResource()); addResourceToMapAndSingletons(new ObjectExitResource()); addResourceToMapAndSingletons(new BatchResource()); addResourceToMapAndSingletons(new MediaResource()); diff --git a/services/build.xml b/services/build.xml index 5bba11747..a15a96252 100644 --- a/services/build.xml +++ b/services/build.xml @@ -170,6 +170,7 @@ + @@ -208,6 +209,7 @@ + @@ -263,6 +265,7 @@ + diff --git a/services/common/src/main/cspace/config/services/tenants/tenant-bindings-proto.xml b/services/common/src/main/cspace/config/services/tenants/tenant-bindings-proto.xml index 342333e6f..80189d28b 100644 --- a/services/common/src/main/cspace/config/services/tenants/tenant-bindings-proto.xml +++ b/services/common/src/main/cspace/config/services/tenants/tenant-bindings-proto.xml @@ -1016,6 +1016,95 @@ + + + + default-domain + org.collectionspace.services.conditioncheck.nuxeo.ConditioncheckDocumentModelHandler + + + + + conditionCheckRefNumber + conditionCheckRefNumber + + + condition + conditionCheckGroupList/[0]/condition + + + + + org.collectionspace.services.conditioncheck.nuxeo.ConditioncheckValidatorHandler + + + objectNameProperty + conditionCheckGroupList/[0]/condition + + + objectNumberProperty + conditionCheckRefNumber + + + + + + + + + + + + + authRef + conditionChecker + + + + termRef + objectAuditCategory + + + termRef + completenessGroupList/*/completeness + + + termRef + conditionCheckGroupList/*/condition + + + termRef + conservationTreatmentPriority + + + termRef + hazardGroupList/*/hazard + + + termRef + conditionCheckMethod + + + termRef + conditionCheckReason + + + termRef + salvagePriorityCodeGroupList/*/salvagePriorityCode + + + + + + + + + + + + + + diff --git a/services/common/src/main/resources/db/postgresql/load_id_generators.sql b/services/common/src/main/resources/db/postgresql/load_id_generators.sql index b4ec5495f..bbadc1524 100644 --- a/services/common/src/main/resources/db/postgresql/load_id_generators.sql +++ b/services/common/src/main/resources/db/postgresql/load_id_generators.sql @@ -154,6 +154,42 @@ acquired for the archives.', FROM id_generators ); +-- CONDITIONCHECK_NUMBER + +INSERT INTO id_generators + (csid, displayname, description, priority, last_generated_id, id_generator_state) + SELECT + '585af100-1a35-11e2-892e-0800200c9a66', + 'Condition Check Number', + 'Identifies a condition check record.', + '9', + '', +' + + + CC + CC + + + + + + . + . + + + 6 + 1 + -1 + + +' + WHERE '585af100-1a35-11e2-892e-0800200c9a66' NOT IN + ( + SELECT csid + FROM id_generators + ); + -- EVALUATION_NUMBER INSERT INTO id_generators diff --git a/services/conditioncheck/.project b/services/conditioncheck/.project new file mode 100644 index 000000000..4a5da7d75 --- /dev/null +++ b/services/conditioncheck/.project @@ -0,0 +1,17 @@ + + + org.collectionspace.services.conditioncheck + + + + + + org.eclipse.m2e.core.maven2Builder + + + + + + org.eclipse.m2e.core.maven2Nature + + diff --git a/services/conditioncheck/3rdparty/.project b/services/conditioncheck/3rdparty/.project new file mode 100644 index 000000000..1a7b39ed1 --- /dev/null +++ b/services/conditioncheck/3rdparty/.project @@ -0,0 +1,17 @@ + + + org.collectionspace.services.conditioncheck.3rdparty + + + + + + org.eclipse.m2e.core.maven2Builder + + + + + + org.eclipse.m2e.core.maven2Nature + + diff --git a/services/conditioncheck/3rdparty/build.xml b/services/conditioncheck/3rdparty/build.xml new file mode 100644 index 000000000..c6781524b --- /dev/null +++ b/services/conditioncheck/3rdparty/build.xml @@ -0,0 +1,130 @@ + + + conditioncheck service 3rdparty + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/build.xml b/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/build.xml new file mode 100644 index 000000000..018c0938c --- /dev/null +++ b/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/build.xml @@ -0,0 +1,160 @@ + + + + conditioncheck nuxeo document type + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/pom.xml b/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/pom.xml new file mode 100644 index 000000000..5f7cd03d9 --- /dev/null +++ b/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/pom.xml @@ -0,0 +1,55 @@ + + + + org.collectionspace.services + org.collectionspace.services.conditioncheck.3rdparty + 4.1-SNAPSHOT + + + 4.0.0 + org.collectionspace.services + org.collectionspace.services.conditioncheck.3rdparty.nuxeo + services.conditioncheck.3rdparty.nuxeo + jar + + Conditioncheck Nuxeo Document Type + + + + conditioncheck + Conditioncheck + conditionchecks_common + cs_default + + + + + + src/main/resources + true + + + ../../../../3rdparty/nuxeo/nuxeo-doctype/src/main/resources + true + + + + + org.apache.maven.plugins + maven-jar-plugin + + + target/classes/META-INF/MANIFEST.MF + + ${eclipseVersion} + 2 + + + + + + + + diff --git a/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/src/main/resources/OSGI-INF/README.txt b/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/src/main/resources/OSGI-INF/README.txt new file mode 100644 index 000000000..5f304de86 --- /dev/null +++ b/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/src/main/resources/OSGI-INF/README.txt @@ -0,0 +1,16 @@ +Files formerly located in this directory are no longer needed +------------------------------------------------------------- + +In CollectionSpace versions 4.0 and higher, changes were introduced +which streamline and simplify the process through which you configure +fields in CollectionSpace's main record types. + +In most cases now, you will typically change the behavior of existing fields, +or create extension schemas to add new fields specific to your museum and/or +community of practice, merely by editing simpler XML-based configuration +files within CollectionSpace's Application layer. + +Services layer files that were formerly located in this directory and +other, similar directories - which you previously needed to manually +create or edit - are now generated automatically from your configuration +in the Application layer. diff --git a/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/src/main/resources/schemas/README.txt b/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/src/main/resources/schemas/README.txt new file mode 100644 index 000000000..5f304de86 --- /dev/null +++ b/services/conditioncheck/3rdparty/nuxeo-platform-cs-conditioncheck/src/main/resources/schemas/README.txt @@ -0,0 +1,16 @@ +Files formerly located in this directory are no longer needed +------------------------------------------------------------- + +In CollectionSpace versions 4.0 and higher, changes were introduced +which streamline and simplify the process through which you configure +fields in CollectionSpace's main record types. + +In most cases now, you will typically change the behavior of existing fields, +or create extension schemas to add new fields specific to your museum and/or +community of practice, merely by editing simpler XML-based configuration +files within CollectionSpace's Application layer. + +Services layer files that were formerly located in this directory and +other, similar directories - which you previously needed to manually +create or edit - are now generated automatically from your configuration +in the Application layer. diff --git a/services/conditioncheck/3rdparty/pom.xml b/services/conditioncheck/3rdparty/pom.xml new file mode 100644 index 000000000..e578bb14f --- /dev/null +++ b/services/conditioncheck/3rdparty/pom.xml @@ -0,0 +1,24 @@ + + + org.collectionspace.services.conditioncheck + org.collectionspace.services + 4.1-SNAPSHOT + + + 4.0.0 + org.collectionspace.services.conditioncheck.3rdparty + services.conditioncheck.3rdparty + pom + + + 3rd party build for conditioncheck service + + + + + + diff --git a/services/conditioncheck/build.xml b/services/conditioncheck/build.xml new file mode 100644 index 000000000..c320a6f49 --- /dev/null +++ b/services/conditioncheck/build.xml @@ -0,0 +1,123 @@ + + + conditioncheck service + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/services/conditioncheck/client/pom.xml b/services/conditioncheck/client/pom.xml new file mode 100644 index 000000000..39cb0bab6 --- /dev/null +++ b/services/conditioncheck/client/pom.xml @@ -0,0 +1,95 @@ + + + + org.collectionspace.services + org.collectionspace.services.conditioncheck + 4.1-SNAPSHOT + + + 4.0.0 + org.collectionspace.services + org.collectionspace.services.conditioncheck.client + services.conditioncheck.client + + + + + org.slf4j + slf4j-api + test + + + org.slf4j + slf4j-log4j12 + test + + + + org.collectionspace.services + org.collectionspace.services.authority.jaxb + true + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.jaxb + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.common + true + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.client + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.conditioncheck.jaxb + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.person.client + ${project.version} + + + + org.testng + testng + + + org.jboss.resteasy + resteasy-jaxrs + + + + tjws + webserver + + + + + org.jboss.resteasy + resteasy-jaxb-provider + + + org.jboss.resteasy + resteasy-multipart-provider + + + commons-httpclient + commons-httpclient + 3.1 + + + + + collectionspace-services-conditioncheck-client + + diff --git a/services/conditioncheck/client/src/main/java/org/collectionspace/services/client/ConditioncheckClient.java b/services/conditioncheck/client/src/main/java/org/collectionspace/services/client/ConditioncheckClient.java new file mode 100644 index 000000000..29b7f199f --- /dev/null +++ b/services/conditioncheck/client/src/main/java/org/collectionspace/services/client/ConditioncheckClient.java @@ -0,0 +1,48 @@ +/** + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Copyright (c) 2009 Regents of the University of California + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * https://source.collectionspace.org/collection-space/LICENSE.txt + */ +package org.collectionspace.services.client; + +/** + * ConditioncheckClient.java + */ +public class ConditioncheckClient extends AbstractCommonListPoxServiceClientImpl { + + public static final String SERVICE_NAME = "conditionchecks"; + public static final String SERVICE_PATH_COMPONENT = SERVICE_NAME; + public static final String SERVICE_PATH = "/" + SERVICE_PATH_COMPONENT; + public static final String SERVICE_PATH_PROXY = SERVICE_PATH + "/"; + public static final String SERVICE_PAYLOAD_NAME = SERVICE_NAME; + + /* (non-Javadoc) + * @see org.collectionspace.services.client.AbstractServiceClientImpl#getServicePathComponent() + */ + @Override + public String getServicePathComponent() { + return SERVICE_PATH_COMPONENT; + } + + @Override + public String getServiceName() { + return SERVICE_NAME; + } + + @Override + public Class getProxyClass() { + return ConditioncheckProxy.class; + } + +} diff --git a/services/conditioncheck/client/src/main/java/org/collectionspace/services/client/ConditioncheckProxy.java b/services/conditioncheck/client/src/main/java/org/collectionspace/services/client/ConditioncheckProxy.java new file mode 100644 index 000000000..c557f05f2 --- /dev/null +++ b/services/conditioncheck/client/src/main/java/org/collectionspace/services/client/ConditioncheckProxy.java @@ -0,0 +1,30 @@ +/** + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Copyright (c) 2009 Regents of the University of California + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * https://source.collectionspace.org/collection-space/LICENSE.txt + */ +package org.collectionspace.services.client; + +import javax.ws.rs.Consumes; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; + +/** + * ConditioncheckProxy.java + */ +@Path(ConditioncheckClient.SERVICE_PATH_PROXY) +@Produces({"application/xml"}) +@Consumes({"application/xml"}) +public interface ConditioncheckProxy extends CollectionSpaceCommonListPoxProxy { +} diff --git a/services/conditioncheck/client/src/test/java/org/collectionspace/services/client/test/ConditioncheckAuthRefsTest.java b/services/conditioncheck/client/src/test/java/org/collectionspace/services/client/test/ConditioncheckAuthRefsTest.java new file mode 100644 index 000000000..9071f3534 --- /dev/null +++ b/services/conditioncheck/client/src/test/java/org/collectionspace/services/client/test/ConditioncheckAuthRefsTest.java @@ -0,0 +1,355 @@ +/** + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Copyright © 2009 Regents of the University of California + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * https://source.collectionspace.org/collection-space/LICENSE.txt + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.collectionspace.services.client.test; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.ws.rs.core.Response; + +import org.collectionspace.services.PersonJAXBSchema; +import org.collectionspace.services.client.CollectionSpaceClient; +import org.collectionspace.services.client.ConditioncheckClient; +import org.collectionspace.services.client.PersonAuthorityClient; +import org.collectionspace.services.client.PersonAuthorityClientUtils; +import org.collectionspace.services.client.PayloadOutputPart; +import org.collectionspace.services.client.PoxPayloadIn; +import org.collectionspace.services.client.PoxPayloadOut; +import org.collectionspace.services.common.api.GregorianCalendarDateTimeUtils; +import org.collectionspace.services.common.authorityref.AuthorityRefList; +import org.collectionspace.services.jaxb.AbstractCommonList; +import org.collectionspace.services.conditioncheck.ConditionchecksCommon; +import org.collectionspace.services.person.PersonTermGroup; + +import org.jboss.resteasy.client.ClientResponse; + +import org.testng.Assert; +import org.testng.annotations.AfterClass; +import org.testng.annotations.Test; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * ConditioncheckAuthRefsTest, carries out Authority References tests against a + * deployed and running Conditioncheck (aka Condition Checks) Service. + */ +public class ConditioncheckAuthRefsTest extends BaseServiceTest { + + private final String CLASS_NAME = ConditioncheckAuthRefsTest.class.getName(); + private final Logger logger = LoggerFactory.getLogger(CLASS_NAME); + + // Instance variables specific to this test. + final String SERVICE_NAME = "conditionchecks"; + final String SERVICE_PATH_COMPONENT = "conditionchecks"; + final String PERSON_AUTHORITY_NAME = "TestPersonAuth"; + private String knownResourceId = null; + private List conditioncheckIdsCreated = new ArrayList(); + private List personIdsCreated = new ArrayList(); + private String personAuthCSID = null; + private String conditionCheckerRefName = null; + + private final int NUM_AUTH_REFS_EXPECTED = 1; + + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.BaseServiceTest#getClientInstance() + */ + @Override + protected CollectionSpaceClient getClientInstance() { + throw new UnsupportedOperationException(); //method not supported (or needed) in this test class + } + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.BaseServiceTest#getAbstractCommonList(org.jboss.resteasy.client.ClientResponse) + */ + @Override + protected AbstractCommonList getCommonList( + ClientResponse response) { + throw new UnsupportedOperationException(); //method not supported (or needed) in this test class + } + + // --------------------------------------------------------------- + // CRUD tests : CREATE tests + // --------------------------------------------------------------- + // Success outcomes + @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class) + public void createWithAuthRefs(String testName) throws Exception { + testSetup(STATUS_CREATED, ServiceRequestType.CREATE); + + // Submit the request to the service and store the response. + String identifier = createIdentifier(); + + // Create all the person refs and entities + createPersonRefs(); + + // Create a new Condition Check resource. + // + // One or more fields in this resource will be PersonAuthority + // references, and will refer to Person resources by their refNames. + ConditioncheckClient conditioncheckClient = new ConditioncheckClient(); + PoxPayloadOut multipart = createConditioncheckInstance( + "conditionCheckRefNumber-" + identifier, + conditionCheckerRefName); + ClientResponse response = conditioncheckClient.create(multipart); + int statusCode = response.getStatus(); + try { + // Check the status code of the response: does it match + // the expected response(s)? + // + // Specifically: + // Does it fall within the set of valid status codes? + // Does it exactly match the expected status code? + if(logger.isDebugEnabled()){ + logger.debug(testName + ": status = " + statusCode); + } + Assert.assertTrue(testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + + // Store the ID returned from the first resource created + // for additional tests below. + if (knownResourceId == null){ + knownResourceId = extractId(response); + if (logger.isDebugEnabled()) { + logger.debug(testName + ": knownResourceId=" + knownResourceId); + } + } + + // Store the IDs from every resource created by tests, + // so they can be deleted after tests have been run. + conditioncheckIdsCreated.add(extractId(response)); + } finally { + response.releaseConnection(); + } + } + + protected void createPersonRefs(){ + + PersonAuthorityClient personAuthClient = new PersonAuthorityClient(); + // Create a temporary PersonAuthority resource, and its corresponding + // refName by which it can be identified. + PoxPayloadOut multipart = PersonAuthorityClientUtils.createPersonAuthorityInstance( + PERSON_AUTHORITY_NAME, PERSON_AUTHORITY_NAME, personAuthClient.getCommonPartName()); + ClientResponse res = personAuthClient.create(multipart); + int statusCode = res.getStatus(); + + Assert.assertTrue(testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, STATUS_CREATED); + personAuthCSID = extractId(res); + + String authRefName = PersonAuthorityClientUtils.getAuthorityRefName(personAuthCSID, null); + + // Create temporary Person resources, and their corresponding refNames + // by which they can be identified. + String csid = createPerson("Carrie", "ConditionChecker1", "carrieConditionChecker", authRefName); + personIdsCreated.add(csid); + conditionCheckerRefName = PersonAuthorityClientUtils.getPersonRefName(personAuthCSID, csid, null); + } + + protected String createPerson(String firstName, String surName, String shortId, String authRefName ) { + PersonAuthorityClient personAuthClient = new PersonAuthorityClient(); + Map personInfo = new HashMap(); + personInfo.put(PersonJAXBSchema.FORE_NAME, firstName); + personInfo.put(PersonJAXBSchema.SUR_NAME, surName); + personInfo.put(PersonJAXBSchema.SHORT_IDENTIFIER, shortId); + List personTerms = new ArrayList(); + PersonTermGroup term = new PersonTermGroup(); + String termName = firstName + " " + surName; + term.setTermDisplayName(termName); + term.setTermName(termName); + personTerms.add(term); + PoxPayloadOut multipart = + PersonAuthorityClientUtils.createPersonInstance(personAuthCSID, + authRefName, personInfo, personTerms, personAuthClient.getItemCommonPartName()); + ClientResponse res = personAuthClient.createItem(personAuthCSID, multipart); + int statusCode = res.getStatus(); + + Assert.assertTrue(testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, STATUS_CREATED); + return extractId(res); + } + + // Success outcomes + @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class, + dependsOnMethods = {"createWithAuthRefs"}) + public void readAndCheckAuthRefs(String testName) throws Exception { + // Perform setup. + testSetup(STATUS_OK, ServiceRequestType.READ); + + // Submit the request to the service and store the response. + ConditioncheckClient conditioncheckClient = new ConditioncheckClient(); + ClientResponse res = conditioncheckClient.read(knownResourceId); + ConditionchecksCommon conditioncheckCommon = null; + try { + assertStatusCode(res, testName); + // Extract the common part from the response. + PoxPayloadIn input = new PoxPayloadIn(res.getEntity()); + conditioncheckCommon = (ConditionchecksCommon) extractPart(input, + conditioncheckClient.getCommonPartName(), ConditionchecksCommon.class); + Assert.assertNotNull(conditioncheckCommon); + if(logger.isDebugEnabled()){ + logger.debug(objectAsXmlString(conditioncheckCommon, ConditionchecksCommon.class)); + } + } finally { + if (res != null) { + res.releaseConnection(); + } + } + // + // Check a couple of fields + Assert.assertEquals(conditioncheckCommon.getConditionChecker(), conditionCheckerRefName); + + // Get the auth refs and check them + ClientResponse res2 = conditioncheckClient.getAuthorityRefs(knownResourceId); + AuthorityRefList list = null; + try { + assertStatusCode(res2, testName); + list = res2.getEntity(); + Assert.assertNotNull(list); + } finally { + if (res2 != null) { + res2.releaseConnection(); + } + } + + List items = list.getAuthorityRefItem(); + int numAuthRefsFound = items.size(); + if(logger.isDebugEnabled()){ + logger.debug("Expected " + NUM_AUTH_REFS_EXPECTED + + " authority references, found " + numAuthRefsFound); + } + + // Optionally output additional data about list members for debugging. + boolean iterateThroughList = true; + if(iterateThroughList && logger.isDebugEnabled()){ + int i = 0; + for(AuthorityRefList.AuthorityRefItem item : items){ + logger.debug(testName + ": list-item[" + i + "] Field:" + + item.getSourceField() + "= " + + item.getAuthDisplayName() + + item.getItemDisplayName()); + logger.debug(testName + ": list-item[" + i + "] refName=" + + item.getRefName()); + logger.debug(testName + ": list-item[" + i + "] URI=" + + item.getUri()); + i++; + } + } + + Assert.assertEquals(numAuthRefsFound, NUM_AUTH_REFS_EXPECTED, + "Did not find all expected authority references! " + + "Expected " + NUM_AUTH_REFS_EXPECTED + ", found " + numAuthRefsFound); + + } + + + // --------------------------------------------------------------- + // Cleanup of resources created during testing + // --------------------------------------------------------------- + + /** + * Deletes all resources created by tests, after all tests have been run. + * + * This cleanup method will always be run, even if one or more tests fail. + * For this reason, it attempts to remove all resources created + * at any point during testing, even if some of those resources + * may be expected to be deleted by certain tests. + */ + @AfterClass(alwaysRun=true) + public void cleanUp() { + String noTest = System.getProperty("noTestCleanup"); + if(Boolean.TRUE.toString().equalsIgnoreCase(noTest)) { + if (logger.isDebugEnabled()) { + logger.debug("Skipping Cleanup phase ..."); + } + return; + } + if (logger.isDebugEnabled()) { + logger.debug("Cleaning up temporary resources created for testing ..."); + } + PersonAuthorityClient personAuthClient = new PersonAuthorityClient(); + // Delete Person resource(s) (before PersonAuthority resources). + + for (String resourceId : personIdsCreated) { + // Note: Any non-success responses are ignored and not reported. + ClientResponse response = + personAuthClient.deleteItem(personAuthCSID, resourceId); // alternative to personAuthClient.deleteItem().releaseConnection(); + response.releaseConnection(); + } + + // Delete PersonAuthority resource(s). + // Note: Any non-success response is ignored and not reported. + if (personAuthCSID != null) { + personAuthClient.delete(personAuthCSID); + // Delete Condition Checks resource(s). + ConditioncheckClient conditioncheckClient = new ConditioncheckClient(); + ClientResponse response = null; + for (String resourceId : conditioncheckIdsCreated) { + // Note: Any non-success responses are ignored and not reported. + response = conditioncheckClient.delete(resourceId); // alternative to conditioncheckClient.delete(resourceId).releaseConnection(); + response.releaseConnection(); + } + } + } + + // --------------------------------------------------------------- + // Utility methods used by tests above + // --------------------------------------------------------------- + public String getServiceName() { + return SERVICE_NAME; + } + + @Override + public String getServicePathComponent() { + return SERVICE_PATH_COMPONENT; + } + + private PoxPayloadOut createConditioncheckInstance(String conditionCheckRefNumber, + String conditionChecker) { + ConditionchecksCommon conditioncheckCommon = new ConditionchecksCommon(); + + conditioncheckCommon.setConditionCheckRefNumber(conditionCheckRefNumber); + conditioncheckCommon.setConditionChecker(conditionChecker); + + PoxPayloadOut multipart = new PoxPayloadOut(this.getServicePathComponent()); + PayloadOutputPart commonPart = + multipart.addPart(new ConditioncheckClient().getCommonPartName(), conditioncheckCommon); + + if(logger.isDebugEnabled()){ + logger.debug("to be created, conditioncheck common"); + logger.debug(objectAsXmlString(conditioncheckCommon, ConditionchecksCommon.class)); + } + + return multipart; + } + + @Override + protected Class getCommonListType() { + return AbstractCommonList.class; + } +} diff --git a/services/conditioncheck/client/src/test/java/org/collectionspace/services/client/test/ConditioncheckServiceTest.java b/services/conditioncheck/client/src/test/java/org/collectionspace/services/client/test/ConditioncheckServiceTest.java new file mode 100644 index 000000000..68d2919e2 --- /dev/null +++ b/services/conditioncheck/client/src/test/java/org/collectionspace/services/client/test/ConditioncheckServiceTest.java @@ -0,0 +1,721 @@ +/** + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Copyright © 2009 Regents of the University of California + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * https://source.collectionspace.org/collection-space/LICENSE.txt + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.collectionspace.services.client.test; + +//import java.util.ArrayList; +import java.util.List; +import javax.ws.rs.core.Response; + +import org.collectionspace.services.client.AbstractCommonListUtils; +import org.collectionspace.services.client.CollectionSpaceClient; +import org.collectionspace.services.client.ConditioncheckClient; +import org.collectionspace.services.client.PayloadInputPart; +import org.collectionspace.services.client.PayloadOutputPart; +import org.collectionspace.services.client.PoxPayloadIn; +import org.collectionspace.services.client.PoxPayloadOut; +import org.collectionspace.services.common.api.GregorianCalendarDateTimeUtils; +import org.collectionspace.services.jaxb.AbstractCommonList; +import org.collectionspace.services.conditioncheck.ConditionchecksCommon; +import org.collectionspace.services.conditioncheck.HazardGroupList; +import org.collectionspace.services.conditioncheck.HazardGroup; + +import org.jboss.resteasy.client.ClientResponse; +import org.testng.Assert; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * ConditioncheckServiceTest, carries out tests against a + * deployed and running Conditioncheck (aka Condition Checks) Service. + */ +public class ConditioncheckServiceTest extends AbstractPoxServiceTestImpl { + + /** The logger. */ + private final String CLASS_NAME = ConditioncheckServiceTest.class.getName(); + private final Logger logger = LoggerFactory.getLogger(CLASS_NAME); + // Instance variables specific to this test. + /** The service path component. */ + final String SERVICE_NAME = "conditionchecks"; + final String SERVICE_PATH_COMPONENT = "conditionchecks"; + private String CONDITIONCHECKER_REF_NAME = + "urn:cspace:org.collectionspace.demo:personauthorities:name(TestPersonAuth):item:name(HarryLender)'Harry Lender'"; + private String CONDITIONCHECK_HAZARD = + "urn:cspace:core.collectionspace.org:vocabularies:name(TestTermList):item:name(hazard1)'multi-dimensional'"; + private String CONDITIONCHECK_HAZARD_NOTE = "Object needs to be extinguished occasionally."; + private final static String CURRENT_DATE_UTC = + GregorianCalendarDateTimeUtils.timestampUTC(); + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.BaseServiceTest#getClientInstance() + */ + @Override + protected CollectionSpaceClient getClientInstance() { + return new ConditioncheckClient(); + } + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.BaseServiceTest#getAbstractCommonList(org.jboss.resteasy.client.ClientResponse) + */ + @Override + protected AbstractCommonList getCommonList( + ClientResponse response) { + return response.getEntity(AbstractCommonList.class); + } + + // --------------------------------------------------------------- + // CRUD tests : CREATE tests + // --------------------------------------------------------------- + + // Success outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.ServiceTest#create(java.lang.String) + */ + @Override +// @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class) + public void create(String testName) throws Exception { + // Perform setup, such as initializing the type of service request + // (e.g. CREATE, DELETE), its valid and expected status codes, and + // its associated HTTP method name (e.g. POST, DELETE). + setupCreate(); + + // Submit the request to the service and store the response. + ConditioncheckClient client = new ConditioncheckClient(); + String identifier = createIdentifier(); + PoxPayloadOut multipart = createConditioncheckInstance(identifier); + String newID = null; + ClientResponse res = client.create(multipart); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + // + // Specifically: + // Does it fall within the set of valid status codes? + // Does it exactly match the expected status code? + if (logger.isDebugEnabled()) { + logger.debug(testName + ": status = " + statusCode); + } + Assert.assertTrue(testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + + newID = extractId(res); + } finally { + if (res != null) { + res.releaseConnection(); + } + } + + // Store the ID returned from the first resource created + // for additional tests below. + if (knownResourceId == null) { + knownResourceId = newID; + if (logger.isDebugEnabled()) { + logger.debug(testName + ": knownResourceId=" + knownResourceId); + } + } + + // Store the IDs from every resource created by tests, + // so they can be deleted after tests have been run. + allResourceIdsCreated.add(newID); + } + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#createList(java.lang.String) + */ + @Override +// @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, +// dependsOnMethods = {"create"}) + public void createList(String testName) throws Exception { + for (int i = 0; i < 3; i++) { + create(testName); + } + } + + + /* + @Override + @Test(dataProvider="testName", dataProviderClass=AbstractServiceTest.class, + dependsOnMethods = {"create", "testSubmitRequest"}) + public void createWithEmptyEntityBody(String testName) throws Exception { + + if (logger.isDebugEnabled()) { + logger.debug(testBanner(testName, CLASS_NAME)); + } + // Perform setup. + setupCreateWithEmptyEntityBody(); + + // Submit the request to the service and store the response. + String method = REQUEST_TYPE.httpMethodName(); + String url = getServiceRootURL(); + String mediaType = MediaType.APPLICATION_XML; + final String entity = ""; + int statusCode = submitRequest(method, url, mediaType, entity); + + // Check the status code of the response: does it match + // the expected response(s)? + if(logger.isDebugEnabled()){ + logger.debug("createWithEmptyEntityBody url=" + url + + " status=" + statusCode); + } + Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode), + invalidStatusCodeMessage(REQUEST_TYPE, statusCode)); + Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE); + } + + @Override + @Test(dataProvider="testName", dataProviderClass=AbstractServiceTest.class, + dependsOnMethods = {"create", "testSubmitRequest"}) + public void createWithMalformedXml(String testName) throws Exception { + + if (logger.isDebugEnabled()) { + logger.debug(testBanner(testName, CLASS_NAME)); + } + // Perform setup. + setupCreateWithMalformedXml(testName, logger); + + // Submit the request to the service and store the response. + String method = REQUEST_TYPE.httpMethodName(); + String url = getServiceRootURL(); + String mediaType = MediaType.APPLICATION_XML; + final String entity = MALFORMED_XML_DATA; // Constant from base class. + int statusCode = submitRequest(method, url, mediaType, entity); + + // Check the status code of the response: does it match + // the expected response(s)? + if(logger.isDebugEnabled()){ + logger.debug(testName + ": url=" + url + + " status=" + statusCode); + } + Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode), + invalidStatusCodeMessage(REQUEST_TYPE, statusCode)); + Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE); + } + + @Override + @Test(dataProvider="testName", dataProviderClass=AbstractServiceTest.class, + dependsOnMethods = {"create", "testSubmitRequest"}) + public void createWithWrongXmlSchema(String testName) throws Exception { + + if (logger.isDebugEnabled()) { + logger.debug(testBanner(testName, CLASS_NAME)); + } + // Perform setup. + setupCreateWithWrongXmlSchema(testName, logger); + + // Submit the request to the service and store the response. + String method = REQUEST_TYPE.httpMethodName(); + String url = getServiceRootURL(); + String mediaType = MediaType.APPLICATION_XML; + final String entity = WRONG_XML_SCHEMA_DATA; + int statusCode = submitRequest(method, url, mediaType, entity); + + // Check the status code of the response: does it match + // the expected response(s)? + if(logger.isDebugEnabled()){ + logger.debug(testName + ": url=" + url + + " status=" + statusCode); + } + Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode), + invalidStatusCodeMessage(REQUEST_TYPE, statusCode)); + Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE); + } + */ + + // --------------------------------------------------------------- + // CRUD tests : READ tests + // --------------------------------------------------------------- + + // Success outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#read(java.lang.String) + */ + @Override +// @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, +// dependsOnMethods = {"create"}) + public void read(String testName) throws Exception { + // Perform setup. + setupRead(); + + // Submit the request to the service and store the response. + ConditioncheckClient client = new ConditioncheckClient(); + ClientResponse res = client.read(knownResourceId); + PoxPayloadIn input = null; + try { + assertStatusCode(res, testName); + input = new PoxPayloadIn(res.getEntity()); + } finally { + if (res != null) { + res.releaseConnection(); + } + } + + // Get the common part of the response and verify that it is not null. + PayloadInputPart payloadInputPart = input.getPart(client.getCommonPartName()); + ConditionchecksCommon conditioncheckCommon = null; + if (payloadInputPart != null) { + conditioncheckCommon = (ConditionchecksCommon) payloadInputPart.getBody(); + } + Assert.assertNotNull(conditioncheckCommon); + + // Check selected fields. + HazardGroupList hazardGroupList = conditioncheckCommon.getHazardGroupList(); + Assert.assertNotNull(hazardGroupList); + List hazardGroups = hazardGroupList.getHazardGroup(); + Assert.assertNotNull(hazardGroups); + String hazard = hazardGroups.get(0).getHazard(); + Assert.assertEquals(hazard, CONDITIONCHECK_HAZARD); + String hazardNote = hazardGroups.get(0).getHazardNote(); + Assert.assertEquals(hazardNote, CONDITIONCHECK_HAZARD_NOTE); + String hazardDate = hazardGroups.get(0).getHazardDate(); + Assert.assertEquals(hazardDate, CURRENT_DATE_UTC); + String conditionChecker = conditioncheckCommon.getConditionChecker(); + Assert.assertEquals(conditionChecker, CONDITIONCHECKER_REF_NAME); + + // Check the values of fields containing Unicode UTF-8 (non-Latin-1) characters. + String conditionCheckNote = conditioncheckCommon.getConditionCheckNote(); + + if (logger.isDebugEnabled()) { + logger.debug("UTF-8 data sent=" + getUTF8DataFragment() + "\n" + + "UTF-8 data received=" + conditionCheckNote); + } + + Assert.assertEquals(conditionCheckNote, getUTF8DataFragment(), + "UTF-8 data retrieved '" + conditionCheckNote + + "' does not match expected data '" + getUTF8DataFragment()); + } + + // Failure outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#readNonExistent(java.lang.String) + */ + @Override +// @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, +// dependsOnMethods = {"read"}) + public void readNonExistent(String testName) throws Exception { + // Perform setup. + setupReadNonExistent(); + + // Submit the request to the service and store the response. + ConditioncheckClient client = new ConditioncheckClient(); + ClientResponse res = client.read(NON_EXISTENT_ID); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + if (logger.isDebugEnabled()) { + logger.debug(testName + ": status = " + statusCode); + } + Assert.assertTrue(testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + } finally { + if (res != null) { + res.releaseConnection(); + } + } + } + + // --------------------------------------------------------------- + // CRUD tests : READ_LIST tests + // --------------------------------------------------------------- + + // Success outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#readList(java.lang.String) + */ + @Override +// @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, +// dependsOnMethods = {"createList", "read"}) + public void readList(String testName) throws Exception { + // Perform setup. + setupReadList(); + + // Submit the request to the service and store the response. + AbstractCommonList list = null; + ConditioncheckClient client = new ConditioncheckClient(); + ClientResponse res = client.readList(); + assertStatusCode(res, testName); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + if (logger.isDebugEnabled()) { + logger.debug(testName + ": status = " + statusCode); + } + Assert.assertTrue(testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + + list = res.getEntity(); + } finally { + if (res != null) { + res.releaseConnection(); + } + } + + // Optionally output additional data about list members for debugging. + boolean iterateThroughList = true; + if(iterateThroughList && logger.isDebugEnabled()){ + AbstractCommonListUtils.ListItemsInAbstractCommonList(list, logger, testName); + } + + } + + // Failure outcomes + // None at present. + + // --------------------------------------------------------------- + // CRUD tests : UPDATE tests + // --------------------------------------------------------------- + + // Success outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#update(java.lang.String) + */ + @Override +// @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, +// dependsOnMethods = {"read"}) + public void update(String testName) throws Exception { + // Perform setup. + setupRead(); + + // Retrieve the contents of a resource to update. + ConditioncheckClient client = new ConditioncheckClient(); + ClientResponse res = client.read(knownResourceId); + PoxPayloadIn input = null; + try { + assertStatusCode(res, testName); + input = new PoxPayloadIn(res.getEntity()); + if (logger.isDebugEnabled()) { + logger.debug("got object to update with ID: " + knownResourceId); + } + } finally { + if (res != null) { + res.releaseConnection(); + } + } + + // Extract the common part from the response. + PayloadInputPart payloadInputPart = input.getPart(client.getCommonPartName()); + ConditionchecksCommon conditioncheckCommon = null; + if (payloadInputPart != null) { + conditioncheckCommon = (ConditionchecksCommon) payloadInputPart.getBody(); + } + Assert.assertNotNull(conditioncheckCommon); + + // Update the content of this resource. + conditioncheckCommon.setConditionCheckRefNumber("updated-" + conditioncheckCommon.getConditionCheckRefNumber()); + + String conditionCheckNote = conditioncheckCommon.getConditionCheckNote(); + conditioncheckCommon.setConditionCheckNote("updated-conditionCheckNote-" + conditionCheckNote); + + if (logger.isDebugEnabled()) { + logger.debug("to be updated object"); + logger.debug(objectAsXmlString(conditioncheckCommon, ConditionchecksCommon.class)); + } + + setupUpdate(); + + // Submit the updated common part in an update request to the service + // and store the response. + PoxPayloadOut output = new PoxPayloadOut(this.getServicePathComponent()); + PayloadOutputPart commonPart = output.addPart(client.getCommonPartName(), conditioncheckCommon); + res = client.update(knownResourceId, output); + try { + assertStatusCode(res, testName); + int statusCode = res.getStatus(); + // Check the status code of the response: does it match the expected response(s)? + if (logger.isDebugEnabled()) { + logger.debug(testName + ": status = " + statusCode); + } + Assert.assertTrue(testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + input = new PoxPayloadIn(res.getEntity()); + } finally { + if (res != null) { + res.releaseConnection(); + } + } + + // Extract the updated common part from the response. + payloadInputPart = input.getPart(client.getCommonPartName()); + ConditionchecksCommon updatedConditioncheckCommon = null; + if (payloadInputPart != null) { + updatedConditioncheckCommon = (ConditionchecksCommon) payloadInputPart.getBody(); + } + Assert.assertNotNull(updatedConditioncheckCommon); + + // Check selected fields in the updated common part. + Assert.assertEquals(updatedConditioncheckCommon.getConditionCheckRefNumber(), + conditioncheckCommon.getConditionCheckRefNumber(), + "Data in updated object did not match submitted data."); + + // Check the values of fields containing Unicode UTF-8 (non-Latin-1) characters. + String originalConditionCheckNote = conditioncheckCommon.getConditionCheckNote(); + String updatedConditionCheckNote = updatedConditioncheckCommon.getConditionCheckNote(); + + Assert.assertEquals(updatedConditionCheckNote, originalConditionCheckNote, + "Data in updated object did not match submitted data."); + + if(logger.isDebugEnabled()){ + logger.debug("UTF-8 data sent=" + originalConditionCheckNote + "\n" + + "UTF-8 data received=" + updatedConditionCheckNote); + } + Assert.assertTrue(updatedConditionCheckNote.contains(getUTF8DataFragment()), + "UTF-8 data retrieved '" + updatedConditionCheckNote + + "' does not match expected data '" + getUTF8DataFragment()); + } + + @Override +// @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, +// dependsOnMethods = {"update", "testSubmitRequest"}) + public void updateNonExistent(String testName) throws Exception { + // Perform setup. + setupUpdateNonExistent(); + + // Submit the request to the service and store the response. + // Note: The ID used in this 'create' call may be arbitrary. + // The only relevant ID may be the one used in update(), below. + ConditioncheckClient client = new ConditioncheckClient(); + PoxPayloadOut multipart = createConditioncheckInstance(NON_EXISTENT_ID); + ClientResponse res = client.update(NON_EXISTENT_ID, multipart); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + if (logger.isDebugEnabled()) { + logger.debug(testName + ": status = " + statusCode); + } + Assert.assertTrue(testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + } finally { + if (res != null) { + res.releaseConnection(); + } + } + } + + // --------------------------------------------------------------- + // CRUD tests : DELETE tests + // --------------------------------------------------------------- + + // Success outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#delete(java.lang.String) + */ + @Override +// @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, +// dependsOnMethods = {"create", "readList", "testSubmitRequest", "update"}) + public void delete(String testName) throws Exception { + // Perform setup. + setupDelete(); + + // Submit the request to the service and store the response. + ConditioncheckClient client = new ConditioncheckClient(); + ClientResponse res = client.delete(knownResourceId); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + if (logger.isDebugEnabled()) { + logger.debug(testName + ": status = " + statusCode); + } + Assert.assertTrue(testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + } finally { + if (res != null) { + res.releaseConnection(); + } + } + } + + // Failure outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#deleteNonExistent(java.lang.String) + */ + @Override +// @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, +// dependsOnMethods = {"delete"}) + public void deleteNonExistent(String testName) throws Exception { + // Perform setup. + setupDeleteNonExistent(); + + // Submit the request to the service and store the response. + ConditioncheckClient client = new ConditioncheckClient(); + ClientResponse res = client.delete(NON_EXISTENT_ID); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + if (logger.isDebugEnabled()) { + logger.debug(testName + ": status = " + statusCode); + } + Assert.assertTrue(testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + } finally { + if (res != null) { + res.releaseConnection(); + } + } + } + + // --------------------------------------------------------------- + // Utility tests : tests of code used in tests above + // --------------------------------------------------------------- + + /** + * Tests the code for manually submitting data that is used by several + * of the methods above. + */ +// @Test(dependsOnMethods = {"create", "read"}) + public void testSubmitRequest() { + + // Expected status code: 200 OK + final int EXPECTED_STATUS = Response.Status.OK.getStatusCode(); + + // Submit the request to the service and store the response. + String method = ServiceRequestType.READ.httpMethodName(); + String url = getResourceURL(knownResourceId); + int statusCode = submitRequest(method, url); + + // Check the status code of the response: does it match + // the expected response(s)? + if (logger.isDebugEnabled()) { + logger.debug("testSubmitRequest: url=" + url + + " status=" + statusCode); + } + Assert.assertEquals(statusCode, EXPECTED_STATUS); + + } + + // --------------------------------------------------------------- + // Utility methods used by tests above + // --------------------------------------------------------------- + + @Override + public String getServiceName() { + return SERVICE_NAME; + } + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.BaseServiceTest#getServicePathComponent() + */ + @Override + public String getServicePathComponent() { + return SERVICE_PATH_COMPONENT; + } + + @Override + protected PoxPayloadOut createInstance(String identifier) { + return createConditioncheckInstance(identifier); + } + + /** + * Creates the conditioncheck instance. + * + * @param identifier the identifier + * @return the multipart output + */ + //private PoxPayloadOut createConditioncheckInstance(String identifier) { + // return createConditioncheckInstance("conditionCheckRefNumber-" + identifier); + //} + + /** + * Creates the conditioncheck instance. + * + * @param conditioncheckRefNumber the conditioncheck number + * @return the multipart output + */ + private PoxPayloadOut createConditioncheckInstance(String conditionCheckRefNumber) { + + ConditionchecksCommon conditioncheckCommon = new ConditionchecksCommon(); + conditioncheckCommon.setConditionCheckRefNumber(conditionCheckRefNumber); + conditioncheckCommon.setConditionChecker(CONDITIONCHECKER_REF_NAME); + conditioncheckCommon.setConditionCheckNote(getUTF8DataFragment()); + + HazardGroupList hazardGroupList = new HazardGroupList(); + List hazardGroups = hazardGroupList.getHazardGroup(); + HazardGroup hazardGroup = new HazardGroup(); + hazardGroup.setHazard(CONDITIONCHECK_HAZARD); + hazardGroup.setHazardDate(CURRENT_DATE_UTC); + hazardGroup.setHazardNote(CONDITIONCHECK_HAZARD_NOTE); + hazardGroups.add(hazardGroup); + conditioncheckCommon.setHazardGroupList(hazardGroupList); + + PoxPayloadOut multipart = new PoxPayloadOut(this.getServicePathComponent()); + PayloadOutputPart commonPart = + multipart.addPart(new ConditioncheckClient().getCommonPartName(), conditioncheckCommon); + + if (logger.isDebugEnabled()) { + logger.debug("to be created, conditioncheck common"); + logger.debug(objectAsXmlString(conditioncheckCommon, ConditionchecksCommon.class)); + } + + return multipart; + } + + @Override + public void CRUDTests(String testName) { + // TODO Auto-generated method stub + + } + + @Override + protected PoxPayloadOut createInstance(String commonPartName, + String identifier) { + PoxPayloadOut result = createConditioncheckInstance(identifier); + return result; + } + + @Override + protected ConditionchecksCommon updateInstance(ConditionchecksCommon commonPartObject) { + // TODO Auto-generated method stub + return null; + } + + @Override + protected void compareUpdatedInstances(ConditionchecksCommon original, + ConditionchecksCommon updated) throws Exception { + // TODO Auto-generated method stub + + } +} diff --git a/services/conditioncheck/client/src/test/resources/log4j.properties b/services/conditioncheck/client/src/test/resources/log4j.properties new file mode 100644 index 000000000..148a3e865 --- /dev/null +++ b/services/conditioncheck/client/src/test/resources/log4j.properties @@ -0,0 +1,23 @@ +log4j.rootLogger=debug, stdout, R + +log4j.appender.stdout=org.apache.log4j.ConsoleAppender +log4j.appender.stdout.layout=org.apache.log4j.PatternLayout + +# Pattern to output the caller's file name and line number. +log4j.appender.stdout.layout.ConversionPattern=%d %-5p [%t] [%c:%L] %m%n + +log4j.appender.R=org.apache.log4j.RollingFileAppender +log4j.appender.R.File=target/test-client.log + +log4j.appender.R.MaxFileSize=100KB +# Keep one backup file +log4j.appender.R.MaxBackupIndex=1 + +log4j.appender.R.layout=org.apache.log4j.PatternLayout +log4j.appender.R.layout.ConversionPattern=%d %-5p [%t] [%c:%L] %m%n + +#packages +log4j.logger.org.collectionspace=DEBUG +log4j.logger.org.apache=INFO +log4j.logger.httpclient=INFO +log4j.logger.org.jboss.resteasy=INFO diff --git a/services/conditioncheck/jaxb/pom.xml b/services/conditioncheck/jaxb/pom.xml new file mode 100644 index 000000000..813c90dbf --- /dev/null +++ b/services/conditioncheck/jaxb/pom.xml @@ -0,0 +1,34 @@ + + + + org.collectionspace.services.conditioncheck + org.collectionspace.services + 4.1-SNAPSHOT + + + 4.0.0 + org.collectionspace.services + org.collectionspace.services.conditioncheck.jaxb + services.conditioncheck.jaxb + + + + org.collectionspace.services + org.collectionspace.services.jaxb + ${project.version} + + + + + collectionspace-services-conditioncheck-jaxb + install + + + org.jvnet.jaxb2.maven2 + maven-jaxb2-plugin + + + + diff --git a/services/conditioncheck/jaxb/src/main/java/org/collectionspace/services/ConditioncheckJAXBSchema.java b/services/conditioncheck/jaxb/src/main/java/org/collectionspace/services/ConditioncheckJAXBSchema.java new file mode 100644 index 000000000..645474156 --- /dev/null +++ b/services/conditioncheck/jaxb/src/main/java/org/collectionspace/services/ConditioncheckJAXBSchema.java @@ -0,0 +1,8 @@ +/** + * + */ +package org.collectionspace.services; + +public interface ConditioncheckJAXBSchema { + final static String CONDITIONCHECK_REF_NUMBER = "conditionCheckRefNumber"; +} diff --git a/services/conditioncheck/jaxb/src/main/java/org/collectionspace/services/ConditioncheckListItemJAXBSchema.java b/services/conditioncheck/jaxb/src/main/java/org/collectionspace/services/ConditioncheckListItemJAXBSchema.java new file mode 100644 index 000000000..75e36afca --- /dev/null +++ b/services/conditioncheck/jaxb/src/main/java/org/collectionspace/services/ConditioncheckListItemJAXBSchema.java @@ -0,0 +1,7 @@ +package org.collectionspace.services; + +public interface ConditioncheckListItemJAXBSchema { + final static String CONDITIONCHECK_REF_NUMBER = "conditionCheckRefNumber"; + final static String CSID = "csid"; + final static String URI = "url"; +} diff --git a/services/conditioncheck/jaxb/src/main/resources/conditionchecks-common.xsd b/services/conditioncheck/jaxb/src/main/resources/conditionchecks-common.xsd new file mode 100644 index 000000000..41a18e46c --- /dev/null +++ b/services/conditioncheck/jaxb/src/main/resources/conditionchecks-common.xsd @@ -0,0 +1,204 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/services/conditioncheck/pom.xml b/services/conditioncheck/pom.xml new file mode 100644 index 000000000..dbec581fd --- /dev/null +++ b/services/conditioncheck/pom.xml @@ -0,0 +1,23 @@ + + + + + org.collectionspace.services + org.collectionspace.services.main + 4.1-SNAPSHOT + + + 4.0.0 + org.collectionspace.services + org.collectionspace.services.conditioncheck + services.conditioncheck + pom + + + jaxb + service + 3rdparty + client + + + diff --git a/services/conditioncheck/service/pom.xml b/services/conditioncheck/service/pom.xml new file mode 100644 index 000000000..a4f0486c7 --- /dev/null +++ b/services/conditioncheck/service/pom.xml @@ -0,0 +1,105 @@ + + + + + org.collectionspace.services + org.collectionspace.services.conditioncheck + 4.1-SNAPSHOT + + + 4.0.0 + org.collectionspace.services + org.collectionspace.services.conditioncheck.service + services.conditioncheck.service + jar + + + + org.collectionspace.services + org.collectionspace.services.common + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.conditioncheck.jaxb + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.conditioncheck.client + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.collectionobject.jaxb + ${project.version} + + + + junit + junit + 4.1 + test + + + org.testng + testng + + + + + + javax.security + jaas + 1.0.01 + provided + + + + dom4j + dom4j + 1.6.1 + provided + + + + + + org.jboss.resteasy + resteasy-jaxrs + + + tjws + webserver + + + + + org.jboss.resteasy + resteasy-jaxb-provider + + + org.jboss.resteasy + resteasy-multipart-provider + + + + + + org.nuxeo.ecm.core + nuxeo-core-api + ${nuxeo.core.version} + + + jboss-remoting + jboss + + + + + + + + collectionspace-services-conditioncheck + + diff --git a/services/conditioncheck/service/profiles.xml b/services/conditioncheck/service/profiles.xml new file mode 100644 index 000000000..7c9dc966e --- /dev/null +++ b/services/conditioncheck/service/profiles.xml @@ -0,0 +1,4 @@ + + + diff --git a/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/ConditioncheckResource.java b/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/ConditioncheckResource.java new file mode 100644 index 000000000..921c4d287 --- /dev/null +++ b/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/ConditioncheckResource.java @@ -0,0 +1,57 @@ +/** + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Copyright 2009 University of California at Berkeley + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * + * https://source.collectionspace.org/collection-space/LICENSE.txt + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.collectionspace.services.conditioncheck; + +import org.collectionspace.services.client.ConditioncheckClient; +import org.collectionspace.services.common.ResourceBase; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.ws.rs.Consumes; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; + +@Path(ConditioncheckClient.SERVICE_PATH) +@Consumes("application/xml") +@Produces("application/xml") +public class ConditioncheckResource extends ResourceBase { + + final Logger logger = LoggerFactory.getLogger(ConditioncheckResource.class); + + @Override + protected String getVersionString() { + final String lastChangeRevision = "$LastChangedRevision$"; + return lastChangeRevision; + } + + @Override + public String getServiceName() { + return ConditioncheckClient.SERVICE_NAME; + } + + @Override + public Class getCommonPartClass() { + return ConditionchecksCommon.class; + } +} diff --git a/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/nuxeo/ConditioncheckConstants.java b/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/nuxeo/ConditioncheckConstants.java new file mode 100644 index 000000000..5ec8cfd76 --- /dev/null +++ b/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/nuxeo/ConditioncheckConstants.java @@ -0,0 +1,35 @@ +/** + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Copyright 2009 University of California at Berkeley + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * + * https://source.collectionspace.org/collection-space/LICENSE.txt + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.collectionspace.services.conditioncheck.nuxeo; + +/** + * ConditioncheckConstants specifies constants for the Condition Checks service + * + */ +public class ConditioncheckConstants { + + public final static String NUXEO_DOCTYPE = "Conditioncheck"; + public final static String NUXEO_SCHEMA_NAME = "conditioncheck"; + public final static String NUXEO_DC_TITLE = "CollectionSpace-Conditioncheck"; +} diff --git a/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/nuxeo/ConditioncheckDocumentModelHandler.java b/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/nuxeo/ConditioncheckDocumentModelHandler.java new file mode 100644 index 000000000..240320db5 --- /dev/null +++ b/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/nuxeo/ConditioncheckDocumentModelHandler.java @@ -0,0 +1,33 @@ +/** + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Copyright 2009 University of California at Berkeley + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * + * https://source.collectionspace.org/collection-space/LICENSE.txt + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.collectionspace.services.conditioncheck.nuxeo; + +import org.collectionspace.services.conditioncheck.ConditionchecksCommon; +import org.collectionspace.services.nuxeo.client.java.DocHandlerBase; + +/** ConditioncheckDocumentModelHandler + */ +public class ConditioncheckDocumentModelHandler + extends DocHandlerBase { +} diff --git a/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/nuxeo/ConditioncheckValidatorHandler.java b/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/nuxeo/ConditioncheckValidatorHandler.java new file mode 100644 index 000000000..e168f98cc --- /dev/null +++ b/services/conditioncheck/service/src/main/java/org/collectionspace/services/conditioncheck/nuxeo/ConditioncheckValidatorHandler.java @@ -0,0 +1,16 @@ +package org.collectionspace.services.conditioncheck.nuxeo; + +import org.collectionspace.services.common.context.ServiceContext; +import org.collectionspace.services.common.document.InvalidDocumentException; +import org.collectionspace.services.common.document.ValidatorHandler; +import org.collectionspace.services.common.document.DocumentHandler.Action; + +public class ConditioncheckValidatorHandler implements ValidatorHandler { + + @Override + public void validate(Action action, ServiceContext ctx) + throws InvalidDocumentException { + // TODO Auto-generated method stub + System.out.println("ConditioncheckValidatorHandler executed."); + } +} diff --git a/services/conditioncheck/service/src/test/java/org/collectionspace/services/test/ConditioncheckServiceTest.java b/services/conditioncheck/service/src/test/java/org/collectionspace/services/test/ConditioncheckServiceTest.java new file mode 100644 index 000000000..461c83433 --- /dev/null +++ b/services/conditioncheck/service/src/test/java/org/collectionspace/services/test/ConditioncheckServiceTest.java @@ -0,0 +1,11 @@ +package org.collectionspace.services.test; + +//import org.collectionspace.services.conditioncheck.Conditioncheck; +//import org.collectionspace.services.conditioncheck.ConditioncheckList; + +/** + * Placeholder for server-side testing of Condition Check service code. + */ +public class ConditioncheckServiceTest { + //empty +} diff --git a/services/conditioncheck/service/src/test/resources/log4j.xml b/services/conditioncheck/service/src/test/resources/log4j.xml new file mode 100644 index 000000000..3869b526d --- /dev/null +++ b/services/conditioncheck/service/src/test/resources/log4j.xml @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/services/pom.xml b/services/pom.xml index f124559db..d03ff4bff 100644 --- a/services/pom.xml +++ b/services/pom.xml @@ -61,6 +61,7 @@ intake loanin loanout + conditioncheck objectexit batch imports