ServiceResult (RestReplay 1.0.27 API)

java.lang.Object
- org.dynamide.restreplay.ServiceResult

```
public class ServiceResult
extends Object
```
This class represents the entire transaction of a test: the options used, the request, the response, and the validation. Many of the fields exposed by this class have no getters or setters. This is to make use within validators and JEXL expressions as easy as possible. Also, this class supports serialization, including some calculated fields, which is used to produce a database of all the JSON representations of this class for all the test cases run. That database, if requested by RunOptions.outputServiceResultDB is present in reports/db/ after a successful run ( ConfigFile.getReportsDir()/RestReplay.REL_PATH_TO_DB ).

Author:

Laramie Crocker

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ServiceResult.Column`
`static class`	`ServiceResult.DUMP_OPTIONS`
`static class`	`ServiceResult.Payload`
`static class`	`ServiceResult.PAYLOAD_STRICTNESS`
`static class`	`ServiceResult.PRETTY_FORMAT`

Field Summary

Fields
Modifier and Type	Field and Description
`List<Alert>`	`alerts`
`String`	`auth`
`String`	`boundary`
`String`	`calcExpectedTreewalkRangeColumns`
`boolean`	`calcGotExpectedResult`
`String`	`calcSuccessLabel`
`String`	`comment`
`int`	`connectionTimeout`
`long`	`contentLength`
`String`	`controlFileName`
`String`	`CSID`
`static Range`	`DEFAULT_SUCCESS_RANGE`
`String`	`deleteURL`
`String`	`domcheck`
`String`	`expectedContentExpanded`
`String`	`expectedContentExpandedAsXml`
`boolean`	`expectedContentExpandedWasJson`
`String`	`expectedContentRaw`
`boolean`	`expectedFailure`
`String`	`expectedResponseFilenameUsed`
`List<ServiceResult.Column>`	`expectedTreewalkRangeColumns`
`Map<TreeWalkResults.TreeWalkEntry.STATUS,Range>`	`expectedTreewalkRangeMap`
`String`	`failureReason`
`String`	`fromTestID`
`String`	`fullURL`
`String`	`gotExpectedResultBecause`
`String`	`idFromMutator`
`boolean`	`isAutodelete`
`boolean`	`isMutation`
`String`	`location`
`int`	`loopIndex`
`String`	`method`
`String`	`mutationDetailBlockID`
`IMutator`	`mutator`
`boolean`	`mutatorSkipped`
`boolean`	`mutatorSkippedByOpts`
`String`	`mutatorType`
`boolean`	`overrideExpectedResult`
`boolean`	`parentSkipped`
`Map<String,ServiceResult.Payload>`	`payloads`
`String`	`payloadStrictness`
`String`	`prettyJSON`
`String`	`protoHostPort`
`List<Range>`	`ranges`
`RestReplayReport.ReportDetailLocations`	`reportDetail`
`RestReplayReport.ReportMasterLocations`	`reportMaster`
`Map<String,String>`	`requestHeaderMap`
`String`	`requestPayload`
`String`	`requestPayloadFilename`
`String`	`requestPayloadsRaw`
`int`	`responseCode`
`Map<String,String>`	`responseHeaderMap`
`org.apache.commons.httpclient.Header[]`	`responseHeaders`
`String`	`responseHeadersDump`
`String`	`responseMessage`
`String`	`sequence`
`int`	`socketTimeout`
`String`	`subresourceCSID`
`String`	`testGroupID`
`String`	`testID`
`String`	`testIDLabel`
`long`	`time`

Constructor Summary

Constructors
Constructor and Description

ServiceResult(RunOptions options)

Constructors
Constructor and Description
`ServiceResult(RunOptions options)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlert(String message, String context, Alert.LEVEL level)`
`void`	`addAlertError(String message)`
`void`	`addAlertError(String message, String context)`
`void`	`addAlertOK(String message)`
`void`	`addAlertOK(String message, String context)`
`void`	`addAlertWarning(String message)`
`void`	`addAlertWarning(String message, String context)`
`void`	`addChild(ServiceResult child)`
`void`	`addError(String msg)`
`void`	`addError(String msg, Throwable t)`
`void`	`addExport(String key, Object value)`
`void`	`addExports(Map<String,Object> newexports)`
`void`	`addPartSummary(String label, TreeWalkResults list)`
`void`	`addRequestHeader(String name, String value)`
`void`	`addVars(Map<String,Object> newVars)`
`void`	`addWarning(String msg)`
`int`	`alertsCount(Alert.LEVEL level)`
`void`	`beginTrappingExports()`
`static boolean`	`codeInSuccessRange(int code)`
`ServiceResult.PRETTY_FORMAT`	`contentTypeFromResponse()`
`static Map<TreeWalkResults.TreeWalkEntry.STATUS,Range>`	`createRangesForLevel(ServiceResult.PAYLOAD_STRICTNESS strictness)`
`String`	`detail(boolean includePayloads)`
`String`	`dump(ServiceResult.DUMP_OPTIONS opt, boolean hasError)`
`String`	`dumpPayloads()`
`List<String>`	`endTrappingExports()`
`String`	`expectedTreewalkRangeMapToString()`
`Object`	`get(String what)`
`List<ServiceResult>`	`getChildResults()`
`String`	`getCurrentValidatorContextName()`
`String`	`getError()`
`String`	`getErrorDetail()`
`Map<String,Object>`	`getExports()`
`int`	`getLoopIndex()`
`String`	`getLoopQualifier(Eval evalStruct)`
`String`	`getMimeType()`
`IMutator`	`getMutator()`
`ServiceResult`	`getParent()`
`String`	`getResult()`
`RunOptions`	`getRunOptions()`
`String`	`getSequence()` The sequence number is generated for each run, so that each ServiceResult is sequentially numbered from zero; this number appears on the right side of the detail report on the first line of each test, and in square brackets in the imports dump at the top of the testGroup report.
`Map<String,Object>`	`getVars()`
`String`	`getXmlResult()`
`Object`	`got(String pathExpression)` This method may be called from a test case, using a syntax with XPath like this: `${testID3.got("//refName")}` or with JSON, like this: `${testID3.got("$..refName")}`
`boolean`	`gotExpectedResult()`
`Object`	`gotJson(String jsonPath)`
`Object`	`gotXPath(String pathExpression)`
`void`	`initExpectedCodeRanges(org.dom4j.Node testNode)` if xml sets no expected/code nodes, then DEFAULT_SUCCESS_RANGE is used.
`boolean`	`isDomWalkOK()`
`boolean`	`isDomWalkOKByRanges(Map<TreeWalkResults.TreeWalkEntry.STATUS,Range> expectedRangeMap)`
`boolean`	`isSUCCESS()`
`String`	`minimal()`
`String`	`minimal(boolean verbosePartsSummary)`
`void`	`overrideGotExpectedResult()` Call this method to create a ServiceResult mock object, for when you are doing autoDelete, and you come across a GET : GETs don't have a DELETE url, so they don't need to be autoDeleted, so an empty ServiceResult object signifies this.
`String`	`partsSummary(boolean detailed)`
`String`	`partsSummaryHTML(boolean detailed)`
`static String`	`payloadJSONtoXML(String payload)`
`static String`	`payloadXMLtoJSON(String payload)`
`void`	`populateSerializedFields()`
`static String`	`prettyPrintJSON(String payload)`
`Object`	`sent(String path)`
`Object`	`sentJson(String jsonPath)`
`Object`	`sentJson(String jsonPath, String source)`
`Object`	`sentXPath(String path)`
`Object`	`sentXPath(String xpath, String source)`
`void`	`setCurrentValidatorContextName(String name)`
`void`	`setMimeType(String mimeHeader)`
`protected void`	`setParent(ServiceResult sr)`
`void`	`setResponseHeaders(org.apache.commons.httpclient.Header[] headers)`
`void`	`setResultWMime(String result, String mimeType)`
`String`	`tiny()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sequence
```
public final String sequence
```

