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:
6 * http://www.collectionspace.org
7 * http://wiki.collectionspace.org
9 * Copyright © 2009 Regents of the University of California
11 * Licensed under the Educational Community License (ECL), Version 2.0.
12 * You may not use this file except in compliance with this License.
14 * You may obtain a copy of the ECL 2.0 License at
15 * https://source.collectionspace.org/collection-space/LICENSE.txt
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.
23 package org.collectionspace.services.client.test;
25 import java.util.ArrayList;
26 import java.util.List;
27 import javax.ws.rs.core.MediaType;
28 import javax.ws.rs.core.Response;
30 import org.collectionspace.services.client.ContactClient;
31 import org.collectionspace.services.client.ContactClientUtils;
32 import org.collectionspace.services.contact.ContactsCommon;
33 import org.collectionspace.services.contact.ContactsCommonList;
35 import org.jboss.resteasy.client.ClientResponse;
37 import org.jboss.resteasy.plugins.providers.multipart.MultipartInput;
38 import org.jboss.resteasy.plugins.providers.multipart.MultipartOutput;
39 import org.jboss.resteasy.plugins.providers.multipart.OutputPart;
40 import org.testng.Assert;
41 import org.testng.annotations.AfterClass;
42 import org.testng.annotations.Test;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
48 * ContactServiceTest, carries out tests against a
49 * deployed and running Contact Service.
51 * $LastChangedRevision: 917 $
52 * $LastChangedDate: 2009-11-06 12:20:28 -0800 (Fri, 06 Nov 2009) $
54 public class ContactServiceTest extends AbstractServiceTestImpl {
56 private final Logger logger =
57 LoggerFactory.getLogger(ContactServiceTest.class);
59 // Instance variables specific to this test.
60 private ContactClient client = new ContactClient();
61 final String SERVICE_PATH_COMPONENT = "contacts";
62 private String knownResourceId = null;
63 private List<String> allResourceIdsCreated = new ArrayList();
65 // ---------------------------------------------------------------
66 // CRUD tests : CREATE tests
67 // ---------------------------------------------------------------
70 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class)
71 public void create(String testName) throws Exception {
73 // Perform setup, such as initializing the type of service request
74 // (e.g. CREATE, DELETE), its valid and expected status codes, and
75 // its associated HTTP method name (e.g. POST, DELETE).
76 setupCreate(testName);
78 // Submit the request to the service and store the response.
79 String identifier = createIdentifier();
81 MultipartOutput multipart = ContactClientUtils.createContactInstance(identifier);
82 ClientResponse<Response> res = client.create(multipart);
84 int statusCode = res.getStatus();
86 // Check the status code of the response: does it match
87 // the expected response(s)?
90 // Does it fall within the set of valid status codes?
91 // Does it exactly match the expected status code?
92 if(logger.isDebugEnabled()){
93 logger.debug(testName + ": status = " + statusCode);
95 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
96 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
97 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
99 // Store the ID returned from the first resource created
100 // for additional tests below.
101 if (knownResourceId == null){
102 knownResourceId = extractId(res);
103 if (logger.isDebugEnabled()) {
104 logger.debug(testName + ": knownResourceId=" + knownResourceId);
108 // Store the IDs from every resource created by tests,
109 // so they can be deleted after tests have been run.
110 allResourceIdsCreated.add(extractId(res));
114 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class,
115 dependsOnMethods = {"create"})
116 public void createList(String testName) throws Exception {
117 for(int i = 0; i < 3; i++){
123 // Placeholders until the three tests below can be uncommented.
124 // See Issue CSPACE-401.
126 public void createWithEmptyEntityBody(String testName) throws Exception {
130 public void createWithMalformedXml(String testName) throws Exception {
134 public void createWithWrongXmlSchema(String testName) throws Exception {
139 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTest.class,
140 dependsOnMethods = {"create", "testSubmitRequest"})
141 public void createWithEmptyEntityBody(String testName) throws Exception {
144 setupCreateWithEmptyEntityBody(testName);
146 // Submit the request to the service and store the response.
147 String method = REQUEST_TYPE.httpMethodName();
148 String url = getServiceRootURL();
149 String mediaType = MediaType.APPLICATION_XML;
150 final String entity = "";
151 int statusCode = submitRequest(method, url, mediaType, entity);
153 // Check the status code of the response: does it match
154 // the expected response(s)?
155 if(logger.isDebugEnabled()){
156 logger.debug("createWithEmptyEntityBody url=" + url +
157 " status=" + statusCode);
159 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
160 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
161 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
165 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTest.class,
166 dependsOnMethods = {"create", "testSubmitRequest"})
167 public void createWithMalformedXml(String testName) throws Exception {
170 setupCreateWithMalformedXml(testName);
172 // Submit the request to the service and store the response.
173 String method = REQUEST_TYPE.httpMethodName();
174 String url = getServiceRootURL();
175 String mediaType = MediaType.APPLICATION_XML;
176 final String entity = MALFORMED_XML_DATA; // Constant from base class.
177 int statusCode = submitRequest(method, url, mediaType, entity);
179 // Check the status code of the response: does it match
180 // the expected response(s)?
181 if(logger.isDebugEnabled()){
182 logger.debug(testName + ": url=" + url +
183 " status=" + statusCode);
185 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
186 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
187 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
191 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTest.class,
192 dependsOnMethods = {"create", "testSubmitRequest"})
193 public void createWithWrongXmlSchema(String testName) throws Exception {
196 setupCreateWithWrongXmlSchema(testName);
198 // Submit the request to the service and store the response.
199 String method = REQUEST_TYPE.httpMethodName();
200 String url = getServiceRootURL();
201 String mediaType = MediaType.APPLICATION_XML;
202 final String entity = WRONG_XML_SCHEMA_DATA;
203 int statusCode = submitRequest(method, url, mediaType, entity);
205 // Check the status code of the response: does it match
206 // the expected response(s)?
207 if(logger.isDebugEnabled()){
208 logger.debug(testName + ": url=" + url +
209 " status=" + statusCode);
211 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
212 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
213 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
217 // ---------------------------------------------------------------
218 // CRUD tests : READ tests
219 // ---------------------------------------------------------------
222 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class,
223 dependsOnMethods = {"create"})
224 public void read(String testName) throws Exception {
229 // Submit the request to the service and store the response.
230 ClientResponse<MultipartInput> res = client.read(knownResourceId);
231 int statusCode = res.getStatus();
233 // Check the status code of the response: does it match
234 // the expected response(s)?
235 if(logger.isDebugEnabled()){
236 logger.debug(testName + ": status = " + statusCode);
238 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
239 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
240 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
242 MultipartInput input = (MultipartInput) res.getEntity();
243 ContactsCommon contact = (ContactsCommon) extractPart(input,
244 client.getCommonPartName(), ContactsCommon.class);
245 Assert.assertNotNull(contact);
250 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class,
251 dependsOnMethods = {"read"})
252 public void readNonExistent(String testName) throws Exception {
255 setupReadNonExistent(testName);
257 // Submit the request to the service and store the response.
258 ClientResponse<MultipartInput> res = client.read(NON_EXISTENT_ID);
259 int statusCode = res.getStatus();
261 // Check the status code of the response: does it match
262 // the expected response(s)?
263 if(logger.isDebugEnabled()){
264 logger.debug(testName + ": status = " + statusCode);
266 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
267 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
268 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
271 // ---------------------------------------------------------------
272 // CRUD tests : READ_LIST tests
273 // ---------------------------------------------------------------
276 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class,
277 dependsOnMethods = {"read"})
278 public void readList(String testName) throws Exception {
281 setupReadList(testName);
283 // Submit the request to the service and store the response.
284 ClientResponse<ContactsCommonList> res = client.readList();
285 ContactsCommonList list = res.getEntity();
286 int statusCode = res.getStatus();
288 // Check the status code of the response: does it match
289 // the expected response(s)?
290 if(logger.isDebugEnabled()){
291 logger.debug(testName + ": status = " + statusCode);
293 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
294 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
295 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
297 // Optionally output additional data about list members for debugging.
298 boolean iterateThroughList = false;
299 if(iterateThroughList && logger.isDebugEnabled()){
300 List<ContactsCommonList.ContactListItem> items =
301 list.getContactListItem();
303 for(ContactsCommonList.ContactListItem item : items){
304 logger.debug(testName + ": list-item[" + i + "] csid=" +
306 logger.debug(testName + ": list-item[" + i + "] objectNumber=" +
307 item.getAddressText1());
308 logger.debug(testName + ": list-item[" + i + "] URI=" +
318 // ---------------------------------------------------------------
319 // CRUD tests : UPDATE tests
320 // ---------------------------------------------------------------
323 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class,
324 dependsOnMethods = {"read"})
325 public void update(String testName) throws Exception {
328 setupUpdate(testName);
330 ClientResponse<MultipartInput> res =
331 client.read(knownResourceId);
332 if(logger.isDebugEnabled()){
333 logger.debug(testName + ": read status = " + res.getStatus());
335 Assert.assertEquals(res.getStatus(), EXPECTED_STATUS_CODE);
337 if(logger.isDebugEnabled()){
338 logger.debug("got object to update with ID: " + knownResourceId);
340 MultipartInput input = (MultipartInput) res.getEntity();
341 ContactsCommon contact = (ContactsCommon) extractPart(input,
342 client.getCommonPartName(), ContactsCommon.class);
343 Assert.assertNotNull(contact);
345 // Update the content of this resource.
346 contact.setAddressText1("updated-" + contact.getAddressText1());
347 contact.setPostcode1("updated-" + contact.getPostcode1());
348 if(logger.isDebugEnabled()){
349 logger.debug("to be updated object");
350 logger.debug(objectAsXmlString(contact, ContactsCommon.class));
352 // Submit the request to the service and store the response.
353 MultipartOutput output = new MultipartOutput();
354 OutputPart commonPart = output.addPart(contact, MediaType.APPLICATION_XML_TYPE);
355 commonPart.getHeaders().add("label", client.getCommonPartName());
357 res = client.update(knownResourceId, output);
358 int statusCode = res.getStatus();
359 // Check the status code of the response: does it match the expected response(s)?
360 if(logger.isDebugEnabled()){
361 logger.debug(testName + ": status = " + statusCode);
363 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
364 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
365 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
368 input = (MultipartInput) res.getEntity();
369 ContactsCommon updatedContact =
370 (ContactsCommon) extractPart(input,
371 client.getCommonPartName(), ContactsCommon.class);
372 Assert.assertNotNull(updatedContact);
374 Assert.assertEquals(updatedContact.getPostcode1(),
375 contact.getPostcode1(),
376 "Data in updated object did not match submitted data.");
381 // Placeholders until the three tests below can be uncommented.
382 // See Issue CSPACE-401.
384 public void updateWithEmptyEntityBody(String testName) throws Exception{
387 public void updateWithMalformedXml(String testName) throws Exception {
390 public void updateWithWrongXmlSchema(String testName) throws Exception {
395 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTest.class,
396 dependsOnMethods = {"create", "update", "testSubmitRequest"})
397 public void updateWithEmptyEntityBody(String testName) throws Exception {
400 setupUpdateWithEmptyEntityBody(testName);
402 // Submit the request to the service and store the response.
403 String method = REQUEST_TYPE.httpMethodName();
404 String url = getResourceURL(knownResourceId);
405 String mediaType = MediaType.APPLICATION_XML;
406 final String entity = "";
407 int statusCode = submitRequest(method, url, mediaType, entity);
409 // Check the status code of the response: does it match
410 // the expected response(s)?
411 if(logger.isDebugEnabled()){
412 logger.debug(testName + ": url=" + url +
413 " status=" + statusCode);
415 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
416 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
417 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
421 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTest.class,
422 dependsOnMethods = {"create", "update", "testSubmitRequest"})
423 public void updateWithMalformedXml(String testName) throws Exception {
426 setupUpdateWithMalformedXml(testName);
428 // Submit the request to the service and store the response.
429 String method = REQUEST_TYPE.httpMethodName();
430 String url = getResourceURL(knownResourceId);
431 String mediaType = MediaType.APPLICATION_XML;
432 final String entity = MALFORMED_XML_DATA;
433 int statusCode = submitRequest(method, url, mediaType, entity);
435 // Check the status code of the response: does it match
436 // the expected response(s)?
437 if(logger.isDebugEnabled()){
438 logger.debug(testName + ": url=" + url +
439 " status=" + statusCode);
441 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
442 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
443 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
447 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTest.class,
448 dependsOnMethods = {"create", "update", "testSubmitRequest"})
449 public void updateWithWrongXmlSchema(String testName) throws Exception {
452 setupUpdateWithWrongXmlSchema(testName);
454 // Submit the request to the service and store the response.
455 String method = REQUEST_TYPE.httpMethodName();
456 String url = getResourceURL(knownResourceId);
457 String mediaType = MediaType.APPLICATION_XML;
458 final String entity = WRONG_XML_SCHEMA_DATA;
459 int statusCode = submitRequest(method, url, mediaType, entity);
461 // Check the status code of the response: does it match
462 // the expected response(s)?
463 if(logger.isDebugEnabled()){
464 logger.debug(testName + ": url=" + url +
465 " status=" + statusCode);
467 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
468 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
469 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
474 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class,
475 dependsOnMethods = {"update", "testSubmitRequest"})
476 public void updateNonExistent(String testName) throws Exception {
479 setupUpdateNonExistent(testName);
481 // Submit the request to the service and store the response.
482 // Note: The ID used in this 'create' call may be arbitrary.
483 // The only relevant ID may be the one used in update(), below.
485 // The only relevant ID may be the one used in update(), below.
486 MultipartOutput multipart = ContactClientUtils.createContactInstance(NON_EXISTENT_ID);
487 ClientResponse<MultipartInput> res =
488 client.update(NON_EXISTENT_ID, multipart);
489 int statusCode = res.getStatus();
491 // Check the status code of the response: does it match
492 // the expected response(s)?
493 if(logger.isDebugEnabled()){
494 logger.debug(testName + ": status = " + statusCode);
496 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
497 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
498 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
501 // ---------------------------------------------------------------
502 // CRUD tests : DELETE tests
503 // ---------------------------------------------------------------
506 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class,
507 dependsOnMethods = {"create", "readList", "testSubmitRequest", "update"})
508 public void delete(String testName) throws Exception {
511 setupDelete(testName);
513 // Submit the request to the service and store the response.
514 ClientResponse<Response> res = client.delete(knownResourceId);
515 int statusCode = res.getStatus();
517 // Check the status code of the response: does it match
518 // the expected response(s)?
519 if(logger.isDebugEnabled()){
520 logger.debug(testName + ": status = " + statusCode);
522 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
523 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
524 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
529 @Test(dataProvider="testName", dataProviderClass=AbstractServiceTestImpl.class,
530 dependsOnMethods = {"delete"})
531 public void deleteNonExistent(String testName) throws Exception {
534 setupDeleteNonExistent(testName);
536 // Submit the request to the service and store the response.
537 ClientResponse<Response> res = client.delete(NON_EXISTENT_ID);
538 int statusCode = res.getStatus();
540 // Check the status code of the response: does it match
541 // the expected response(s)?
542 if(logger.isDebugEnabled()){
543 logger.debug(testName + ": status = " + statusCode);
545 Assert.assertTrue(REQUEST_TYPE.isValidStatusCode(statusCode),
546 invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
547 Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE);
550 // ---------------------------------------------------------------
551 // Utility tests : tests of code used in tests above
552 // ---------------------------------------------------------------
554 * Tests the code for manually submitting data that is used by several
555 * of the methods above.
557 @Test(dependsOnMethods = {"create", "read"})
558 public void testSubmitRequest() {
560 // Expected status code: 200 OK
561 final int EXPECTED_STATUS = Response.Status.OK.getStatusCode();
563 // Submit the request to the service and store the response.
564 String method = ServiceRequestType.READ.httpMethodName();
565 String url = getResourceURL(knownResourceId);
566 int statusCode = submitRequest(method, url);
568 // Check the status code of the response: does it match
569 // the expected response(s)?
570 if(logger.isDebugEnabled()){
571 logger.debug("testSubmitRequest: url=" + url +
572 " status=" + statusCode);
574 Assert.assertEquals(statusCode, EXPECTED_STATUS);
578 // ---------------------------------------------------------------
579 // Cleanup of resources created during testing
580 // ---------------------------------------------------------------
583 * Deletes all resources created by tests, after all tests have been run.
585 * This cleanup method will always be run, even if one or more tests fail.
586 * For this reason, it attempts to remove all resources created
587 * at any point during testing, even if some of those resources
588 * may be expected to be deleted by certain tests.
590 @AfterClass(alwaysRun=true)
591 public void cleanUp() {
592 if (logger.isDebugEnabled()) {
593 logger.debug("Cleaning up temporary resources created for testing ...");
595 for (String resourceId : allResourceIdsCreated) {
596 // Note: Any non-success responses are ignored and not reported.
597 ClientResponse<Response> res = client.delete(resourceId);
601 // ---------------------------------------------------------------
602 // Utility methods used by tests above
603 // ---------------------------------------------------------------
605 public String getServicePathComponent() {
606 return SERVICE_PATH_COMPONENT;