git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 /**
   2  * This document is a part of the source code and related artifacts
   3  * for CollectionSpace, an open source collections management system
   4  * for museums and related institutions:
   5  *
   6  * http://www.collectionspace.org
   7  * http://wiki.collectionspace.org
   8  *
   9  * Copyright © 2009 Regents of the University of California
  10  *
  11  * Licensed under the Educational Community License (ECL), Version 2.0.
  12  * You may not use this file except in compliance with this License.
  13  *
  14  * You may obtain a copy of the ECL 2.0 License at
  15  * https://source.collectionspace.org/collection-space/LICENSE.txt
  16  *
  17  * Unless required by applicable law or agreed to in writing, software
  18  * distributed under the License is distributed on an "AS IS" BASIS,
  19  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20  * See the License for the specific language governing permissions and
  21  * limitations under the License.
  22  */
  23 package org.collectionspace.services.client.test;
  24
  25 import javax.ws.rs.core.MediaType;
  26 import javax.ws.rs.core.Response;
  27
  28 import org.collectionspace.services.client.CollectionSpaceClient;
  29 import org.collectionspace.services.client.ObjectExitClient;
  30 import org.collectionspace.services.client.PayloadOutputPart;
  31 import org.collectionspace.services.client.PoxPayloadIn;
  32 import org.collectionspace.services.client.PoxPayloadOut;
  33 import org.collectionspace.services.common.AbstractCommonListUtils;
  34 import org.collectionspace.services.jaxb.AbstractCommonList;
  35 import org.collectionspace.services.objectexit.ObjectexitCommon;
  36
  37 import org.jboss.resteasy.client.ClientResponse;
  38
  39 import org.testng.Assert;
  40 import org.testng.annotations.Test;
  41
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44 //import org.w3c.dom.Element;
  45 //import org.w3c.dom.Node;
  46
  47 /**
  48  * ObjectExitServiceTest, carries out tests against a deployed and running ObjectExit Service. <p/>
  49  * $LastChangedRevision:  $
  50  * $LastChangedDate:  $
  51  */
  52 public class ObjectExitServiceTest extends AbstractServiceTestImpl {
  53
  54     private final String CLASS_NAME = ObjectExitServiceTest.class.getName();
  55     private final Logger logger = LoggerFactory.getLogger(CLASS_NAME);
  56     final String SERVICE_PATH_COMPONENT = "objectexit";
  57     private String knownResourceId = null;
  58
  59     @Override
  60         public String getServicePathComponent() {
  61                 return ObjectExitClient.SERVICE_PATH_COMPONENT;
  62         }
  63
  64         @Override
  65         protected String getServiceName() {
  66                 return ObjectExitClient.SERVICE_NAME;
  67         }
  68
  69     @Override
  70     protected CollectionSpaceClient getClientInstance() {
  71         return new ObjectExitClient();
  72     }
  73
  74     @Override
  75     protected AbstractCommonList getAbstractCommonList(ClientResponse<AbstractCommonList> response) {
  76         return response.getEntity(AbstractCommonList.class);
  77     }
  78
  79     @Override
  80     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class)
  81     public void create(String testName) throws Exception {
  82         logger.debug(testBanner(testName, CLASS_NAME));
  83         setupCreate();
  84         ObjectExitClient client = new ObjectExitClient();
  85         PoxPayloadOut multipart = createObjectExitInstance(createIdentifier());
  86         ClientResponse<Response> res = client.create(multipart);
  87         assertStatusCode(res, testName);
  88         if (knownResourceId == null) {
  89             knownResourceId = extractId(res);  // Store the ID returned from the first resource created for additional tests below.
  90             logger.debug(testName + ": knownResourceId=" + knownResourceId);
  91         }
  92         allResourceIdsCreated.add(extractId(res)); // Store the IDs from every resource created by tests so they can be deleted after tests have been run.
  93     }
  94
  95     @Override
  96     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, dependsOnMethods = {"create"})
  97     public void createList(String testName) throws Exception {
  98         logger.debug(testBanner(testName, CLASS_NAME));
  99         for (int i = 0; i < 3; i++) {
 100             create(testName);
 101         }
 102     }
 103
 104     @Override
 105     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, dependsOnMethods = {"create"})
 106     public void read(String testName) throws Exception {
 107         logger.debug(testBanner(testName, CLASS_NAME));
 108         setupRead();
 109         ObjectExitClient client = new ObjectExitClient();
 110         ClientResponse<String> res = client.read(knownResourceId);
 111         assertStatusCode(res, testName);
 112         PoxPayloadIn input = new PoxPayloadIn(res.getEntity());
 113         ObjectexitCommon objectexit = (ObjectexitCommon) extractPart(input, client.getCommonPartName(), ObjectexitCommon.class);
 114         Assert.assertNotNull(objectexit);
 115     }
 116
 117     @Override
 118     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, dependsOnMethods = {"createList", "read"})
 119     public void readList(String testName) throws Exception {
 120         logger.debug(testBanner(testName, CLASS_NAME));
 121         setupReadList();
 122         ObjectExitClient client = new ObjectExitClient();
 123         ClientResponse<AbstractCommonList> res = client.readList();
 124         assertStatusCode(res, testName);
 125         String bar = "\r\n\r\n=================================\r\n\r\n";
 126         System.out.println(bar+" res: "+res);
 127         AbstractCommonList list = res.getEntity();
 128         System.out.println(bar+" list: "+list);
 129
 130         // Optionally output additional data about list members for debugging.
 131         boolean iterateThroughList = true;
 132         if(iterateThroughList && logger.isDebugEnabled()){
 133                 AbstractCommonListUtils.ListItemsInAbstractCommonList(list, logger, testName);
 134         }
 135
 136     }
 137
 138     @Override
 139     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, dependsOnMethods = {"read"})
 140     public void update(String testName) throws Exception {
 141         logger.debug(testBanner(testName, CLASS_NAME));
 142         setupUpdate();
 143         ObjectExitClient client = new ObjectExitClient();
 144         ClientResponse<String> res = client.read(knownResourceId);
 145         assertStatusCode(res, testName);
 146         logger.debug("got object to update with ID: " + knownResourceId);
 147         PoxPayloadIn input = new PoxPayloadIn(res.getEntity());
 148         ObjectexitCommon objectexit = (ObjectexitCommon) extractPart(input, client.getCommonPartName(), ObjectexitCommon.class);
 149         Assert.assertNotNull(objectexit);
 150
 151         objectexit.setExitNumber("updated-" + objectexit.getExitNumber());
 152         logger.debug("Object to be updated:"+objectAsXmlString(objectexit, ObjectexitCommon.class));
 153         PoxPayloadOut output = new PoxPayloadOut(ObjectExitClient.SERVICE_PAYLOAD_NAME);
 154         PayloadOutputPart commonPart = output.addPart(objectexit, MediaType.APPLICATION_XML_TYPE);
 155         commonPart.setLabel(client.getCommonPartName());
 156         res = client.update(knownResourceId, output);
 157         assertStatusCode(res, testName);
 158         input = new PoxPayloadIn(res.getEntity());
 159         ObjectexitCommon updatedObjectExit = (ObjectexitCommon) extractPart(input, client.getCommonPartName(), ObjectexitCommon.class);
 160         Assert.assertNotNull(updatedObjectExit);
 161     }
 162
 163     @Override
 164     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, dependsOnMethods = {"update", "testSubmitRequest"})
 165     public void updateNonExistent(String testName) throws Exception {
 166         logger.debug(testBanner(testName, CLASS_NAME));
 167         setupUpdateNonExistent();
 168         // Submit the request to the service and store the response.
 169         // Note: The ID used in this 'create' call may be arbitrary.
 170         // The only relevant ID may be the one used in update(), below.
 171         ObjectExitClient client = new ObjectExitClient();
 172         PoxPayloadOut multipart = createObjectExitInstance(NON_EXISTENT_ID);
 173         ClientResponse<String> res = client.update(NON_EXISTENT_ID, multipart);
 174         assertStatusCode(res, testName);
 175     }
 176
 177     @Override
 178     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, dependsOnMethods = {"create", "readList", "testSubmitRequest", "update"})
 179     public void delete(String testName) throws Exception {
 180         logger.debug(testBanner(testName, CLASS_NAME));
 181         setupDelete();
 182         ObjectExitClient client = new ObjectExitClient();
 183         ClientResponse<Response> res = client.delete(knownResourceId);
 184         assertStatusCode(res, testName);
 185     }
 186
 187     // ---------------------------------------------------------------
 188     // Failure outcome tests : means we expect response to fail, but test to succeed
 189     // ---------------------------------------------------------------
 190
 191     // Failure outcome
 192     @Override
 193     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, dependsOnMethods = {"read"})
 194     public void readNonExistent(String testName) throws Exception {
 195         logger.debug(testBanner(testName, CLASS_NAME));
 196         setupReadNonExistent();
 197         ObjectExitClient client = new ObjectExitClient();
 198         ClientResponse<String> res = client.read(NON_EXISTENT_ID);
 199         assertStatusCode(res, testName);
 200     }
 201
 202     // Failure outcome
 203     @Override
 204     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class, dependsOnMethods = {"delete"})
 205     public void deleteNonExistent(String testName) throws Exception {
 206         logger.debug(testBanner(testName, CLASS_NAME));
 207         setupDeleteNonExistent();
 208         ObjectExitClient client = new ObjectExitClient();
 209         ClientResponse<Response> res = client.delete(NON_EXISTENT_ID);
 210         assertStatusCode(res, testName);
 211     }
 212
 213     // Failure outcomes
 214     // Placeholders until the tests below can be implemented. See Issue CSPACE-401.
 215
 216     @Override
 217     public void createWithEmptyEntityBody(String testName) throws Exception {
 218     }
 219
 220     @Override
 221     public void createWithMalformedXml(String testName) throws Exception {
 222     }
 223
 224     @Override
 225     public void createWithWrongXmlSchema(String testName) throws Exception {
 226     }
 227
 228     @Override
 229     public void updateWithEmptyEntityBody(String testName) throws Exception {
 230     }
 231
 232     @Override
 233     public void updateWithMalformedXml(String testName) throws Exception {
 234     }
 235
 236     @Override
 237     public void updateWithWrongXmlSchema(String testName) throws Exception {
 238     }
 239
 240     // ---------------------------------------------------------------
 241     // Utility tests : tests of code used in tests above
 242     // ---------------------------------------------------------------
 243
 244     @Test(dependsOnMethods = {"create", "read"})
 245     public void testSubmitRequest() {
 246         final int EXPECTED_STATUS = Response.Status.OK.getStatusCode(); // Expected status code: 200 OK
 247         String method = ServiceRequestType.READ.httpMethodName();
 248         String url = getResourceURL(knownResourceId);
 249         int statusCode = submitRequest(method, url);
 250         logger.debug("testSubmitRequest: url=" + url + " status=" + statusCode);
 251         Assert.assertEquals(statusCode, EXPECTED_STATUS);
 252     }
 253
 254     // ---------------------------------------------------------------
 255     // Utility methods used by tests above
 256     // ---------------------------------------------------------------
 257
 258     @Override
 259     protected PoxPayloadOut createInstance(String identifier) {
 260         ObjectExitClient client = new ObjectExitClient();
 261         return createObjectExitInstance(identifier);
 262     }
 263
 264     private PoxPayloadOut createObjectExitInstance(String exitNumber) {
 265         String identifier = "objectexitNumber-" + exitNumber;
 266         ObjectexitCommon objectexit = new ObjectexitCommon();
 267         objectexit.setExitNumber(identifier);
 268         objectexit.setDepositor("urn:cspace:org.collectionspace.demo:orgauthority:name(TestOrgAuth):organization:name(Northern Climes Museum)'Northern Climes Museum'");
 269         PoxPayloadOut multipart = new PoxPayloadOut(ObjectExitClient.SERVICE_PAYLOAD_NAME);
 270         PayloadOutputPart commonPart = multipart.addPart(objectexit, MediaType.APPLICATION_XML_TYPE);
 271         commonPart.setLabel(new ObjectExitClient().getCommonPartName());
 272
 273         if (logger.isDebugEnabled()) {
 274             logger.debug("to be created, objectexit common");
 275             logger.debug(objectAsXmlString(objectexit, ObjectexitCommon.class));
 276         }
 277
 278         return multipart;
 279     }
 280 }