AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest Class Reference
Inheritance diagram for alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest:
Collaboration graph
[legend]

Public Member Functions

void SetUp () override
 
void TearDown () override
 
void initializeCapabilityAgent ()
 
void sendSetIndicatorDirective (const std::string &payload, const std::string &messageId)
 
void sendClearIndicatorDirective (const std::string &messageId)
 
const std::string generatePayload (bool persistVisualIndicator, bool playAudioIndicator, const std::string &assetId=ASSET_ID1, const std::string &assetUrl=ASSET_URL1)
 
- Public Member Functions inherited from testing::Test
virtual ~Test ()
 

Public Attributes

std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterfacem_metricRecorder
 The metric recorder. More...
 
std::shared_ptr< TestNotificationsObserverm_testNotificationsObserver
 A test observer to wait for AudioPlayer state changes More...
 
std::shared_ptr< NotificationsCapabilityAgentm_notificationsCapabilityAgent
 NotificationsCapabilityAgent to test More...
 
std::shared_ptr< TestNotificationsStoragem_notificationsStorage
 Storage for notifications More...
 
std::shared_ptr< MockNotificationRendererm_renderer
 Player to play notification audio assets. More...
 
std::shared_ptr< MockContextManagerm_mockContextManager
 ContextManager to provide state and update state. More...
 
std::unique_ptr< MockDirectiveHandlerResultm_mockDirectiveHandlerResult
 A directive handler result to send the result to. More...
 
std::shared_ptr< MockExceptionEncounteredSenderm_mockExceptionSender
 An exception sender used to send exception encountered events to AVS. More...
 
std::shared_ptr< StubAudioFactorym_stubAudioFactory
 A audio factory for testing. More...
 
std::shared_ptr< TestNotificationsAudioFactorym_testNotificationsAudioFactory
 A notifications audio factory for testing. More...
 
acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterfacem_mockEndpointCapabilitiesRegistrar
 An endpoint capabilities registrar with which to register the Bluetooth CA. More...
 
std::shared_ptr< acsdkShutdownManagerInterfaces::test::MockShutdownNotifierm_shutdownNotifier
 Mock ShutdownNotifier. More...
 
std::mutex m_mutex
 Serializes access to m_setIndicatorTrigger. More...
 
std::condition_variable m_setIndicatorTrigger
 Triggers threads waiting on a SetIndicator directive to be processed. More...
 
std::shared_ptr< NiceMock< registrationManager::MockCustomerDataManager > > m_dataManager
 Shared pointer to CustomerDataManager. More...
 
unsigned int m_numSetIndicatorsProcessed
 A count of how many SetIndicator directives have been processed. More...
 

Additional Inherited Members

- Public Types inherited from testing::Test
typedef internal::SetUpTestCaseFunc SetUpTestCaseFunc
 
typedef internal::TearDownTestCaseFunc TearDownTestCaseFunc
 
- Static Public Member Functions inherited from testing::Test
static void SetUpTestCase ()
 
static void TearDownTestCase ()
 
static bool HasFatalFailure ()
 
static bool HasNonfatalFailure ()
 
static bool HasFailure ()
 
static void RecordProperty (const std::string &key, const std::string &value)
 
static void RecordProperty (const std::string &key, int value)
 
- Protected Member Functions inherited from testing::Test
 Test ()
 

Member Function Documentation

◆ generatePayload()

const std::string alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::generatePayload ( bool  persistVisualIndicator,
bool  playAudioIndicator,
const std::string &  assetId = ASSET_ID1,
const std::string &  assetUrl = ASSET_URL1 
)

Utility function to generate direcive payloads

◆ initializeCapabilityAgent()

void alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::initializeCapabilityAgent ( )

Utility function to create the capability agent. This allows modifying of subcomponents before the CA is created.

◆ sendClearIndicatorDirective()

void alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::sendClearIndicatorDirective ( const std::string &  messageId)

Utility function to send ClearIndicatorDirective

◆ sendSetIndicatorDirective()

void alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::sendSetIndicatorDirective ( const std::string &  payload,
const std::string &  messageId 
)

Utility function to send SetIndicatorDirective

◆ SetUp()

void alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::SetUp ( )
overridevirtual

Reimplemented from testing::Test.

◆ TearDown()

void alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::TearDown ( )
overridevirtual

Reimplemented from testing::Test.

Member Data Documentation

◆ m_dataManager

std::shared_ptr<NiceMock<registrationManager::MockCustomerDataManager> > alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_dataManager

Shared pointer to CustomerDataManager.

◆ m_metricRecorder

std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_metricRecorder

The metric recorder.

◆ m_mockContextManager

std::shared_ptr<MockContextManager> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_mockContextManager

ContextManager to provide state and update state.

◆ m_mockDirectiveHandlerResult

std::unique_ptr<MockDirectiveHandlerResult> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_mockDirectiveHandlerResult

A directive handler result to send the result to.

◆ m_mockEndpointCapabilitiesRegistrar

acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_mockEndpointCapabilitiesRegistrar

An endpoint capabilities registrar with which to register the Bluetooth CA.

◆ m_mockExceptionSender

std::shared_ptr<MockExceptionEncounteredSender> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_mockExceptionSender

An exception sender used to send exception encountered events to AVS.

◆ m_mutex

std::mutex alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_mutex

Serializes access to m_setIndicatorTrigger.

◆ m_notificationsCapabilityAgent

std::shared_ptr<NotificationsCapabilityAgent> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_notificationsCapabilityAgent

◆ m_notificationsStorage

std::shared_ptr<TestNotificationsStorage> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_notificationsStorage

Storage for notifications

◆ m_numSetIndicatorsProcessed

unsigned int alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_numSetIndicatorsProcessed

A count of how many SetIndicator directives have been processed.

◆ m_renderer

std::shared_ptr<MockNotificationRenderer> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_renderer

Player to play notification audio assets.

◆ m_setIndicatorTrigger

std::condition_variable alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_setIndicatorTrigger

Triggers threads waiting on a SetIndicator directive to be processed.

◆ m_shutdownNotifier

std::shared_ptr<acsdkShutdownManagerInterfaces::test::MockShutdownNotifier> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_shutdownNotifier

Mock ShutdownNotifier.

◆ m_stubAudioFactory

std::shared_ptr<StubAudioFactory> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_stubAudioFactory

A audio factory for testing.

◆ m_testNotificationsAudioFactory

std::shared_ptr<TestNotificationsAudioFactory> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_testNotificationsAudioFactory

A notifications audio factory for testing.

◆ m_testNotificationsObserver

std::shared_ptr<TestNotificationsObserver> alexaClientSDK::acsdkNotifications::test::NotificationsCapabilityAgentTest::m_testNotificationsObserver

A test observer to wait for AudioPlayer state changes


The documentation for this class was generated from the following file:

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0