summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYaroslav Mamykin (GitHub) <33784535+YarikMamykin@users.noreply.github.com>2020-01-15 18:03:18 +0200
committerJacob Keeler <jacob.keeler@livioradio.com>2020-01-15 11:03:18 -0500
commit86d541bc9d5bbe6e525caa858effd5bf76892582 (patch)
tree182b05eeef8979a01c319ea3caa89d6800028ea3
parente32a774e3b4d6a497855457436d65db169617e83 (diff)
downloadsdl_core-86d541bc9d5bbe6e525caa858effd5bf76892582.tar.gz
Fix sdl versioning for vehicle data (#3049)
* Fix versioning appliance for vehicle data
-rw-r--r--src/components/application_manager/rpc_plugins/rc_rpc_plugin/test/commands/rc_get_interior_vehicle_data_consent_test.cc8
-rw-r--r--src/components/application_manager/src/rpc_handler_impl.cc2
-rw-r--r--src/components/application_manager/src/rpc_service_impl.cc19
-rwxr-xr-xsrc/components/application_manager/test/CMakeLists.txt5
-rw-r--r--src/components/application_manager/test/rpc_handler_impl_test.cc123
-rw-r--r--src/components/include/utils/semantic_version.h22
-rw-r--r--src/components/smart_objects/CMakeLists.txt2
-rw-r--r--src/components/smart_objects/include/smart_objects/object_schema_item.h7
-rw-r--r--src/components/smart_objects/src/object_schema_item.cc81
9 files changed, 201 insertions, 68 deletions
diff --git a/src/components/application_manager/rpc_plugins/rc_rpc_plugin/test/commands/rc_get_interior_vehicle_data_consent_test.cc b/src/components/application_manager/rpc_plugins/rc_rpc_plugin/test/commands/rc_get_interior_vehicle_data_consent_test.cc
index d44265a1d5..55be43f37b 100644
--- a/src/components/application_manager/rpc_plugins/rc_rpc_plugin/test/commands/rc_get_interior_vehicle_data_consent_test.cc
+++ b/src/components/application_manager/rpc_plugins/rc_rpc_plugin/test/commands/rc_get_interior_vehicle_data_consent_test.cc
@@ -265,15 +265,17 @@ TEST_F(RCGetInteriorVehicleDataConsentTest,
TEST_F(RCGetInteriorVehicleDataConsentTest,
Run_MobileSendButtonPressMessage_HMISendINUSEModeToMobile) {
- // Arrange
- auto mobile_message = CreateBasicMessage();
-
// Expectations
EXPECT_CALL(mock_allocation_manager_, AcquireResource(_, _, _))
.WillOnce(Return(rc_rpc_plugin::AcquireResult::IN_USE));
+ auto msg_ver = utils::SemanticVersion();
+ ON_CALL(*mock_app_, msg_version()).WillByDefault(ReturnRef(msg_ver));
+
EXPECT_CALL(*optional_mock_rpc_plugin, GetCommandFactory())
.WillOnce(ReturnRef(mock_command_factory));
+
+ auto mobile_message = CreateBasicMessage();
auto rc_consent_response =
CreateRCCommand<commands::RCGetInteriorVehicleDataConsentResponse>(
mobile_message);
diff --git a/src/components/application_manager/src/rpc_handler_impl.cc b/src/components/application_manager/src/rpc_handler_impl.cc
index 695d94628d..e8468e95cc 100644
--- a/src/components/application_manager/src/rpc_handler_impl.cc
+++ b/src/components/application_manager/src/rpc_handler_impl.cc
@@ -31,7 +31,6 @@
*/
#include "application_manager/rpc_handler_impl.h"
-
#include "application_manager/app_service_manager.h"
#include "application_manager/plugin_manager/plugin_keys.h"
@@ -308,6 +307,7 @@ void RPCHandlerImpl::GetMessageVersion(
if (sync_msg_version.keyExists(strings::patch_version)) {
patch = sync_msg_version[strings::patch_version].asUInt();
}
+
utils::SemanticVersion temp_version(major, minor, patch);
if (temp_version.isValid()) {
message_version = (temp_version >= utils::rpc_version_5)
diff --git a/src/components/application_manager/src/rpc_service_impl.cc b/src/components/application_manager/src/rpc_service_impl.cc
index 79b2cbd752..9a2d5d1118 100644
--- a/src/components/application_manager/src/rpc_service_impl.cc
+++ b/src/components/application_manager/src/rpc_service_impl.cc
@@ -186,9 +186,6 @@ bool RPCServiceImpl::ManageMobileCommand(
return false;
}
#endif // ENABLE_SECURITY
-
- // Message for "CheckPermission" must be with attached schema
- mobile_so_factory().attachSchema(*message, false);
}
auto plugin =
@@ -511,11 +508,6 @@ void RPCServiceImpl::SendMessageToMobile(
app->usage_report().RecordRejectionsSyncOutOfMemory();
}
- mobile_so_factory().attachSchema(*message, false);
- LOG4CXX_DEBUG(
- logger_,
- "Attached schema to message, result if valid: " << message->isValid());
-
// Messages to mobile are not yet prioritized so use default priority value
std::shared_ptr<Message> message_to_send(
new Message(protocol_handler::MessagePriority::kDefault));
@@ -542,13 +534,20 @@ void RPCServiceImpl::SendMessageToMobile(
(*message)[jhs::S_PARAMS][jhs::S_MESSAGE_TYPE].asInt())) {
allow_unknown_parameters = false;
}
+
+ const auto api_function_id = static_cast<mobile_apis::FunctionID::eType>(
+ (*message)[strings::params][strings::function_id].asUInt());
+
+ mobile_so_factory().attachSchema(*message, false);
+ LOG4CXX_DEBUG(
+ logger_,
+ "Attached schema to message, result if valid: " << message->isValid());
+
if (!ConvertSOtoMessage(
(*message), (*message_to_send), allow_unknown_parameters)) {
LOG4CXX_WARN(logger_, "Can't send msg to Mobile: failed to create string");
return;
}
- const auto api_function_id = static_cast<mobile_apis::FunctionID::eType>(
- (*message)[strings::params][strings::function_id].asUInt());
smart_objects::SmartObject& msg_to_mobile = *message;
// If correlation_id is not present, it is from-HMI message which should be
diff --git a/src/components/application_manager/test/CMakeLists.txt b/src/components/application_manager/test/CMakeLists.txt
index f6146f96f9..230be524c8 100755
--- a/src/components/application_manager/test/CMakeLists.txt
+++ b/src/components/application_manager/test/CMakeLists.txt
@@ -86,6 +86,9 @@ set (RequestController_SOURCES
${AM_TEST_DIR}/mock_message_helper.cc
)
+set (RPCHandlerImplTest_SOURCES ${AM_TEST_DIR}/rpc_handler_impl_test.cc
+ ${AM_TEST_DIR}/mock_message_helper.cc)
+
set(LIBRARIES
Utils
ApplicationManager
@@ -144,6 +147,8 @@ create_test("help_prompt_manager_test" "${testSourcesHelpPromptManager}" "${LIBR
create_test("request_controller_test" "${RequestController_SOURCES}" "${LIBRARIES}")
+create_test("rpc_handler_impl_test" "${RPCHandlerImplTest_SOURCES}" "${LIBRARIES}")
+
set(ResumptionData_SOURCES
${AM_TEST_DIR}/resumption/resumption_data_test.cc
${AM_TEST_DIR}/resumption/resumption_data_db_test.cc
diff --git a/src/components/application_manager/test/rpc_handler_impl_test.cc b/src/components/application_manager/test/rpc_handler_impl_test.cc
new file mode 100644
index 0000000000..47c6cd73be
--- /dev/null
+++ b/src/components/application_manager/test/rpc_handler_impl_test.cc
@@ -0,0 +1,123 @@
+/*
+ * Copyright (c) 2019, 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 "application_manager/rpc_handler_impl.h"
+#include <memory>
+#include "application_manager/mock_application_manager.h"
+#include "application_manager/smart_object_keys.h"
+#include "interfaces/HMI_API.h"
+#include "interfaces/MOBILE_API.h"
+
+namespace test {
+namespace components {
+namespace application_manager_test {
+
+using ::test::components::application_manager_test::MockApplicationManager;
+using ::testing::_;
+using ::testing::Mock;
+using ::testing::NiceMock;
+using namespace ::smart_objects;
+using namespace application_manager::rpc_handler;
+
+class RPCHandlerImplTest : public ::testing::Test {
+ public:
+ RPCHandlerImplTest()
+ : rpc_handler_(new RPCHandlerImpl(
+ mock_app_mngr_, hmi_so_factory_, mobile_so_factory_)) {}
+
+ protected:
+ std::unique_ptr<RPCHandlerImpl> rpc_handler_;
+ hmi_apis::HMI_API hmi_so_factory_;
+ mobile_apis::MOBILE_API mobile_so_factory_;
+ NiceMock<MockApplicationManager> mock_app_mngr_;
+};
+
+TEST_F(RPCHandlerImplTest, GetMessageVersion_SUCCESS) {
+ namespace json_str = ns_smart_device_link::ns_json_handler::strings;
+ namespace app_str = application_manager::strings;
+
+ std::vector<utils::SemanticVersion> test_versions = {
+ utils::SemanticVersion("2.5.0"),
+ utils::SemanticVersion("3.0.0"),
+ utils::SemanticVersion("5.0.0"),
+ utils::SemanticVersion("6.1.0")};
+
+ std::vector<utils::SemanticVersion> expected_versions = {
+ utils::base_rpc_version,
+ utils::base_rpc_version,
+ utils::SemanticVersion("5.0.0"),
+ utils::SemanticVersion("6.1.0")};
+
+ SmartObject message;
+ message[json_str::S_MSG_PARAMS] = SmartObject(SmartType_Map);
+ message[json_str::S_MSG_PARAMS][app_str::sync_msg_version] =
+ SmartObject(SmartType_Map);
+
+ for (size_t i = 0; i < test_versions.size(); ++i) {
+ message[json_str::S_MSG_PARAMS][app_str::sync_msg_version]
+ [app_str::major_version] = test_versions[i].major_version_;
+ message[json_str::S_MSG_PARAMS][app_str::sync_msg_version]
+ [app_str::minor_version] = test_versions[i].minor_version_;
+ message[json_str::S_MSG_PARAMS][app_str::sync_msg_version]
+ [app_str::patch_version] = test_versions[i].patch_version_;
+
+ utils::SemanticVersion result_message_version;
+ rpc_handler_->GetMessageVersion(message, result_message_version);
+ EXPECT_EQ(expected_versions[i], result_message_version);
+ }
+}
+
+TEST_F(RPCHandlerImplTest, GetMessageVersion_InvalidVersion) {
+ namespace json_str = ns_smart_device_link::ns_json_handler::strings;
+ namespace app_str = application_manager::strings;
+
+ SmartObject message;
+ message[json_str::S_MSG_PARAMS] = SmartObject(SmartType_Map);
+ message[json_str::S_MSG_PARAMS][app_str::sync_msg_version] =
+ SmartObject(SmartType_Map);
+ message[json_str::S_MSG_PARAMS][app_str::sync_msg_version]
+ [app_str::major_version] = 0;
+ message[json_str::S_MSG_PARAMS][app_str::sync_msg_version]
+ [app_str::minor_version] = 0;
+ message[json_str::S_MSG_PARAMS][app_str::sync_msg_version]
+ [app_str::patch_version] = 0;
+
+ utils::SemanticVersion expected_version("0.0.0");
+
+ utils::SemanticVersion result_message_version;
+ rpc_handler_->GetMessageVersion(message, result_message_version);
+ EXPECT_EQ(expected_version, result_message_version);
+}
+
+} // namespace application_manager_test
+} // namespace components
+} // namespace test
diff --git a/src/components/include/utils/semantic_version.h b/src/components/include/utils/semantic_version.h
index 5b2f2a1cdf..01b04495ad 100644
--- a/src/components/include/utils/semantic_version.h
+++ b/src/components/include/utils/semantic_version.h
@@ -51,16 +51,16 @@ struct SemanticVersion {
SemanticVersion(const std::string& versionString)
: major_version_(0), minor_version_(0), patch_version_(0) {
- unsigned int major_int, minor_int, patch_int;
- int readElements = sscanf(
- versionString.c_str(), "%u.%u.%u", &major_int, &minor_int, &patch_int);
- if (readElements != 3) {
- // LOG4CXX_WARN(logger_,
- // "Error while parsing version string: " << versionString);
- } else {
- major_version_ = static_cast<uint8_t>(major_int);
- minor_version_ = static_cast<uint8_t>(minor_int);
- patch_version_ = static_cast<uint8_t>(patch_int);
+ int readElements = sscanf(versionString.c_str(),
+ "%hu.%hu.%hu",
+ &major_version_,
+ &minor_version_,
+ &patch_version_);
+
+ if (readElements < 2) {
+ major_version_ = 0;
+ minor_version_ = 0;
+ patch_version_ = 0;
}
}
@@ -122,4 +122,4 @@ extern const SemanticVersion base_rpc_version;
extern const SemanticVersion rpc_version_5;
} // namespace utils
-#endif // SRC_COMPONENTS_INCLUDE_UTILS_CALLABLE_H \ No newline at end of file
+#endif // SRC_COMPONENTS_INCLUDE_UTILS_CALLABLE_H
diff --git a/src/components/smart_objects/CMakeLists.txt b/src/components/smart_objects/CMakeLists.txt
index ef84c52ab9..6bc70f8226 100644
--- a/src/components/smart_objects/CMakeLists.txt
+++ b/src/components/smart_objects/CMakeLists.txt
@@ -34,6 +34,7 @@ include_directories(
${COMPONENTS_DIR}/include
${COMPONENTS_DIR}/smart_objects/include
${COMPONENTS_DIR}/utils/include
+ ${CMAKE_BINARY_DIR}/src/components/interfaces
${BOOST_INCLUDE_DIR}
)
@@ -45,6 +46,7 @@ collect_sources(SOURCES "${PATHS}")
add_library("SmartObjects" ${SOURCES})
target_link_libraries("SmartObjects" Utils)
+add_dependencies("SmartObjects" MOBILE_API)
if(ENABLE_LOG)
target_link_libraries("SmartObjects" log4cxx -L${LOG4CXX_LIBS_DIRECTORY})
diff --git a/src/components/smart_objects/include/smart_objects/object_schema_item.h b/src/components/smart_objects/include/smart_objects/object_schema_item.h
index ee42b36620..58e13106d4 100644
--- a/src/components/smart_objects/include/smart_objects/object_schema_item.h
+++ b/src/components/smart_objects/include/smart_objects/object_schema_item.h
@@ -68,6 +68,7 @@ struct SMember {
const bool IsDeprecated = false,
const bool IsRemoved = false,
const std::vector<SMember>& history_vector = {});
+
/**
* @brief Checks the version a parameter was removed (until)
* If the mobile's msg version is greater than or
@@ -179,9 +180,11 @@ class CObjectSchemaItem : public ISchemaItem {
/**
* @brief Returns the correct schema item based on message version.
* @param member Schema member
- * @param MmessageVersion Semantic Version of mobile message.
+ * @param MessageVersion Semantic Version of mobile message.
+ * @return Pointer to correct schema item if item found or nullptr, if item
+ *was not found.
**/
- const SMember& GetCorrectMember(const SMember& member,
+ const SMember* GetCorrectMember(const SMember& member,
const utils::SemanticVersion& messageVersion);
/**
diff --git a/src/components/smart_objects/src/object_schema_item.cc b/src/components/smart_objects/src/object_schema_item.cc
index 01e4ec46e0..27c64de7e2 100644
--- a/src/components/smart_objects/src/object_schema_item.cc
+++ b/src/components/smart_objects/src/object_schema_item.cc
@@ -33,6 +33,7 @@
#include <algorithm>
+#include "generated_msg_version.h"
#include "smart_objects/always_false_schema_item.h"
#include "smart_objects/smart_object.h"
@@ -40,6 +41,9 @@ namespace {
const char connection_key[] = "connection_key";
const char binary_data[] = "binary_data";
const char app_id[] = "appID";
+const utils::SemanticVersion kModuleVersion(application_manager::major_version,
+ application_manager::minor_version,
+ application_manager::patch_version);
} // namespace
namespace ns_smart_device_link {
namespace ns_smart_objects {
@@ -80,25 +84,17 @@ bool SMember::CheckHistoryFieldVersion(
if (MessageVersion.isValid()) {
if (mSince != boost::none) {
if (MessageVersion < mSince.get()) {
- return false; // Msg version predates `since` field
- } else {
- if (mUntil != boost::none && (MessageVersion >= mUntil.get())) {
- return false; // Msg version newer than `until` field
- } else {
- return true; // Mobile msg version falls within specified version
- // range
- }
+ return false;
}
}
-
- if (mUntil != boost::none && (MessageVersion >= mUntil.get())) {
- return false; // Msg version newer than `until` field
- } else {
- return true; // Mobile msg version falls within specified version range
+ if (mUntil != boost::none) {
+ if (MessageVersion >= mUntil.get()) {
+ return false; // Msg version newer than `until` field
+ }
}
}
- return true; // Not enough version information. Default true.
+ return true; // All checks passed. Return true.
}
std::shared_ptr<CObjectSchemaItem> CObjectSchemaItem::create(
@@ -126,12 +122,12 @@ errors::eType CObjectSchemaItem::validate(
++it) {
const std::string& key = it->first;
const SMember& member = it->second;
- const SMember& correct_member = GetCorrectMember(member, MessageVersion);
+ const SMember* correct_member = GetCorrectMember(member, MessageVersion);
std::set<std::string>::const_iterator key_it = object_keys.find(key);
if (object_keys.end() == key_it) {
- if (correct_member.mIsMandatory == true &&
- correct_member.mIsRemoved == false) {
+ if (correct_member && correct_member->mIsMandatory == true &&
+ correct_member->mIsRemoved == false) {
std::string validation_info = "Missing mandatory parameter: " + key;
report__->set_validation_info(validation_info);
return errors::MISSING_MANDATORY_PARAMETER;
@@ -142,11 +138,16 @@ errors::eType CObjectSchemaItem::validate(
errors::eType result = errors::OK;
// Check if MessageVersion matches schema version
- result =
- correct_member.mSchemaItem->validate(field,
- &report__->ReportSubobject(key),
- MessageVersion,
- allow_unknown_enums);
+ if (correct_member) {
+ result =
+ correct_member->mSchemaItem->validate(field,
+ &report__->ReportSubobject(key),
+ MessageVersion,
+ allow_unknown_enums);
+ } else {
+ result = errors::ERROR;
+ }
+
if (errors::OK != result) {
return result;
}
@@ -251,45 +252,43 @@ CObjectSchemaItem::CObjectSchemaItem(const Members& members)
void CObjectSchemaItem::RemoveFakeParams(
SmartObject& Object, const utils::SemanticVersion& MessageVersion) {
- for (SmartMap::const_iterator it = Object.map_begin();
- it != Object.map_end();) {
- const std::string& key = it->first;
+ for (const auto& key : Object.enumerate()) {
std::map<std::string, SMember>::const_iterator members_it =
mMembers.find(key);
- if (mMembers.end() == members_it
- // FIXME(EZamakhov): Remove illegal usage of filed in AM
- && key.compare(connection_key) != 0 && key.compare(binary_data) != 0 &&
- key.compare(app_id) != 0) {
- ++it;
- Object.erase(key);
- } else if (mMembers.end() != members_it &&
- GetCorrectMember(members_it->second, MessageVersion)
- .mIsRemoved) {
- ++it;
+ if (mMembers.end() != members_it) {
+ const SMember* member =
+ GetCorrectMember(members_it->second, MessageVersion);
+ if (!member || member->mIsRemoved) {
+ Object.erase(key);
+ }
+ continue;
+ } else if (key.compare(connection_key) != 0 &&
+ key.compare(binary_data) != 0 && key.compare(app_id) != 0) {
Object.erase(key);
- } else {
- ++it;
}
}
}
-const SMember& CObjectSchemaItem::GetCorrectMember(
+const SMember* CObjectSchemaItem::GetCorrectMember(
const SMember& member, const utils::SemanticVersion& messageVersion) {
// Check if member is the correct version
if (member.CheckHistoryFieldVersion(messageVersion)) {
- return member;
+ return &member;
}
// Check for history tag items
if (!member.mHistoryVector.empty()) {
for (uint i = 0; i < member.mHistoryVector.size(); i++) {
if (member.mHistoryVector[i].CheckHistoryFieldVersion(messageVersion)) {
- return member.mHistoryVector[i];
+ return &member.mHistoryVector[i];
}
}
}
+
// Return member as default
- return member;
+ return (member.mSince != boost::none && member.mSince.get() > kModuleVersion)
+ ? &member
+ : nullptr;
}
} // namespace ns_smart_objects