Issue 37140 - new getters and setters

Author: gabc-cpp

src/app/WriteHandler.cpp

@@ -788,7 +788,7 @@ DataModel::ActionReturnStatus WriteHandler::CheckWriteAllowed(const Access::Subj
     }
 
     // Allow writes on writable attributes only
-    VerifyOrReturnValue(attributeEntry->writePrivilegeHasValue(), Status::UnsupportedWrite);
+    VerifyOrReturnValue(attributeEntry->WriteAllowed(), Status::UnsupportedWrite);
 
     bool checkAcl = true;
     if (mLastSuccessfullyWrittenPath.has_value())

src/app/data-model-provider/MetadataTypes.h

@@ -22,7 +22,6 @@
 #include <access/Privilege.h>
 #include <lib/core/DataModelTypes.h>
 #include <lib/support/BitFlags.h>
-#include <assert.h>
 
 namespace chip {
 namespace app {
@@ -86,29 +85,13 @@ enum class AttributeQualityFlags : uint32_t
 };
 
 
-struct attribute_entry_mask_t {
-
-    // attribute quality flags
-    //
-    std::underlying_type_t<AttributeQualityFlags> flags : 7 ;  // generally defaults to View if readable
-
-    // read/write access privilege variables
-    //
-    std::underlying_type_t<Access::Privilege> readPrivilege : 5 ;  // generally defaults to View if readable
-    std::underlying_type_t<Access::Privilege> writePrivilege : 5 ; // generally defaults to Operate if writable
-
-};
-
-
-// Static ASSERT to check size of mask type.
-static_assert(sizeof(attribute_entry_mask_t) <= 4, "Size of attribute_entry_mask_t is not as expected.");
-
 // zero is not a valid privilege, just a default initial value for privileges
 constexpr std::underlying_type_t<Access::Privilege> kNoPrivilege(0) ;
 
 
 struct AttributeEntry
 {
+
     AttributeId attributeId;
 
     // Constructor
@@ -122,10 +105,6 @@ struct AttributeEntry
                       sizeof(chip::to_underlying(r)),
                       "Size of readPrivilege is not able to accomodate parameter (r).");
 
-        // ASSERT to validate entry parameter value.
-        assert(kNoPrivilege != chip::to_underlying(r));
-
-
         mask.readPrivilege = chip::to_underlying(r);
     }
 
@@ -141,9 +120,6 @@ struct AttributeEntry
                       sizeof(chip::to_underlying(w)),
                       "Size of writePrivilege is not able to accomodate parameter (w).");
 
-        // ASSERT to validate entry parameter value.
-        assert(kNoPrivilege != chip::to_underlying(w));
-
         mask.writePrivilege = chip::to_underlying(w);
     }
 
@@ -169,13 +145,30 @@ struct AttributeEntry
 
     constexpr bool FlagsHas(AttributeQualityFlags f) const { return (mask.flags & chip::to_underlying(f)) != 0; }   
 
-    bool readPrivilegeHasValue() {return mask.readPrivilege;}
-    bool writePrivilegeHasValue() {return mask.writePrivilege;}
+    bool ReadAllowed() {return mask.readPrivilege != kNoPrivilege;}
+    bool WriteAllowed() {return mask.writePrivilege != kNoPrivilege;}
 
 
     private:
 
-       attribute_entry_mask_t mask;
+        struct attribute_entry_mask_t {
+
+            // attribute quality flags
+            //
+            std::underlying_type_t<AttributeQualityFlags> flags : 7 ;
+
+            // read/write access privilege variables
+            //
+            std::underlying_type_t<Access::Privilege> readPrivilege : 5 ;
+            std::underlying_type_t<Access::Privilege> writePrivilege : 5 ;
+
+        };
+
+        
+        // Static ASSERT to check size of mask type "attribute_entry_mask_t".
+        static_assert(sizeof(attribute_entry_mask_t) <= 4, "Size of attribute_entry_mask_t is not as expected.");
+
+        attribute_entry_mask_t mask;
 
 };
 
