git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 /**\r
   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
   5  *\r
   6  * http://www.collectionspace.org\r
   7  * http://wiki.collectionspace.org\r
   8  *\r
   9  * Copyright (c) 2009 Regents of the University of California\r
  10  *\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
  13  *\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
  16  *\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
  22  */\r
  23 \r
  24 package org.collectionspace.services.IntegrationTests.xmlreplay;\r
  25 \r
  26 import org.apache.commons.httpclient.Header;\r
  27 \r
  28 import java.util.ArrayList;\r
  29 import java.util.HashMap;\r
  30 import java.util.List;\r
  31 import java.util.Map;\r
  32 \r
  33 /**\r
  34  * User: laramie\r
  35  * $LastChangedRevision:  $\r
  36  * $LastChangedDate:  $\r
  37  */\r
  38 public class ServiceResult {\r
  39     public String testID = "";\r
  40     public String testGroupID = "";\r
  41     public String fullURL = "";\r
  42     public String deleteURL = "";\r
  43     public String location = "";\r
  44     public String CSID = "";\r
  45     public String subresourceCSID = "";\r
  46     public String result = "";\r
  47     public int responseCode = 0;\r
  48     public String responseMessage = "";\r
  49     public String method = "";\r
  50     public String error = "";\r
  51     public String fromTestID = "";\r
  52     public String auth = "";\r
  53     public String boundary = "";\r
  54     public String payloadStrictness = "";\r
  55     public long contentLength = 0;\r
  56     public String failureReason = "";\r
  57     public Header[] responseHeaders = new Header[0];\r
  58     public List<Integer> expectedCodes = new ArrayList<Integer>();\r
  59     private Map<String, TreeWalkResults> partSummaries = new HashMap<String, TreeWalkResults>();\r
  60     public void addPartSummary(String label, TreeWalkResults list){\r
  61         partSummaries.put(label, list);\r
  62     }\r
  63     public String partsSummary(boolean detailed){\r
  64         StringBuffer buf = new StringBuffer();\r
  65         if (!isDomWalkOK()){\r
  66             if (detailed) buf.append("\r\nDOM CHECK FAILED:\r\n");\r
  67             else buf.append("; DOM CHECK FAILED:");\r
  68         }\r
  69         for (Map.Entry<String,TreeWalkResults> entry : partSummaries.entrySet()) {\r
  70             String key = entry.getKey();\r
  71             TreeWalkResults value = entry.getValue();\r
  72             buf.append(" label:"+key+": ");\r
  73             if (detailed){\r
  74                 buf.append("\r\n");\r
  75                 buf.append(value.fullSummary());\r
  76             } else {\r
  77                 buf.append(value.miniSummary());\r
  78             }\r
  79 \r
  80         }\r
  81         return buf.toString();\r
  82     }\r
  83     public boolean codeInSuccessRange(int code){\r
  84         if (0<=code && code<200){\r
  85             return false;\r
  86         } else if (400<=code) {\r
  87             return false;\r
  88         }\r
  89         return true;\r
  90     }\r
  91 \r
  92     public boolean isDomWalkOK(){\r
  93         if (Tools.isEmpty(payloadStrictness)){\r
  94             return true;\r
  95         }\r
  96         PAYLOAD_STRICTNESS strictness = PAYLOAD_STRICTNESS.valueOf(payloadStrictness);\r
  97         for (Map.Entry<String,TreeWalkResults> entry : partSummaries.entrySet()) {\r
  98             String key = entry.getKey();\r
  99             TreeWalkResults value = entry.getValue();\r
 100             if (value.hasDocErrors()){\r
 101                 failureReason = " : DOM DOC_ERROR; ";\r
 102                 return false;\r
 103             }\r
 104             switch (strictness){\r
 105             case STRICT:\r
 106                 if (!value.isStrictMatch()) {\r
 107                     failureReason = " : DOM NOT STRICT; ";\r
 108                     return false;\r
 109                 }\r
 110                 break;\r
 111             case ADDOK:\r
 112                 if (value.countFor(TreeWalkResults.TreeWalkEntry.STATUS.TEXT_DIFFERENT)>0) {\r
 113                     failureReason = " : DOM TEXT_DIFFERENT; ";\r
 114                     return false;\r
 115                 }\r
 116                 if (value.countFor(TreeWalkResults.TreeWalkEntry.STATUS.R_MISSING)>0){\r
 117                     failureReason = " : DOM R_MISSING; ";\r
 118                     return false;\r
 119                 }\r
 120                 break;\r
 121             case TEXT:\r
 122                 if (value.countFor(TreeWalkResults.TreeWalkEntry.STATUS.TEXT_DIFFERENT)>0) {\r
 123                     failureReason = " : DOM TEXT_DIFFERENT; ";\r
 124                     return false;\r
 125                 }\r
 126                 break;\r
 127             case TREE:\r
 128                 if (!value.treesMatch()) {\r
 129                     failureReason = " : DOM TREE MISMATCH; ";\r
 130                     return false;\r
 131                 }\r
 132                 break;\r
 133             case ZERO:\r
 134                 break;\r
 135             }\r
 136         }\r
 137         return true;\r
 138     }\r
 139 \r
 140     public boolean gotExpectedResult(){\r
 141         if (Tools.notEmpty(failureReason)){\r
 142             return false;\r
 143         }\r
 144         for (Integer oneExpected : expectedCodes){\r
 145             if (responseCode == oneExpected){\r
 146                 return isDomWalkOK();\r
 147             }\r
 148         }\r
 149         if ( expectedCodes.size()>0 && codeInSuccessRange(responseCode)){ //none found, but result expected.\r
 150             for (Integer oneExpected : expectedCodes){\r
 151                 if ( ! codeInSuccessRange(oneExpected)){\r
 152                     return isDomWalkOK();\r
 153                 }\r
 154             }\r
 155         }\r
 156         boolean ok = codeInSuccessRange(responseCode);\r
 157         if (ok) {\r
 158             return isDomWalkOK();\r
 159         }\r
 160         failureReason = " : STATUS CODE UNEXPECTED; ";\r
 161         return false;\r
 162     }\r
 163 \r
 164     //public static final String[] DUMP_OPTIONS = {"minimal", "detailed", "full"};\r
 165     public static enum DUMP_OPTIONS {minimal, detailed, full};\r
 166 \r
 167     public static enum PAYLOAD_STRICTNESS {ZERO, ADDOK, TREE, TEXT, STRICT};\r
 168 \r
 169     public String toString(){\r
 170         return detail(true);\r
 171 \r
 172     }\r
 173     public String detail(boolean includePayloads){\r
 174         return "{"\r
 175                 + ( gotExpectedResult() ? "SUCCESS" : "FAILURE"  )\r
 176                 + failureReason\r
 177                 +"; "+method\r
 178                 +"; "+responseCode\r
 179                 + ( (expectedCodes.size()>0) ? "; expectedCodes:"+expectedCodes : "" )\r
 180                 + ( Tools.notEmpty(testID) ? "; testID:"+testID : "" )\r
 181                 + ( Tools.notEmpty(testGroupID) ? "; testGroupID:"+testGroupID : "" )\r
 182                 + ( Tools.notEmpty(fromTestID) ? "; fromTestID:"+fromTestID : "" )\r
 183                 + ( Tools.notEmpty(responseMessage) ? "; msg:"+responseMessage : "" )\r
 184                 +"; URL:"+fullURL\r
 185                 +"; auth: "+auth\r
 186                 + ( Tools.notEmpty(deleteURL) ? "; deleteURL:"+deleteURL : "" )\r
 187                 + ( Tools.notEmpty(location) ? "; location.CSID:"+location : "" )\r
 188                 + ( Tools.notEmpty(error) ? "; ERROR:"+error : "" )\r
 189                 + "; gotExpected:"+gotExpectedResult()\r
 190                 + ( includePayloads && Tools.notEmpty(result) ? "; result:"+result : "" )\r
 191                 + ( partsSummary(true))\r
 192                 +"}";\r
 193     }\r
 194     public String minimal(){\r
 195         return "{"\r
 196                 + ( gotExpectedResult() ? "SUCCESS" : "FAILURE"  )\r
 197                 + failureReason\r
 198                 + ( Tools.notEmpty(testID) ? "; "+testID : "" )\r
 199                 +"; "+method\r
 200                 +"; "+responseCode\r
 201                 + (expectedCodes.size()>0 ? "; expected:"+expectedCodes : "")\r
 202                 + ( Tools.notEmpty(responseMessage) ? "; msg:"+responseMessage : "" )\r
 203                 +"; URL:"+fullURL\r
 204                 +"; auth: "+auth\r
 205                 + ( Tools.notEmpty(error) ? "; ERROR:"+error : "" )\r
 206                 + ( partsSummary(false))\r
 207                 +"}";\r
 208     }\r
 209     public String dump(ServiceResult.DUMP_OPTIONS opt){\r
 210         switch (opt){\r
 211             case minimal:\r
 212                 return minimal();\r
 213             case detailed:\r
 214                 return detail(false);\r
 215             case full:\r
 216                 return detail(true);\r
 217             default:\r
 218                 return toString();\r
 219         }\r
 220     }\r
 221 }\r