Classes
class	MockModeControllerInterface

class	ModeControllerCapabilityAgentTest

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, std::string payload)

	TEST_F (ModeControllerCapabilityAgentTest, test_givenInvalidParameters_create_shouldFail)
	Test that create() returns a nullptr if called with invalid arguments. More...

	TEST_F (ModeControllerCapabilityAgentTest, test_setModeDirective_successCase)

	TEST_F (ModeControllerCapabilityAgentTest, test_setModeDirective_errorCase)

	TEST_F (ModeControllerCapabilityAgentTest, test_adjustModeValueDirective_successCase)

	TEST_F (ModeControllerCapabilityAgentTest, test_adjustModeValueDirective_errorCase)

	TEST_F (ModeControllerCapabilityAgentTest, test_reportStateChange_successCase)

	TEST_F (ModeControllerCapabilityAgentTest, test_reportStateChange_errorCase)

	TEST_F (ModeControllerCapabilityAgentTest, test_unknownDirectiveWithProactivelyReportedAndRetrievableTrue)

	TEST_F (ModeControllerCapabilityAgentTest, test_unknownDirectiveWithProactivelyReportedAndRetrievableFalse)

Variables
static const std::string	NAMESPACE {"Alexa.ModeController"}
	The namespace for capability agent. More...

static const std::string	INTERFACE_VERSION {"3"}
	The supported version. More...

static const std::string	NAME_SETMODE {"SetMode"}
	The name for SetMode directive. More...

static const std::string	NAME_ADJUSTMODE {"AdjustMode"}
	The name for AdjustMode directive. More...

static const std::string	MODE_PROPERTY_NAME {"mode"}
	The name for modeValue property. More...

static const std::string	UNKNOWN_DIRECTIVE {"Unknown"}
	An unknown directive signature. More...

static std::string	MODE_OPEN = "open"
	Mode for testing. More...

static std::string	MODE_CLOSED = "close"
	Mode for testing. More...

static int	MODE_DELTA = 1
	Mode Delta for testing. More...

static const std::string	SET_MODE_PAYLOAD_TEST
	SetModeValue payload for testing. More...

static const std::string	ADJUST_MODE_PAYLOAD_TEST
	AdjustModeValue payload for testing. More...

Typedef Documentation

◆ EndpointIdentifier

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

Function Documentation

◆ buildAVSDirective()

static std::shared_ptr<AVSDirective> alexaClientSDK::capabilityAgents::modeController::test::buildAVSDirective	(	std::string	directiveName,
		std::string	payload
	)

static

Utility function to build the AVSDirective for test.

Parameters

directiveName	The name of the test directive to build.
payload	The unparsed payload of directive in JSON.

Returns: The created AVSDirective object or nullptr if build failed.

◆ CORRELATION_TOKEN()

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

static

Correlation token key.

◆ CORRELATION_TOKEN_TEST()

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

static

Correlation token for testing.

◆ DIALOG_REQUEST_ID()

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

static

Dialog request Id key.

◆ DIALOG_REQUEST_ID_TEST()

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

static

DialogRequestId for testing.

◆ EVENT()

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

static

Event key.

◆ EVENT_CORRELATION_TOKEN()

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

static

Event correlation token key.

◆ EVENT_CORRELATION_TOKEN_TEST()

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

static

Event correlation for testing.

◆ HEADER()

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

static

Header key.

◆ MESSAGE_ID()

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

static

MessageId key.

◆ MESSAGE_ID_TEST()

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

static

MessageId for testing.

◆ TEST_ENDPOINT_ID()

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

static

The test EndpointId.

◆ TEST_F() [1/9]

alexaClientSDK::capabilityAgents::modeController::test::TEST_F	(	ModeControllerCapabilityAgentTest	,
		test_givenInvalidParameters_create_shouldFail
	)

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

◆ TEST_F() [2/9]

alexaClientSDK::capabilityAgents::modeController::test::TEST_F	(	ModeControllerCapabilityAgentTest	,
		test_setModeDirective_successCase
	)

Test successful handling of SetMode directive.

◆ TEST_F() [3/9]

alexaClientSDK::capabilityAgents::modeController::test::TEST_F	(	ModeControllerCapabilityAgentTest	,
		test_setModeDirective_errorCase
	)

Test error path of SetMode directive.

◆ TEST_F() [4/9]

alexaClientSDK::capabilityAgents::modeController::test::TEST_F	(	ModeControllerCapabilityAgentTest	,
		test_adjustModeValueDirective_successCase
	)

Test successful handling of AdjustMode directive.

◆ TEST_F() [5/9]

alexaClientSDK::capabilityAgents::modeController::test::TEST_F	(	ModeControllerCapabilityAgentTest	,
		test_adjustModeValueDirective_errorCase
	)