reportMaster

public RestReplayReport.ReportMasterLocations reportMaster

reportDetail

public RestReplayReport.ReportDetailLocations reportDetail

controlFileName
```
public String controlFileName
```

testID
```
public String testID
```

testGroupID
```
public String testGroupID
```

testIDLabel
```
public String testIDLabel
```

idFromMutator
```
public String idFromMutator
```

isMutation
```
public boolean isMutation
```

mutatorType
```
public String mutatorType
```

mutator
```
public transient IMutator mutator
```

mutationDetailBlockID
```
public String mutationDetailBlockID
```

mutatorSkipped
```
public boolean mutatorSkipped
```

mutatorSkippedByOpts
```
public boolean mutatorSkippedByOpts
```

comment
```
public String comment
```

isAutodelete
```
public boolean isAutodelete
```

parentSkipped
```
public boolean parentSkipped
```

loopIndex
```
public int loopIndex
```

fullURL
```
public String fullURL
```

deleteURL
```
public String deleteURL
```

protoHostPort
```
public String protoHostPort
```

location
```
public String location
```

CSID
```
public String CSID
```

subresourceCSID
```
public String subresourceCSID
```

requestPayloadFilename
```
public String requestPayloadFilename
```

requestPayload
```
public String requestPayload
```

requestPayloadsRaw
```
public String requestPayloadsRaw
```

