2 * This document is a part of the source code and related artifacts
\r
3 * for CollectionSpace, an open source collections management system
\r
4 * for museums and related institutions:
\r
6 * http://www.collectionspace.org
\r
7 * http://wiki.collectionspace.org
\r
9 * Copyright (c) 2009 Regents of the University of California
\r
11 * Licensed under the Educational Community License (ECL), Version 2.0.
\r
12 * You may not use this file except in compliance with this License.
\r
14 * You may obtain a copy of the ECL 2.0 License at
\r
15 * https://source.collectionspace.org/collection-space/LICENSE.txt
\r
17 * Unless required by applicable law or agreed to in writing, software
\r
18 * distributed under the License is distributed on an "AS IS" BASIS,
\r
19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
20 * See the License for the specific language governing permissions and
\r
21 * limitations under the License.
\r
24 package org.collectionspace.services.IntegrationTests.xmlreplay;
\r
26 import org.collectionspace.services.common.Tools;
\r
27 import org.testng.Assert;
\r
29 import java.io.File;
\r
30 import java.util.ArrayList;
\r
31 import java.util.List;
\r
33 /** Subclass this test to programmatically control XmlReplay from a surefire test. See example in IntegrationTests :: XmlReplaySelfTest
\r
35 * $LastChangedRevision: $
\r
36 * $LastChangedDate: $
\r
38 public class XmlReplayTest {
\r
40 public static final String XMLREPLAY_REL_DIR_TO_MODULE = "/src/test/resources/test-data/xmlreplay";
\r
42 /** To use this method, you should have a test repository of xml files in the path
\r
43 * defined by XMLREPLAY_REL_DIR_TO_MODULE, relative to your pom.xml file, but normally
\r
44 * you would use the central repository of tests, which live in services/IntegrationTests,
\r
45 * and which you can use by calling createXmlReplay() which calls createXmlReplayUsingIntegrationTestsModule() for you.
\r
47 public static XmlReplay createXmlReplayForModule() throws Exception {
\r
48 String pwd = (new File(".")).getCanonicalPath();
\r
49 System.out.println("createXmlReplayForModule.pwd: "+pwd);
\r
50 XmlReplay replay = new XmlReplay(pwd+XMLREPLAY_REL_DIR_TO_MODULE);
\r
51 System.out.println("XmlReplay: "+replay);
\r
55 /** Use this method if your test xml files are stored in the central repository,
\r
56 * which is "services/IntegrationTests" + XMLREPLAY_REL_DIR_TO_MODULE
\r
58 public static XmlReplay createXmlReplay() throws Exception {
\r
59 return createXmlReplayUsingIntegrationTestsModule("../..");
\r
63 * @param relToServicesRoot is a Unix-like path from the calling module to the services root,
\r
64 * so if if you are in services/dimension/client/
\r
65 * then relToServicesRoot is "../.." which is how most of the client tests are set up, or if you
\r
66 * are setting up your test repository relative to the main service, e.g. you are in
\r
67 * services/dimension/, then relToServicesRoot is ".."
\r
69 public static XmlReplay createXmlReplayUsingIntegrationTestsModule(String relToServicesRoot) throws Exception {
\r
70 String thisDir = Tools.glue(relToServicesRoot, "/", "IntegrationTests");
\r
71 String pwd = (new File(thisDir)).getCanonicalPath();
\r
72 System.out.println("createXmlReplayUsingIntegrationTestsModule.pwd: "+pwd);
\r
73 XmlReplay replay = new XmlReplay(pwd+XMLREPLAY_REL_DIR_TO_MODULE);
\r
74 System.out.println("XmlReplay: "+replay);
\r
78 public static void logTest(ServiceResult sresult, String testname){
\r
79 ResultSummary summary = resultSummary(sresult);
\r
80 org.testng.Reporter.log(summary.table);
\r
81 Assert.assertEquals(summary.oks, summary.total, "Expected all "+summary.total+ " XmlReplay tests to pass. See Output from test '"+testname+"'.");
\r
84 public static void logTest(List<ServiceResult> list, String testname){
\r
85 ResultSummary summary = resultSummary(list);
\r
86 org.testng.Reporter.log(summary.table);
\r
87 Assert.assertEquals(summary.oks, summary.total, "Expected all "+summary.total+ " XmlReplay tests to pass. See Output from test '"+testname+"'.");
\r
90 public static void logTestForGroup(List<List<ServiceResult>> list, String testname){
\r
91 ResultSummary summary = resultSummaryForGroup(list);
\r
92 org.testng.Reporter.log(summary.table);
\r
93 Assert.assertEquals(summary.oks, summary.total, "Expected all "+summary.total+ " XmlReplay tests to pass. See Output from test '"+testname+"'.");
\r
97 //============== HELPERS AND FORMATTING =====================================================
\r
99 private static final String TBLSTART = "<table border='1'>";
\r
100 private static final String ROWSTART = "<tr><td bgcolor='white'>";
\r
101 private static final String ROWSTARTRED = "<tr><td bgcolor='red'><b>";
\r
102 private static final String SEP = "</td><td>";
\r
103 private static final String ROWEND = "</td></tr>";
\r
104 private static final String ROWENDRED = "</b></td></tr>";
\r
105 private static final String TBLEND = "</table>";
\r
107 public static class ResultSummary {
\r
108 public long oks = 0;
\r
109 public long total = 0;
\r
110 public String table = "";
\r
111 public List<String> groups = new ArrayList<String>();
\r
114 public static ResultSummary resultSummaryForGroup(List<List<ServiceResult>> list){
\r
115 ResultSummary summary = new ResultSummary();
\r
118 StringBuffer buff = new StringBuffer();
\r
119 buff.append(TBLSTART);
\r
120 for (List<ServiceResult> serviceResults : list){
\r
121 String groupID = "";
\r
122 if (serviceResults.size()>0){
\r
123 groupID = serviceResults.get(0).testGroupID;
\r
124 summary.groups.add(groupID);
\r
126 buff.append(ROWSTART+"XmlReplay testGroup "+groupID+ROWEND);
\r
127 for (ServiceResult serviceResult : serviceResults){
\r
129 if (serviceResult.gotExpectedResult()){
\r
131 buff.append(ROWSTART+serviceResult.minimal()+ROWEND);
\r
133 buff.append(ROWSTARTRED+serviceResult.minimal()+ROWENDRED);
\r
137 buff.append(TBLEND);
\r
138 summary.table = buff.toString();
\r
142 public static ResultSummary resultSummary(List<ServiceResult> serviceResults){
\r
143 ResultSummary summary = new ResultSummary();
\r
146 StringBuffer buff = new StringBuffer();
\r
147 buff.append(TBLSTART);
\r
148 for (ServiceResult serviceResult : serviceResults){
\r
150 if (serviceResult.gotExpectedResult()){
\r
152 buff.append(ROWSTART+serviceResult.minimal()+ROWEND);
\r
154 buff.append(ROWSTARTRED+serviceResult.minimal()+ROWENDRED);
\r
157 buff.append(TBLEND);
\r
158 summary.table = buff.toString();
\r
162 public static ResultSummary resultSummary(ServiceResult serviceResult){
\r
163 ResultSummary summary = new ResultSummary();
\r
166 StringBuffer buff = new StringBuffer();
\r
167 buff.append(TBLSTART);
\r
168 if (serviceResult.gotExpectedResult()){
\r
170 buff.append(ROWSTART+serviceResult.minimal()+ROWEND);
\r
172 buff.append(ROWSTARTRED+serviceResult.minimal()+ROWENDRED);
\r
174 buff.append(TBLEND);
\r
175 summary.table = buff.toString();
\r