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.api.Tools;
\r
28 import java.util.ArrayList;
\r
29 import java.util.Arrays;
\r
30 import java.util.List;
\r
34 * $LastChangedRevision: $
\r
35 * $LastChangedDate: $
\r
37 public class TreeWalkResults extends ArrayList<TreeWalkResults.TreeWalkEntry> {
\r
38 public String toString(String LEAD){
\r
39 StringBuffer res = new StringBuffer();
\r
40 for (TreeWalkResults.TreeWalkEntry entry: this) {
\r
41 res.append(entry.toString(LEAD));
\r
43 return res.toString();
\r
46 /** This cllass has two public Lists: you can construct your own to set the acceptable and unacceptable STATUS codes.
\r
47 * They are defaulted to R_ADDED being acceptable. */
\r
48 public static class MatchSpec {
\r
49 public static final TreeWalkEntry.STATUS[] defaultAcceptableStatiArray = {TreeWalkEntry.STATUS.INFO,
\r
50 TreeWalkEntry.STATUS.MATCHED,
\r
51 TreeWalkEntry.STATUS.R_ADDED};
\r
53 public static final TreeWalkEntry.STATUS[] defaultErrorStatiArray = {TreeWalkEntry.STATUS.R_MISSING,
\r
54 TreeWalkEntry.STATUS.NESTED_ERROR,
\r
55 TreeWalkEntry.STATUS.TEXT_DIFFERENT,
\r
56 TreeWalkEntry.STATUS.DOC_ERROR};
\r
57 public List<TreeWalkEntry.STATUS> errorStati;
\r
59 public static MatchSpec createDefault(){
\r
60 MatchSpec result = new MatchSpec();
\r
61 result.errorStati = Arrays.asList(defaultErrorStatiArray);
\r
64 public static MatchSpec create(TreeWalkEntry.STATUS[] statiArray){
\r
65 MatchSpec result = new MatchSpec();
\r
66 result.errorStati = Arrays.asList(statiArray);
\r
69 public void removeErrorFromSpec(TreeWalkEntry.STATUS status){
\r
70 ArrayList arrayList = new ArrayList(errorStati);
\r
71 arrayList.remove(status);
\r
72 errorStati = arrayList;
\r
74 public String toString(){
\r
75 StringBuffer buff = new StringBuffer("{");
\r
77 for (TreeWalkEntry.STATUS status : errorStati){
\r
78 if (i>0) buff.append(",");
\r
79 String foo = status.toString();
\r
84 return buff.toString();
\r
89 public static class TreeWalkEntry {
\r
90 public String lpath = "";
\r
91 public String rpath = "";
\r
92 public String ltextTrimmed = "";
\r
93 public String rtextTrimmed = "";
\r
94 public String expected = "";
\r
95 public String actual = "";
\r
96 public String message = "";
\r
97 public String errmessage = "";
\r
98 public TreeWalkResults nested;
\r
99 public static enum STATUS {INFO, MATCHED, R_MISSING, R_ADDED, DOC_ERROR, TEXT_DIFFERENT, NESTED_ERROR};
\r
100 public STATUS status;
\r
101 public String toString(){
\r
102 return toString("\r\n");
\r
104 public String toString(String LEAD){
\r
105 String INDENT = " ";
\r
109 +(Tools.notEmpty(lpath) ? ", L.path:"+lpath : "")
\r
110 +(Tools.notEmpty(rpath) ? ", R.path:"+rpath : "")
\r
111 +(Tools.notEmpty(message) ? ", message:"+message : "")
\r
112 +(Tools.notEmpty(errmessage) ? ", errmessage:"+errmessage : "")
\r
113 +", status:"+status
\r
114 +((status != STATUS.MATCHED) && Tools.notEmpty(ltextTrimmed) ? ","+LEAD+" L.trimmed:"+ltextTrimmed : "")
\r
115 +((status != STATUS.MATCHED) && Tools.notEmpty(rtextTrimmed) ? ","+LEAD+" R.trimmed:"+rtextTrimmed : "")
\r
116 +((status != STATUS.MATCHED) && Tools.notEmpty(expected) ? LEAD+"EXPECTED:"+LEAD+"------------------"+LEAD+expected.trim()+LEAD+"------------------" : "")
\r
117 +((status != STATUS.MATCHED) && Tools.notEmpty(actual) ? LEAD+"ACTUAL:"+LEAD+"------------------"+LEAD+actual.trim()+LEAD+"------------------"+LEAD : "")
\r
118 +((status != STATUS.MATCHED) && (nested != null) ? LEAD+"NESTED:"+LEAD+"------------------"+LEAD+nested.toString(LEAD+INDENT)+LEAD+"------------------"+LEAD : "")
\r
123 public boolean hasDocErrors(){
\r
124 for (TreeWalkEntry entry : this){
\r
125 if (entry.status == TreeWalkEntry.STATUS.DOC_ERROR){
\r
132 public String getErrorMessages(){
\r
133 StringBuffer buf = new StringBuffer();
\r
134 boolean first = true;
\r
135 for (TreeWalkEntry entry : this){
\r
136 if ( Tools.notEmpty(entry.errmessage)){
\r
138 buf.append(",errors:");
\r
142 buf.append('\''+entry.errmessage+"\'");
\r
146 return buf.toString();
\r
151 public boolean isStrictMatch(){
\r
152 for (TreeWalkEntry entry : this){
\r
153 if (entry.status == TreeWalkEntry.STATUS.DOC_ERROR){
\r
156 if ( !( entry.status == TreeWalkEntry.STATUS.MATCHED
\r
157 || entry.status == TreeWalkEntry.STATUS.INFO)){
\r
163 public int getMismatchCount(){
\r
165 for (TreeWalkEntry entry : this){
\r
166 if ( entry.status == TreeWalkEntry.STATUS.DOC_ERROR
\r
167 || entry.status != TreeWalkEntry.STATUS.MATCHED
\r
168 || entry.status != TreeWalkEntry.STATUS.INFO){
\r
174 /** For our purposes, trees match if they have the same element tree structure - no checking is done for text node changes. */
\r
175 public boolean treesMatch(){
\r
176 for (TreeWalkEntry entry : this){
\r
177 if (entry.status == TreeWalkEntry.STATUS.DOC_ERROR
\r
178 || entry.status == TreeWalkEntry.STATUS.R_MISSING
\r
179 || entry.status == TreeWalkEntry.STATUS.R_ADDED ){
\r
186 public boolean treesMatch(MatchSpec matchSpec) {
\r
187 for (TreeWalkEntry entry : this) {
\r
188 if (matchSpec.errorStati.contains(entry.status)) {
\r
195 public int countFor(TreeWalkEntry.STATUS status){
\r
197 for (TreeWalkEntry entry : this){
\r
198 if (entry.status.equals(status)){
\r
205 public String miniSummary(){
\r
206 //MATCHED, INFO, R_MISSING, R_ADDED, TEXT_DIFFERENT};
\r
207 StringBuffer buf = new StringBuffer();
\r
209 boolean nextline = false;
\r
210 for (TreeWalkEntry.STATUS st : TreeWalkEntry.STATUS.values()){
\r
211 if (nextline) buf.append(',');
\r
212 buf.append(st.name()+':'+countFor(st));
\r
215 buf.append(getErrorMessages());
\r
217 return buf.toString();
\r
220 public String fullSummary(){
\r
221 StringBuffer buf = new StringBuffer();
\r
222 for (TreeWalkResults.TreeWalkEntry entry : this){
\r
223 buf.append(entry.toString()).append("\r\n");
\r
225 return buf.toString();
\r
229 public String leftID;
\r
230 public String rightID;
\r