prettyJSON
```
public String prettyJSON
```

time
```
public long time
```

responseCode
```
public int responseCode
```

responseMessage
```
public String responseMessage
```

method
```
public String method
```

socketTimeout
```
public int socketTimeout
```

connectionTimeout
```
public int connectionTimeout
```

fromTestID
```
public String fromTestID
```

auth
```
public String auth
```

boundary
```
public String boundary
```

payloadStrictness
```
public String payloadStrictness
```

contentLength
```
public long contentLength
```

failureReason
```
public String failureReason
```

expectedFailure
```
public boolean expectedFailure
```

expectedContentExpandedWasJson

public boolean expectedContentExpandedWasJson

expectedContentExpanded
```
public String expectedContentExpanded
```

expectedContentExpandedAsXml

public String expectedContentExpandedAsXml

expectedContentRaw
```
public String expectedContentRaw
```

expectedResponseFilenameUsed

public String expectedResponseFilenameUsed

domcheck
```
public String domcheck
```

expectedTreewalkRangeColumns

public transient List<ServiceResult.Column> expectedTreewalkRangeColumns

expectedTreewalkRangeMap

public transient Map<TreeWalkResults.TreeWalkEntry.STATUS,Range> expectedTreewalkRangeMap

requestHeaderMap

public Map<String,String> requestHeaderMap

responseHeaderMap

public Map<String,String> responseHeaderMap

responseHeaders

public org.apache.commons.httpclient.Header[] responseHeaders

responseHeadersDump
```
public String responseHeadersDump
```

ranges
```
public List<Range> ranges
```

DEFAULT_SUCCESS_RANGE

public static final Range DEFAULT_SUCCESS_RANGE

alerts
```
public List<Alert> alerts
```

overrideExpectedResult
```
public boolean overrideExpectedResult
```

gotExpectedResultBecause
```
public String gotExpectedResultBecause
```

payloads

public Map<String,ServiceResult.Payload> payloads

calcGotExpectedResult
```
public boolean calcGotExpectedResult
```

calcSuccessLabel
```
public String calcSuccessLabel
```

calcExpectedTreewalkRangeColumns

public String calcExpectedTreewalkRangeColumns

Constructor Detail

ServiceResult

public ServiceResult(RunOptions options)

Method Detail

