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.authorization.client.test;
  24
  25 //import java.util.ArrayList;
  26 import java.util.List;
  27 import javax.ws.rs.core.Response;
  28 //import org.collectionspace.services.authorization.ActionType;
  29 import org.collectionspace.services.authorization.EffectType;
  30
  31 import org.collectionspace.services.client.CollectionSpaceClient;
  32 import org.collectionspace.services.client.PermissionClient;
  33 import org.collectionspace.services.authorization.Permission;
  34 import org.collectionspace.services.authorization.PermissionAction;
  35 import org.collectionspace.services.authorization.PermissionsList;
  36 import org.collectionspace.services.client.PermissionFactory;
  37 import org.collectionspace.services.client.test.AbstractServiceTestImpl;
  38 import org.collectionspace.services.client.test.ServiceRequestType;
  39 import org.collectionspace.services.jaxb.AbstractCommonList;
  40 import org.jboss.resteasy.client.ClientResponse;
  41
  42 import org.testng.Assert;
  43 import org.testng.annotations.Test;
  44
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 /**
  49  * PermissionServiceTest, carries out tests against a
  50  * deployed and running Permission Service.
  51  *
  52  * $LastChangedRevision: 917 $
  53  * $LastChangedDate: 2009-11-06 12:20:28 -0800 (Fri, 06 Nov 2009) $
  54  */
  55 public class PermissionServiceTest extends AbstractServiceTestImpl {
  56
  57     /** The Constant logger. */
  58     private final static String CLASS_NAME = PermissionServiceTest.class.getName();
  59     private final static Logger logger = LoggerFactory.getLogger(CLASS_NAME);
  60
  61     // Instance variables specific to this test.
  62     /** The known resource id. */
  63     private String knownResourceId = null;
  64     private String knownResource = "accounts-test";
  65     /** The add tenant. */
  66     boolean addTenant = true;
  67     /*
  68      * This method is called only by the parent class, AbstractServiceTestImpl
  69      */
  70
  71     /* (non-Javadoc)
  72      * @see org.collectionspace.services.client.test.BaseServiceTest#getServicePathComponent()
  73      */
  74     @Override
  75     protected String getServicePathComponent() {
  76         return new PermissionClient().getServicePathComponent();
  77     }
  78
  79     /* (non-Javadoc)
  80      * @see org.collectionspace.services.client.test.BaseServiceTest#getClientInstance()
  81      */
  82     @Override
  83     protected CollectionSpaceClient getClientInstance() {
  84         return new PermissionClient();
  85     }
  86
  87     /* (non-Javadoc)
  88      * @see org.collectionspace.services.client.test.BaseServiceTest#getAbstractCommonList(org.jboss.resteasy.client.ClientResponse)
  89      */
  90     @Override
  91     protected AbstractCommonList getAbstractCommonList(
  92             ClientResponse<AbstractCommonList> response) {
  93         //FIXME: http://issues.collectionspace.org/browse/CSPACE-1697
  94         throw new UnsupportedOperationException();
  95     }
  96
  97     /* (non-Javadoc)
  98      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#readPaginatedList(java.lang.String)
  99      */
 100     @Test(dataProvider = "testName")
 101     @Override
 102     public void readPaginatedList(String testName) throws Exception {
 103         //FIXME: http://issues.collectionspace.org/browse/CSPACE-1697
 104     }
 105
 106     // ---------------------------------------------------------------
 107     // CRUD tests : CREATE tests
 108     // ---------------------------------------------------------------
 109     // Success outcomes
 110     /* (non-Javadoc)
 111      * @see org.collectionspace.services.client.test.ServiceTest#create(java.lang.String)
 112      */
 113     @Override
 114     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class)
 115     public void create(String testName) throws Exception {
 116
 117         if (logger.isDebugEnabled()) {
 118             logger.debug(testBanner(testName, CLASS_NAME));
 119         }
 120         // Perform setup, such as initializing the type of service request
 121         // (e.g. CREATE, DELETE), its valid and expected status codes, and
 122         // its associated HTTP method name (e.g. POST, DELETE).
 123         setupCreate();
 124
 125         // Submit the request to the service and store the response.
 126         List<PermissionAction> actions = PermissionFactory.createDefaultActions();
 127         Permission permission = createPermissionInstance(knownResource,
 128                 "default permissions for account",
 129                 actions,
 130                 EffectType.PERMIT,
 131                 true,
 132                 true,
 133                 true);
 134         PermissionClient client = new PermissionClient();
 135         ClientResponse<Response> res = client.create(permission);
 136         int statusCode = res.getStatus();
 137
 138         // Check the status code of the response: does it match
 139         // the expected response(s)?
 140         //
 141         // Specifically:
 142         // Does it fall within the set of valid status codes?
 143         // Does it exactly match the expected status code?
 144         if (logger.isDebugEnabled()) {
 145             logger.debug(testName + ": status = " + statusCode);
 146         }
 147         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 148                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 149         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 150
 151         // Store the ID returned from this create operation
 152         // for additional tests below.
 153         knownResourceId = extractId(res);
 154         if (logger.isDebugEnabled()) {
 155             logger.debug(testName + ": knownResourceId=" + knownResourceId);
 156         }
 157     }
 158
 159     /**
 160      * Creates the without resource name.
 161      *
 162      * @param testName the test name
 163      * @throws Exception the exception
 164      */
 165     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 166     dependsOnMethods = {"create"})
 167     public void createWithoutResourceName(String testName) throws Exception {
 168
 169         if (logger.isDebugEnabled()) {
 170             logger.debug(testBanner(testName, CLASS_NAME));
 171         }
 172         setupCreate();
 173
 174         // Submit the request to the service and store the response.
 175         List<PermissionAction> actions = PermissionFactory.createDefaultActions();
 176         Permission permission = createPermissionInstance(null,
 177                 "default permissions for account",
 178                 actions,
 179                 EffectType.PERMIT,
 180                 false,
 181                 true,
 182                 true);
 183         PermissionClient client = new PermissionClient();
 184         ClientResponse<Response> res = client.create(permission);
 185         int statusCode = res.getStatus();
 186         // Does it exactly match the expected status code?
 187         if (logger.isDebugEnabled()) {
 188             logger.debug(testName + ": status = " + statusCode);
 189         }
 190         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 191                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 192         Assert.assertEquals(statusCode, Response.Status.BAD_REQUEST.getStatusCode());
 193     }
 194
 195     //to not cause uniqueness violation for permission, createList is removed
 196     /* (non-Javadoc)
 197      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#createList(java.lang.String)
 198      */
 199     @Override
 200     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 201     dependsOnMethods = {"create"})
 202     public void createList(String testName) throws Exception {
 203
 204         if (logger.isDebugEnabled()) {
 205             logger.debug(testBanner(testName, CLASS_NAME));
 206         }
 207         setupCreate();
 208         // Submit the request to the service and store the response.
 209         List<PermissionAction> actions = PermissionFactory.createDefaultActions();
 210         Permission permission1 = createPermissionInstance("test-objects",
 211                 "default permissions for test-objects",
 212                 actions,
 213                 EffectType.PERMIT,
 214                 true,
 215                 true,
 216                 true);
 217         PermissionClient client = new PermissionClient();
 218         ClientResponse<Response> res = client.create(permission1);
 219         int statusCode = res.getStatus();
 220         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 221                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 222         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 223         allResourceIdsCreated.add(extractId(res));
 224
 225         Permission permission2 = createPermissionInstance("test-acquisitions",
 226                 "default permissions for test-acquisitions",
 227                 actions,
 228                 EffectType.PERMIT,
 229                 true,
 230                 true,
 231                 true);
 232         res = client.create(permission2);
 233         statusCode = res.getStatus();
 234         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 235                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 236         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 237         allResourceIdsCreated.add(extractId(res));
 238
 239         Permission permission3 = createPermissionInstance("test-ids",
 240                 "default permissions for id service",
 241                 actions,
 242                 EffectType.PERMIT,
 243                 true,
 244                 true,
 245                 true);
 246         res = client.create(permission3);
 247         statusCode = res.getStatus();
 248         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 249                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 250         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 251         allResourceIdsCreated.add(extractId(res));
 252     }
 253
 254     // Failure outcomes
 255     // Placeholders until the three tests below can be uncommented.
 256     // See Issue CSPACE-401.
 257     /* (non-Javadoc)
 258      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#createWithEmptyEntityBody(java.lang.String)
 259      */
 260     @Override
 261     public void createWithEmptyEntityBody(String testName) throws Exception {
 262         //FIXME: Should this test really be empty?  If so, please comment accordingly.
 263     }
 264
 265     /* (non-Javadoc)
 266      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#createWithMalformedXml(java.lang.String)
 267      */
 268     @Override
 269     public void createWithMalformedXml(String testName) throws Exception {
 270         //FIXME: Should this test really be empty?  If so, please comment accordingly.
 271     }
 272
 273     /* (non-Javadoc)
 274      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#createWithWrongXmlSchema(java.lang.String)
 275      */
 276     @Override
 277     public void createWithWrongXmlSchema(String testName) throws Exception {
 278         //FIXME: Should this test really be empty?  If so, please comment accordingly.
 279     }
 280
 281     // ---------------------------------------------------------------
 282     // CRUD tests : READ tests
 283     // ---------------------------------------------------------------
 284     // Success outcomes
 285     /* (non-Javadoc)
 286      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#read(java.lang.String)
 287      */
 288     @Override
 289     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 290     dependsOnMethods = {"create"})
 291     public void read(String testName) throws Exception {
 292
 293         if (logger.isDebugEnabled()) {
 294             logger.debug(testBanner(testName, CLASS_NAME));
 295         }
 296         // Perform setup.
 297         setupRead();
 298
 299         // Submit the request to the service and store the response.
 300         PermissionClient client = new PermissionClient();
 301         ClientResponse<Permission> res = client.read(knownResourceId);
 302         int statusCode = res.getStatus();
 303
 304         // Check the status code of the response: does it match
 305         // the expected response(s)?
 306         if (logger.isDebugEnabled()) {
 307             logger.debug(testName + ": status = " + statusCode);
 308         }
 309         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 310                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 311         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 312
 313         Permission output = (Permission) res.getEntity();
 314         Assert.assertNotNull(output);
 315     }
 316
 317     // Failure outcomes
 318     /* (non-Javadoc)
 319      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#readNonExistent(java.lang.String)
 320      */
 321     @Override
 322     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 323     dependsOnMethods = {"read"})
 324     public void readNonExistent(String testName) throws Exception {
 325
 326         if (logger.isDebugEnabled()) {
 327             logger.debug(testBanner(testName, CLASS_NAME));
 328         }
 329         // Perform setup.
 330         setupReadNonExistent();
 331
 332         // Submit the request to the service and store the response.
 333         PermissionClient client = new PermissionClient();
 334         ClientResponse<Permission> res = client.read(NON_EXISTENT_ID);
 335         int statusCode = res.getStatus();
 336
 337         // Check the status code of the response: does it match
 338         // the expected response(s)?
 339         if (logger.isDebugEnabled()) {
 340             logger.debug(testName + ": status = " + statusCode);
 341         }
 342         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 343                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 344         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 345     }
 346
 347     // ---------------------------------------------------------------
 348     // CRUD tests : READ_LIST tests
 349     // ---------------------------------------------------------------
 350     // Success outcomes
 351     /* (non-Javadoc)
 352      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#readList(java.lang.String)
 353      */
 354     @Override
 355     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 356     dependsOnMethods = {"createList", "read"})
 357     public void readList(String testName) throws Exception {
 358
 359         if (logger.isDebugEnabled()) {
 360             logger.debug(testBanner(testName, CLASS_NAME));
 361         }
 362         // Perform setup.
 363         setupReadList();
 364
 365         // Submit the request to the service and store the response.
 366         PermissionClient client = new PermissionClient();
 367         ClientResponse<PermissionsList> res = client.readList();
 368         PermissionsList list = res.getEntity();
 369         int statusCode = res.getStatus();
 370
 371         // Check the status code of the response: does it match
 372         // the expected response(s)?
 373         if (logger.isDebugEnabled()) {
 374             logger.debug(testName + ": status = " + statusCode);
 375         }
 376         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 377                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 378         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 379
 380         // Optionally output additional data about list members for debugging.
 381         boolean iterateThroughList = true;
 382         if (iterateThroughList && logger.isDebugEnabled()) {
 383             printList(testName, list);
 384         }
 385     }
 386
 387     /**
 388      * Search resource name.
 389      *
 390      * @param testName the test name
 391      * @throws Exception the exception
 392      */
 393     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 394     dependsOnMethods = {"createList", "read"})
 395     public void searchResourceName(String testName) throws Exception {
 396
 397         if (logger.isDebugEnabled()) {
 398             logger.debug(testBanner(testName, CLASS_NAME));
 399         }
 400         // Perform setup.
 401         setupReadList();
 402
 403         // Submit the request to the service and store the response.
 404         PermissionClient client = new PermissionClient();
 405         ClientResponse<PermissionsList> res = client.readSearchList("acquisition");
 406         PermissionsList list = res.getEntity();
 407         int statusCode = res.getStatus();
 408         // Check the status code of the response: does it match
 409         // the expected response(s)?
 410         if (logger.isDebugEnabled()) {
 411             logger.debug(testName + ": status = " + statusCode);
 412         }
 413         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 414                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 415         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 416         int EXPECTED_ITEMS = 1;
 417         if (logger.isDebugEnabled()) {
 418             logger.debug(testName + ": received = " + list.getPermissions().size()
 419                     + " expected=" + EXPECTED_ITEMS);
 420         }
 421         Assert.assertEquals(EXPECTED_ITEMS, list.getPermissions().size());
 422         // Optionally output additional data about list members for debugging.
 423         boolean iterateThroughList = true;
 424         if (iterateThroughList && logger.isDebugEnabled()) {
 425             printList(testName, list);
 426         }
 427     }
 428
 429     // Failure outcomes
 430     // None at present.
 431     // ---------------------------------------------------------------
 432     // CRUD tests : UPDATE tests
 433     // ---------------------------------------------------------------
 434     // Success outcomes
 435     /* (non-Javadoc)
 436      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#update(java.lang.String)
 437      */
 438     @Override
 439     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 440     dependsOnMethods = {"read", "readList", "readNonExistent"})
 441     public void update(String testName) throws Exception {
 442
 443         if (logger.isDebugEnabled()) {
 444             logger.debug(testBanner(testName, CLASS_NAME));
 445         }
 446         // Perform setup.
 447         setupUpdate();
 448
 449         Permission permToUpdate = new Permission();
 450         permToUpdate.setCsid(knownResourceId);
 451         permToUpdate.setResourceName(knownResource);
 452         // Update the content of this resource.
 453         permToUpdate.setDescription("updated description");
 454         if (logger.isDebugEnabled()) {
 455             logger.debug("updated object");
 456             logger.debug(objectAsXmlString(permToUpdate,
 457                     Permission.class));
 458         }
 459         PermissionClient client = new PermissionClient();
 460         // Submit the request to the service and store the response.
 461         ClientResponse<Permission> res = client.update(knownResourceId, permToUpdate);
 462         int statusCode = res.getStatus();
 463         // Check the status code of the response: does it match the expected response(s)?
 464         if (logger.isDebugEnabled()) {
 465             logger.debug(testName + ": status = " + statusCode);
 466         }
 467         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 468                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 469         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 470
 471
 472         Permission permUpdated = (Permission) res.getEntity();
 473         Assert.assertNotNull(permUpdated);
 474
 475         Assert.assertEquals(permUpdated.getDescription(),
 476                 permToUpdate.getDescription(),
 477                 "Data in updated object did not match submitted data.");
 478     }
 479
 480     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 481     dependsOnMethods = {"read", "readList", "readNonExistent"})
 482     public void updateNotAllowed(String testName) throws Exception {
 483
 484         // Perform setup.
 485         setupUpdate();
 486
 487         Permission permToUpdate = new Permission();
 488         permToUpdate.setCsid(knownResourceId);
 489         // Update the content of this resource.
 490         permToUpdate.setResourceName("updated-resource");
 491         if (logger.isDebugEnabled()) {
 492             logger.debug("updated object");
 493             logger.debug(objectAsXmlString(permToUpdate,
 494                     Permission.class));
 495         }
 496         PermissionClient client = new PermissionClient();
 497         // Submit the request to the service and store the response.
 498         ClientResponse<Permission> res = client.update(knownResourceId, permToUpdate);
 499         int statusCode = res.getStatus();
 500         // Check the status code of the response: does it match the expected response(s)?
 501         if (logger.isDebugEnabled()) {
 502             logger.debug(testName + ": status = " + statusCode);
 503         }
 504         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 505                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 506         Assert.assertEquals(statusCode, Response.Status.BAD_REQUEST.getStatusCode());
 507
 508     }
 509
 510     /**
 511      * Update actions.
 512      *
 513      * @param testName the test name
 514      * @throws Exception the exception
 515      */
 516     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 517     dependsOnMethods = {"updateNotAllowed"})
 518     public void updateActions(String testName) throws Exception {
 519
 520         if (logger.isDebugEnabled()) {
 521             logger.debug(testBanner(testName, CLASS_NAME));
 522         }
 523         // Perform setup.
 524         setupUpdate();
 525
 526         Permission permToUpdate = new Permission();
 527         permToUpdate.setCsid(knownResourceId);
 528         permToUpdate.setResourceName(knownResource);
 529         // Update the content of this resource.
 530         List<PermissionAction> actions = PermissionFactory.createDefaultActions();
 531         int default_actions = actions.size();
 532         actions.remove(0);
 533         actions.remove(0);
 534         int toUpdate_actions = actions.size();
 535         if (logger.isDebugEnabled()) {
 536             logger.debug(testName + " no. of actions default=" + default_actions
 537                     + " to update =" + toUpdate_actions);
 538         }
 539         permToUpdate.setActions(actions);
 540         if (logger.isDebugEnabled()) {
 541             logger.debug(testName + " updated object\n"
 542                     + objectAsXmlString(permToUpdate, Permission.class));
 543         }
 544         PermissionClient client = new PermissionClient();
 545         // Submit the request to the service and store the response.
 546         ClientResponse<Permission> res = client.update(knownResourceId, permToUpdate);
 547         int statusCode = res.getStatus();
 548         // Check the status code of the response: does it match the expected response(s)?
 549         if (logger.isDebugEnabled()) {
 550             logger.debug(testName + ": status = " + statusCode);
 551         }
 552         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 553                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 554         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 555
 556         Permission permUpdated = (Permission) res.getEntity();
 557         Assert.assertNotNull(permUpdated);
 558         int updated_actions = permToUpdate.getActions().size();
 559         if (logger.isDebugEnabled()) {
 560             logger.debug(testName + " no. of actions to update=" + toUpdate_actions
 561                     + " updated =" + updated_actions);
 562         }
 563         Assert.assertEquals(toUpdate_actions,
 564                 updated_actions,
 565                 "Data in updated object did not match submitted data.");
 566     }
 567     // Failure outcomes
 568     // Placeholders until the three tests below can be uncommented.
 569     // See Issue CSPACE-401.
 570
 571     /* (non-Javadoc)
 572      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#updateWithEmptyEntityBody(java.lang.String)
 573      */
 574     @Override
 575     public void updateWithEmptyEntityBody(String testName) throws Exception {
 576         //FIXME: Should this test really be empty?  If so, please comment accordingly.
 577     }
 578
 579     /* (non-Javadoc)
 580      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#updateWithMalformedXml(java.lang.String)
 581      */
 582     @Override
 583     public void updateWithMalformedXml(String testName) throws Exception {
 584         //FIXME: Should this test really be empty?  If so, please comment accordingly.
 585     }
 586
 587     /* (non-Javadoc)
 588      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#updateWithWrongXmlSchema(java.lang.String)
 589      */
 590     @Override
 591     public void updateWithWrongXmlSchema(String testName) throws Exception {
 592         //FIXME: Should this test really be empty?  If so, please comment accordingly.
 593     }
 594
 595     /* (non-Javadoc)
 596      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#updateNonExistent(java.lang.String)
 597      */
 598     @Override
 599     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 600     dependsOnMethods = {"readNonExistent", "testSubmitRequest"})
 601     public void updateNonExistent(String testName) throws Exception {
 602
 603         if (logger.isDebugEnabled()) {
 604             logger.debug(testBanner(testName, CLASS_NAME));
 605         }
 606         // Perform setup.
 607         setupUpdateNonExistent();
 608
 609         // Submit the request to the service and store the response.
 610         //
 611         // Note: The ID used in this 'create' call may be arbitrary.
 612         // The only relevant ID may be the one used in updatePermission(), below.
 613         PermissionClient client = new PermissionClient();
 614         List<PermissionAction> actions = PermissionFactory.createDefaultActions();
 615         Permission permission = createPermissionInstance("test-acquisitions",
 616                 "default permissions for test-acquisitions",
 617                 actions,
 618                 EffectType.PERMIT,
 619                 true,
 620                 true,
 621                 true);
 622         ClientResponse<Permission> res =
 623                 client.update(NON_EXISTENT_ID, permission);
 624         int statusCode = res.getStatus();
 625
 626         // Check the status code of the response: does it match
 627         // the expected response(s)?
 628         if (logger.isDebugEnabled()) {
 629             logger.debug(testName + ": status = " + statusCode);
 630         }
 631         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 632                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 633         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 634     }
 635
 636     // ---------------------------------------------------------------
 637     // CRUD tests : DELETE tests
 638     // ---------------------------------------------------------------
 639     // Success outcomes
 640     /* (non-Javadoc)
 641      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#delete(java.lang.String)
 642      */
 643     @Override
 644     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 645     dependsOnMethods = {"updateActions", "testSubmitRequest"})
 646     public void delete(String testName) throws Exception {
 647
 648         if (logger.isDebugEnabled()) {
 649             logger.debug(testBanner(testName, CLASS_NAME));
 650         }
 651         // Perform setup.
 652         setupDelete();
 653
 654         // Submit the request to the service and store the response.
 655         PermissionClient client = new PermissionClient();
 656         ClientResponse<Response> res = client.delete(knownResourceId);
 657         int statusCode = res.getStatus();
 658
 659         // Check the status code of the response: does it match
 660         // the expected response(s)?
 661         if (logger.isDebugEnabled()) {
 662             logger.debug(testName + ": status = " + statusCode);
 663         }
 664         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 665                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 666         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 667     }
 668
 669     // Failure outcomes
 670     /* (non-Javadoc)
 671      * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#deleteNonExistent(java.lang.String)
 672      */
 673     @Override
 674     @Test(dataProvider = "testName", dataProviderClass = AbstractServiceTestImpl.class,
 675     dependsOnMethods = {"delete"})
 676     public void deleteNonExistent(String testName) throws Exception {
 677
 678         if (logger.isDebugEnabled()) {
 679             logger.debug(testBanner(testName, CLASS_NAME));
 680         }
 681         // Perform setup.
 682         setupDeleteNonExistent();
 683
 684         // Submit the request to the service and store the response.
 685         PermissionClient client = new PermissionClient();
 686         ClientResponse<Response> res = client.delete(NON_EXISTENT_ID);
 687         int statusCode = res.getStatus();
 688
 689         // Check the status code of the response: does it match
 690         // the expected response(s)?
 691         if (logger.isDebugEnabled()) {
 692             logger.debug(testName + ": status = " + statusCode);
 693         }
 694         Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
 695                 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
 696         Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
 697     }
 698
 699     // ---------------------------------------------------------------
 700     // Utility tests : tests of code used in tests above
 701     // ---------------------------------------------------------------
 702     /**
 703      * Tests the code for manually submitting data that is used by several
 704      * of the methods above.
 705      * @throws Exception
 706      */
 707     @Test(dependsOnMethods = {"create"})
 708     public void testSubmitRequest() throws Exception {
 709
 710         // Expected status code: 200 OK
 711         final int EXPECTED_STATUS = Response.Status.OK.getStatusCode();
 712
 713         // Submit the request to the service and store the response.
 714         String method = ServiceRequestType.READ.httpMethodName();
 715         String url = getResourceURL(knownResourceId);
 716         int statusCode = submitRequest(method, url);
 717
 718         // Check the status code of the response: does it match
 719         // the expected response(s)?
 720         if (logger.isDebugEnabled()) {
 721             logger.debug("testSubmitRequest: url=" + url
 722                     + " status=" + statusCode);
 723         }
 724         Assert.assertEquals(statusCode, EXPECTED_STATUS);
 725
 726     }
 727
 728     // ---------------------------------------------------------------
 729     // Utility methods used by tests above
 730     // ---------------------------------------------------------------
 731     /**
 732      * create permission instance
 733      * @param resourceName
 734      * @param description
 735      * @param actionList list of actions for this permission
 736      * @param effect effect of the permission
 737      * @param useResourceName
 738      * @param useAction
 739      * @param useEffect
 740      * @return permission
 741      */
 742     public static Permission createPermissionInstance(String resourceName,
 743             String description,
 744             List<PermissionAction> actionList,
 745             EffectType effect,
 746             boolean useResourceName,
 747             boolean useAction,
 748             boolean useEffect) {
 749
 750         Permission permission = PermissionFactory.createPermissionInstance(resourceName,
 751                 description, actionList, effect,
 752                 useResourceName, useAction, useEffect);
 753
 754         if (logger.isDebugEnabled()) {
 755             logger.debug("to be created, permission");
 756             logger.debug(objectAsXmlString(permission, Permission.class));
 757         }
 758         return permission;
 759     }
 760
 761     /**
 762      * Prints the list.
 763      *
 764      * @param testName the test name
 765      * @param list the list
 766      * @return the int
 767      */
 768     private int printList(String testName, PermissionsList list) {
 769
 770         int i = 0;
 771
 772         for (Permission permission : list.getPermissions()) {
 773             logger.debug(testName + " permission csid=" + permission.getCsid()
 774                     + " name=" + permission.getResourceName()
 775                     + " desc=" + permission.getDescription());
 776             i++;
 777         }
 778         return i;
 779     }
 780 }