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 import org.collectionspace.services.common.api.Tools;\r
  28 \r
  29 import java.util.ArrayList;\r
  30 import java.util.HashMap;\r
  31 import java.util.List;\r
  32 import java.util.Map;\r
  33 \r
  34 /**\r
  35  * User: laramie\r
  36  * $LastChangedRevision:  $\r
  37  * $LastChangedDate:  $\r
  38  */\r
  39 public class ServiceResult {\r
  40     public String testID = "";\r
  41     public String testGroupID = "";\r
  42     public String fullURL = "";\r
  43     public String deleteURL = "";\r
  44     public String location = "";\r
  45     public String CSID = "";\r
  46     public String subresourceCSID = "";\r
  47     public String requestPayload = "";  //just like requestPayloadRaw, but may have multipart boundary and headers.\r
  48     public Map<String, String> requestPayloadsRaw = new HashMap<String, String>();\r
  49     public String result = "";\r
  50     public int responseCode = 0;\r
  51     public String responseMessage = "";\r
  52     public String method = "";\r
  53     public String error = "";\r
  54     public String fromTestID = "";\r
  55     public String auth = "";\r
  56     public String boundary = "";\r
  57     public String payloadStrictness = "";\r
  58     public long contentLength = 0;\r
  59     public String failureReason = "";\r
  60     public Header[] responseHeaders = new Header[0];\r
  61     public List<Integer> expectedCodes = new ArrayList<Integer>();\r
  62     private Map<String, TreeWalkResults> partSummaries = new HashMap<String, TreeWalkResults>();\r
  63     public void addPartSummary(String label, TreeWalkResults list){\r
  64         partSummaries.put(label, list);\r
  65     }\r
  66     public String partsSummary(boolean detailed){\r
  67         StringBuffer buf = new StringBuffer();\r
  68         if (!isDomWalkOK()){\r
  69             if (detailed) buf.append("\r\nDOM CHECK FAILED:\r\n");\r
  70             else buf.append("; DOM CHECK FAILED:");\r
  71         }\r
  72         for (Map.Entry<String,TreeWalkResults> entry : partSummaries.entrySet()) {\r
  73             String key = entry.getKey();\r
  74             TreeWalkResults value = entry.getValue();\r
  75             buf.append(" label:"+key+": ");\r
  76             if (detailed){\r
  77                 buf.append("\r\n");\r
  78                 buf.append(value.fullSummary());\r
  79             } else {\r
  80                 buf.append(value.miniSummary());\r
  81             }\r
  82 \r
  83         }\r
  84         return buf.toString();\r
  85     }\r
  86     public boolean codeInSuccessRange(int code){\r
  87         if (0<=code && code<200){\r
  88             return false;\r
  89         } else if (400<=code) {\r
  90             return false;\r
  91         }\r
  92         return true;\r
  93     }\r
  94 \r
  95     public boolean isDomWalkOK(){\r
  96         if (Tools.isEmpty(payloadStrictness)){\r
  97             return true;\r
  98         }\r
  99         PAYLOAD_STRICTNESS strictness = PAYLOAD_STRICTNESS.valueOf(payloadStrictness);\r
 100         for (Map.Entry<String,TreeWalkResults> entry : partSummaries.entrySet()) {\r
 101             String key = entry.getKey();\r
 102             TreeWalkResults value = entry.getValue();\r
 103             if (value.hasDocErrors()){\r
 104                 failureReason = " : DOM DOC_ERROR; ";\r
 105                 return false;\r
 106             }\r
 107             switch (strictness){\r
 108             case STRICT:\r
 109                 if (!value.isStrictMatch()) {\r
 110                     failureReason = " : DOM NOT STRICT; ";\r
 111                     return false;\r
 112                 }\r
 113                 break;\r
 114             case ADDOK:\r
 115                 if (value.countFor(TreeWalkResults.TreeWalkEntry.STATUS.TEXT_DIFFERENT)>0) {\r
 116                     failureReason = " : DOM TEXT_DIFFERENT; ";\r
 117                     return false;\r
 118                 }\r
 119                 if (value.countFor(TreeWalkResults.TreeWalkEntry.STATUS.R_MISSING)>0){\r
 120                     failureReason = " : DOM R_MISSING; ";\r
 121                     return false;\r
 122                 }\r
 123                 break;\r
 124             case TEXT:\r
 125                 if (value.countFor(TreeWalkResults.TreeWalkEntry.STATUS.TEXT_DIFFERENT)>0) {\r
 126                     failureReason = " : DOM TEXT_DIFFERENT; ";\r
 127                     return false;\r
 128                 }\r
 129                 break;\r
 130             case TREE:\r
 131                 if (!value.treesMatch()) {\r
 132                     failureReason = " : DOM TREE MISMATCH; ";\r
 133                     return false;\r
 134                 }\r
 135                 break;\r
 136             case TREE_TEXT:\r
 137                 if (value.countFor(TreeWalkResults.TreeWalkEntry.STATUS.TEXT_DIFFERENT)>0) {\r
 138                     failureReason = " : DOM TEXT_DIFFERENT; ";\r
 139                     return false;\r
 140                 }\r
 141                 if (!value.treesMatch()) {\r
 142                     failureReason = " : DOM TREE MISMATCH; ";\r
 143                     return false;\r
 144                 }\r
 145                 break;\r
 146             case ZERO:\r
 147                 break;\r
 148             }\r
 149         }\r
 150         return true;\r
 151     }\r
 152 \r
 153     private boolean overrideExpectedResult = false;\r
 154 \r
 155     /** Call this method to create a ServiceResult mock object, for when you are doing autoDelete, and you come\r
 156      *  across a GET : GETs don't have a DELETE url, so they don't need to be autoDeleted, so an empty ServiceResult object\r
 157      *  signifies this.\r
 158      */\r
 159     public void overrideGotExpectedResult(){\r
 160         overrideExpectedResult = true;\r
 161     }\r
 162 \r
 163     public boolean gotExpectedResult(){\r
 164         if (overrideExpectedResult){\r
 165             return true;\r
 166         }\r
 167         if (Tools.notEmpty(failureReason)){\r
 168             return false;\r
 169         }\r
 170         for (Integer oneExpected : expectedCodes){\r
 171             if (responseCode == oneExpected){\r
 172                 return isDomWalkOK();\r
 173             }\r
 174         }\r
 175         if ( expectedCodes.size()>0 && codeInSuccessRange(responseCode)){ //none found, but result expected.\r
 176             for (Integer oneExpected : expectedCodes){\r
 177                 if ( ! codeInSuccessRange(oneExpected)){\r
 178                     return isDomWalkOK();\r
 179                 }\r
 180             }\r
 181         }\r
 182         boolean ok = codeInSuccessRange(responseCode);\r
 183         if (ok) {\r
 184             return isDomWalkOK();\r
 185         }\r
 186         failureReason = " : STATUS CODE UNEXPECTED; ";\r
 187         return false;\r
 188     }\r
 189 \r
 190     //public static final String[] DUMP_OPTIONS = {"minimal", "detailed", "full"};\r
 191     public static enum DUMP_OPTIONS {minimal, detailed, full};\r
 192 \r
 193     public static enum PAYLOAD_STRICTNESS {ZERO, ADDOK, TREE, TEXT, TREE_TEXT, STRICT};\r
 194 \r
 195     public String toString(){\r
 196         return detail(true);\r
 197 \r
 198     }\r
 199 \r
 200     private static final String LINE = "\r\n==================================";\r
 201     private static final String CRLF = "\r\n";\r
 202 \r
 203     public String detail(boolean includePayloads){\r
 204         String res =  "{"\r
 205                 + ( gotExpectedResult() ? "SUCCESS" : "FAILURE"  )\r
 206                 + failureReason\r
 207                 +"; "+method\r
 208                 +"; "+responseCode\r
 209                 + ( (expectedCodes.size()>0) ? "; expectedCodes:"+expectedCodes : "" )\r
 210                 + ( Tools.notEmpty(testID) ? "; testID:"+testID : "" )\r
 211                 + ( Tools.notEmpty(testGroupID) ? "; testGroupID:"+testGroupID : "" )\r
 212                 + ( Tools.notEmpty(fromTestID) ? "; fromTestID:"+fromTestID : "" )\r
 213                 + ( Tools.notEmpty(responseMessage) ? "; msg:"+responseMessage : "" )\r
 214                 +"; URL:"+fullURL\r
 215                 +"; auth: "+auth\r
 216                 + ( Tools.notEmpty(deleteURL) ? "; deleteURL:"+deleteURL : "" )\r
 217                 + ( Tools.notEmpty(location) ? "; location.CSID:"+location : "" )\r
 218                 + ( Tools.notEmpty(error) ? "; ERROR:"+error : "" )\r
 219                 + "; gotExpected:"+gotExpectedResult()\r
 220                 +";result:"+result+";"\r
 221                 + ( partsSummary(true))\r
 222                 +"}"\r
 223                 + ( includePayloads && Tools.notBlank(requestPayload) ? LINE+"requestPayload:"+LINE+CRLF+requestPayload+LINE : "" )\r
 224                 + ( includePayloads && Tools.notBlank(result) ? LINE+"result:"+LINE+CRLF+result : "" );\r
 225         return res;\r
 226     }\r
 227 \r
 228     public String minimal(){\r
 229         return "{"\r
 230                 + ( gotExpectedResult() ? "SUCCESS" : "FAILURE"  )\r
 231                 + failureReason\r
 232                 + ( Tools.notEmpty(testID) ? "; "+testID : "" )\r
 233                 +"; "+method\r
 234                 +"; "+responseCode\r
 235                 + (expectedCodes.size()>0 ? "; expected:"+expectedCodes : "")\r
 236                 + ( Tools.notEmpty(responseMessage) ? "; msg:"+responseMessage : "" )\r
 237                 +"; URL:"+fullURL\r
 238                 +"; auth: "+auth\r
 239                 + ( Tools.notEmpty(error) ? "; ERROR:"+error : "" )\r
 240                 + ( partsSummary(false))\r
 241                 +"}";\r
 242     }\r
 243     public String dump(ServiceResult.DUMP_OPTIONS opt){\r
 244         switch (opt){\r
 245             case minimal:\r
 246                 return minimal();\r
 247             case detailed:\r
 248                 return detail(false);\r
 249             case full:\r
 250                 return detail(true);\r
 251             default:\r
 252                 return toString();\r
 253         }\r
 254     }\r
 255 \r
 256     /** This method may be called from a test case, using a syntax like ${testID3.resValue("persons_common", "//refName")}   */\r
 257     public String got(String partName, String xpath) throws Exception {\r
 258         try {\r
 259             PayloadLogger.HttpTraffic traffic = PayloadLogger.readPayloads(this.result, this.boundary, this.contentLength);\r
 260             PayloadLogger.Part partFromServer = traffic.getPart(partName);\r
 261             String source = partFromServer.getContent();\r
 262             org.jdom.Element element = (org.jdom.Element) XmlCompareJdom.selectSingleNode(source, xpath, null);  //todo: passing null for namespace may not work.\r
 263             String sr = element != null ? element.getText() : "";\r
 264             return sr;\r
 265         } catch (Exception e){\r
 266             return "ERROR reading response value: "+e;\r
 267         }\r
 268     }\r
 269 \r
 270     /** This method may be called from a test case, using a syntax like ${oe9.reqValue("personauthorities_common","//shortIdentifier")}    */\r
 271     public String sent(String partName, String xpath) throws Exception {\r
 272         try {\r
 273             if (Tools.isEmpty(partName)){\r
 274                 partName = "default";\r
 275             }\r
 276             String source = this.requestPayloadsRaw.get(partName);\r
 277             if (source == null){\r
 278                 return "ERROR:null:requestPayloadsRaw["+partName+"]";\r
 279             }\r
 280             org.jdom.Element element = (org.jdom.Element) XmlCompareJdom.selectSingleNode(source, xpath, null);   //e.g. "//shortIdentifier");  //todo: passing null for namespace may not work.\r
 281             String sr = element != null ? element.getText() : "";\r
 282             return sr;\r
 283         } catch (Exception e){\r
 284             return "ERROR reading request value: "+e;\r
 285         }\r
 286     }\r
 287 }\r