This repository has been archived by the owner on May 21, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
OTA-4174: IP Secondary TCP server refactoring
- improve the TCP server implementation - add tests for the TCP server and the RPC (serialization/deserialization) Signed-off-by: Mike Sul <ext-mykhaylo.sul@here.com>
- Loading branch information
Mike Sul
committed
Jan 15, 2020
1 parent
4fd855c
commit 27db9c8
Showing
16 changed files
with
319 additions
and
156 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| #ifndef AKTUALIZR_SECONDARY_TCP_SERVER_H_ | ||
| #define AKTUALIZR_SECONDARY_TCP_SERVER_H_ | ||
|
|
||
| #include "utilities/utils.h" | ||
|
|
||
| #include <atomic> | ||
|
|
||
| namespace Uptane { | ||
| class SecondaryInterface; | ||
| } // namespace Uptane | ||
| /** | ||
| * Listens on a socket, decodes calls (ASN.1) and forwards them to an Uptane Secondary | ||
| * implementation | ||
| */ | ||
| class SecondaryTcpServer { | ||
| public: | ||
| SecondaryTcpServer(Uptane::SecondaryInterface& secondary, const std::string& primary_ip, in_port_t primary_port, | ||
| in_port_t port = 0); | ||
|
|
||
| SecondaryTcpServer(Uptane::SecondaryInterface& secondary, in_port_t port = 0) | ||
| : keep_running_(true), impl_(secondary), listen_socket_(port) {} | ||
|
|
||
| SecondaryTcpServer(const SecondaryTcpServer&) = delete; | ||
| SecondaryTcpServer& operator=(const SecondaryTcpServer&) = delete; | ||
|
|
||
| public: | ||
| /** | ||
| * Accept connections on the socket, decode requests and respond using the secondary implementation | ||
| */ | ||
| void run(); | ||
| void stop(); | ||
|
|
||
| in_port_t port() const; | ||
|
|
||
| private: | ||
| void HandleOneConnection(int socket); | ||
|
|
||
| private: | ||
| std::atomic<bool> keep_running_; | ||
| Uptane::SecondaryInterface& impl_; | ||
| ListenSocket listen_socket_; | ||
| }; | ||
|
|
||
| #endif // AKTUALIZR_SECONDARY_TCP_SERVER_H_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| #include <gtest/gtest.h> | ||
|
|
||
| #include "ipuptanesecondary.h" | ||
| #include "logging/logging.h" | ||
| #include "secondary_tcp_server.h" | ||
| #include "test_utils.h" | ||
| #include "uptane/secondaryinterface.h" | ||
|
|
||
| class SecondaryMock : public Uptane::SecondaryInterface { | ||
| public: | ||
| SecondaryMock(const Uptane::EcuSerial& serial, const Uptane::HardwareIdentifier& hdw_id, const PublicKey& pub_key, | ||
| const Json::Value& manifest) | ||
| : _serial(serial), _hdw_id(hdw_id), _pub_key(pub_key), _manifest(manifest) {} | ||
|
|
||
| public: | ||
| virtual Uptane::EcuSerial getSerial() { return _serial; } | ||
| virtual Uptane::HardwareIdentifier getHwId() { return _hdw_id; } | ||
| virtual PublicKey getPublicKey() { return _pub_key; } | ||
| virtual Json::Value getManifest() { return _manifest; } | ||
| virtual bool putMetadata(const Uptane::RawMetaPack& meta_pack) { | ||
| _metapack = meta_pack; | ||
| return true; | ||
| } | ||
| virtual int32_t getRootVersion(bool director) { | ||
| (void)director; | ||
| return 0; | ||
| } | ||
| virtual bool putRoot(const std::string& root, bool director) { | ||
| (void)root; | ||
| (void)director; | ||
| return true; | ||
| } | ||
|
|
||
| virtual bool sendFirmware(const std::shared_ptr<std::string>& data) { | ||
| _data = *data; | ||
| return true; | ||
| } | ||
|
|
||
| public: | ||
| const Uptane::EcuSerial _serial; | ||
| const Uptane::HardwareIdentifier _hdw_id; | ||
| const PublicKey _pub_key; | ||
| const Json::Value _manifest; | ||
|
|
||
| Uptane::RawMetaPack _metapack; | ||
| std::string _data; | ||
| }; | ||
|
|
||
| bool operator==(const Uptane::RawMetaPack& lhs, const Uptane::RawMetaPack& rhs) { | ||
| return (lhs.director_root == rhs.director_root) && (lhs.image_root == rhs.image_root) && | ||
| (lhs.director_targets == rhs.director_targets) && (lhs.image_snapshot == rhs.image_snapshot) && | ||
| (lhs.image_timestamp == rhs.image_timestamp) && (lhs.image_targets == rhs.image_targets); | ||
| } | ||
|
|
||
| // Test the serialization/deserialization and the TCP/IP communication implementation | ||
| // that occurs during communication between Primary and IP Secondary | ||
| TEST(SecondaryTcpServer, TestIpSecondaryRPC) { | ||
| // secondary object on Secondary ECU | ||
| SecondaryMock secondary(Uptane::EcuSerial("serial"), Uptane::HardwareIdentifier("hardware-id"), | ||
| PublicKey("pub-key", KeyType::kED25519), Json::Value::null); | ||
|
|
||
| // create Secondary on Secondary ECU, and run it in a dedicated thread | ||
| SecondaryTcpServer secondary_server{secondary}; | ||
| std::thread secondary_server_thread{[&secondary_server]() { secondary_server.run(); }}; | ||
|
|
||
| // create Secondary on Primary ECU, try it a few times since the secondary thread | ||
| // might not be ready at the moment of the first try | ||
| const int max_try = 5; | ||
| std::shared_ptr<Uptane::SecondaryInterface> ip_secondary; | ||
| for (int ii = 0; ii < max_try && ip_secondary == nullptr; ++ii) { | ||
| auto secondary_res = Uptane::IpUptaneSecondary::connectAndCreate("localhost", secondary_server.port()); | ||
| if (secondary_res.first) { | ||
| ip_secondary = secondary_res.second; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| ASSERT_TRUE(ip_secondary != nullptr) << "Failed to create IP Secondary"; | ||
| EXPECT_EQ(ip_secondary->getSerial(), secondary.getSerial()); | ||
| EXPECT_EQ(ip_secondary->getHwId(), secondary.getHwId()); | ||
| EXPECT_EQ(ip_secondary->getPublicKey(), secondary.getPublicKey()); | ||
| EXPECT_EQ(ip_secondary->getManifest(), secondary.getManifest()); | ||
|
|
||
| Uptane::RawMetaPack meta_pack{"director-root", "director-target", "image_root", | ||
| "image_targets", "image_timestamp", "image_snapshot"}; | ||
|
|
||
| EXPECT_TRUE(ip_secondary->putMetadata(meta_pack)); | ||
| EXPECT_TRUE(meta_pack == secondary._metapack); | ||
|
|
||
| std::string firmware = "firmware"; | ||
| EXPECT_TRUE(ip_secondary->sendFirmware(std::make_shared<std::string>(firmware))); | ||
| EXPECT_EQ(firmware, secondary._data); | ||
|
|
||
| secondary_server.stop(); | ||
| secondary_server_thread.join(); | ||
| } | ||
|
|
||
| TEST(SecondaryTcpServer, TestIpSecondaryIfSecondaryIsNotRunning) { | ||
| in_port_t secondary_port = TestUtils::getFreePortAsInt(); | ||
| std::shared_ptr<Uptane::SecondaryInterface> ip_secondary; | ||
|
|
||
| // trying to connect to a non-running Secondary and create a corresponding instance on Primary | ||
| auto secondary_res = Uptane::IpUptaneSecondary::connectAndCreate("localhost", secondary_port); | ||
| if (secondary_res.first) { | ||
| ip_secondary = secondary_res.second; | ||
| } | ||
| EXPECT_EQ(ip_secondary, nullptr); | ||
|
|
||
| // create Primary's secondary without connecting to Secondary | ||
| ip_secondary = std::make_shared<Uptane::IpUptaneSecondary>("localhost", secondary_port, Uptane::EcuSerial("serial"), | ||
| Uptane::HardwareIdentifier("hwid"), | ||
| PublicKey("key", KeyType::kED25519)); | ||
|
|
||
| Uptane::RawMetaPack meta_pack{"director-root", "director-target", "image_root", | ||
| "image_targets", "image_timestamp", "image_snapshot"}; | ||
|
|
||
| // expect failures since the secondary is not running | ||
| EXPECT_EQ(ip_secondary->getManifest(), Json::Value()); | ||
| EXPECT_FALSE(ip_secondary->sendFirmware(std::make_shared<std::string>("firmware"))); | ||
| EXPECT_FALSE(ip_secondary->putMetadata(meta_pack)); | ||
| } | ||
|
|
||
| int main(int argc, char** argv) { | ||
| ::testing::InitGoogleTest(&argc, argv); | ||
|
|
||
| logger_init(); | ||
| logger_set_threshold(boost::log::trivial::info); | ||
|
|
||
| return RUN_ALL_TESTS(); | ||
| } |
Oops, something went wrong.