Reset error state when shutting down chip-tool commands. (#20818)

Some commands store an error status. If they fail, the next invocation of the same command in interactive mode will also claim to have failed, even if it succeeded, because the error status carries over. The fix is to reset the error status on Shutdown of the command.
project-chip · Oct 10, 2023 · 05f7bb8 · 05f7bb8
1 parent 16a1fdc
commit 05f7bb8
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 1 deletion.
diff --git a/examples/chip-tool/commands/clusters/ClusterCommand.h b/examples/chip-tool/commands/clusters/ClusterCommand.h
@@ -124,6 +124,12 @@ class ClusterCommand : public InteractionModelCommands, public ModelCommand, pub
         }
     }
 
+    void Shutdown() override
+    {
+        mError = CHIP_NO_ERROR;
+        ModelCommand::Shutdown();
+    }
+
 protected:
     ClusterCommand(const char * commandName, CredentialIssuerCommands * credsIssuerConfig) :
         InteractionModelCommands(this), ModelCommand(commandName, credsIssuerConfig)

diff --git a/examples/chip-tool/commands/clusters/ReportCommand.h b/examples/chip-tool/commands/clusters/ReportCommand.h
@@ -98,6 +98,7 @@ class ReportCommand : public InteractionModelReports, public ModelCommand, publi
     {
         // We don't shut down InteractionModelReports here; we leave it for
         // Cleanup to handle.
+        mError = CHIP_NO_ERROR;
         ModelCommand::Shutdown();
     }
 

diff --git a/examples/chip-tool/commands/clusters/WriteAttributeCommand.h b/examples/chip-tool/commands/clusters/WriteAttributeCommand.h
@@ -149,6 +149,12 @@ class WriteAttribute : public InteractionModelWriter, public ModelCommand, publi
                                                            dataVersion);
     }
 
+    void Shutdown() override
+    {
+        mError = CHIP_NO_ERROR;
+        ModelCommand::Shutdown();
+    }
+
 protected:
     WriteAttribute(const char * attributeName, CredentialIssuerCommands * credsIssuerConfig) :
         InteractionModelWriter(this), ModelCommand("write", credsIssuerConfig)

diff --git a/examples/darwin-framework-tool/commands/clusters/ClusterCommandBridge.h b/examples/darwin-framework-tool/commands/clusters/ClusterCommandBridge.h
@@ -101,6 +101,12 @@ class ClusterCommand : public ModelCommand {
         return CHIP_NO_ERROR;
     }
 
+    void Shutdown() override
+    {
+        mError = nil;
+        ModelCommand::Shutdown();
+    }
+
 protected:
     ClusterCommand(const char * _Nonnull commandName)
         : ModelCommand(commandName)

diff --git a/examples/darwin-framework-tool/commands/clusters/ModelCommandBridge.mm b/examples/darwin-framework-tool/commands/clusters/ModelCommandBridge.mm
@@ -53,4 +53,8 @@
     return CHIP_NO_ERROR;
 }
 
-void ModelCommand::Shutdown() { ResetArguments(); }
+void ModelCommand::Shutdown()
+{
+    ResetArguments();
+    CHIPCommandBridge::Shutdown();
+}