Aktualizr secondary auto reboot

CHANGELOG.md

@@ -6,6 +6,9 @@ Our versioning scheme is `YEAR.N` where `N` is incremented whenever a new releas
 
 ## [??? (unreleased)]
 
+### Added
+
+- Aktualizr secondaries can now reboot automatically after triggering an update: [PR](https://github.com/advancedtelematic/aktualizr/pull/1578)
 
 ## [2020.3] - 2020-02-27
 

src/aktualizr_secondary/aktualizr_secondary.cc

@@ -135,6 +135,8 @@ data::ResultCode::Numeric AktualizrSecondary::install(const std::string& target_
   return install_result;
 }
 
+void AktualizrSecondary::completeInstall() { update_agent_->completeInstall(); }
+
 bool AktualizrSecondary::doFullVerification(const Metadata& metadata) {
   // 5.4.4.2. Full verification  https://uptane.github.io/uptane-standard/uptane-standard.html#metadata_verification
 

src/aktualizr_secondary/aktualizr_secondary.h

@@ -34,6 +34,7 @@ class AktualizrSecondary : public Uptane::SecondaryInterface {
   bool sendFirmware(const std::string& firmware) override;
   data::ResultCode::Numeric install(const std::string& target_name) override;
 
+  void completeInstall();
   bool putMetadata(const Metadata& metadata);
 
  private:

src/aktualizr_secondary/aktualizr_secondary_config.cc

@@ -19,13 +19,15 @@ void AktualizrSecondaryUptaneConfig::updateFromPropertyTree(const boost::propert
   CopyFromConfig(ecu_hardware_id, "ecu_hardware_id", pt);
   CopyFromConfig(key_source, "key_source", pt);
   CopyFromConfig(key_type, "key_type", pt);
+  CopyFromConfig(force_install_completion, "force_install_completion", pt);
 }
 
 void AktualizrSecondaryUptaneConfig::writeToStream(std::ostream& out_stream) const {
   writeOption(out_stream, ecu_serial, "ecu_serial");
   writeOption(out_stream, ecu_hardware_id, "ecu_hardware_id");
   writeOption(out_stream, key_source, "key_source");
   writeOption(out_stream, key_type, "key_type");
+  writeOption(out_stream, force_install_completion, "force_install_completion");
 }
 
 AktualizrSecondaryConfig::AktualizrSecondaryConfig(const boost::program_options::variables_map& cmd) {

src/aktualizr_secondary/aktualizr_secondary_config.h

@@ -31,6 +31,7 @@ struct AktualizrSecondaryUptaneConfig {
   std::string ecu_hardware_id;
   CryptoSource key_source{CryptoSource::kFile};
   KeyType key_type{KeyType::kRSA2048};
+  bool force_install_completion{false};
 
   void updateFromPropertyTree(const boost::property_tree::ptree& pt);
   void writeToStream(std::ostream& out_stream) const;

src/aktualizr_secondary/main.cc

@@ -88,7 +88,14 @@ int main(int argc, char *argv[]) {
     LOG_DEBUG << "Current directory: " << boost::filesystem::current_path().string();
 
     auto secondary = AktualizrSecondaryFactory::create(config);
-    SecondaryTcpServer(*secondary, config.network.primary_ip, config.network.primary_port, config.network.port).run();
+    SecondaryTcpServer tcp_server(*secondary, config.network.primary_ip, config.network.primary_port,
+                                  config.network.port, config.uptane.force_install_completion);
+
+    tcp_server.run();
+
+    if (tcp_server.exit_reason() == SecondaryTcpServer::ExitReason::kRebootNeeded) {
+      secondary->completeInstall();
+    }
 
   } catch (std::runtime_error &exc) {
     LOG_ERROR << "Error: " << exc.what();

src/aktualizr_secondary/secondary_tcp_server.cc

@@ -9,8 +9,12 @@
 #include <netinet/tcp.h>
 
 SecondaryTcpServer::SecondaryTcpServer(Uptane::SecondaryInterface &secondary, const std::string &primary_ip,
-                                       in_port_t primary_port, in_port_t port)
-    : SecondaryTcpServer(secondary, port) {
+                                       in_port_t primary_port, in_port_t port, bool reboot_after_install)
+    : impl_(secondary), listen_socket_(port), keep_running_(true), reboot_after_install_(reboot_after_install) {
+  if (primary_ip.empty()) {
+    return;
+  }
+
   ConnectionSocket conn_socket(primary_ip, primary_port, listen_socket_.port());
   if (conn_socket.connect() == 0) {
     LOG_INFO << "Connected to Primary, sending info about this secondary...";
@@ -27,18 +31,22 @@ void SecondaryTcpServer::run() {
   LOG_INFO << "Secondary TCP server listens on " << listen_socket_.toString();
 
   while (keep_running_.load()) {
-    int con_fd;
     sockaddr_storage peer_sa{};
     socklen_t peer_sa_size = sizeof(sockaddr_storage);
 
     LOG_DEBUG << "Waiting for connection from client...";
-    if ((con_fd = accept(*listen_socket_, reinterpret_cast<sockaddr *>(&peer_sa), &peer_sa_size)) == -1) {
+    int con_fd = accept(*listen_socket_, reinterpret_cast<sockaddr *>(&peer_sa), &peer_sa_size);
+    if (con_fd == -1) {
       LOG_INFO << "Socket accept failed. aborting";
       break;
     }
+    Socket con_socket(con_fd);
     LOG_DEBUG << "Connected...";
-    HandleOneConnection(con_fd);
+    bool continue_serving = HandleOneConnection(*con_socket);
     LOG_DEBUG << "Client disconnected";
+    if (!continue_serving) {
+      break;
+    }
   }
   LOG_INFO << "Secondary TCP server exit";
 }
@@ -50,8 +58,9 @@ void SecondaryTcpServer::stop() {
 }
 
 in_port_t SecondaryTcpServer::port() const { return listen_socket_.port(); }
+SecondaryTcpServer::ExitReason SecondaryTcpServer::exit_reason() const { return exit_reason_; }
 
-void SecondaryTcpServer::HandleOneConnection(int socket) {
+bool SecondaryTcpServer::HandleOneConnection(int socket) {
   // Outside the message loop, because one recv() may have parts of 2 messages
   // Note that one recv() call returning 2+ messages doesn't work at the
   // moment. This shouldn't be a problem until we have messages that aren't
@@ -64,6 +73,8 @@ void SecondaryTcpServer::HandleOneConnection(int socket) {
     asn_dec_rval_t res;
     asn_codec_ctx_s context{};
     ssize_t received;
+    bool need_reboot = false;
+
     do {
       received = recv(socket, buffer.Tail(), buffer.TailSpace(), 0);
       LOG_TRACE << "Got " << received << " bytes "
@@ -76,7 +87,7 @@ void SecondaryTcpServer::HandleOneConnection(int socket) {
     Asn1Message::Ptr msg = Asn1Message::FromRaw(&m);
 
     if (res.code != RC_OK) {
-      return;  // Either an error or the client closed the socket
+      return true;  // Either an error or the client closed the socket
     }
 
     // Figure out what to do with the message
@@ -144,10 +155,14 @@ void SecondaryTcpServer::HandleOneConnection(int socket) {
         resp->present(AKIpUptaneMes_PR_installResp);
         auto response_message = resp->installResp();
         response_message->result = static_cast<AKInstallationResultCode_t>(install_result);
+
+        if (install_result == data::ResultCode::Numeric::kNeedCompletion) {
+          need_reboot = true;
+        }
       } break;
       default:
         LOG_ERROR << "Unrecognised message type:" << msg->present();
-        return;
+        return true;
     }
 
     // Send the response
@@ -157,15 +172,22 @@ void SecondaryTcpServer::HandleOneConnection(int socket) {
       asn_enc_rval_t encode_result =
           der_encode(&asn_DEF_AKIpUptaneMes, &resp->msg_, Asn1SocketWriteCallback, reinterpret_cast<void *>(&socket));
       if (encode_result.encoded == -1) {
-        return;  // write error
+        return true;  // write error
       }
       optval = 1;
       setsockopt(socket, IPPROTO_TCP, TCP_NODELAY, &optval, sizeof(int));
     } else {
       LOG_DEBUG << "Not sending a response to message " << msg->present();
     }
+
+    if (need_reboot && reboot_after_install_) {
+      exit_reason_ = ExitReason::kRebootNeeded;
+      return false;
+    }
+
   }  // Go back round and read another message
 
+  return true;
   // Parse error => Shutdown the socket
   // write error => Shutdown the socket
   // Timeout on write => shutdown

src/aktualizr_secondary/secondary_tcp_server.h

@@ -14,11 +14,14 @@ class SecondaryInterface;
  */
 class SecondaryTcpServer {
  public:
-  SecondaryTcpServer(Uptane::SecondaryInterface& secondary, const std::string& primary_ip, in_port_t primary_port,
-                     in_port_t port = 0);
+  enum class ExitReason {
+    kNotApplicable,
+    kRebootNeeded,
+    kUnkown,
+  };
 
-  SecondaryTcpServer(Uptane::SecondaryInterface& secondary, in_port_t port = 0)
-      : keep_running_(true), impl_(secondary), listen_socket_(port) {}
+  SecondaryTcpServer(Uptane::SecondaryInterface& secondary, const std::string& primary_ip, in_port_t primary_port,
+                     in_port_t port = 0, bool reboot_after_install = false);
 
   SecondaryTcpServer(const SecondaryTcpServer&) = delete;
   SecondaryTcpServer& operator=(const SecondaryTcpServer&) = delete;
@@ -31,14 +34,17 @@ class SecondaryTcpServer {
   void stop();
 
   in_port_t port() const;
+  ExitReason exit_reason() const;
 
  private:
-  void HandleOneConnection(int socket);
+  bool HandleOneConnection(int socket);
 
  private:
-  std::atomic<bool> keep_running_;
   Uptane::SecondaryInterface& impl_;
   ListenSocket listen_socket_;
+  std::atomic<bool> keep_running_;
+  bool reboot_after_install_;
+  ExitReason exit_reason_{ExitReason::kNotApplicable};
 };
 
 #endif  // AKTUALIZR_SECONDARY_TCP_SERVER_H_

src/aktualizr_secondary/secondary_tcp_server_test.cc

@@ -67,7 +67,7 @@ TEST(SecondaryTcpServer, TestIpSecondaryRPC) {
                           PublicKey("pub-key", KeyType::kED25519), Uptane::Manifest());
 
   // create Secondary on Secondary ECU, and run it in a dedicated thread
-  SecondaryTcpServer secondary_server{secondary};
+  SecondaryTcpServer secondary_server(secondary, "", 0);
   std::thread secondary_server_thread{[&secondary_server]() { secondary_server.run(); }};
 
   // create Secondary on Primary ECU, try it a few times since the secondary thread

src/aktualizr_secondary/update_agent.h

@@ -13,6 +13,7 @@ class UpdateAgent {
 
   virtual bool download(const Uptane::Target& target, const std::string& data) = 0;
   virtual data::ResultCode::Numeric install(const Uptane::Target& target) = 0;
+  virtual void completeInstall() = 0;
   virtual data::InstallationResult applyPendingInstall(const Uptane::Target& target) = 0;
 
   virtual ~UpdateAgent() = default;

src/aktualizr_secondary/update_agent_file.cc

@@ -54,6 +54,8 @@ data::ResultCode::Numeric FileUpdateAgent::install(const Uptane::Target& target)
   return data::ResultCode::Numeric::kOk;
 }
 
+void FileUpdateAgent::completeInstall() {}
+
 data::InstallationResult FileUpdateAgent::applyPendingInstall(const Uptane::Target& target) {
   (void)target;
   return data::InstallationResult(data::ResultCode::Numeric::kInternalError,

src/aktualizr_secondary/update_agent_file.h

@@ -13,6 +13,7 @@ class FileUpdateAgent : public UpdateAgent {
   bool getInstalledImageInfo(Uptane::InstalledImageInfo& installed_image_info) const override;
   bool download(const Uptane::Target& target, const std::string& data) override;
   data::ResultCode::Numeric install(const Uptane::Target& target) override;
+  void completeInstall() override;
   data::InstallationResult applyPendingInstall(const Uptane::Target& target) override;
 
  private:

src/aktualizr_secondary/update_agent_ostree.cc

@@ -77,6 +77,8 @@ data::ResultCode::Numeric OstreeUpdateAgent::install(const Uptane::Target& targe
   return (_ostreePackMan->install(target)).result_code.num_code;
 }
 
+void OstreeUpdateAgent::completeInstall() { _ostreePackMan->completeInstall(); }
+
 data::InstallationResult OstreeUpdateAgent::applyPendingInstall(const Uptane::Target& target) {
   return _ostreePackMan->finalizeInstall(target);
 }

src/aktualizr_secondary/update_agent_ostree.h

@@ -20,6 +20,7 @@ class OstreeUpdateAgent : public UpdateAgent {
   bool getInstalledImageInfo(Uptane::InstalledImageInfo& installed_image_info) const override;
   bool download(const Uptane::Target& target, const std::string& data) override;
   data::ResultCode::Numeric install(const Uptane::Target& target) override;
+  void completeInstall() override;
   data::InstallationResult applyPendingInstall(const Uptane::Target& target) override;
 
  private:

src/libaktualizr/utilities/utils.h

@@ -127,7 +127,8 @@ bool operator<(const sockaddr_storage &left, const sockaddr_storage &right);  //
 class Socket {
  public:
   Socket();
-  virtual ~Socket() = 0;
+  Socket(int fd) : socket_fd_(fd) {}
+  virtual ~Socket();
 
   Socket(const Socket &) = delete;
   Socket &operator=(const Socket &) = delete;

tests/CMakeLists.txt

@@ -186,9 +186,12 @@ add_test(NAME test_log_negative
 set_tests_properties(test_log_negative
                      PROPERTIES PASS_REGULAR_EXPRESSION "Invalid log level")
 
+if (BUILD_OSTREE)
+    set(TEST_IPSEC_ARGS "--ostree")
+endif ()
 add_test(NAME test_ip_secondary
          COMMAND ${PROJECT_SOURCE_DIR}/tests/ipsecondary_test.py
-         --build-dir ${PROJECT_BINARY_DIR} --src-dir ${PROJECT_SOURCE_DIR} --ostree ${BUILD_OSTREE})
+         --build-dir ${PROJECT_BINARY_DIR} --src-dir ${PROJECT_SOURCE_DIR} ${TEST_IPSEC_ARGS})
 
 add_test(NAME test_director_failure
         COMMAND ${PROJECT_SOURCE_DIR}/tests/test_director_failure.py

tests/ipsecondary_test.py

@@ -145,6 +145,46 @@ def test_secondary_ostree_update(uptane_repo, secondary, aktualizr, treehub, sys
     return True
 
 
+@with_treehub()
+@with_uptane_backend()
+@with_director()
+@with_sysroot()
+@with_secondary(start=False, output_logs=False, force_reboot=True)
+@with_aktualizr(start=False, run_mode='once', output_logs=True)
+def test_secondary_ostree_reboot(uptane_repo, secondary, aktualizr, treehub, sysroot, director, **kwargs):
+    target_rev = treehub.revision
+    expected_targetname = uptane_repo.add_ostree_target(secondary.id, target_rev, "GARAGE_TARGET_NAME")
+
+    with secondary:
+        with aktualizr:
+            aktualizr.wait_for_completion()
+        secondary.wait_for_completion()
+
+    pending_rev = aktualizr.get_current_pending_image_info(secondary.id)
+
+    if pending_rev != target_rev:
+        logger.error("Pending version {} != the target one {}".format(pending_rev, target_rev))
+        return False
+
+    sysroot.update_revision(pending_rev)
+
+    with secondary:
+        with aktualizr:
+            aktualizr.wait_for_completion()
+
+    if not director.get_install_result():
+        logger.error("Installation result is not successful")
+        return False
+
+    installed_rev = aktualizr.get_current_image_info(secondary.id)
+
+    if installed_rev != target_rev:
+        logger.error("Installed version {} != the target one {}".format(installed_rev, target_rev))
+        return False
+
+    return True
+
+
 @with_uptane_backend()
 @with_director()
 @with_secondary(start=False)
@@ -305,7 +345,7 @@ def test_primary_multiple_secondaries(uptane_repo, secondary, secondary2, aktual
     parser = argparse.ArgumentParser(description='Test IP Secondary')
     parser.add_argument('-b', '--build-dir', help='build directory', default='build')
     parser.add_argument('-s', '--src-dir', help='source directory', default='.')
-    parser.add_argument('-o', '--ostree', help='ostree support', default='OFF')
+    parser.add_argument('-o', '--ostree', help='ostree support', action='store_true')
 
     input_params = parser.parse_args()
 
@@ -323,8 +363,11 @@ def test_primary_multiple_secondaries(uptane_repo, secondary, secondary2, aktual
                     test_primary_multiple_secondaries,
     ]
 
-    if input_params.ostree == 'ON':
-        test_suite.append(test_secondary_ostree_update)
+    if input_params.ostree:
+        test_suite += [
+           test_secondary_ostree_update,
+           test_secondary_ostree_reboot,
+        ]
 
     test_suite_run_result = TestRunner(test_suite).run()