alexaClientSDK::capabilityAgents::toggleController::test Namespace Reference

Classes
class	MockToggleControllerInterface
class	ToggleControllerCapabilityAgentTest

Typedefs
using	EndpointIdentifier = endpoints::EndpointIdentifier

Functions
static std::chrono::milliseconds	TIMEOUT (1000)
	Timeout when waiting for futures to be set. More...
static const EndpointIdentifier	TEST_ENDPOINT_ID ("testEndpointId")
	The test EndpointId. More...
static const EndpointIdentifier	TEST_INSTANCE ("testInstance")
	The test instance. More...
static const std::string	EVENT ("event")
	Event key. More...
static const std::string	HEADER ("header")
	Header key. More...
static const std::string	MESSAGE_ID ("messageId")
	MessageId key. More...
static const std::string	MESSAGE_ID_TEST ("MessageId_Test")
	MessageId for testing. More...
static const std::string	DIALOG_REQUEST_ID ("dialogRequestId")
	Dialog request Id key. More...
static const std::string	DIALOG_REQUEST_ID_TEST ("DialogRequestId_Test")
	DialogRequestId for testing. More...
static const std::string	CORRELATION_TOKEN ("correlationToken")
	Correlation token key. More...
static const std::string	CORRELATION_TOKEN_TEST ("CorrelationToken_Test")
	Correlation token for testing. More...
static const std::string	EVENT_CORRELATION_TOKEN ("eventCorrelationToken")
	Event correlation token key. More...
static const std::string	EVENT_CORRELATION_TOKEN_TEST ("EventCorrelationToken_Test")
	Event correlation for testing. More...
static const std::string	TIME_OF_SAMPLE ("timeOfSample")
	Time of sample key. More...
static const std::string	TIME_OF_SAMPLE_TEST ("2017-02-03T16:20:50.523Z")
	Time of sample used for testing. More...
static std::shared_ptr< AVSDirective >	buildAVSDirective (std::string directiveName)
	TEST_F (ToggleControllerCapabilityAgentTest, test_givenInvalidParameters_create_shouldFail)
	Test that create() returns a nullptr if called with invalid arguments. More...
	TEST_F (ToggleControllerCapabilityAgentTest, test_turnOnDirective_successCase)
	TEST_F (ToggleControllerCapabilityAgentTest, test_turnOnDirective_errorCase)
	TEST_F (ToggleControllerCapabilityAgentTest, test_turnOffDirective_successCase)
	TEST_F (ToggleControllerCapabilityAgentTest, test_turnOffDirective_errorCase)
	TEST_F (ToggleControllerCapabilityAgentTest, test_reportStateChange_successCase)
	TEST_F (ToggleControllerCapabilityAgentTest, test_reportStateChange_errorCase)
	TEST_F (ToggleControllerCapabilityAgentTest, test_unknownDirectiveWithProactivelyReportedAndRetrievableTrue)
	TEST_F (ToggleControllerCapabilityAgentTest, test_unknownDirectiveWithProactivelyReportedAndRetrievableFalse)

Variables
static const std::string	NAMESPACE {"Alexa.ToggleController"}
	The namespace for capability agent. More...
static const std::string	INTERFACE_VERSION {"3"}
	The supported version. More...
static const std::string	NAME_TURNON {"TurnOn"}
	The name for TurnOn directive. More...
static const std::string	NAME_TURNOFF {"TurnOff"}
	The name for TurnOff directive. More...
static const std::string	TOGGLESTATE_PROPERTY_NAME {"toggleState"}
	The name for toggleState property. More...
static const std::string	UNKNOWN_DIRECTIVE {"Unknown"}
	An unknown directive signature. More...

Typedef Documentation

EndpointIdentifier

using alexaClientSDK::capabilityAgents::toggleController::test::EndpointIdentifier = typedef endpoints::EndpointIdentifier

Function Documentation

buildAVSDirective()

static std::shared_ptr<AVSDirective> alexaClientSDK::capabilityAgents::toggleController::test::buildAVSDirective ( std::string  directiveName )

static

Utility function to build the AVSDirective for test.

Parameters

directiveName

The name of the test directive to build.

Returns

The created AVSDirective object or nullptr if build failed.

CORRELATION_TOKEN()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::CORRELATION_TOKEN ( "correlationToken"  )

static

Correlation token key.

CORRELATION_TOKEN_TEST()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::CORRELATION_TOKEN_TEST ( "CorrelationToken_Test"  )

static

Correlation token for testing.

DIALOG_REQUEST_ID()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::DIALOG_REQUEST_ID ( "dialogRequestId"  )

static

Dialog request Id key.

DIALOG_REQUEST_ID_TEST()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::DIALOG_REQUEST_ID_TEST ( "DialogRequestId_Test"  )

static

DialogRequestId for testing.

EVENT()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::EVENT ( "event"  )

static

Event key.

EVENT_CORRELATION_TOKEN()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::EVENT_CORRELATION_TOKEN ( "eventCorrelationToken"  )

static

Event correlation token key.