Test error path of AdjustMode directive.

◆ TEST_F() [6/9]

alexaClientSDK::capabilityAgents::modeController::test::TEST_F	(	ModeControllerCapabilityAgentTest	,
		test_reportStateChange_successCase
	)

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

◆ TEST_F() [7/9]

alexaClientSDK::capabilityAgents::modeController::test::TEST_F	(	ModeControllerCapabilityAgentTest	,
		test_reportStateChange_errorCase
	)

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

◆ TEST_F() [8/9]

alexaClientSDK::capabilityAgents::modeController::test::TEST_F	(	ModeControllerCapabilityAgentTest	,
		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::modeController::test::TEST_F	(	ModeControllerCapabilityAgentTest	,
		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::modeController::test::TEST_INSTANCE ( "testInstance" )

static

The test instance.

◆ TIME_OF_SAMPLE()

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

static

Time of sample key.

◆ TIME_OF_SAMPLE_TEST()

static const std::string alexaClientSDK::capabilityAgents::modeController::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::modeController::test::TIMEOUT ( 1000 )

static

Timeout when waiting for futures to be set.

Variable Documentation

◆ ADJUST_MODE_PAYLOAD_TEST

const std::string alexaClientSDK::capabilityAgents::modeController::test::ADJUST_MODE_PAYLOAD_TEST

static

Initial value:

= R"({
    "modeDelta":1
})"

AdjustModeValue payload for testing.

◆ INTERFACE_VERSION

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

static

The supported version.

◆ MODE_CLOSED

std::string alexaClientSDK::capabilityAgents::modeController::test::MODE_CLOSED = "close"

static

Mode for testing.

◆ MODE_DELTA

int alexaClientSDK::capabilityAgents::modeController::test::MODE_DELTA = 1

static

Mode Delta for testing.

◆ MODE_OPEN

std::string alexaClientSDK::capabilityAgents::modeController::test::MODE_OPEN = "open"

static

Mode for testing.

◆ MODE_PROPERTY_NAME

const std::string alexaClientSDK::capabilityAgents::modeController::test::MODE_PROPERTY_NAME {"mode"}

static

The name for modeValue property.

◆ NAME_ADJUSTMODE

const std::string alexaClientSDK::capabilityAgents::modeController::test::NAME_ADJUSTMODE {"AdjustMode"}

static

The name for AdjustMode directive.

◆ NAME_SETMODE

const std::string alexaClientSDK::capabilityAgents::modeController::test::NAME_SETMODE {"SetMode"}

static

The name for SetMode directive.

◆ NAMESPACE

const std::string alexaClientSDK::capabilityAgents::modeController::test::NAMESPACE {"Alexa.ModeController"}

static

The namespace for capability agent.

◆ SET_MODE_PAYLOAD_TEST

const std::string alexaClientSDK::capabilityAgents::modeController::test::SET_MODE_PAYLOAD_TEST

static

Initial value:

= R"({
    "mode":")" + MODE_OPEN + R"("
})"

SetModeValue payload for testing.

◆ UNKNOWN_DIRECTIVE

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

static

An unknown directive signature.

Classes

Typedefs

Functions

Variables

Typedef Documentation

◆ EndpointIdentifier

Function Documentation

◆ buildAVSDirective()

◆ CORRELATION_TOKEN()

◆ CORRELATION_TOKEN_TEST()

◆ DIALOG_REQUEST_ID()

◆ DIALOG_REQUEST_ID_TEST()

◆ EVENT()

◆ EVENT_CORRELATION_TOKEN()

◆ EVENT_CORRELATION_TOKEN_TEST()

◆ HEADER()

◆ MESSAGE_ID()

◆ MESSAGE_ID_TEST()

◆ TEST_ENDPOINT_ID()

◆ TEST_F() [1/9]

◆ TEST_F() [2/9]

◆ TEST_F() [3/9]

◆ TEST_F() [4/9]

◆ TEST_F() [5/9]

◆ TEST_F() [6/9]

◆ TEST_F() [7/9]

◆ TEST_F() [8/9]

◆ TEST_F() [9/9]

◆ TEST_INSTANCE()

◆ TIME_OF_SAMPLE()

◆ TIME_OF_SAMPLE_TEST()

◆ TIMEOUT()

Variable Documentation

◆ ADJUST_MODE_PAYLOAD_TEST

◆ INTERFACE_VERSION

◆ MODE_CLOSED

◆ MODE_DELTA

◆ MODE_OPEN

◆ MODE_PROPERTY_NAME

◆ NAME_ADJUSTMODE

◆ NAME_SETMODE

◆ NAMESPACE

◆ SET_MODE_PAYLOAD_TEST

◆ UNKNOWN_DIRECTIVE