UIC-3222: Refactor Get All Users Checksum

Now the attribute ALL_USERS_CHECKSUM is defined at the end of the User interview if device support it
Add command to force the refresh of the checksum

Author: silabs-borisl

applications/zpc/components/zcl_cluster_servers/src/user_credential_cluster_server.cpp

@@ -548,6 +548,25 @@ sl_status_t uuic_association_set(dotdot_unid_t unid,
     destination_credential_slot);
 }
 
+sl_status_t get_all_users_checksum(dotdot_unid_t unid,
+                                  dotdot_endpoint_id_t endpoint,
+                                  uic_mqtt_dotdot_callback_call_type_t call_type)
+{
+  attribute_store_node_t endpoint_node
+    = attribute_store_network_helper_get_endpoint_node(unid, endpoint);
+
+  // Now that we know that the command is supported, return here if it is
+  // a support check type of call.
+  if (UIC_MQTT_DOTDOT_CALLBACK_TYPE_SUPPORT_CHECK == call_type) {
+    return zwave_command_class_user_credential_supports(endpoint_node,
+                                                        ALL_USERS_CHECKSUM_GET)
+             ? SL_STATUS_OK
+             : SL_STATUS_FAIL;
+  }
+
+  return zwave_command_class_user_credential_get_all_users_checksum(endpoint_node);
+}
+
 sl_status_t get_user_checksum(dotdot_unid_t unid,
                               dotdot_endpoint_id_t endpoint,
                               uic_mqtt_dotdot_callback_call_type_t call_type,
@@ -1048,7 +1067,7 @@ void on_user_credential_message(sl_log_level_t log_level,
   nlohmann::json payload;
   payload["level"]        = log_level;
   payload["message"]      = message;
-  
+
   std::string payload_str = payload.dump();
   uic_mqtt_publish("ucl/Event", payload_str.c_str(), payload_str.length(), true);
 }
@@ -1113,5 +1132,8 @@ sl_status_t user_credential_cluster_server_init()
   // Credential Checksum
   uic_mqtt_dotdot_user_credential_get_credential_checksum_callback_set(
     &get_credential_checksum);
+  // All Users Checksum
+  uic_mqtt_dotdot_user_credential_get_all_users_checksum_callback_set(
+    &get_all_users_checksum);
   return SL_STATUS_OK;
 }

applications/zpc/components/zcl_cluster_servers/test/user_credential_cluster_server_test.cpp

