/* Copyright (c) 2018, Ford Motor Company All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the Ford Motor Company nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include #include "gtest/gtest.h" #include "mobile/speak_request.h" #include "application_manager/commands/commands_test.h" #include "application_manager/commands/command_request_test.h" #include "interfaces/HMI_API.h" #include "interfaces/MOBILE_API.h" #include "utils/helpers.h" #include "smart_objects/smart_object.h" #include "utils/custom_string.h" #include "application_manager/application.h" #include "application_manager/smart_object_keys.h" #include "application_manager/mock_application.h" #include "application_manager/mock_application_manager.h" #include "application_manager/mock_message_helper.h" #include "application_manager/event_engine/event.h" #include "application_manager/mock_hmi_interface.h" namespace test { namespace components { namespace commands_test { namespace mobile_commands_test { namespace speak_request { namespace am = application_manager; namespace mobile_result = mobile_apis::Result; namespace hmi_response = ::application_manager::hmi_response; namespace strings = ::application_manager::strings; using am::commands::CommandImpl; using am::ApplicationManager; using am::commands::MessageSharedPtr; using am::ApplicationSharedPtr; using am::MockMessageHelper; using ::testing::_; using ::testing::Return; using ::testing::ReturnRef; using sdl_rpc_plugin::commands::SpeakRequest; using ::test::components::application_manager_test::MockApplication; typedef std::shared_ptr CommandPtr; namespace { const uint32_t kAppId = 10u; const uint32_t kConnectionKey = 5u; } class SpeakRequestTest : public CommandRequestTest { public: SpeakRequestTest() : request_(CreateMessage(smart_objects::SmartType_Map)) , response_(CreateMessage(smart_objects::SmartType_Map)) , app_(CreateMockApp()) {} void CheckExpectations(const hmi_apis::Common_Result::eType hmi_response, const mobile_apis::Result::eType mobile_response, const am::HmiInterfaces::InterfaceState state, const bool success) { std::shared_ptr command = CreateCommand(request_); (*response_)[strings::params][hmi_response::code] = hmi_response; (*response_)[strings::msg_params] = 0; am::event_engine::Event event_tts(hmi_apis::FunctionID::TTS_Speak); event_tts.set_smart_object(*response_); MockAppPtr mock_app(CreateMockApp()); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(mock_app)); MessageSharedPtr response_to_mobile; EXPECT_CALL(mock_hmi_interfaces_, GetInterfaceState(_)) .WillRepeatedly(Return(state)); EXPECT_CALL(mock_rpc_service_, ManageMobileCommand( _, am::commands::Command::CommandSource::SOURCE_SDL)) .WillOnce(DoAll(SaveArg<0>(&response_to_mobile), Return(true))); command->on_event(event_tts); EXPECT_EQ( (*response_to_mobile)[strings::msg_params][strings::success].asBool(), success); EXPECT_EQ((*response_to_mobile)[strings::msg_params][strings::result_code] .asInt(), static_cast(mobile_response)); } MessageSharedPtr request_; MessageSharedPtr response_; MockAppPtr app_; }; TEST_F(SpeakRequestTest, OnEvent_SUCCESS_Expect_true) { std::shared_ptr command = CreateCommand(request_); (*response_)[strings::params][hmi_response::code] = hmi_apis::Common_Result::SUCCESS; (*response_)[strings::msg_params] = 0; am::event_engine::Event event_tts(hmi_apis::FunctionID::TTS_Speak); event_tts.set_smart_object(*response_); MockAppPtr mock_app(CreateMockApp()); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(mock_app)); MessageSharedPtr response_to_mobile; EXPECT_CALL( mock_rpc_service_, ManageMobileCommand(_, am::commands::Command::CommandSource::SOURCE_SDL)) .WillOnce(DoAll(SaveArg<0>(&response_to_mobile), Return(true))); command->on_event(event_tts); EXPECT_EQ( (*response_to_mobile)[strings::msg_params][strings::success].asBool(), true); EXPECT_EQ( (*response_to_mobile)[strings::msg_params][strings::result_code].asInt(), static_cast(mobile_apis::Result::SUCCESS)); } TEST_F(SpeakRequestTest, OnEvent_UNSUPPORTED_RESOURCE_STATE_AVAILABLE_Expect_true) { CheckExpectations(hmi_apis::Common_Result::UNSUPPORTED_RESOURCE, mobile_apis::Result::UNSUPPORTED_RESOURCE, am::HmiInterfaces::STATE_AVAILABLE, true); } TEST_F(SpeakRequestTest, OnEvent_UNSUPPORTED_RESOURCE_STATE_NOT_AVAILABLE_Expect_false) { CheckExpectations(hmi_apis::Common_Result::UNSUPPORTED_RESOURCE, mobile_apis::Result::UNSUPPORTED_RESOURCE, am::HmiInterfaces::STATE_NOT_AVAILABLE, false); } TEST_F(SpeakRequestTest, OnEvent_UNSUPPORTED_RESOURCE_STATE_NOT_RESPONSE_Expect_true) { CheckExpectations(hmi_apis::Common_Result::UNSUPPORTED_RESOURCE, mobile_apis::Result::UNSUPPORTED_RESOURCE, am::HmiInterfaces::STATE_NOT_RESPONSE, true); } TEST_F(SpeakRequestTest, Run_ApplicationIsNotRegistered) { CommandPtr command(CreateCommand(request_)); ON_CALL(app_mngr_, application(_)) .WillByDefault(Return(ApplicationSharedPtr())); EXPECT_CALL( mock_rpc_service_, ManageMobileCommand( MobileResultCodeIs(mobile_result::APPLICATION_NOT_REGISTERED), _)); command->Run(); } TEST_F(SpeakRequestTest, Run_MsgWithWhiteSpace_InvalidData) { (*request_)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = " "; CommandPtr command(CreateCommand(request_)); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(app_)); EXPECT_CALL( mock_rpc_service_, ManageMobileCommand(MobileResultCodeIs(mobile_result::INVALID_DATA), _)); command->Run(); } TEST_F(SpeakRequestTest, Run_MsgWithIncorrectChar1_InvalidData) { (*request_)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = "sd\\t"; CommandPtr command(CreateCommand(request_)); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(app_)); EXPECT_CALL( mock_rpc_service_, ManageMobileCommand(MobileResultCodeIs(mobile_result::INVALID_DATA), _)); command->Run(); } TEST_F(SpeakRequestTest, Run_MsgWithIncorrectChar2_InvalidData) { (*request_)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = "sd\\n"; CommandPtr command(CreateCommand(request_)); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(app_)); EXPECT_CALL( mock_rpc_service_, ManageMobileCommand(MobileResultCodeIs(mobile_result::INVALID_DATA), _)); command->Run(); } TEST_F(SpeakRequestTest, Run_MsgWithIncorrectChar3_InvalidData) { (*request_)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = "sd\tdf"; CommandPtr command(CreateCommand(request_)); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(app_)); EXPECT_CALL( mock_rpc_service_, ManageMobileCommand(MobileResultCodeIs(mobile_result::INVALID_DATA), _)); command->Run(); } TEST_F(SpeakRequestTest, Run_MsgWithIncorrectChar4_InvalidData) { (*request_)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = "sd\n rer"; CommandPtr command(CreateCommand(request_)); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(app_)); EXPECT_CALL( mock_rpc_service_, ManageMobileCommand(MobileResultCodeIs(mobile_result::INVALID_DATA), _)); command->Run(); } TEST_F(SpeakRequestTest, Run_MsgWithIncorrectCharInfirstPlace_InvalidData) { (*request_)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = "\n"; CommandPtr command(CreateCommand(request_)); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(app_)); EXPECT_CALL( mock_rpc_service_, ManageMobileCommand(MobileResultCodeIs(mobile_result::INVALID_DATA), _)); command->Run(); } TEST_F(SpeakRequestTest, Run_MsgWithEmptyString_Success) { (*request_)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = ""; CommandPtr command(CreateCommand(request_)); EXPECT_CALL( mock_message_helper_, VerifyTtsFiles( (*request_)[am::strings::msg_params][am::strings::tts_chunks], _, _)) .WillOnce(Return(mobile_apis::Result::SUCCESS)); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(app_)); ON_CALL(*app_, app_id()).WillByDefault(Return(kAppId)); EXPECT_CALL( mock_rpc_service_, ManageHMICommand(HMIResultCodeIs(hmi_apis::FunctionID::TTS_Speak))); command->Run(); } TEST_F(SpeakRequestTest, Run_MsgCorrect_Success) { (*request_)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = "asda"; CommandPtr command(CreateCommand(request_)); EXPECT_CALL( mock_message_helper_, VerifyTtsFiles( (*request_)[am::strings::msg_params][am::strings::tts_chunks], _, _)) .WillOnce(Return(mobile_apis::Result::SUCCESS)); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(app_)); ON_CALL(*app_, app_id()).WillByDefault(Return(kAppId)); EXPECT_CALL( mock_rpc_service_, ManageHMICommand(HMIResultCodeIs(hmi_apis::FunctionID::TTS_Speak))); command->Run(); } TEST_F(SpeakRequestTest, OnEvent_WrongEventId_UNSUCCESS) { Event event(Event::EventID::INVALID_ENUM); CommandPtr command(CreateCommand()); EXPECT_CALL(mock_rpc_service_, ManageMobileCommand(_, _)).Times(0); command->on_event(event); } TEST_F(SpeakRequestTest, OnEvent_TTS_Speak_SUCCESS) { Event event(Event::EventID::TTS_Speak); MessageSharedPtr event_msg(CreateMessage(smart_objects::SmartType_Map)); hmi_apis::Common_Result::eType hmi_result = hmi_apis::Common_Result::SUCCESS; (*event_msg)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = "1234"; (*event_msg)[am::strings::params][am::hmi_response::code] = hmi_result; (*event_msg)[am::strings::params][am::strings::connection_key] = kConnectionKey; event.set_smart_object(*event_msg); CommandPtr command(CreateCommand(request_)); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(app_)); EXPECT_CALL( mock_rpc_service_, ManageMobileCommand(MobileResultCodeIs(mobile_result::SUCCESS), _)); command->on_event(event); } TEST_F(SpeakRequestTest, OnEvent_TTS_SpeakWithWarning_WarningWithSuccess) { Event event(Event::EventID::TTS_Speak); MessageSharedPtr event_msg(CreateMessage(smart_objects::SmartType_Map)); hmi_apis::Common_Result::eType hmi_result = hmi_apis::Common_Result::WARNINGS; (*event_msg)[am::strings::params][am::hmi_response::code] = hmi_result; (*event_msg)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = "asda"; event.set_smart_object(*event_msg); CommandPtr command(CreateCommand()); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(app_)); EXPECT_CALL( mock_rpc_service_, ManageMobileCommand(MobileResultCodeIs(mobile_result::WARNINGS), _)); command->on_event(event); } TEST_F(SpeakRequestTest, OnEvent_TTS_OnResetTimeout_UpdateTimeout) { Event event(Event::EventID::TTS_OnResetTimeout); (*request_)[am::strings::params][am::strings::connection_key] = kConnectionKey; (*request_)[am::strings::params][am::strings::correlation_id] = kAppId; CommandPtr command(CreateCommand(request_)); EXPECT_CALL(app_mngr_, updateRequestTimeout(kConnectionKey, kAppId, _)); command->on_event(event); } TEST_F(SpeakRequestTest, OnEvent_ApplicationIsNotRegistered_UNSUCCESS) { const hmi_apis::Common_Result::eType hmi_result = hmi_apis::Common_Result::SUCCESS; Event event(Event::EventID::TTS_Speak); MessageSharedPtr event_msg(CreateMessage(smart_objects::SmartType_Map)); (*event_msg)[am::strings::msg_params][am::strings::tts_chunks][0] [am::strings::text] = "text"; (*event_msg)[am::strings::params][am::hmi_response::code] = hmi_result; (*event_msg)[am::strings::params][am::strings::connection_key] = kConnectionKey; event.set_smart_object(*event_msg); CommandPtr command(CreateCommand(request_)); EXPECT_CALL(app_mngr_, application(_)) .WillOnce(Return(ApplicationSharedPtr())); command->on_event(event); } } // namespace speak_request } // namespace mobile_commands_test } // namespace commands_test } // namespace component } // namespace test