Re-organize a bit ... boilerplate still seems A LOT

Author: andy31415

src/app/codegen-interaction-model/tests/TestAttributeReportIBsEncoding.cpp

@@ -104,5 +104,27 @@ CHIP_ERROR DecodeAttributeReportIBs(ByteSpan data, std::vector<DecodedAttributeD
     return err;
 }
 
+CHIP_ERROR EncodedReportIBs::StartEncoding(app::AttributeReportIBs::Builder & builder)
+{
+    mEncodeWriter.Init(mTlvDataBuffer);
+    ReturnErrorOnFailure(mEncodeWriter.StartContainer(TLV::AnonymousTag(), TLV::kTLVType_Structure, mOuterStructureType));
+    return builder.Init(&mEncodeWriter, to_underlying(ReportDataMessage::Tag::kAttributeReportIBs));
+}
+
+CHIP_ERROR EncodedReportIBs::FinishEncoding(app::AttributeReportIBs::Builder & builder)
+{
+    builder.EndOfContainer();
+    ReturnErrorOnFailure(mEncodeWriter.EndContainer(mOuterStructureType));
+    ReturnErrorOnFailure(mEncodeWriter.Finalize());
+
+    mDecodeSpan = ByteSpan(mTlvDataBuffer, mEncodeWriter.GetLengthWritten());
+    return CHIP_NO_ERROR;
+}
+
+CHIP_ERROR EncodedReportIBs::Decode(std::vector<DecodedAttributeData> & decoded_items)
+{
+    return DecodeAttributeReportIBs(mDecodeSpan, decoded_items);
+}
+
 } // namespace Test
 } // namespace chip

src/app/codegen-interaction-model/tests/TestAttributeReportIBsEncoding.h

@@ -18,8 +18,11 @@
 
 #include <app/ConcreteAttributePath.h>
 #include <app/MessageDef/AttributeDataIB.h>
+#include <app/MessageDef/AttributeReportIBs.h>
+#include <app/MessageDef/ReportDataMessage.h>
 #include <lib/core/DataModelTypes.h>
 #include <lib/core/TLVReader.h>
+#include <lib/core/TLVWriter.h>
 
 #include <vector>
 
@@ -37,5 +40,29 @@ struct DecodedAttributeData
 
 CHIP_ERROR DecodeAttributeReportIBs(ByteSpan data, std::vector<DecodedAttributeData> & decoded_items);
 
+/// Maintains an internal TLV buffer for data encoding and
+/// decoding for ReportIBs.
+///
+/// Main use case is that explicit TLV layouts (structure and container starting) need to be
+/// prepared to have a proper AttributeReportIBs::Builder/parser to exist.
+class EncodedReportIBs
+{
+public:
+    /// Initialize the report structures required to encode a
+    CHIP_ERROR StartEncoding(app::AttributeReportIBs::Builder & builder);
+    CHIP_ERROR FinishEncoding(app::AttributeReportIBs::Builder & builder);
+
+    /// Decode the embedded attribute report IBs.
+    /// The TLVReaders inside data have a lifetime tied to the current object (its readers point
+    /// inside the current object)
+    CHIP_ERROR Decode(std::vector<DecodedAttributeData> & decoded_items);
+
+private:
+    uint8_t mTlvDataBuffer[1024];
+    TLV::TLVType mOuterStructureType;
+    TLV::TLVWriter mEncodeWriter;
+    ByteSpan mDecodeSpan;
+};
+
 } // namespace Test
 } // namespace chip

src/app/codegen-interaction-model/tests/TestCodegenModelViaMocks.cpp

@@ -426,18 +426,12 @@ TEST(TestCodegenModelViaMocks, EmberAttributeReadAclDeny)
     ASSERT_TRUE(info.has_value());
 
     DataVersion dataVersion = info->dataVersion; // NOLINT(bugprone-unchecked-optional-access)
-
-    uint8_t tlvBuffer[1024];
-
-    TLV::TLVWriter tlvWriter;
-    tlvWriter.Init(tlvBuffer);
-
+    EncodedReportIBs reportIBs;
     AttributeReportIBs::Builder builder;