getSequence
```
public String getSequence()
```
The sequence number is generated for each run, so that each ServiceResult is sequentially numbered from zero; this number appears on the right side of the detail report on the first line of each test, and in square brackets in the imports dump at the top of the testGroup report. It is used to disambiguate reports when the runID is not specified in a run element, and in filenames in the json db report.

getRunOptions
```
public RunOptions getRunOptions()
```

addChild

public void addChild(ServiceResult child)

getChildResults

public List<ServiceResult> getChildResults()

getParent
```
public ServiceResult getParent()
```

setParent

protected void setParent(ServiceResult sr)

getMutator
```
public IMutator getMutator()
```

getLoopIndex
```
public int getLoopIndex()
```

getLoopQualifier

public String getLoopQualifier(Eval evalStruct)

getXmlResult
```
public String getXmlResult()
```

getResult
```
public String getResult()
```

setResultWMime

public void setResultWMime(String result,
                           String mimeType)

getError
```
public String getError()
```

getErrorDetail
```
public String getErrorDetail()
```

addError
```
public void addError(String msg)
```

addError

public void addError(String msg,
                     Throwable t)

addWarning
```
public void addWarning(String msg)
```

getMimeType
```
public String getMimeType()
```

setMimeType

public void setMimeType(String mimeHeader)

expectedTreewalkRangeMapToString

public String expectedTreewalkRangeMapToString()

setResponseHeaders

public void setResponseHeaders(org.apache.commons.httpclient.Header[] headers)

initExpectedCodeRanges
```
public void initExpectedCodeRanges(org.dom4j.Node testNode)
```
if xml sets no expected/code nodes, then DEFAULT_SUCCESS_RANGE is used.

getCurrentValidatorContextName

public String getCurrentValidatorContextName()

setCurrentValidatorContextName

public void setCurrentValidatorContextName(String name)

getVars
```
public Map<String,Object> getVars()
```

addVars

public void addVars(Map<String,Object> newVars)

getExports

public Map<String,Object> getExports()

addExports

public void addExports(Map<String,Object> newexports)

addExport

public void addExport(String key,
                      Object value)

beginTrappingExports
```
public void beginTrappingExports()
```

endTrappingExports

public List<String> endTrappingExports()

alertsCount

public int alertsCount(Alert.LEVEL level)

addPartSummary

public void addPartSummary(String label,
                           TreeWalkResults list)

partsSummary

public String partsSummary(boolean detailed)

partsSummaryHTML

public String partsSummaryHTML(boolean detailed)

codeInSuccessRange

public static boolean codeInSuccessRange(int code)

isSUCCESS
```
public boolean isSUCCESS()
```

createRangesForLevel

public static Map<TreeWalkResults.TreeWalkEntry.STATUS,Range> createRangesForLevel(ServiceResult.PAYLOAD_STRICTNESS strictness)

isDomWalkOK
```
public boolean isDomWalkOK()
```

isDomWalkOKByRanges

public boolean isDomWalkOKByRanges(Map<TreeWalkResults.TreeWalkEntry.STATUS,Range> expectedRangeMap)

overrideGotExpectedResult
```
public void overrideGotExpectedResult()
```
Call this method to create a ServiceResult mock object, for when you are doing autoDelete, and you come across a GET : GETs don't have a DELETE url, so they don't need to be autoDeleted, so an empty ServiceResult object signifies this.

gotExpectedResult
```
public boolean gotExpectedResult()
```

addRequestHeader

public void addRequestHeader(String name,
                             String value)

toString
```
public String toString()
```
Overrides:

toString in class Object

dumpPayloads
```
public String dumpPayloads()
```

detail

public String detail(boolean includePayloads)

minimal
```
public String minimal()
```

minimal

public String minimal(boolean verbosePartsSummary)

tiny
```
public String tiny()
```

dump

public String dump(ServiceResult.DUMP_OPTIONS opt,
                   boolean hasError)