@@ -26,6 +26,7 @@ extern "C" {
 #include "attribute_store_defined_attribute_types.h"
 #include "zwave_command_class_association_types.h"
 #include "zap-types.h"
+#include "zwave_command_class_version_types.h"
 
 // ZPC Components
 #include "zpc_attribute_store_type_registration.h"
@@ -48,6 +49,9 @@ extern "C" {
 // Attribute macro, shortening those long defines for attribute types:
 #define ATTRIBUTE(type) ATTRIBUTE_COMMAND_CLASS_USER_CREDENTIAL_##type
 
+// Useful definitions
+attribute_store::attribute cpp_endpoint_node;
+
 // Header declarations
 void mock_deletion_user_mqtt_topic(user_credential_user_unique_id_t user_id);
 void mock_deletion_cred_mqtt_topic(user_credential_user_unique_id_t user_id,
@@ -86,6 +90,7 @@ uic_mqtt_dotdot_user_credential_credential_learn_stop_callback_t credential_lear
 uic_mqtt_dotdot_user_credential_credential_association_callback_t credential_association_command = NULL;
 uic_mqtt_dotdot_user_credential_get_user_checksum_callback_t get_user_checksum_command = NULL;
 uic_mqtt_dotdot_user_credential_get_credential_checksum_callback_t get_credential_checksum_command = NULL;
+uic_mqtt_dotdot_user_credential_get_all_users_checksum_callback_t get_all_users_checksum_command = NULL;
 // clang-format on
 
 // Stub functions for intercepting callback registration.
@@ -210,6 +215,15 @@ void uic_mqtt_dotdot_user_credential_get_credential_checksum_callback_set_stub(
   get_credential_checksum_command = callback;
 }
 
+void uic_mqtt_dotdot_user_credential_get_all_users_checksum_callback_set_stub(
+  const uic_mqtt_dotdot_user_credential_get_all_users_checksum_callback_t
+    callback,
+  int cmock_num_calls)
+{
+  get_all_users_checksum_command = callback;
+}
+
+
 /// Setup the test suite (called once before all test_xxx functions are called)
 void suiteSetUp()
 {
@@ -293,6 +307,7 @@ void setUp()
   uic_mqtt_dotdot_user_credential_get_user_checksum_callback_set_Stub(&uic_mqtt_dotdot_user_credential_get_user_checksum_callback_set_stub);
   // Credential checksum
   uic_mqtt_dotdot_user_credential_get_credential_checksum_callback_set_Stub(&uic_mqtt_dotdot_user_credential_get_credential_checksum_callback_set_stub);
+  uic_mqtt_dotdot_user_credential_get_all_users_checksum_callback_set_Stub(&uic_mqtt_dotdot_user_credential_get_all_users_checksum_callback_set_stub);
   // clang-format on
 
   // Run the component init
@@ -303,6 +318,17 @@ void setUp()
   setup_user_capabilities();
   // Need to call this after init() to have the mqtt callback initialized
   setup_cred_capabilities();
+
+  // Setup helper
+  cpp_endpoint_node = attribute_store::attribute(endpoint_id_node);
+}
+
+void set_version(zwave_cc_version_t version)
+{
+  // Set the version
+  cpp_endpoint_node
+    .emplace_node(ATTRIBUTE(VERSION))
+    .set_reported(version);
 }
 
 /////////////////////////////////////////////////////////////////////////
@@ -2352,6 +2378,57 @@ void test_user_credential_cluster_test_credential_checksum_happy_case()
     "Checksum node reported value should be not defined");
 }
 
+
+void test_user_credential_cluster_test_all_users_checksum_happy_case()
+{
+  set_version(1);
+
+  // Command not supported yet (default user capabilities SUPPORT_ALL_USERS_CHECKSUM set to 0)
+  TEST_ASSERT_EQUAL_MESSAGE(
+    SL_STATUS_FAIL,
+    get_all_users_checksum_command(supporting_node_unid,
+                                   endpoint_id,
+                                   UIC_MQTT_DOTDOT_CALLBACK_TYPE_SUPPORT_CHECK),
+    "Not supported yet since we are missing the capability");
+
+  cpp_endpoint_node.child_by_type(ATTRIBUTE(SUPPORT_ALL_USERS_CHECKSUM))
+    .set_reported<uint8_t>(1);
+
+  TEST_ASSERT_EQUAL_MESSAGE(
+    SL_STATUS_OK,
+    get_all_users_checksum_command(supporting_node_unid,
+                                   endpoint_id,
+                                   UIC_MQTT_DOTDOT_CALLBACK_TYPE_NORMAL),
+    "Should be able to setup attribute store for get_all_users_checksum");
+
+  auto checksum_node
+    = cpp_endpoint_node.child_by_type(ATTRIBUTE(ALL_USERS_CHECKSUM));
+
+  TEST_ASSERT_TRUE_MESSAGE(
+    checksum_node.is_valid(),
+    "All users checksum node should exists");
+
+  checksum_node.set_desired<uint16_t>(1312);
+  checksum_node.set_reported<uint16_t>(12);
+
+  // Try a second time to see if we clear the attributes
+  TEST_ASSERT_EQUAL_MESSAGE(
+    SL_STATUS_OK,
+    get_all_users_checksum_command(supporting_node_unid,
+                                   endpoint_id,
+                                   UIC_MQTT_DOTDOT_CALLBACK_TYPE_NORMAL),
+    "Should be able to setup attribute store for get_all_users_checksum");
+  
+  TEST_ASSERT_FALSE_MESSAGE(
+    checksum_node.desired_exists(),
+    "Checksum node desired value should NOT exists");
+
+  TEST_ASSERT_FALSE_MESSAGE(
+    checksum_node.reported_exists(),
+    "Checksum node reported value should NOT exists");
+}
+
+
 ///////////////////////////////////////////////////
 // Support tests
 ///////////////////////////////////////////////////

applications/zpc/components/zwave_command_classes/src/private/user_credential/user_credential_user_capabilities.cpp

@@ -41,7 +41,7 @@ user_capabilities::user_capabilities(attribute_store::attribute endpoint_node) {
     this->support_user_schedule
         = endpoint_node.child_by_type(ATTRIBUTE(SUPPORT_USER_SCHEDULE))
             .reported<uint8_t>();
-    this->support_all_user_checksum
+    this->support_all_users_checksum
         = endpoint_node.child_by_type(ATTRIBUTE(SUPPORT_ALL_USERS_CHECKSUM))
             .reported<uint8_t>();
     this->support_by_user_checksum
@@ -54,6 +54,7 @@ user_capabilities::user_capabilities(attribute_store::attribute endpoint_node) {
     sl_log_error(LOG_TAG,
                  "Something was wrong getting user capabilities : %s",
                  e.what());
+    attribute_store_log();
     this->is_data_valid = false;
   }
 }
@@ -116,4 +117,9 @@ bool user_capabilities::is_credential_rule_supported(
   return (supported_credential_rules_bitmask & (1 << credential_rule));
 }
 
+bool user_capabilities::is_all_users_checksum_supported() const
+{
+  return support_all_users_checksum;
+}
+
 }  // namespace user_credential

applications/zpc/components/zwave_command_classes/src/private/user_credential/user_credential_user_capabilities.h

@@ -79,6 +79,13 @@ class user_capabilities
   bool
     is_credential_rule_supported(user_credential_rule_t credential_rule) const;
 
+  /**
+   * @brief Check if all users checksum is supported
+   * @return true All users checksum is supported
+   * @return false All users checksum is not supported
+   */
+  bool is_all_users_checksum_supported() const;
+
   private:
   // Maximum number of users that can be stored in the device
   uint16_t max_user_count = 0;
@@ -91,7 +98,7 @@ class user_capabilities
   // Device support for scheduling users
   uint8_t support_user_schedule = 0;
   // Device support for getting the checksum of all users
-  uint8_t support_all_user_checksum = 0;
+  uint8_t support_all_users_checksum = 0;
   // Device support for getting the checksum of a specific user
   uint8_t support_by_user_checksum = 0;