-    CHIP_ERROR err = builder.Init(&tlvWriter);
-    ASSERT_EQ(err, CHIP_NO_ERROR);
-    AttributeValueEncoder encoder(builder, kAdminSubjectDescriptor, readRequest.path, dataVersion);
+    ASSERT_EQ(reportIBs.StartEncoding(builder), CHIP_NO_ERROR);
+    AttributeValueEncoder encoder(builder, kDenySubjectDescriptor, readRequest.path, dataVersion);
 
-    err = model.ReadAttribute(readRequest, encoder);
+    CHIP_ERROR err = model.ReadAttribute(readRequest, encoder);
     ASSERT_EQ(err, CHIP_ERROR_ACCESS_DENIED);
 }
 
@@ -459,21 +453,13 @@ TEST(TestCodegenModelViaMocks, EmberAttributeInvalidRead)
     ASSERT_TRUE(info.has_value());
 
     DataVersion dataVersion = info->dataVersion; // NOLINT(bugprone-unchecked-optional-access)
-
-    uint8_t tlvBuffer[1024];
-
-    TLV::TLVWriter tlvWriter;
-    tlvWriter.Init(tlvBuffer);
-
+    EncodedReportIBs reportIBs;
     AttributeReportIBs::Builder builder;
-    CHIP_ERROR err = builder.Init(&tlvWriter);
-    ASSERT_EQ(err, CHIP_NO_ERROR);
+    ASSERT_EQ(reportIBs.StartEncoding(builder), CHIP_NO_ERROR);
     AttributeValueEncoder encoder(builder, kAdminSubjectDescriptor, readRequest.path, dataVersion);
 
-    err = model.ReadAttribute(readRequest, encoder);
+    CHIP_ERROR err = model.ReadAttribute(readRequest, encoder);
     ASSERT_EQ(err, CHIP_IM_GLOBAL_STATUS(UnsupportedAttribute));
-
-    // TODO: value validation here?
 }
 
 TEST(TestCodegenModelViaMocks, EmberAttributeRead)
@@ -495,39 +481,22 @@ TEST(TestCodegenModelViaMocks, EmberAttributeRead)
 
     DataVersion dataVersion = info->dataVersion; // NOLINT(bugprone-unchecked-optional-access)
 
-    uint8_t tlvBuffer[1024];
-
-    TLV::TLVWriter tlvWriter;
-    tlvWriter.Init(tlvBuffer);
-    CHIP_ERROR err = CHIP_NO_ERROR;
-
-    TLV::TLVType outer;
-    err = tlvWriter.StartContainer(TLV::AnonymousTag(), TLV::kTLVType_Structure, outer);
-    ASSERT_EQ(err, CHIP_NO_ERROR);
-
+    EncodedReportIBs reportIBs;
     AttributeReportIBs::Builder builder;
-
-    err = builder.Init(&tlvWriter, to_underlying(ReportDataMessage::Tag::kAttributeReportIBs));
-    ASSERT_EQ(err, CHIP_NO_ERROR);
+    ASSERT_EQ(reportIBs.StartEncoding(builder), CHIP_NO_ERROR);
     AttributeValueEncoder encoder(builder, kAdminSubjectDescriptor, readRequest.path, dataVersion);
 
     uint8_t data[] = { 0x01, 0x02, 0x03, 0x04 };
     chip::Test::SetEmberReadOutput(ByteSpan(data));
 
-    err = model.ReadAttribute(readRequest, encoder);
+    CHIP_ERROR err = model.ReadAttribute(readRequest, encoder);
     ASSERT_EQ(err, CHIP_NO_ERROR);
 
-    builder.EndOfContainer();
-
-    err = tlvWriter.EndContainer(outer);
-    ASSERT_EQ(err, CHIP_NO_ERROR);
-
-    err = tlvWriter.Finalize();
-    ASSERT_EQ(err, CHIP_NO_ERROR);
+    ASSERT_EQ(reportIBs.FinishEncoding(builder), CHIP_NO_ERROR);
 
     //// VALIDATE
     std::vector<DecodedAttributeData> attribute_data;
-    err = DecodeAttributeReportIBs(ByteSpan(tlvBuffer, tlvWriter.GetLengthWritten()), attribute_data);
+    err = reportIBs.Decode(attribute_data);
     ASSERT_EQ(err, CHIP_NO_ERROR);
     ASSERT_EQ(attribute_data.size(), 1u);