io.klerch.alexa.test.response

Class AlexaResponse

java.lang.Object

io.klerch.alexa.test.response.AlexaResponse

public class AlexaResponse
extends Object

The response object holds the skill speechlet response and provides a bunch of methods you can use to validate contents over assertions.

Constructor Summary

Constructors

Constructor and Description
AlexaResponse(AlexaRequest request, String requestPayload, String responsePayload)

Method Summary

Modifier and Type	Method and Description
AlexaResponse	assertContains(String jsonPathExpression, String s)
AlexaResponse	assertEquals(String jsonPathExpression, Object o)
AlexaResponse	assertExecutionTimeLessThan(long millis) Validates the execution time of the request call to the skill.
AlexaResponse	assertExists(String jsonPathExpression)
AlexaResponse	assertFalse(String jsonPathExpression)
AlexaResponse	assertNotExists(String jsonPathExpression)
AlexaResponse	assertThat(Predicate<com.amazon.speech.json.SpeechletResponseEnvelope> responseEnvelope) Validates a custom predicate executed against the response envelope.
AlexaResponse	assertThat(String jsonPathExpression) Validates a custom json-path expression throws an IllegalArgumentException in the expression does not return an element
AlexaResponse	assertTrue(String jsonPathExpression)
boolean	contains(String jsonPathExpression, String s)
AlexaSession	done() exits the fluent interface and returns the actor in order to continue with next skill request.
boolean	equals(String jsonPathExpression, Object o)
boolean	exists(String jsonPathExpression)
Optional<String>	get(String jsonPath)
AlexaRequest	getRequest()
com.amazon.speech.json.SpeechletResponseEnvelope	getResponseEnvelope()
AlexaResponse	ifContains(String jsonPathExpression, String s, Consumer<AlexaSession> followUp)
AlexaResponse	ifEquals(String jsonPathExpression, Object o, Consumer<AlexaSession> followUp)
AlexaResponse	ifExists(String jsonPathExpression, Consumer<AlexaSession> followUp)
AlexaResponse	ifFalse(String jsonPathExpression, Consumer<AlexaSession> followUp)
AlexaResponse	ifIs(String jsonPathExpression, Consumer<AlexaSession> followUp) Validates a custom predicate executed against the response envelope.
AlexaResponse	ifNotExists(String jsonPathExpression, Consumer<AlexaSession> followUp)
AlexaResponse	ifTrue(String jsonPathExpression, Consumer<AlexaSession> followUp)
boolean	is(Predicate<com.amazon.speech.json.SpeechletResponseEnvelope> responseEnvelope) Validates a custom predicate executed against the response envelope.
AlexaResponse	is(Predicate<com.amazon.speech.json.SpeechletResponseEnvelope> responseEnvelope, Consumer<AlexaSession> followUp) Validates a custom predicate executed against the response envelope.
boolean	is(String jsonPathExpression) Validates a custom json-path expression
boolean	isEmpty() An AlexaResponse is empty for requests that do not get a response from the skill e.g.
boolean	isFalse(String jsonPathExpression)
boolean	isTrue(String jsonPathExpression)
boolean	notExists(String jsonPathExpression)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlexaResponse

public AlexaResponse(AlexaRequest request,
                     String requestPayload,
                     String responsePayload)

Method Detail

getResponseEnvelope

public com.amazon.speech.json.SpeechletResponseEnvelope getResponseEnvelope()

getRequest

public AlexaRequest getRequest()

get

public Optional<String> get(String jsonPath)

isEmpty

public boolean isEmpty()

An AlexaResponse is empty for requests that do not get a response from the skill e.g. the SessionStartedRequest.

Returns:

True, if there wasn't a response.

assertExecutionTimeLessThan

public AlexaResponse assertExecutionTimeLessThan(long millis)

Validates the execution time of the request call to the skill. It throws an IllegalArgumentException in case the execution time exceeded the milliseconds given

Parameters:

millis - milliseconds (inclusive) that should not be exceeded by the skill call

Returns:

this response

assertThat

public AlexaResponse assertThat(Predicate<com.amazon.speech.json.SpeechletResponseEnvelope> responseEnvelope)

Validates a custom predicate executed against the response envelope. It throws an IllegalArgumentException in case the predicate is not true.

Parameters:

responseEnvelope - the response envelope of the request

Returns:

this response

assertThat

public AlexaResponse assertThat(String jsonPathExpression)

Validates a custom json-path expression throws an IllegalArgumentException in the expression does not return an element

Parameters:

jsonPathExpression - a json-path expression

Returns:

this response

assertTrue

public AlexaResponse assertTrue(String jsonPathExpression)

assertFalse

public AlexaResponse assertFalse(String jsonPathExpression)

assertExists

public AlexaResponse assertExists(String jsonPathExpression)

assertNotExists

public AlexaResponse assertNotExists(String jsonPathExpression)

assertEquals

public AlexaResponse assertEquals(String jsonPathExpression,
                                  Object o)

assertContains

public AlexaResponse assertContains(String jsonPathExpression,
                                    String s)

is

public boolean is(Predicate<com.amazon.speech.json.SpeechletResponseEnvelope> responseEnvelope)

Validates a custom predicate executed against the response envelope.

Parameters:

responseEnvelope - the response envelope of the request

Returns:

True, if predicate is true

is

public boolean is(String jsonPathExpression)

Validates a custom json-path expression

Parameters:

jsonPathExpression - a json-path expression

Returns:

True, if expression returns an element

is

public AlexaResponse is(Predicate<com.amazon.speech.json.SpeechletResponseEnvelope> responseEnvelope,
                        Consumer<AlexaSession> followUp)

Validates a custom predicate executed against the response envelope.

Parameters:

responseEnvelope - the response envelope of the request

followUp - code-block executes when condition is true

Returns:

this response

ifIs

public AlexaResponse ifIs(String jsonPathExpression,
                          Consumer<AlexaSession> followUp)

Validates a custom predicate executed against the response envelope.

Parameters:

jsonPathExpression - the response envelope of the request

followUp - code-block executes when condition is true

Returns:

this response

isTrue

public boolean isTrue(String jsonPathExpression)

isFalse

public boolean isFalse(String jsonPathExpression)

exists

public boolean exists(String jsonPathExpression)

notExists

public boolean notExists(String jsonPathExpression)

equals

public boolean equals(String jsonPathExpression,
                      Object o)

contains

public boolean contains(String jsonPathExpression,
                        String s)

ifTrue

public AlexaResponse ifTrue(String jsonPathExpression,
                            Consumer<AlexaSession> followUp)

ifFalse

public AlexaResponse ifFalse(String jsonPathExpression,
                             Consumer<AlexaSession> followUp)

ifExists

public AlexaResponse ifExists(String jsonPathExpression,
                              Consumer<AlexaSession> followUp)

ifNotExists

public AlexaResponse ifNotExists(String jsonPathExpression,
                                 Consumer<AlexaSession> followUp)

ifEquals

public AlexaResponse ifEquals(String jsonPathExpression,
                              Object o,
                              Consumer<AlexaSession> followUp)

ifContains

public AlexaResponse ifContains(String jsonPathExpression,
                                String s,
                                Consumer<AlexaSession> followUp)

done

public AlexaSession done()

exits the fluent interface and returns the actor in order to continue with next skill request.

Returns:

actor