EVENT_CORRELATION_TOKEN_TEST()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::EVENT_CORRELATION_TOKEN_TEST ( "EventCorrelationToken_Test"  )

static

Event correlation for testing.

HEADER()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::HEADER ( "header"  )

static

Header key.

MESSAGE_ID()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::MESSAGE_ID ( "messageId"  )

static

MessageId key.

MESSAGE_ID_TEST()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::MESSAGE_ID_TEST ( "MessageId_Test"  )

static

MessageId for testing.

TEST_ENDPOINT_ID()

static const EndpointIdentifier alexaClientSDK::capabilityAgents::toggleController::test::TEST_ENDPOINT_ID ( "testEndpointId"  )

static

The test EndpointId.

TEST_F() [1/9]

alexaClientSDK::capabilityAgents::toggleController::test::TEST_F	(	ToggleControllerCapabilityAgentTest	,
		test_givenInvalidParameters_create_shouldFail
	)

Test that create() returns a nullptr if called with invalid arguments.

TEST_F() [2/9]

alexaClientSDK::capabilityAgents::toggleController::test::TEST_F	(	ToggleControllerCapabilityAgentTest	,
		test_turnOnDirective_successCase
	)

Test successful handling of TurnOn directive.

TEST_F() [3/9]

alexaClientSDK::capabilityAgents::toggleController::test::TEST_F	(	ToggleControllerCapabilityAgentTest	,
		test_turnOnDirective_errorCase
	)

Test error path of TurnOn directive.

TEST_F() [4/9]

alexaClientSDK::capabilityAgents::toggleController::test::TEST_F	(	ToggleControllerCapabilityAgentTest	,
		test_turnOffDirective_successCase
	)

Test successful handling of TurnOff directive.

TEST_F() [5/9]

alexaClientSDK::capabilityAgents::toggleController::test::TEST_F	(	ToggleControllerCapabilityAgentTest	,
		test_turnOffDirective_errorCase
	)

Test error path of TurnOff directive.

TEST_F() [6/9]

alexaClientSDK::capabilityAgents::toggleController::test::TEST_F	(	ToggleControllerCapabilityAgentTest	,
		test_reportStateChange_successCase
	)

Test triggering of reportStateChange and subsequent call to the ContextManager to build the context.

TEST_F() [7/9]

alexaClientSDK::capabilityAgents::toggleController::test::TEST_F	(	ToggleControllerCapabilityAgentTest	,
		test_reportStateChange_errorCase
	)

Test triggering of reportStateChange and subsequent failure to get the getToggleState and call to the ContextManager to report the failure.

TEST_F() [8/9]

alexaClientSDK::capabilityAgents::toggleController::test::TEST_F	(	ToggleControllerCapabilityAgentTest	,
		test_unknownDirectiveWithProactivelyReportedAndRetrievableTrue
	)

Tests unknown Directive with both proactively reported and retrievable set. Expect that the sendExceptionEncountered and setFailed will be called.

TEST_F() [9/9]

alexaClientSDK::capabilityAgents::toggleController::test::TEST_F	(	ToggleControllerCapabilityAgentTest	,
		test_unknownDirectiveWithProactivelyReportedAndRetrievableFalse
	)

Tests unknown Directive with both proactively reported and retrievable as false. Expect that the sendExceptionEncountered and setFailed will be called.

TEST_INSTANCE()

static const EndpointIdentifier alexaClientSDK::capabilityAgents::toggleController::test::TEST_INSTANCE ( "testInstance"  )

static

The test instance.

TIME_OF_SAMPLE()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::TIME_OF_SAMPLE ( "timeOfSample"  )

static

Time of sample key.

TIME_OF_SAMPLE_TEST()

static const std::string alexaClientSDK::capabilityAgents::toggleController::test::TIME_OF_SAMPLE_TEST ( "2017-02-03T16:20:50.523Z"  )

static

Time of sample used for testing.

TIMEOUT()

static std::chrono::milliseconds alexaClientSDK::capabilityAgents::toggleController::test::TIMEOUT ( 1000  )

static

Timeout when waiting for futures to be set.

Variable Documentation

INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::toggleController::test::INTERFACE_VERSION {"3"}

static

The supported version.

NAME_TURNOFF

const std::string alexaClientSDK::capabilityAgents::toggleController::test::NAME_TURNOFF {"TurnOff"}

static

The name for TurnOff directive.

NAME_TURNON

const std::string alexaClientSDK::capabilityAgents::toggleController::test::NAME_TURNON {"TurnOn"}

static

The name for TurnOn directive.

NAMESPACE

const std::string alexaClientSDK::capabilityAgents::toggleController::test::NAMESPACE {"Alexa.ToggleController"}

static

The namespace for capability agent.

TOGGLESTATE_PROPERTY_NAME

const std::string alexaClientSDK::capabilityAgents::toggleController::test::TOGGLESTATE_PROPERTY_NAME {"toggleState"}

static

The name for toggleState property.

UNKNOWN_DIRECTIVE

const std::string alexaClientSDK::capabilityAgents::toggleController::test::UNKNOWN_DIRECTIVE {"Unknown"}

static

An unknown directive signature.