@@ -191,24 +184,6 @@ enum class CommandQualityFlags : uint32_t
 
 
 
-struct accepted_command_entry_mask_t {
-
-    // command quality flags
-    //
-    std::underlying_type_t<CommandQualityFlags> flags : 3 ;  // generally defaults to View if readable
-
-    // invoke privilege variable
-    //
-    std::underlying_type_t<Access::Privilege> invokePrivilege : 5 ;
-
-};
-
-
-// Static ASSERT to check size of mask type.
-static_assert(sizeof(accepted_command_entry_mask_t) <= 4, "Size of accepted_command_entry_mask_t is not as expected.");
-
-
-
 struct AcceptedCommandEntry
 {
     CommandId commandId;
@@ -226,9 +201,6 @@ struct AcceptedCommandEntry
                       sizeof(chip::to_underlying(i)),
                       "Size of invokePrivilege is not able to accomodate parameter (i).");
 
-        // ASSERT to validate entry parameter value.
-        assert(kNoPrivilege != chip::to_underlying(i));
-
         mask.invokePrivilege = chip::to_underlying(i);
     }
 
@@ -258,7 +230,23 @@ struct AcceptedCommandEntry
 
     private:
 
-       accepted_command_entry_mask_t mask;
+        struct accepted_command_entry_mask_t {
+
+            // command quality flags
+            //
+            std::underlying_type_t<CommandQualityFlags> flags : 3 ;  // generally defaults to View if readable
+
+            // invoke privilege variable
+            //
+            std::underlying_type_t<Access::Privilege> invokePrivilege : 5 ;
+
+        };
+
+
+        // Static ASSERT to check size of mask type "accepted_command_entry_mask_t".
+        static_assert(sizeof(accepted_command_entry_mask_t) <= 4, "Size of accepted_command_entry_mask_t is not as expected.");
+    
+        accepted_command_entry_mask_t mask;
 
 };
 

src/app/reporting/Engine.cpp

@@ -79,7 +79,7 @@ std::optional<CHIP_ERROR> ValidateReadAttributeACL(DataModel::Provider * dataMod
     // privilege and default to kView (this is correct for global attributes and a reasonable check
     // for others)
     Privilege requiredPrivilege = Privilege::kView;
-    if (info.has_value() && info->readPrivilegeHasValue())
+    if (info.has_value() && info->ReadAllowed())
     {
         // attribute exists and is readable, set the correct read privilege
         requiredPrivilege = info->GetReadPrivilege();
@@ -108,7 +108,7 @@ std::optional<CHIP_ERROR> ValidateReadAttributeACL(DataModel::Provider * dataMod
         //             this SHOULD be done here when info does not have a value. This was not done as a first pass to
         //             minimize amount of delta in the initial PR.
         //           - "write-only" attributes should return UNSUPPORTED_READ (this is done here)
-        if (info.has_value() && !info->readPrivilegeHasValue())
+        if (info.has_value() && !info->ReadAllowed())
         {
             return CHIP_IM_GLOBAL_STATUS(UnsupportedRead);
         }

src/data-model-providers/codegen/tests/TestCodegenModelViaMocks.cpp

@@ -1135,7 +1135,7 @@ TEST_F(TestCodegenModelViaMocks, FindAttribute)
     ASSERT_TRUE(info.has_value());
     EXPECT_FALSE(info->FlagsHas(AttributeQualityFlags::kListAttribute)); // NOLINT(bugprone-unchecked-optional-access)
     EXPECT_EQ(info->GetReadPrivilege(), chip::Access::Privilege::kAdminister); // NOLINT(bugprone-unchecked-optional-access)
-    EXPECT_FALSE(info->writePrivilegeHasValue());                       // NOLINT(bugprone-unchecked-optional-access)
+    EXPECT_FALSE(info->WriteAllowed());                       // NOLINT(bugprone-unchecked-optional-access)
 }
 
 // global attributes are EXPLICITLY supported