got
```
public Object got(String pathExpression)
           throws Exception
```
This method may be called from a test case, using a syntax with XPath like this: ${testID3.got("//refName")} or with JSON, like this: ${testID3.got("$..refName")}

JsonPath docs say ALL expressions start with $.

An XPath could only start with a $ if you named an element like so: $myvariable. So don't do that.

If you know which syntax you want to use, see these variants: gotXPath(String) gotJson(String)

Parameters:

pathExpression - If this.result is JSON, as determined by contentTypeFromResponse(), then JsonPath is assumed, otherwise XPath is assumed.

Throws:

Exception

gotXPath

public Object gotXPath(String pathExpression)
                throws Exception

Throws:: Exception

gotJson

public Object gotJson(String jsonPath)

sent
```
public Object sent(String path)
            throws Exception
```
This method may be called from a test case, using a syntax with XPath like this: ${testID3.sent("//refName")} or with JSON, like this: ${testID3.sent("$..refName")}

JsonPath docs say ALL expressions start with $.

An XPath could only start with a $ if you named an element like so: $myvariable. So don't do that.

If you know which syntax you want to use, see these variants: sentXPath(String) sentJson(String)

Parameters:

path - If this.result is JSON, as determined by contentTypeFromResponse(), then JsonPath is assumed, otherwise XPath is assumed.

Throws:

Exception

sentXPath

public Object sentXPath(String path)
                 throws Exception

Throws:: Exception

sentXPath

public Object sentXPath(String xpath,
                        String source)
                 throws Exception

Throws:: Exception

sentJson

public Object sentJson(String jsonPath)

sentJson

public Object sentJson(String jsonPath,
                       String source)

get
```
public Object get(String what)
```

prettyPrintJSON

public static String prettyPrintJSON(String payload)

payloadJSONtoXML

public static String payloadJSONtoXML(String payload)

payloadXMLtoJSON

public static String payloadXMLtoJSON(String payload)

contentTypeFromResponse

public ServiceResult.PRETTY_FORMAT contentTypeFromResponse()

addAlert

public void addAlert(String message,
                     String context,
                     Alert.LEVEL level)

addAlertError

public void addAlertError(String message,
                          String context)

addAlertWarning

public void addAlertWarning(String message,
                            String context)

addAlertOK

public void addAlertOK(String message,
                       String context)

addAlertError

public void addAlertError(String message)

addAlertWarning

public void addAlertWarning(String message)

addAlertOK

public void addAlertOK(String message)

populateSerializedFields

public void populateSerializedFields()

Class ServiceResult

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sequence

reportMaster

reportDetail

controlFileName

testID

testGroupID

testIDLabel

idFromMutator

isMutation

mutatorType

mutator

mutationDetailBlockID

mutatorSkipped

mutatorSkippedByOpts

comment

isAutodelete

parentSkipped

loopIndex

fullURL

deleteURL

protoHostPort

location

CSID

subresourceCSID

requestPayloadFilename

requestPayload

requestPayloadsRaw

prettyJSON

time

responseCode

responseMessage

method

socketTimeout

connectionTimeout

fromTestID

auth

boundary

payloadStrictness

contentLength

failureReason

expectedFailure

expectedContentExpandedWasJson

expectedContentExpanded

expectedContentExpandedAsXml

expectedContentRaw

expectedResponseFilenameUsed

domcheck

expectedTreewalkRangeColumns

expectedTreewalkRangeMap

requestHeaderMap

responseHeaderMap

responseHeaders

responseHeadersDump

ranges

DEFAULT_SUCCESS_RANGE

alerts

overrideExpectedResult

gotExpectedResultBecause

payloads

calcGotExpectedResult

calcSuccessLabel

calcExpectedTreewalkRangeColumns

Constructor Detail

ServiceResult

Method Detail

getSequence

getRunOptions

addChild

getChildResults

getParent

setParent

getMutator

getLoopIndex