Add retire_node_code proposal (#1558)

Author: achamayou

python/ccf/proposal_generator.py

@@ -310,6 +310,12 @@ def new_node_code(code_digest: str, **kwargs):
     return build_proposal("new_node_code", code_digest_bytes, **kwargs)
 
 
+@cli_proposal
+def retire_node_code(code_digest: str, **kwargs):
+    code_digest_bytes = list(bytearray.fromhex(code_digest))
+    return build_proposal("retire_node_code", code_digest_bytes, **kwargs)
+
+
 @cli_proposal
 def new_user_code(code_digest: str, **kwargs):
     code_digest_bytes = list(bytearray.fromhex(code_digest))

src/node/rpc/member_frontend.h

@@ -304,6 +304,26 @@ namespace ccf
       return true;
     }
 
+    bool retire_code_id(
+      kv::Tx& tx,
+      const CodeDigest& code_id,
+      CodeIDs& code_id_table,
+      ObjectId proposal_id)
+    {
+      auto code_ids = tx.get_view(code_id_table);
+      auto existing_code_id = code_ids->get(code_id);
+      if (!existing_code_id)
+      {
+        LOG_FAIL_FMT(
+          "Proposal {}: No such code id in table: {:02x}",
+          proposal_id,
+          fmt::join(code_id, ""));
+        return false;
+      }
+      code_ids->put(code_id, CodeStatus::RETIRED);
+      return true;
+    }
+
     //! Table of functions that proposal scripts can propose to invoke
     const std::unordered_map<
       std::string,
@@ -473,6 +493,15 @@ namespace ccf
              this->network.node_code_ids,
              proposal_id);
          }},
+        // retire node code ID
+        {"retire_node_code",
+         [this](ObjectId proposal_id, kv::Tx& tx, const nlohmann::json& args) {
+           return this->retire_code_id(
+             tx,
+             args.get<CodeDigest>(),
+             this->network.node_code_ids,
+             proposal_id);
+         }},
         // accept new user code ID
         {"new_user_code",
          [this](ObjectId proposal_id, kv::Tx& tx, const nlohmann::json& args) {

tests/code_update.py

@@ -110,6 +110,41 @@ def run(args):
         assert new_node
         network.wait_for_node_commit_sync(args.consensus)
 
+        LOG.info("Remove first code id")
+        network.consortium.retire_code(new_node, first_code_id)
+
+        with new_node.client() as uc:
+            r = uc.get("/node/code")
+            versions = sorted(r.body["versions"], key=lambda x: x["digest"])
+            expected = sorted(
+                [
+                    {"digest": first_code_id, "status": "RETIRED"},
+                    {"digest": new_code_id, "status": "ACCEPTED"},
+                ],
+                key=lambda x: x["digest"],
+            )
+            assert versions == expected, versions
+
+        LOG.info(f"Adding a node with retired code id {first_code_id}")
+        code_not_found_exception = None
+        try:
+            network.create_and_add_pending_node(
+                args.package, "localhost", args, timeout=3
+            )
+        except infra.network.CodeIdRetired as err:
+            code_not_found_exception = err
+
+        assert (
+            code_not_found_exception is not None
+        ), f"Adding a node with unsupported code id {new_code_id} should fail"
+
+        LOG.info("Adding another node with the new code to the network")
+        new_node = network.create_and_trust_node(
+            args.patched_file_name, "localhost", args
+        )
+        assert new_node
+        network.wait_for_node_commit_sync(args.consensus)
+
 
 if __name__ == "__main__":
 

tests/infra/consortium.py

@@ -355,6 +355,12 @@ def add_new_code(self, remote_node, new_code_id):
         proposal.vote_for = careful_vote
         return self.vote_using_majority(remote_node, proposal)
 
+    def retire_code(self, remote_node, code_id):
+        proposal_body, careful_vote = self.make_proposal("retire_node_code", code_id)
+        proposal = self.get_any_active_member().propose(remote_node, proposal_body)
+        proposal.vote_for = careful_vote
+        return self.vote_using_majority(remote_node, proposal)
+
     def add_new_user_code(self, remote_node, new_code_id):
         proposal_body, careful_vote = self.make_proposal("new_user_code", new_code_id)
         proposal = self.get_any_active_member().propose(remote_node, proposal_body)

tests/infra/network.py

@@ -47,6 +47,10 @@ class CodeIdNotFound(Exception):
     pass
 
 
+class CodeIdRetired(Exception):
+    pass
+
+
 class NodeShutdownError(Exception):
     pass
 
@@ -473,6 +477,8 @@ def create_and_add_pending_node(
                 for error in errors:
                     if "CODE_ID_NOT_FOUND" in error:
                         raise CodeIdNotFound from e
+                    if "CODE_ID_RETIRED" in error:
+                        raise CodeIdRetired from e
             raise
 
         return new_node