2017-10-30 22:14:38 +00:00
|
|
|
/*
|
|
|
|
* TemplateRuntimeTest.cpp
|
|
|
|
*
|
|
|
|
* Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License").
|
|
|
|
* You may not use this file except in compliance with the License.
|
|
|
|
* A copy of the License is located at
|
|
|
|
*
|
|
|
|
* http://aws.amazon.com/apache2.0/
|
|
|
|
*
|
|
|
|
* or in the "license" file accompanying this file. This file is distributed
|
|
|
|
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
|
|
|
|
* express or implied. See the License for the specific language governing
|
|
|
|
* permissions and limitations under the License.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/// @file TemplateRuntimeTest
|
|
|
|
#include <memory>
|
|
|
|
|
|
|
|
#include <gmock/gmock.h>
|
|
|
|
#include <gtest/gtest.h>
|
|
|
|
#include <rapidjson/document.h>
|
|
|
|
|
|
|
|
#include <AVSCommon/AVS/Attachment/MockAttachmentManager.h>
|
|
|
|
#include <AVSCommon/SDKInterfaces/AudioPlayerInterface.h>
|
|
|
|
#include <AVSCommon/SDKInterfaces/AudioPlayerObserverInterface.h>
|
|
|
|
#include <AVSCommon/SDKInterfaces/MockDirectiveHandlerResult.h>
|
|
|
|
#include <AVSCommon/SDKInterfaces/MockExceptionEncounteredSender.h>
|
|
|
|
#include <AVSCommon/SDKInterfaces/TemplateRuntimeObserverInterface.h>
|
|
|
|
#include <AVSCommon/Utils/JSON/JSONUtils.h>
|
|
|
|
#include <AVSCommon/Utils/Memory/Memory.h>
|
|
|
|
|
|
|
|
#include "TemplateRuntime/TemplateRuntime.h"
|
|
|
|
|
|
|
|
namespace alexaClientSDK {
|
|
|
|
namespace capabilityAgents {
|
|
|
|
namespace templateRuntime {
|
|
|
|
namespace test {
|
|
|
|
|
|
|
|
using namespace avsCommon::avs;
|
|
|
|
using namespace avsCommon::avs::attachment::test;
|
|
|
|
using namespace avsCommon::sdkInterfaces;
|
|
|
|
using namespace avsCommon::sdkInterfaces::test;
|
|
|
|
using namespace avsCommon::utils::memory;
|
|
|
|
using namespace rapidjson;
|
|
|
|
using namespace ::testing;
|
|
|
|
|
|
|
|
/// Timeout when waiting for futures to be set.
|
|
|
|
static std::chrono::milliseconds TIMEOUT(1000);
|
|
|
|
|
|
|
|
/// The namespace for this capability agent.
|
|
|
|
static const std::string NAMESPACE{"TemplateRuntime"};
|
|
|
|
|
|
|
|
/// An unknown directive signature.
|
|
|
|
static const std::string UNKNOWN_DIRECTIVE{"Unknown"};
|
|
|
|
|
|
|
|
/// The RenderTemplate directive signature.
|
|
|
|
static const NamespaceAndName TEMPLATE{NAMESPACE, "RenderTemplate"};
|
|
|
|
|
|
|
|
/// The RenderPlayerInfo directive signature.
|
|
|
|
static const NamespaceAndName PLAYER_INFO{NAMESPACE, "RenderPlayerInfo"};
|
|
|
|
|
|
|
|
/// The @c MessageId identifer.
|
|
|
|
static const std::string MESSAGE_ID("messageId");
|
|
|
|
|
|
|
|
/// An audioItemId for the RenderPlayerInfo directive.
|
|
|
|
static const std::string AUDIO_ITEM_ID("AudioItemId abcdefgh");
|
|
|
|
|
|
|
|
/// An audioItemId without a corresponding RenderPlayerInfo directive.
|
|
|
|
static const std::string AUDIO_ITEM_ID_1("AudioItemId 12345678");
|
|
|
|
|
|
|
|
/// A RenderTemplate directive payload.
|
|
|
|
// clang-format off
|
|
|
|
static const std::string TEMPLATE_PAYLOAD = "{"
|
|
|
|
"\"token\":\"TOKEN1\","
|
|
|
|
"\"type\":\"BodyTemplate1\","
|
|
|
|
"\"title\":{"
|
|
|
|
"\"mainTitle\":\"MAIN_TITLE\","
|
|
|
|
"\"subTitle\":\"SUB_TITLE\""
|
|
|
|
"}"
|
|
|
|
"}";
|
|
|
|
// clang-format on
|
|
|
|
|
|
|
|
/// A RenderPlayerInfo directive payload.
|
|
|
|
// clang-format off
|
|
|
|
static const std::string PLAYERINFO_PAYLOAD = "{"
|
|
|
|
"\"audioItemId\":\"" + AUDIO_ITEM_ID + "\","
|
|
|
|
"\"content\":{"
|
|
|
|
"\"title\":\"TITLE\","
|
|
|
|
"\"header\":\"HEADER\""
|
|
|
|
"}"
|
|
|
|
"}";
|
|
|
|
// clang-format on
|
|
|
|
|
|
|
|
/// A malformed RenderPlayerInfo directive payload.
|
|
|
|
// clang-format off
|
|
|
|
static const std::string MALFORM_PLAYERINFO_PAYLOAD = "{"
|
|
|
|
"\"audioItemId\"::::\"" + AUDIO_ITEM_ID + "\","
|
|
|
|
"\"content\":{{{{"
|
|
|
|
"\"title\":\"TITLE\","
|
|
|
|
"\"header\":\"HEADER\""
|
|
|
|
"}"
|
|
|
|
"}";
|
|
|
|
// clang-format on
|
|
|
|
|
|
|
|
class MockAudioPlayer : public AudioPlayerInterface {
|
|
|
|
public:
|
|
|
|
MOCK_METHOD1(addObserver, void(std::shared_ptr<avsCommon::sdkInterfaces::AudioPlayerObserverInterface> observer));
|
|
|
|
MOCK_METHOD1(
|
|
|
|
removeObserver,
|
|
|
|
void(std::shared_ptr<avsCommon::sdkInterfaces::AudioPlayerObserverInterface> observer));
|
|
|
|
MOCK_METHOD0(getAudioItemOffset, std::chrono::milliseconds());
|
|
|
|
};
|
|
|
|
|
|
|
|
class MockGui : public TemplateRuntimeObserverInterface {
|
|
|
|
public:
|
|
|
|
MOCK_METHOD1(renderTemplateCard, void(const std::string& jsonPayload));
|
|
|
|
MOCK_METHOD2(
|
|
|
|
renderPlayerInfoCard,
|
|
|
|
void(const std::string& jsonPayload, TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo));
|
|
|
|
};
|
|
|
|
|
|
|
|
/// Test harness for @c TemplateRuntime class.
|
|
|
|
class TemplateRuntimeTest : public ::testing::Test {
|
|
|
|
public:
|
|
|
|
/// Set up the test harness for running a test.
|
|
|
|
void SetUp() override;
|
|
|
|
|
|
|
|
/// Clean up the test harness after running a test.
|
|
|
|
void TearDown() override;
|
|
|
|
|
|
|
|
/// Function to set the promise and wake @c m_wakeSetCompleteFuture.
|
|
|
|
void wakeOnSetCompleted();
|
|
|
|
|
|
|
|
/// Function to set the promise and wake @c m_wakeRenderTemplateCardFuture.
|
|
|
|
void wakeOnRenderTemplateCard();
|
|
|
|
|
|
|
|
/// Function to set the promise and wake @c m_wakeRenderPlayerInfoCardFuture.
|
|
|
|
void wakeOnRenderPlayerInfoCard();
|
|
|
|
|
|
|
|
/// A constructor which initializes the promises and futures needed for the test class.
|
|
|
|
TemplateRuntimeTest() :
|
|
|
|
m_wakeSetCompletedPromise{},
|
|
|
|
m_wakeSetCompletedFuture{m_wakeSetCompletedPromise.get_future()},
|
|
|
|
m_wakeRenderTemplateCardPromise{},
|
|
|
|
m_wakeRenderTemplateCardFuture{m_wakeRenderTemplateCardPromise.get_future()},
|
|
|
|
m_wakeRenderPlayerInfoCardPromise{},
|
|
|
|
m_wakeRenderPlayerInfoCardFuture{m_wakeRenderPlayerInfoCardPromise.get_future()} {
|
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
/// Promise to synchronize directive handling through setCompleted.
|
|
|
|
std::promise<void> m_wakeSetCompletedPromise;
|
|
|
|
|
|
|
|
/// Future to synchronize directive handling through setCompleted.
|
|
|
|
std::future<void> m_wakeSetCompletedFuture;
|
|
|
|
|
|
|
|
/// Promise to synchronize directive handling with RenderTemplateCard callback.
|
|
|
|
std::promise<void> m_wakeRenderTemplateCardPromise;
|
|
|
|
|
|
|
|
/// Future to synchronize directive handling with RenderTemplateCard callback.
|
|
|
|
std::future<void> m_wakeRenderTemplateCardFuture;
|
|
|
|
|
|
|
|
/// Promise to synchronize directive handling with RenderPlayerInfoCard callback.
|
|
|
|
std::promise<void> m_wakeRenderPlayerInfoCardPromise;
|
|
|
|
|
|
|
|
/// Future to synchronize directive handling with RenderPlayerInfoCard callback.
|
|
|
|
std::future<void> m_wakeRenderPlayerInfoCardFuture;
|
|
|
|
|
|
|
|
/// A nice mock for the AudioPlayerInterface calls.
|
|
|
|
std::shared_ptr<NiceMock<MockAudioPlayer>> m_mockAudioPlayerInterface;
|
|
|
|
|
|
|
|
/// A strict mock that allows the test to strictly monitor the exceptions being sent.
|
|
|
|
std::shared_ptr<StrictMock<MockExceptionEncounteredSender>> m_mockExceptionSender;
|
|
|
|
|
|
|
|
/// A strict mock that allows the test to strictly monitor the handling of directives.
|
|
|
|
std::unique_ptr<StrictMock<MockDirectiveHandlerResult>> m_mockDirectiveHandlerResult;
|
|
|
|
|
|
|
|
/// A strict mock to allow testing of the observer callback.
|
|
|
|
std::shared_ptr<StrictMock<MockGui>> m_mockGui;
|
|
|
|
|
|
|
|
/// A pointer to an instance of the TemplateRuntime that will be instantiated per test.
|
|
|
|
std::shared_ptr<TemplateRuntime> m_templateRuntime;
|
|
|
|
};
|
|
|
|
|
|
|
|
void TemplateRuntimeTest::SetUp() {
|
|
|
|
m_mockExceptionSender = std::make_shared<StrictMock<MockExceptionEncounteredSender>>();
|
|
|
|
m_mockDirectiveHandlerResult = make_unique<StrictMock<MockDirectiveHandlerResult>>();
|
|
|
|
m_mockAudioPlayerInterface = std::make_shared<NiceMock<MockAudioPlayer>>();
|
|
|
|
m_mockGui = std::make_shared<StrictMock<MockGui>>();
|
|
|
|
}
|
|
|
|
|
|
|
|
void TemplateRuntimeTest::TearDown() {
|
|
|
|
if (m_templateRuntime) {
|
|
|
|
m_templateRuntime->shutdown();
|
|
|
|
m_templateRuntime.reset();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void TemplateRuntimeTest::wakeOnSetCompleted() {
|
|
|
|
m_wakeSetCompletedPromise.set_value();
|
|
|
|
}
|
|
|
|
|
|
|
|
void TemplateRuntimeTest::wakeOnRenderTemplateCard() {
|
|
|
|
m_wakeRenderTemplateCardPromise.set_value();
|
|
|
|
}
|
|
|
|
|
|
|
|
void TemplateRuntimeTest::wakeOnRenderPlayerInfoCard() {
|
|
|
|
m_wakeRenderPlayerInfoCardPromise.set_value();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests creating the TemplateRuntime with a null audioPlayerInterface.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testNullAudioPlayerInterface) {
|
|
|
|
m_templateRuntime = TemplateRuntime::create(nullptr, m_mockExceptionSender);
|
|
|
|
ASSERT_EQ(m_templateRuntime, nullptr);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests creating the TemplateRuntime with a null exceptionSender.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testNullExceptionSender) {
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, nullptr);
|
|
|
|
ASSERT_EQ(m_templateRuntime, nullptr);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests that the TemplateRuntime successfully add itself with the AudioPlayer at constructor time, and
|
|
|
|
* successfully remove itself with the AudioPlayer during shutdown.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testAudioPlayerAddRemoveObserver) {
|
|
|
|
EXPECT_CALL(*m_mockAudioPlayerInterface, addObserver(NotNull())).Times(Exactly(1));
|
|
|
|
EXPECT_CALL(*m_mockAudioPlayerInterface, removeObserver(NotNull())).Times(Exactly(1));
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, m_mockExceptionSender);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests unknown Directive. Expect that the sendExceptionEncountered and setFailed will be called.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testUnknownDirective) {
|
|
|
|
// Create TemplateRuntime and add m_mockGui and its observer.
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, m_mockExceptionSender);
|
|
|
|
m_templateRuntime->addObserver(m_mockGui);
|
|
|
|
|
|
|
|
// Create Directive.
|
|
|
|
auto attachmentManager = std::make_shared<StrictMock<MockAttachmentManager>>();
|
|
|
|
auto avsMessageHeader = std::make_shared<AVSMessageHeader>(NAMESPACE, UNKNOWN_DIRECTIVE, MESSAGE_ID);
|
|
|
|
std::shared_ptr<AVSDirective> directive = AVSDirective::create("", avsMessageHeader, "", attachmentManager, "");
|
|
|
|
|
|
|
|
EXPECT_CALL(*m_mockExceptionSender, sendExceptionEncountered(_, _, _)).Times(Exactly(1));
|
|
|
|
EXPECT_CALL(*m_mockDirectiveHandlerResult, setFailed(_))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnSetCompleted));
|
|
|
|
|
|
|
|
m_templateRuntime->CapabilityAgent::preHandleDirective(directive, std::move(m_mockDirectiveHandlerResult));
|
|
|
|
m_wakeSetCompletedFuture.wait_for(TIMEOUT);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests RenderTemplate Directive. Expect that the renderTemplateCard callback will be called.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testRenderTemplateDirective) {
|
|
|
|
// Create TemplateRuntime and add m_mockGui and its observer.
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, m_mockExceptionSender);
|
|
|
|
m_templateRuntime->addObserver(m_mockGui);
|
|
|
|
|
|
|
|
// Create Directive.
|
|
|
|
auto attachmentManager = std::make_shared<StrictMock<MockAttachmentManager>>();
|
|
|
|
auto avsMessageHeader = std::make_shared<AVSMessageHeader>(TEMPLATE.nameSpace, TEMPLATE.name, MESSAGE_ID);
|
|
|
|
std::shared_ptr<AVSDirective> directive =
|
|
|
|
AVSDirective::create("", avsMessageHeader, TEMPLATE_PAYLOAD, attachmentManager, "");
|
|
|
|
|
|
|
|
EXPECT_CALL(*m_mockGui, renderTemplateCard(TEMPLATE_PAYLOAD)).Times(Exactly(1));
|
|
|
|
EXPECT_CALL(*m_mockDirectiveHandlerResult, setCompleted())
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnSetCompleted));
|
|
|
|
|
|
|
|
m_templateRuntime->CapabilityAgent::preHandleDirective(directive, std::move(m_mockDirectiveHandlerResult));
|
|
|
|
m_templateRuntime->CapabilityAgent::handleDirective(MESSAGE_ID);
|
|
|
|
m_wakeSetCompletedFuture.wait_for(TIMEOUT);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests RenderTemplate Directive using the handleDirectiveImmediately. Expect that the renderTemplateCard
|
|
|
|
* callback will be called.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testHandleDirectiveImmediately) {
|
|
|
|
// Create TemplateRuntime and add m_mockGui and its observer.
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, m_mockExceptionSender);
|
|
|
|
m_templateRuntime->addObserver(m_mockGui);
|
|
|
|
|
|
|
|
// Create Directive.
|
|
|
|
auto attachmentManager = std::make_shared<StrictMock<MockAttachmentManager>>();
|
|
|
|
auto avsMessageHeader = std::make_shared<AVSMessageHeader>(TEMPLATE.nameSpace, TEMPLATE.name, MESSAGE_ID);
|
|
|
|
std::shared_ptr<AVSDirective> directive =
|
|
|
|
AVSDirective::create("", avsMessageHeader, TEMPLATE_PAYLOAD, attachmentManager, "");
|
|
|
|
|
|
|
|
EXPECT_CALL(*m_mockGui, renderTemplateCard(TEMPLATE_PAYLOAD))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnRenderTemplateCard));
|
|
|
|
|
|
|
|
m_templateRuntime->handleDirectiveImmediately(directive);
|
|
|
|
m_wakeRenderTemplateCardFuture.wait_for(TIMEOUT);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests RenderTemplate Directive received before the corresponding AudioPlayer call. Expect
|
|
|
|
* that the renderTemplateCard callback will be called.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testRenderPlayerInfoDirectiveBefore) {
|
|
|
|
// Create TemplateRuntime and add m_mockGui and its observer.
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, m_mockExceptionSender);
|
|
|
|
m_templateRuntime->addObserver(m_mockGui);
|
|
|
|
|
|
|
|
// Create Directive.
|
|
|
|
auto attachmentManager = std::make_shared<StrictMock<MockAttachmentManager>>();
|
|
|
|
auto avsMessageHeader = std::make_shared<AVSMessageHeader>(PLAYER_INFO.nameSpace, PLAYER_INFO.name, MESSAGE_ID);
|
|
|
|
std::shared_ptr<AVSDirective> directive =
|
|
|
|
AVSDirective::create("", avsMessageHeader, PLAYERINFO_PAYLOAD, attachmentManager, "");
|
|
|
|
|
|
|
|
::testing::InSequence s;
|
|
|
|
EXPECT_CALL(*m_mockDirectiveHandlerResult, setCompleted())
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnSetCompleted));
|
|
|
|
EXPECT_CALL(*m_mockGui, renderTemplateCard(_)).Times(Exactly(0));
|
|
|
|
|
|
|
|
// do not expect renderPlayerInfo card call until AudioPlayer notify with the correct audioItemId
|
|
|
|
EXPECT_CALL(*m_mockGui, renderPlayerInfoCard(_, _)).Times(Exactly(0));
|
|
|
|
|
|
|
|
m_templateRuntime->CapabilityAgent::preHandleDirective(directive, std::move(m_mockDirectiveHandlerResult));
|
|
|
|
m_templateRuntime->CapabilityAgent::handleDirective(MESSAGE_ID);
|
|
|
|
m_wakeSetCompletedFuture.wait_for(TIMEOUT);
|
|
|
|
|
|
|
|
EXPECT_CALL(*m_mockGui, renderPlayerInfoCard(PLAYERINFO_PAYLOAD, _))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnRenderPlayerInfoCard));
|
|
|
|
|
|
|
|
AudioPlayerObserverInterface::Context context;
|
|
|
|
context.audioItemId = AUDIO_ITEM_ID;
|
|
|
|
context.offset = TIMEOUT;
|
|
|
|
m_templateRuntime->onPlayerActivityChanged(avsCommon::avs::PlayerActivity::PLAYING, context);
|
|
|
|
|
|
|
|
m_wakeRenderPlayerInfoCardFuture.wait_for(TIMEOUT);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests RenderTemplate Directive received after the corresponding AudioPlayer call. Expect
|
|
|
|
* that the renderTemplateCard callback will be called.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testRenderPlayerInfoDirectiveAfter) {
|
|
|
|
// Create TemplateRuntime and add m_mockGui and its observer.
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, m_mockExceptionSender);
|
|
|
|
m_templateRuntime->addObserver(m_mockGui);
|
|
|
|
|
|
|
|
// Create Directive.
|
|
|
|
auto attachmentManager = std::make_shared<StrictMock<MockAttachmentManager>>();
|
|
|
|
auto avsMessageHeader = std::make_shared<AVSMessageHeader>(PLAYER_INFO.nameSpace, PLAYER_INFO.name, MESSAGE_ID);
|
|
|
|
std::shared_ptr<AVSDirective> directive =
|
|
|
|
AVSDirective::create("", avsMessageHeader, PLAYERINFO_PAYLOAD, attachmentManager, "");
|
|
|
|
|
|
|
|
EXPECT_CALL(*m_mockGui, renderPlayerInfoCard(PLAYERINFO_PAYLOAD, _))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnRenderPlayerInfoCard));
|
|
|
|
EXPECT_CALL(*m_mockDirectiveHandlerResult, setCompleted())
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnSetCompleted));
|
|
|
|
|
|
|
|
AudioPlayerObserverInterface::Context context;
|
|
|
|
context.audioItemId = AUDIO_ITEM_ID;
|
|
|
|
context.offset = TIMEOUT;
|
|
|
|
m_templateRuntime->onPlayerActivityChanged(avsCommon::avs::PlayerActivity::PLAYING, context);
|
|
|
|
m_templateRuntime->CapabilityAgent::preHandleDirective(directive, std::move(m_mockDirectiveHandlerResult));
|
|
|
|
m_templateRuntime->CapabilityAgent::handleDirective(MESSAGE_ID);
|
|
|
|
|
|
|
|
m_wakeRenderPlayerInfoCardFuture.wait_for(TIMEOUT);
|
|
|
|
m_wakeSetCompletedFuture.wait_for(TIMEOUT);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests RenderTemplate Directive received without an audioItemId. Expect that the
|
|
|
|
* sendExceptionEncountered and setFailed will be called.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testRenderPlayerInfoDirectiveWithoutAudioItemId) {
|
|
|
|
// Create TemplateRuntime and add m_mockGui and its observer.
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, m_mockExceptionSender);
|
|
|
|
m_templateRuntime->addObserver(m_mockGui);
|
|
|
|
|
|
|
|
// Create Directive.
|
|
|
|
auto attachmentManager = std::make_shared<StrictMock<MockAttachmentManager>>();
|
|
|
|
auto avsMessageHeader = std::make_shared<AVSMessageHeader>(PLAYER_INFO.nameSpace, PLAYER_INFO.name, MESSAGE_ID);
|
|
|
|
std::shared_ptr<AVSDirective> directive =
|
|
|
|
AVSDirective::create("", avsMessageHeader, TEMPLATE_PAYLOAD, attachmentManager, "");
|
|
|
|
|
|
|
|
EXPECT_CALL(*m_mockExceptionSender, sendExceptionEncountered(_, _, _)).Times(Exactly(1));
|
|
|
|
EXPECT_CALL(*m_mockDirectiveHandlerResult, setFailed(_))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnSetCompleted));
|
|
|
|
|
|
|
|
m_templateRuntime->CapabilityAgent::preHandleDirective(directive, std::move(m_mockDirectiveHandlerResult));
|
|
|
|
m_wakeSetCompletedFuture.wait_for(TIMEOUT);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests when a malformed RenderTemplate Directive is received. Expect that the
|
|
|
|
* sendExceptionEncountered and setFailed will be called.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testMalformedRenderPlayerInfoDirective) {
|
|
|
|
// Create TemplateRuntime and add m_mockGui and its observer.
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, m_mockExceptionSender);
|
|
|
|
m_templateRuntime->addObserver(m_mockGui);
|
|
|
|
|
|
|
|
// Create Directive.
|
|
|
|
auto attachmentManager = std::make_shared<StrictMock<MockAttachmentManager>>();
|
|
|
|
auto avsMessageHeader = std::make_shared<AVSMessageHeader>(PLAYER_INFO.nameSpace, PLAYER_INFO.name, MESSAGE_ID);
|
|
|
|
std::shared_ptr<AVSDirective> directive =
|
|
|
|
AVSDirective::create("", avsMessageHeader, MALFORM_PLAYERINFO_PAYLOAD, attachmentManager, "");
|
|
|
|
|
|
|
|
EXPECT_CALL(*m_mockExceptionSender, sendExceptionEncountered(_, _, _)).Times(Exactly(1));
|
|
|
|
EXPECT_CALL(*m_mockDirectiveHandlerResult, setFailed(_))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnSetCompleted));
|
|
|
|
|
|
|
|
m_templateRuntime->CapabilityAgent::preHandleDirective(directive, std::move(m_mockDirectiveHandlerResult));
|
|
|
|
m_wakeSetCompletedFuture.wait_for(TIMEOUT);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests AudioPlayer notified the handling of AUDIO_ITEM_ID_1, and then RenderTemplate Directive with
|
|
|
|
* AUDIO_ITEM_ID is received. Expect that the renderTemplateCard callback will not be called until
|
|
|
|
* the AudioPlayer notified the handling of AUDIO_ITEM_ID later.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testRenderPlayerInfoDirectiveDifferentAudioItemId) {
|
|
|
|
// Create TemplateRuntime and add m_mockGui and its observer.
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, m_mockExceptionSender);
|
|
|
|
m_templateRuntime->addObserver(m_mockGui);
|
|
|
|
|
|
|
|
// Create Directive.
|
|
|
|
auto attachmentManager = std::make_shared<StrictMock<MockAttachmentManager>>();
|
|
|
|
auto avsMessageHeader = std::make_shared<AVSMessageHeader>(PLAYER_INFO.nameSpace, PLAYER_INFO.name, MESSAGE_ID);
|
|
|
|
std::shared_ptr<AVSDirective> directive =
|
|
|
|
AVSDirective::create("", avsMessageHeader, PLAYERINFO_PAYLOAD, attachmentManager, "");
|
|
|
|
|
|
|
|
EXPECT_CALL(*m_mockGui, renderPlayerInfoCard(PLAYERINFO_PAYLOAD, _)).Times(Exactly(0));
|
|
|
|
EXPECT_CALL(*m_mockDirectiveHandlerResult, setCompleted())
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnSetCompleted));
|
|
|
|
|
|
|
|
AudioPlayerObserverInterface::Context context;
|
|
|
|
context.audioItemId = AUDIO_ITEM_ID_1;
|
|
|
|
context.offset = TIMEOUT;
|
|
|
|
m_templateRuntime->onPlayerActivityChanged(avsCommon::avs::PlayerActivity::PLAYING, context);
|
|
|
|
m_templateRuntime->CapabilityAgent::preHandleDirective(directive, std::move(m_mockDirectiveHandlerResult));
|
|
|
|
m_templateRuntime->CapabilityAgent::handleDirective(MESSAGE_ID);
|
|
|
|
m_wakeSetCompletedFuture.wait_for(TIMEOUT);
|
|
|
|
|
|
|
|
EXPECT_CALL(*m_mockGui, renderPlayerInfoCard(PLAYERINFO_PAYLOAD, _))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnRenderPlayerInfoCard));
|
|
|
|
|
|
|
|
context.audioItemId = AUDIO_ITEM_ID;
|
|
|
|
m_templateRuntime->onPlayerActivityChanged(avsCommon::avs::PlayerActivity::PLAYING, context);
|
|
|
|
|
|
|
|
m_wakeRenderPlayerInfoCardFuture.wait_for(TIMEOUT);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Tests AudioPlayer callbacks will trigger the correct renderPlayerInfoCard callbacks. Expect
|
|
|
|
* the payload, audioPlayerState and offset to match to the ones passed in by the
|
|
|
|
* AudioPlayerObserverInterface.
|
|
|
|
*/
|
|
|
|
TEST_F(TemplateRuntimeTest, testRenderPlayerInfoDirectiveAudioStateUpdate) {
|
|
|
|
// Create TemplateRuntime and add m_mockGui and its observer.
|
|
|
|
m_templateRuntime = TemplateRuntime::create(m_mockAudioPlayerInterface, m_mockExceptionSender);
|
|
|
|
m_templateRuntime->addObserver(m_mockGui);
|
|
|
|
|
|
|
|
// Create Directive.
|
|
|
|
auto attachmentManager = std::make_shared<StrictMock<MockAttachmentManager>>();
|
|
|
|
auto avsMessageHeader = std::make_shared<AVSMessageHeader>(PLAYER_INFO.nameSpace, PLAYER_INFO.name, MESSAGE_ID);
|
|
|
|
std::shared_ptr<AVSDirective> directive =
|
|
|
|
AVSDirective::create("", avsMessageHeader, PLAYERINFO_PAYLOAD, attachmentManager, "");
|
|
|
|
|
|
|
|
::testing::InSequence s;
|
|
|
|
// Send a directive first to TemplateRuntime
|
|
|
|
EXPECT_CALL(*m_mockDirectiveHandlerResult, setCompleted())
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(InvokeWithoutArgs(this, &TemplateRuntimeTest::wakeOnSetCompleted));
|
|
|
|
m_templateRuntime->CapabilityAgent::preHandleDirective(directive, std::move(m_mockDirectiveHandlerResult));
|
|
|
|
m_templateRuntime->CapabilityAgent::handleDirective(MESSAGE_ID);
|
|
|
|
m_wakeSetCompletedFuture.wait_for(TIMEOUT);
|
|
|
|
|
|
|
|
AudioPlayerObserverInterface::Context context;
|
|
|
|
context.audioItemId = AUDIO_ITEM_ID;
|
|
|
|
|
|
|
|
// Test onAudioPlayed() callback with 100ms offset
|
|
|
|
std::promise<void> wakePlayPromise;
|
|
|
|
std::future<void> wakePlayFuture = wakePlayPromise.get_future();
|
|
|
|
context.offset = std::chrono::milliseconds(100);
|
|
|
|
EXPECT_CALL(*m_mockGui, renderPlayerInfoCard(PLAYERINFO_PAYLOAD, _))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(Invoke(
|
2017-12-09 00:07:37 +00:00
|
|
|
[&wakePlayPromise, context](
|
2017-10-30 22:14:38 +00:00
|
|
|
const std::string& jsonPayload, TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo) {
|
|
|
|
EXPECT_EQ(audioPlayerInfo.audioPlayerState, avsCommon::avs::PlayerActivity::PLAYING);
|
|
|
|
EXPECT_EQ(audioPlayerInfo.offset, context.offset);
|
|
|
|
wakePlayPromise.set_value();
|
|
|
|
}));
|
|
|
|
m_templateRuntime->onPlayerActivityChanged(avsCommon::avs::PlayerActivity::PLAYING, context);
|
|
|
|
wakePlayFuture.wait_for(TIMEOUT);
|
|
|
|
|
|
|
|
// Test onAudioPaused() callback with 200ms offset
|
|
|
|
std::promise<void> wakePausePromise;
|
|
|
|
std::future<void> wakePauseFuture = wakePausePromise.get_future();
|
|
|
|
context.offset = std::chrono::milliseconds(200);
|
|
|
|
EXPECT_CALL(*m_mockGui, renderPlayerInfoCard(PLAYERINFO_PAYLOAD, _))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(Invoke(
|
2017-12-09 00:07:37 +00:00
|
|
|
[&wakePausePromise, context](
|
2017-10-30 22:14:38 +00:00
|
|
|
const std::string& jsonPayload, TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo) {
|
|
|
|
EXPECT_EQ(audioPlayerInfo.audioPlayerState, avsCommon::avs::PlayerActivity::PAUSED);
|
|
|
|
EXPECT_EQ(audioPlayerInfo.offset, context.offset);
|
|
|
|
wakePausePromise.set_value();
|
|
|
|
}));
|
|
|
|
m_templateRuntime->onPlayerActivityChanged(avsCommon::avs::PlayerActivity::PAUSED, context);
|
|
|
|
wakePauseFuture.wait_for(TIMEOUT);
|
|
|
|
|
|
|
|
// Test onAudioStopped() callback with 300ms offset
|
|
|
|
std::promise<void> wakeStopPromise;
|
|
|
|
std::future<void> wakeStopFuture = wakeStopPromise.get_future();
|
|
|
|
context.offset = std::chrono::milliseconds(300);
|
|
|
|
EXPECT_CALL(*m_mockGui, renderPlayerInfoCard(PLAYERINFO_PAYLOAD, _))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(Invoke(
|
2017-12-09 00:07:37 +00:00
|
|
|
[&wakeStopPromise, context](
|
2017-10-30 22:14:38 +00:00
|
|
|
const std::string& jsonPayload, TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo) {
|
|
|
|
EXPECT_EQ(audioPlayerInfo.audioPlayerState, avsCommon::avs::PlayerActivity::STOPPED);
|
|
|
|
EXPECT_EQ(audioPlayerInfo.offset, context.offset);
|
|
|
|
wakeStopPromise.set_value();
|
|
|
|
}));
|
|
|
|
m_templateRuntime->onPlayerActivityChanged(avsCommon::avs::PlayerActivity::STOPPED, context);
|
|
|
|
wakeStopFuture.wait_for(TIMEOUT);
|
|
|
|
|
|
|
|
// Test onAudioFinished() callback with 400ms offset
|
|
|
|
std::promise<void> wakeFinishPromise;
|
|
|
|
std::future<void> wakeFinishFuture = wakeFinishPromise.get_future();
|
|
|
|
context.offset = std::chrono::milliseconds(400);
|
|
|
|
EXPECT_CALL(*m_mockGui, renderPlayerInfoCard(PLAYERINFO_PAYLOAD, _))
|
|
|
|
.Times(Exactly(1))
|
|
|
|
.WillOnce(Invoke(
|
2017-12-09 00:07:37 +00:00
|
|
|
[&wakeFinishPromise, context](
|
2017-10-30 22:14:38 +00:00
|
|
|
const std::string& jsonPayload, TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo) {
|
|
|
|
EXPECT_EQ(audioPlayerInfo.audioPlayerState, avsCommon::avs::PlayerActivity::FINISHED);
|
|
|
|
EXPECT_EQ(audioPlayerInfo.offset, context.offset);
|
|
|
|
wakeFinishPromise.set_value();
|
|
|
|
}));
|
|
|
|
m_templateRuntime->onPlayerActivityChanged(avsCommon::avs::PlayerActivity::FINISHED, context);
|
|
|
|
wakeFinishFuture.wait_for(TIMEOUT);
|
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace test
|
|
|
|
} // namespace templateRuntime
|
|
|
|
} // namespace capabilityAgents
|
|
|
|
} // namespace alexaClientSDK
|