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 java.util.ArrayList;
  26 import java.util.HashMap;
  27 import java.util.List;
  28 import java.util.Map;
  29
  30 import javax.ws.rs.core.Response;
  31
  32 import org.collectionspace.services.PersonJAXBSchema;
  33 import org.collectionspace.services.client.CollectionSpaceClient;
  34 import org.collectionspace.services.client.LoaninClient;
  35 import org.collectionspace.services.client.PersonAuthorityClient;
  36 import org.collectionspace.services.client.PersonAuthorityClientUtils;
  37 import org.collectionspace.services.client.PayloadOutputPart;
  38 import org.collectionspace.services.client.PoxPayloadIn;
  39 import org.collectionspace.services.client.PoxPayloadOut;
  40 import org.collectionspace.services.common.api.GregorianCalendarDateTimeUtils;
  41 import org.collectionspace.services.common.authorityref.AuthorityRefList;
  42 import org.collectionspace.services.jaxb.AbstractCommonList;
  43 import org.collectionspace.services.loanin.LenderGroup;
  44 import org.collectionspace.services.loanin.LenderGroupList;
  45 import org.collectionspace.services.loanin.LoansinCommon;
  46 import org.collectionspace.services.person.PersonTermGroup;
  47
  48 import org.jboss.resteasy.client.ClientResponse;
  49
  50 import org.testng.Assert;
  51 import org.testng.annotations.AfterClass;
  52 import org.testng.annotations.Test;
  53
  54 import org.slf4j.Logger;
  55 import org.slf4j.LoggerFactory;
  56
  57 /**
  58  * LoaninAuthRefsTest, carries out Authority References tests against a
  59  * deployed and running Loanin (aka Loans In) Service.
  60  *
  61  * $LastChangedRevision$
  62  * $LastChangedDate$
  63  */
  64 public class LoaninAuthRefsTest extends BaseServiceTest<AbstractCommonList> {
  65
  66     private final String CLASS_NAME = LoaninAuthRefsTest.class.getName();
  67     private final Logger logger = LoggerFactory.getLogger(CLASS_NAME);
  68
  69     // Instance variables specific to this test.
  70     final String SERVICE_NAME = "loansin";
  71     final String SERVICE_PATH_COMPONENT = "loansin";
  72     final String PERSON_AUTHORITY_NAME = "TestPersonAuth";
  73     private String knownResourceId = null;
  74     private List<String> loaninIdsCreated = new ArrayList<String>();
  75     private List<String> personIdsCreated = new ArrayList<String>();
  76     private String personAuthCSID = null;
  77     private String lenderRefName = null;
  78     private String lendersAuthorizerRefName = null;
  79     private String lendersContactRefName = null;
  80     private String borrowersContactRefName = null;
  81     private String borrowersAuthorizerRefName = null;
  82     private final int NUM_AUTH_REFS_EXPECTED = 5;
  83     private final static String CURRENT_DATE_UTC =
  84             GregorianCalendarDateTimeUtils.currentDateUTC();
  85
  86     /* (non-Javadoc)
  87      * @see org.collectionspace.services.client.test.BaseServiceTest#getClientInstance()
  88      */
  89     @Override
  90     protected CollectionSpaceClient getClientInstance() {
  91         throw new UnsupportedOperationException(); //method not supported (or needed) in this test class
  92     }
  93
  94     /* (non-Javadoc)
  95      * @see org.collectionspace.services.client.test.BaseServiceTest#getAbstractCommonList(org.jboss.resteasy.client.ClientResponse)
  96      */
  97     @Override
  98         protected AbstractCommonList getCommonList(
  99                         ClientResponse<AbstractCommonList> response) {
 100         throw new UnsupportedOperationException(); //method not supported (or needed) in this test class
 101     }
 102
 103     // ---------------------------------------------------------------
 104     // CRUD tests : CREATE tests
 105     // ---------------------------------------------------------------
 106     // Success outcomes
 107     @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class)
 108     public void createWithAuthRefs(String testName) throws Exception {
 109         testSetup(STATUS_CREATED, ServiceRequestType.CREATE);
 110
 111         // Submit the request to the service and store the response.
 112         String identifier = createIdentifier();
 113
 114         // Create all the person refs and entities
 115         createPersonRefs();
 116
 117         // Create a new Loans In resource.
 118         //
 119         // One or more fields in this resource will be PersonAuthority
 120         // references, and will refer to Person resources by their refNames.
 121         LoaninClient loaninClient = new LoaninClient();
 122         PoxPayloadOut multipart = createLoaninInstance(
 123                 "loanInNumber-" + identifier,
 124                 CURRENT_DATE_UTC,
 125                 lenderRefName,
 126                 lendersAuthorizerRefName,
 127                 lendersContactRefName,
 128                 borrowersContactRefName,
 129                 borrowersAuthorizerRefName);
 130         String newId = null;
 131         Response response = loaninClient.create(multipart);
 132         try {
 133             int statusCode = response.getStatus();
 134                 // Check the status code of the response: does it match
 135                 // the expected response(s)?
 136                 //
 137                 // Specifically:
 138                 // Does it fall within the set of valid status codes?
 139                 // Does it exactly match the expected status code?
 140                 if(logger.isDebugEnabled()){
 141                     logger.debug(testName + ": status = " + statusCode);
 142                 }
 143                 Assert.assertTrue(testRequestType.isValidStatusCode(statusCode),
 144                         invalidStatusCodeMessage(testRequestType, statusCode));
 145                 Assert.assertEquals(statusCode, testExpectedStatusCode);
 146                 newId = extractId(response);
 147         } finally {
 148                 response.close();
 149         }
 150
 151         // Store the ID returned from the first resource created
 152         // for additional tests below.
 153         if (knownResourceId == null){
 154             knownResourceId = newId;
 155             if (logger.isDebugEnabled()) {
 156                 logger.debug(testName + ": knownResourceId=" + knownResourceId);
 157             }
 158         }
 159
 160         // Store the IDs from every resource created by tests,
 161         // so they can be deleted after tests have been run.
 162         loaninIdsCreated.add(newId);
 163     }
 164
 165     protected void createPersonRefs(){
 166
 167         PersonAuthorityClient personAuthClient = new PersonAuthorityClient();
 168         // Create a temporary PersonAuthority resource, and its corresponding
 169         // refName by which it can be identified.
 170         PoxPayloadOut multipart = PersonAuthorityClientUtils.createPersonAuthorityInstance(
 171             PERSON_AUTHORITY_NAME, PERSON_AUTHORITY_NAME, personAuthClient.getCommonPartName());
 172         Response res = personAuthClient.create(multipart);
 173         try {
 174                 int statusCode = res.getStatus();
 175
 176                 Assert.assertTrue(testRequestType.isValidStatusCode(statusCode),
 177                     invalidStatusCodeMessage(testRequestType, statusCode));
 178                 Assert.assertEquals(statusCode, STATUS_CREATED);
 179                 personAuthCSID = extractId(res);
 180         } finally {
 181                 res.close();
 182         }
 183
 184         String authRefName = PersonAuthorityClientUtils.getAuthorityRefName(personAuthCSID, null);
 185
 186         // Create temporary Person resources, and their corresponding refNames
 187         // by which they can be identified.
 188         String csid = createPerson("Linus", "Lender", "linusLender", authRefName);
 189         personIdsCreated.add(csid);
 190         lenderRefName = PersonAuthorityClientUtils.getPersonRefName(personAuthCSID, csid, null);
 191
 192         csid = createPerson("Art", "Lendersauthorizor", "artLendersauthorizor", authRefName);
 193         personIdsCreated.add(csid);
 194         lendersAuthorizerRefName = PersonAuthorityClientUtils.getPersonRefName(personAuthCSID, csid, null);
 195
 196         csid = createPerson("Larry", "Lenderscontact", "larryLenderscontact", authRefName);
 197         personIdsCreated.add(csid);
 198         lendersContactRefName = PersonAuthorityClientUtils.getPersonRefName(personAuthCSID, csid, null);
 199
 200         csid = createPerson("Carrie", "Borrowerscontact", "carrieBorrowerscontact", authRefName);
 201         personIdsCreated.add(csid);
 202         borrowersContactRefName = PersonAuthorityClientUtils.getPersonRefName(personAuthCSID, csid, null);
 203
 204         csid = createPerson("Bonnie", "Borrowersauthorizer", "bonnieBorrowersauthorizer", authRefName);
 205         personIdsCreated.add(csid);
 206         borrowersAuthorizerRefName = PersonAuthorityClientUtils.getPersonRefName(personAuthCSID, csid, null);
 207
 208         // FIXME: Add instance(s) of 'lenders' field when we can work with
 209         // repeatable / multivalued authority reference fields.  Be sure to
 210     }
 211
 212     protected String createPerson(String firstName, String surName, String shortId, String authRefName ) {
 213         PersonAuthorityClient personAuthClient = new PersonAuthorityClient();
 214         Map<String, String> personInfo = new HashMap<String,String>();
 215         personInfo.put(PersonJAXBSchema.FORE_NAME, firstName);
 216         personInfo.put(PersonJAXBSchema.SUR_NAME, surName);
 217         personInfo.put(PersonJAXBSchema.SHORT_IDENTIFIER, shortId);
 218         List<PersonTermGroup> personTerms = new ArrayList<PersonTermGroup>();
 219         PersonTermGroup term = new PersonTermGroup();
 220         String termName = firstName + " " + surName;
 221         term.setTermDisplayName(termName);
 222         term.setTermName(termName);
 223         personTerms.add(term);
 224         PoxPayloadOut multipart =
 225                 PersonAuthorityClientUtils.createPersonInstance(personAuthCSID,
 226                                 authRefName, personInfo, personTerms, personAuthClient.getItemCommonPartName());
 227         ClientResponse<Response> res = personAuthClient.createItem(personAuthCSID, multipart);
 228         int statusCode = res.getStatus();
 229
 230         Assert.assertTrue(testRequestType.isValidStatusCode(statusCode),
 231                 invalidStatusCodeMessage(testRequestType, statusCode));
 232         Assert.assertEquals(statusCode, STATUS_CREATED);
 233         return extractId(res);
 234     }
 235
 236     // Success outcomes
 237     @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class,
 238         dependsOnMethods = {"createWithAuthRefs"})
 239     public void readAndCheckAuthRefs(String testName) throws Exception {
 240         // Perform setup.
 241         testSetup(STATUS_OK, ServiceRequestType.READ);
 242
 243         // Submit the request to the service and store the response.
 244         LoaninClient loaninClient = new LoaninClient();
 245         ClientResponse<String> res = loaninClient.read(knownResourceId);
 246         LoansinCommon loaninCommon = null;
 247         try {
 248                 assertStatusCode(res, testName);
 249                 // Extract the common part from the response.
 250                 PoxPayloadIn input = new PoxPayloadIn(res.getEntity());
 251                 loaninCommon = (LoansinCommon) extractPart(input,
 252                     loaninClient.getCommonPartName(), LoansinCommon.class);
 253                 Assert.assertNotNull(loaninCommon);
 254                 if(logger.isDebugEnabled()){
 255                     logger.debug(objectAsXmlString(loaninCommon, LoansinCommon.class));
 256                 }
 257         } finally {
 258                 if (res != null) {
 259                 res.releaseConnection();
 260             }
 261         }
 262         //
 263         // Check a couple of fields
 264         // Assert.assertEquals(loaninCommon.getLender(), lenderRefName);
 265         // Assert.assertEquals(loaninCommon.getLendersAuthorizer(), lendersAuthorizerRefName);
 266         // Assert.assertEquals(loaninCommon.getLendersContact(), lendersContactRefName);
 267         //
 268         Assert.assertEquals(loaninCommon.getBorrowersContact(), borrowersContactRefName);
 269         Assert.assertEquals(loaninCommon.getBorrowersAuthorizer(), borrowersAuthorizerRefName);
 270
 271         // Get the auth refs and check them
 272         ClientResponse<AuthorityRefList> res2 = loaninClient.getAuthorityRefs(knownResourceId);
 273         AuthorityRefList list = null;
 274         try {
 275                 assertStatusCode(res2, testName);
 276                 list = res2.getEntity();
 277                 Assert.assertNotNull(list);
 278         } finally {
 279                 if (res2 != null) {
 280                         res2.releaseConnection();
 281             }
 282         }
 283
 284         List<AuthorityRefList.AuthorityRefItem> items = list.getAuthorityRefItem();
 285         int numAuthRefsFound = items.size();
 286         if(logger.isDebugEnabled()){
 287             logger.debug("Expected " + NUM_AUTH_REFS_EXPECTED +
 288                 " authority references, found " + numAuthRefsFound);
 289         }
 290
 291         // Optionally output additional data about list members for debugging.
 292         boolean iterateThroughList = true;
 293         if(iterateThroughList && logger.isDebugEnabled()){
 294             int i = 0;
 295             for(AuthorityRefList.AuthorityRefItem item : items){
 296                 logger.debug(testName + ": list-item[" + i + "] Field:" +
 297                                 item.getSourceField() + "= " +
 298                         item.getAuthDisplayName() +
 299                         item.getItemDisplayName());
 300                 logger.debug(testName + ": list-item[" + i + "] refName=" +
 301                         item.getRefName());
 302                 logger.debug(testName + ": list-item[" + i + "] URI=" +
 303                         item.getUri());
 304                 i++;
 305             }
 306         }
 307
 308         Assert.assertEquals(numAuthRefsFound, NUM_AUTH_REFS_EXPECTED,
 309             "Did not find all expected authority references! " +
 310             "Expected " + NUM_AUTH_REFS_EXPECTED + ", found " + numAuthRefsFound);
 311
 312     }
 313
 314
 315     // ---------------------------------------------------------------
 316     // Cleanup of resources created during testing
 317     // ---------------------------------------------------------------
 318
 319     /**
 320      * Deletes all resources created by tests, after all tests have been run.
 321      *
 322      * This cleanup method will always be run, even if one or more tests fail.
 323      * For this reason, it attempts to remove all resources created
 324      * at any point during testing, even if some of those resources
 325      * may be expected to be deleted by certain tests.
 326      */
 327     @AfterClass(alwaysRun=true)
 328     public void cleanUp() {
 329         String noTest = System.getProperty("noTestCleanup");
 330         if(Boolean.TRUE.toString().equalsIgnoreCase(noTest)) {
 331             if (logger.isDebugEnabled()) {
 332                 logger.debug("Skipping Cleanup phase ...");
 333             }
 334             return;
 335         }
 336         if (logger.isDebugEnabled()) {
 337             logger.debug("Cleaning up temporary resources created for testing ...");
 338         }
 339         PersonAuthorityClient personAuthClient = new PersonAuthorityClient();
 340         // Delete Person resource(s) (before PersonAuthority resources).
 341
 342         for (String resourceId : personIdsCreated) {
 343             // Note: Any non-success responses are ignored and not reported.
 344                 ClientResponse<Response> response =
 345                         personAuthClient.deleteItem(personAuthCSID, resourceId); // alternative to personAuthClient.deleteItem().releaseConnection();
 346                 response.releaseConnection();
 347         }
 348
 349         // Delete PersonAuthority resource(s).
 350         // Note: Any non-success response is ignored and not reported.
 351         if (personAuthCSID != null) {
 352                 personAuthClient.delete(personAuthCSID);
 353                 // Delete Loans In resource(s).
 354                 LoaninClient loaninClient = new LoaninClient();
 355                 ClientResponse<Response> response = null;
 356                 for (String resourceId : loaninIdsCreated) {
 357                     // Note: Any non-success responses are ignored and not reported.
 358                     response = loaninClient.delete(resourceId); // alternative to loaninClient.delete(resourceId).releaseConnection();
 359                     response.releaseConnection();
 360                 }
 361         }
 362     }
 363
 364     // ---------------------------------------------------------------
 365     // Utility methods used by tests above
 366     // ---------------------------------------------------------------
 367     public String getServiceName() {
 368         return SERVICE_NAME;
 369     }
 370
 371     @Override
 372     public String getServicePathComponent() {
 373         return SERVICE_PATH_COMPONENT;
 374     }
 375
 376     private PoxPayloadOut createLoaninInstance(String loaninNumber,
 377                 String returnDate,
 378                 String lender,
 379                 String lendersAuthorizer,
 380                 String lendersContact,
 381                 String borrowersContact,
 382                 String borrowersAuthorizer) {
 383         LoansinCommon loaninCommon = new LoansinCommon();
 384         loaninCommon.setLoanInNumber(loaninNumber);
 385         loaninCommon.setLoanInNumber(returnDate);
 386         LenderGroupList lenderGroupList =  new LenderGroupList();
 387         LenderGroup lenderGroup = new LenderGroup();
 388         lenderGroup.setLender(lender);
 389         lenderGroup.setLendersAuthorizer(lendersAuthorizer);
 390         lenderGroup.setLendersContact(lendersContact);
 391         lenderGroupList.getLenderGroup().add(lenderGroup);
 392         loaninCommon.setLenderGroupList(lenderGroupList);
 393         loaninCommon.setBorrowersContact(borrowersContact);
 394         loaninCommon.setBorrowersAuthorizer(borrowersAuthorizer);
 395
 396         PoxPayloadOut multipart = new PoxPayloadOut(this.getServicePathComponent());
 397         PayloadOutputPart commonPart =
 398                         multipart.addPart(new LoaninClient().getCommonPartName(), loaninCommon);
 399
 400         if(logger.isDebugEnabled()){
 401                 logger.debug("to be created, loanin common");
 402                 logger.debug(objectAsXmlString(loaninCommon, LoansinCommon.class));
 403         }
 404
 405         return multipart;
 406     }
 407
 408     @Override
 409     protected Class<AbstractCommonList> getCommonListType() {
 410         return AbstractCommonList.class;
 411     }
 412 }