#include "nlohmann/json.hpp" #include "rde/external_storer_interface.hpp" #include "rde/rde_handler.hpp" #include #include #include #include #include namespace bios_bmc_smm_error_logger { namespace rde { using ::testing::_; using ::testing::NiceMock; using ::testing::Return; // Mock for ExternalStorerInterface class MockExternalStorerInterface : public ExternalStorerInterface { public: MOCK_METHOD(bool, publishJson, (std::string_view jsonStr), (override)); }; // Test fixture for RdeCommandHandler class RdeCommandHandlerTest : public ::testing::Test { protected: std::unique_ptr mockExStorerInstance; // Note: RdeCommandHandler takes ownership of the raw pointer. // We pass mockExStorerInstance.get() and it's moved into the handler. // For safety in test setup, we'll create the handler with a moved // unique_ptr. std::unique_ptr handler; void SetUp() override { auto exStorer = std::make_unique>(); // Keep a raw pointer for EXPECT_CALL, but handler owns the unique_ptr mockExStorer = exStorer.get(); handler = std::make_unique(std::move(exStorer)); } // Helper to create RdeOperationInitReqHeader and its command data std::vector createOpInitReqCmd( bool containsPayload, uint8_t opType, uint8_t sendDataTransferHandle, uint32_t resourceID, uint8_t opLocatorLength, uint16_t requestPayloadLength, const std::vector& payloadData = {}) { RdeOperationInitReqHeader header{}; header.containsRequestPayload = containsPayload; header.operationType = opType; header.sendDataTransferHandle = sendDataTransferHandle; header.resourceID = resourceID; header.operationLocatorLength = opLocatorLength; header.requestPayloadLength = requestPayloadLength; std::vector command(sizeof(header)); memcpy(command.data(), &header, sizeof(header)); command.insert(command.end(), payloadData.begin(), payloadData.end()); return command; } // Helper to create MultipartReceiveResHeader and its command data std::vector createMultiPartRespCmd( uint8_t transferFlag, uint32_t nextDataTransferHandleAsResourceId, uint16_t dataLength, const std::vector& payloadData, const std::optional& checksum = std::nullopt) { MultipartReceiveResHeader header{}; header.transferFlag = transferFlag; header.nextDataTransferHandle = nextDataTransferHandleAsResourceId; header.dataLengthBytes = dataLength; std::vector command(sizeof(header)); memcpy(command.data(), &header, sizeof(header)); command.insert(command.end(), payloadData.begin(), payloadData.end()); if (checksum) { uint32_t csVal = *checksum; command.push_back(static_cast(csVal & 0xFF)); command.push_back(static_cast((csVal >> 8) & 0xFF)); command.push_back(static_cast((csVal >> 16) & 0xFF)); command.push_back(static_cast((csVal >> 24) & 0xFF)); } return command; } // To be used by EXPECT_CALL MockExternalStorerInterface* mockExStorer; }; TEST_F(RdeCommandHandlerTest, DecodeRdeCommand_InvalidType) { std::vector cmdData = {0x01, 0x02}; auto status = handler->decodeRdeCommand(cmdData, static_cast(0xFF)); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidCommand); } TEST_F(RdeCommandHandlerTest, GetDictionaryCount_Initial) { EXPECT_EQ(handler->getDictionaryCount(), 0); } TEST_F(RdeCommandHandlerTest, OperationInitRequest_NoPayload) { auto cmd = createOpInitReqCmd( false, // containsRequestPayload static_cast(RdeOperationInitType::RdeOpInitOperationUpdate), 0, 1, 0, 0); auto status = handler->decodeRdeCommand(cmd, RdeCommandType::RdeOperationInitRequest); EXPECT_EQ(status, RdeDecodeStatus::RdeOk); } TEST_F(RdeCommandHandlerTest, OperationInitRequest_CmdTooSmallForHeader) { std::vector cmdData = {0x01, 0x02}; // Smaller than header auto status = handler->decodeRdeCommand( cmdData, RdeCommandType::RdeOperationInitRequest); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidCommand); } TEST_F(RdeCommandHandlerTest, OperationInitRequest_CmdTooSmallForDeclaredPayload) { // Header declares payload, but actual data is too short. // Header: containsPayload=true, opLocatorLength=1, requestPayloadLength=5 // Actual payload data provided: only 1 byte for locator, 0 for payload. RdeOperationInitReqHeader header{}; header.containsRequestPayload = true; header.operationLocatorLength = 1; header.requestPayloadLength = 5; // Expects 5 bytes of payload std::vector cmdData(sizeof(header)); memcpy(cmdData.data(), &header, sizeof(header)); cmdData.push_back(0xAA); // Only 1 byte for locator, payload missing auto status = handler->decodeRdeCommand( cmdData, RdeCommandType::RdeOperationInitRequest); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidCommand); } TEST_F(RdeCommandHandlerTest, OperationInitRequest_UnsupportedOperationType) { auto cmd = createOpInitReqCmd(true, 0xFE, 0, 1, 0, 5, {1, 2, 3, 4, 5}); auto status = handler->decodeRdeCommand(cmd, RdeCommandType::RdeOperationInitRequest); EXPECT_EQ(status, RdeDecodeStatus::RdeUnsupportedOperation); } TEST_F(RdeCommandHandlerTest, OperationInitRequest_PayloadOverflowNotSupported) { auto cmd = createOpInitReqCmd( true, static_cast(RdeOperationInitType::RdeOpInitOperationUpdate), 1, 1, 0, 5, {1, 2, 3, 4, 5}); // sendDataTransferHandle != 0 auto status = handler->decodeRdeCommand(cmd, RdeCommandType::RdeOperationInitRequest); EXPECT_EQ(status, RdeDecodeStatus::RdePayloadOverflow); } TEST_F(RdeCommandHandlerTest, OperationInitRequest_SchemaDictionaryNotFound) { std::vector locatorAndPayload = {0x00}; // Minimal locator auto cmd = createOpInitReqCmd( true, static_cast(RdeOperationInitType::RdeOpInitOperationUpdate), 0, 123, 1, 0, locatorAndPayload); // resourceID 123, opLocatorLength=1, // payloadLength=0 auto status = handler->decodeRdeCommand(cmd, RdeCommandType::RdeOperationInitRequest); EXPECT_EQ(status, RdeDecodeStatus::RdeNoDictionary); } TEST_F(RdeCommandHandlerTest, OperationInitRequest_AnnotationDictionaryNotFound) { uint32_t schemaResourceId = 1; std::vector schemaDictData = {'s', 'c', 'h', 'e', 'm', 'a'}; uint32_t schemaChecksum = 0xb88e4152; // CRC32("schema") auto cmdSchema = createMultiPartRespCmd( static_cast( RdeMultiReceiveTransferFlag::RdeMRecFlagStartAndEnd), schemaResourceId, schemaDictData.size(), schemaDictData, schemaChecksum); ASSERT_EQ(handler->decodeRdeCommand( cmdSchema, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); std::vector locatorAndPayload = {0x00}; auto cmdOpInit = createOpInitReqCmd( true, static_cast(RdeOperationInitType::RdeOpInitOperationUpdate), 0, schemaResourceId, 1, 0, locatorAndPayload); auto status = handler->decodeRdeCommand( cmdOpInit, RdeCommandType::RdeOperationInitRequest); EXPECT_EQ(status, RdeDecodeStatus::RdeNoDictionary); } TEST_F(RdeCommandHandlerTest, OperationInitRequest_BejDecodingError) { // Add dummy schema dictionary uint32_t schemaResourceId = 1; std::vector schemaDictData = {'s', 'c', 'h', 'e', 'm', 'a'}; uint32_t schemaChecksum = 0xb88e4152; // CRC32("schema") auto cmdSchema = createMultiPartRespCmd( static_cast( RdeMultiReceiveTransferFlag::RdeMRecFlagStartAndEnd), schemaResourceId, schemaDictData.size(), schemaDictData, schemaChecksum); ASSERT_EQ(handler->decodeRdeCommand( cmdSchema, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); // Add dummy annotation dictionary uint32_t annotationResourceId = 0; // DictionaryManager::annotationResourceId std::vector annotationDictData = {'a', 'n', 'n', 'o'}; uint32_t annotationChecksum = 0xc6e493b0; // CRC32("anno") auto cmdAnnotation = createMultiPartRespCmd( static_cast( RdeMultiReceiveTransferFlag::RdeMRecFlagStartAndEnd), annotationResourceId, annotationDictData.size(), annotationDictData, annotationChecksum); ASSERT_EQ(handler->decodeRdeCommand( cmdAnnotation, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); std::vector locator = {0x00}; std::vector bejPayload = {0x01, 0x02}; // Dummy BEJ payload std::vector opInitFullPayload = locator; opInitFullPayload.insert(opInitFullPayload.end(), bejPayload.begin(), bejPayload.end()); auto cmdOpInit = createOpInitReqCmd( true, static_cast(RdeOperationInitType::RdeOpInitOperationUpdate), 0, schemaResourceId, locator.size(), bejPayload.size(), opInitFullPayload); // Expect BEJ decoding to fail with invalid dictionaries EXPECT_CALL(*mockExStorer, publishJson(_)).Times(0); auto status = handler->decodeRdeCommand( cmdOpInit, RdeCommandType::RdeOperationInitRequest); EXPECT_EQ(status, RdeDecodeStatus::RdeBejDecodingError); } TEST_F(RdeCommandHandlerTest, OperationInitRequest_ExternalStorerPublishFails) { // This test requires BejDecoder to succeed. Since we can't easily mock // BejDecoder or provide universally valid simple BEJ dicts/payloads that // guarantee success for the internal BejDecoder, this specific path is hard // to test in isolation. We would need a known schema, annotation, and // payload that successfully decodes. GTEST_SKIP() << "Skipping due to complexity of ensuring BEJ decode success without mock or valid complex BEJ data."; } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_CmdTooSmallForHeader) { std::vector cmdData = {0x01}; auto status = handler->decodeRdeCommand( cmdData, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidCommand); } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_CmdTooSmallForDeclaredPayload) { MultipartReceiveResHeader header{}; header.transferFlag = static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagStart); header.nextDataTransferHandle = 1; header.dataLengthBytes = 10; // Expects 10 bytes std::vector cmdData(sizeof(header)); memcpy(cmdData.data(), &header, sizeof(header)); cmdData.push_back(0xAA); // Only 1 byte of payload provided auto status = handler->decodeRdeCommand( cmdData, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidCommand); } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_InvalidTransferFlag) { std::vector payload = {'d', 'a', 't', 'a'}; auto cmd = createMultiPartRespCmd(0xFF, 1, payload.size(), payload); // Invalid flag auto status = handler->decodeRdeCommand( cmd, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidCommand); } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_FlagStart) { uint32_t resourceId = 1; std::vector dataPayload = {'s', 't', 'a', 'r', 't'}; auto cmd = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagStart), resourceId, dataPayload.size(), dataPayload); auto status = handler->decodeRdeCommand( cmd, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeOk); EXPECT_EQ(handler->getDictionaryCount(), 0); // Not yet complete } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_FlagMiddle_InvalidOrder) { uint32_t resourceId = 1; std::vector dataPayload = {'m', 'i', 'd', 'd', 'l', 'e'}; auto cmd = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagMiddle), resourceId, dataPayload.size(), dataPayload); auto status = handler->decodeRdeCommand( cmd, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidPktOrder); } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_FlagMiddle_AfterStart_SameResource) { uint32_t resourceId = 1; std::vector startPayload = {'s', 't', 'a', 'r', 't'}; auto cmdStart = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagStart), resourceId, startPayload.size(), startPayload); ASSERT_EQ(handler->decodeRdeCommand( cmdStart, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); std::vector middlePayload = {'m', 'i', 'd', 'd', 'l', 'e'}; auto cmdMiddle = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagMiddle), resourceId, middlePayload.size(), middlePayload); auto status = handler->decodeRdeCommand( cmdMiddle, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeOk); EXPECT_EQ(handler->getDictionaryCount(), 0); } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_FlagMiddle_AfterStart_NewResource) { // Tests current behavior: if Middle flag comes for a new resource, // previous resource is marked complete, new one is started. CRC continues. uint32_t resourceId1 = 1; std::vector startPayload1 = {'r', '1', 's'}; auto cmdStart1 = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagStart), resourceId1, startPayload1.size(), startPayload1); ASSERT_EQ(handler->decodeRdeCommand( cmdStart1, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); uint32_t resourceId2 = 2; std::vector middlePayload2 = {'r', '2', 'm'}; auto cmdMiddle2 = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagMiddle), resourceId2, middlePayload2.size(), middlePayload2); auto status = handler->decodeRdeCommand( cmdMiddle2, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeOk); EXPECT_EQ(handler->getDictionaryCount(), 1); // Resource 1 completed } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_FlagEnd_InvalidOrder) { uint32_t resourceId = 1; std::vector dataPayload = {'e', 'n', 'd'}; uint32_t checksum = 0xfc33b1; // CRC32("end") auto cmd = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagEnd), resourceId, dataPayload.size(), dataPayload, checksum); auto status = handler->decodeRdeCommand( cmd, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidPktOrder); } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_FlagEnd_AfterStart_SameResource_ValidChecksum) { uint32_t resourceId = 1; std::vector startPayload = {'s', 't', 'a', 'r', 't'}; auto cmdStart = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagStart), resourceId, startPayload.size(), startPayload); ASSERT_EQ(handler->decodeRdeCommand( cmdStart, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); std::vector endPayload = {'e', 'n', 'd'}; uint32_t checksum = 0x4800f1a; // CRC32("startend") auto cmdEnd = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagEnd), resourceId, endPayload.size(), endPayload, checksum); auto status = handler->decodeRdeCommand( cmdEnd, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeStopFlagReceived); EXPECT_EQ(handler->getDictionaryCount(), 1); } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_FlagEnd_AfterStart_SameResource_InvalidChecksum) { uint32_t resourceId = 1; std::vector startPayload = {'s', 't', 'a', 'r', 't'}; auto cmdStart = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagStart), resourceId, startPayload.size(), startPayload); ASSERT_EQ(handler->decodeRdeCommand( cmdStart, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); std::vector endPayload = {'e', 'n', 'd'}; uint32_t invalidChecksum = 0x12345678; // Invalid checksum auto cmdEnd = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagEnd), resourceId, endPayload.size(), endPayload, invalidChecksum); auto status = handler->decodeRdeCommand( cmdEnd, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidChecksum); EXPECT_EQ(handler->getDictionaryCount(), 0); // Dictionaries invalidated } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_FlagEnd_AfterStart_NewResource_UsesPrevCrcState) { // This test verifies that if an End flag for a new resource follows a Start // flag for a different resource, the CRC calculation for the new resource's // data incorrectly continues from the previous resource's CRC state. uint32_t resourceId1 = 1; std::vector startPayload1 = {'r', '1', 's'}; // CRC for "r1s" auto cmdStart1 = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagStart), resourceId1, startPayload1.size(), startPayload1); ASSERT_EQ(handler->decodeRdeCommand( cmdStart1, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); uint32_t resourceId2 = 2; std::vector endPayload2 = {'r', '2', 'e'}; // Checksum for "r2e" ALONE is 0x789ca48a. // If CRC continued from "r1s", this checksum will be wrong. uint32_t checksumForR2eAlone = 0x789ca48a; auto cmdEnd2 = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagEnd), resourceId2, endPayload2.size(), endPayload2, checksumForR2eAlone); auto status = handler->decodeRdeCommand( cmdEnd2, RdeCommandType::RdeMultiPartReceiveResponse); // Expect InvalidChecksum because internal CRC is for "r1s" + "r2e" EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidChecksum); EXPECT_EQ(handler->getDictionaryCount(), 0); // Dictionaries invalidated } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_FlagStartAndEnd_ValidChecksum) { uint32_t resourceId = 1; std::vector dataPayload = {'c', 'o', 'm', 'p', 'l', 'e', 't', 'e'}; uint32_t checksum = 0x4267d023; // CRC32("complete") auto cmd = createMultiPartRespCmd( static_cast( RdeMultiReceiveTransferFlag::RdeMRecFlagStartAndEnd), resourceId, dataPayload.size(), dataPayload, checksum); auto status = handler->decodeRdeCommand( cmd, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeStopFlagReceived); EXPECT_EQ(handler->getDictionaryCount(), 1); } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_FlagStartAndEnd_InvalidChecksum) { uint32_t resourceId = 1; std::vector dataPayload = {'c', 'o', 'm', 'p', 'l', 'e', 't', 'e'}; uint32_t invalidChecksum = 0x12345678; // Invalid checksum auto cmd = createMultiPartRespCmd( static_cast( RdeMultiReceiveTransferFlag::RdeMRecFlagStartAndEnd), resourceId, dataPayload.size(), dataPayload, invalidChecksum); auto status = handler->decodeRdeCommand( cmd, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidChecksum); EXPECT_EQ(handler->getDictionaryCount(), 0); } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_Sequence_StartMiddleEnd_Valid) { uint32_t resourceId = 42; std::vector startPayload = {'p', 'a', 'r', 't', '1'}; auto cmdStart = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagStart), resourceId, startPayload.size(), startPayload); ASSERT_EQ(handler->decodeRdeCommand( cmdStart, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); std::vector middlePayload = {'p', 'a', 'r', 't', '2'}; auto cmdMiddle = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagMiddle), resourceId, middlePayload.size(), middlePayload); ASSERT_EQ(handler->decodeRdeCommand( cmdMiddle, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); std::vector endPayload = {'p', 'a', 'r', 't', '3'}; uint32_t checksum = 0xf5295f3; // CRC32("part1part2part3") auto cmdEnd = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagEnd), resourceId, endPayload.size(), endPayload, checksum); auto status = handler->decodeRdeCommand( cmdEnd, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeStopFlagReceived); EXPECT_EQ(handler->getDictionaryCount(), 1); } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_MultipleDictionaries_ValidSequence) { // Dictionary 1: StartAndEnd uint32_t resourceId1 = 1; std::vector payload1 = {'d', 'i', 'c', 't', '1'}; uint32_t checksum1 = 0xbca257a8; // CRC32("dict1") auto cmd1 = createMultiPartRespCmd( static_cast( RdeMultiReceiveTransferFlag::RdeMRecFlagStartAndEnd), resourceId1, payload1.size(), payload1, checksum1); ASSERT_EQ(handler->decodeRdeCommand( cmd1, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); ASSERT_EQ(handler->getDictionaryCount(), 1); // Dictionary 2: Start, Middle, End uint32_t resourceId2 = 2; std::vector startPayload2 = {'d', '2', '_'}; auto cmdStart2 = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagStart), resourceId2, startPayload2.size(), startPayload2); ASSERT_EQ(handler->decodeRdeCommand( cmdStart2, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); ASSERT_EQ(handler->getDictionaryCount(), 1); // Dict1 still valid, Dict2 not yet std::vector middlePayload2 = {'m', 'i', 'd'}; auto cmdMiddle2 = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagMiddle), resourceId2, middlePayload2.size(), middlePayload2); ASSERT_EQ(handler->decodeRdeCommand( cmdMiddle2, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); std::vector endPayload2 = {'e', 'n', 'd'}; uint32_t checksum2 = 0x9e428a17; // CRC32("d2_midend") auto cmdEnd2 = createMultiPartRespCmd( static_cast(RdeMultiReceiveTransferFlag::RdeMRecFlagEnd), resourceId2, endPayload2.size(), endPayload2, checksum2); ASSERT_EQ(handler->decodeRdeCommand( cmdEnd2, RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); ASSERT_EQ(handler->getDictionaryCount(), 2); // Both dictionaries should now be valid } TEST_F(RdeCommandHandlerTest, MultiPartReceiveResp_HandleCrc_MismatchedSize) { // Header will claim 10 bytes of data. MultipartReceiveResHeader header{}; header.transferFlag = static_cast( RdeMultiReceiveTransferFlag::RdeMRecFlagStartAndEnd); header.nextDataTransferHandle = 1; // dummy resource ID header.dataLengthBytes = 10; // Create a command that is exactly the size of the header + data, which // means it is missing the 4-byte checksum. This will pass the initial size // check but fail the one in handleCrc. size_t actualSize = sizeof(MultipartReceiveResHeader) + header.dataLengthBytes; std::vector command(actualSize); memcpy(command.data(), &header, sizeof(header)); auto status = handler->decodeRdeCommand( command, RdeCommandType::RdeMultiPartReceiveResponse); EXPECT_EQ(status, RdeDecodeStatus::RdeInvalidCommand); } /** * @brief Dummy values for annotation dictionary. We do not need the annotation * dictionary. So this contains a dictionary with some dummy values. But the RDE * header is correct. */ constexpr std::array mRcvDummyAnnotation{ {0x00, 0x03, 0x00, 0x00, 0x00, 0x00, 0x18, 0x00, 0x00, 0x00, 0x0, 0x0, 0xc, 0x0, 0x0, 0xf0, 0xf0, 0xf1, 0x18, 0x00, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0x0, 0x5, 0x0, 0xc, 0x84, 0x0, 0x14, 0x0, 0xe2, 0x14, 0xd2, 0x0b}}; constexpr std::array mRcvDummyInvalidChecksum{ {0x00, 0x03, 0x00, 0x00, 0x00, 0x00, 0x18, 0x00, 0x00, 0x00, 0x0, 0x0, 0xc, 0x0, 0x0, 0xf0, 0xf0, 0xf1, 0x17, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0x0, 0x5, 0x0, 0xc, 0x84, 0x0, 0x14, 0x0, 0x17, 0x86, 0x00, 0x00}}; /** * @brief MultipartReceive command with START_AND_END flag set. */ constexpr std::array mRcvInput0StartAndEnd{ {0x00, 0x03, 0x02, 0x00, 0x00, 0x00, 0x17, 0x01, 0x00, 0x00, 0x0, 0x0, 0xc, 0x0, 0x0, 0xf0, 0xf0, 0xf1, 0x17, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0x0, 0x5, 0x0, 0xc, 0x84, 0x0, 0x14, 0x0, 0x0, 0x48, 0x0, 0x1, 0x0, 0x13, 0x90, 0x0, 0x56, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x3, 0xa3, 0x0, 0x74, 0x2, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0xa6, 0x0, 0x34, 0x3, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0xbc, 0x0, 0x64, 0x4, 0x0, 0x0, 0x0, 0x0, 0x0, 0x13, 0xd2, 0x0, 0x0, 0x0, 0x0, 0x52, 0x0, 0x2, 0x0, 0x0, 0x0, 0x0, 0x74, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0xf, 0xe5, 0x0, 0x46, 0x1, 0x0, 0x66, 0x0, 0x3, 0x0, 0xb, 0xf4, 0x0, 0x50, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x9, 0xff, 0x0, 0x50, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x7, 0x8, 0x1, 0x50, 0x2, 0x0, 0x0, 0x0, 0x0, 0x0, 0x7, 0xf, 0x1, 0x44, 0x75, 0x6d, 0x6d, 0x79, 0x53, 0x69, 0x6d, 0x70, 0x6c, 0x65, 0x0, 0x43, 0x68, 0x69, 0x6c, 0x64, 0x41, 0x72, 0x72, 0x61, 0x79, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x49, 0x64, 0x0, 0x53, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x45, 0x6e, 0x61, 0x62, 0x6c, 0x65, 0x64, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x53, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x49, 0x6e, 0x74, 0x65, 0x67, 0x65, 0x72, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x53, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x52, 0x65, 0x61, 0x6c, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x41, 0x6e, 0x6f, 0x74, 0x68, 0x65, 0x72, 0x42, 0x6f, 0x6f, 0x6c, 0x65, 0x61, 0x6e, 0x0, 0x4c, 0x69, 0x6e, 0x6b, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, 0x0, 0x4c, 0x69, 0x6e, 0x6b, 0x44, 0x6f, 0x77, 0x6e, 0x0, 0x4c, 0x69, 0x6e, 0x6b, 0x55, 0x70, 0x0, 0x4e, 0x6f, 0x4c, 0x69, 0x6e, 0x6b, 0x0, 0x0, 0x8c, 0x87, 0xed, 0x74}}; /** * @brief MultipartReceive command with START flag set. */ constexpr std::array mRcvInput1Start{ {0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x9c, 0x00, 0x00, 0x00, 0x0, 0x0, 0xc, 0x0, 0x0, 0xf0, 0xf0, 0xf1, 0x17, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0x0, 0x5, 0x0, 0xc, 0x84, 0x0, 0x14, 0x0, 0x0, 0x48, 0x0, 0x1, 0x0, 0x13, 0x90, 0x0, 0x56, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x3, 0xa3, 0x0, 0x74, 0x2, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0xa6, 0x0, 0x34, 0x3, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0xbc, 0x0, 0x64, 0x4, 0x0, 0x0, 0x0, 0x0, 0x0, 0x13, 0xd2, 0x0, 0x0, 0x0, 0x0, 0x52, 0x0, 0x2, 0x0, 0x0, 0x0, 0x0, 0x74, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0xf, 0xe5, 0x0, 0x46, 0x1, 0x0, 0x66, 0x0, 0x3, 0x0, 0xb, 0xf4, 0x0, 0x50, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x9, 0xff, 0x0, 0x50, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x7, 0x8, 0x1, 0x50, 0x2, 0x0, 0x0, 0x0, 0x0, 0x0, 0x7, 0xf, 0x1, 0x44, 0x75, 0x6d, 0x6d, 0x79, 0x53, 0x69, 0x6d, 0x70, 0x6c, 0x65, 0x0, 0x43, 0x68, 0x69, 0x6c, 0x64, 0x41, 0x72, 0x72, 0x61, 0x79, 0x50, 0x72}}; /** * @brief MultipartReceive command with END flag set. */ constexpr std::array mRcvInput1End{ {0x00, 0x02, 0x02, 0x00, 0x00, 0x00, 0x7b, 0x00, 0x00, 0x00, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x49, 0x64, 0x0, 0x53, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x45, 0x6e, 0x61, 0x62, 0x6c, 0x65, 0x64, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x53, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x49, 0x6e, 0x74, 0x65, 0x67, 0x65, 0x72, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x53, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x52, 0x65, 0x61, 0x6c, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x41, 0x6e, 0x6f, 0x74, 0x68, 0x65, 0x72, 0x42, 0x6f, 0x6f, 0x6c, 0x65, 0x61, 0x6e, 0x0, 0x4c, 0x69, 0x6e, 0x6b, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, 0x0, 0x4c, 0x69, 0x6e, 0x6b, 0x44, 0x6f, 0x77, 0x6e, 0x0, 0x4c, 0x69, 0x6e, 0x6b, 0x55, 0x70, 0x0, 0x4e, 0x6f, 0x4c, 0x69, 0x6e, 0x6b, 0x0, 0x0, 0x8c, 0x87, 0xed, 0x74}}; /** * @brief MultipartReceive command with START flag set. */ constexpr std::array mRcvInput2Start{ {0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x60, 0x0, 0x00, 0x00, 0x0, 0x0, 0xc, 0x0, 0x0, 0xf0, 0xf0, 0xf1, 0x17, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0x0, 0x5, 0x0, 0xc, 0x84, 0x0, 0x14, 0x0, 0x0, 0x48, 0x0, 0x1, 0x0, 0x13, 0x90, 0x0, 0x56, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x3, 0xa3, 0x0, 0x74, 0x2, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0xa6, 0x0, 0x34, 0x3, 0x0, 0x0, 0x0, 0x0, 0x0, 0x16, 0xbc, 0x0, 0x64, 0x4, 0x0, 0x0, 0x0, 0x0, 0x0, 0x13, 0xd2, 0x0, 0x0, 0x0, 0x0, 0x52, 0x0, 0x2, 0x0, 0x0, 0x0, 0x0, 0x74, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0xf, 0xe5, 0x0, 0x46, 0x1, 0x0, 0x66}}; /** * @brief MultipartReceive command with MIDDLE flag set. */ constexpr std::array mRcvInput2Mid{ {0x00, 0x01, 0x02, 0x00, 0x00, 0x00, 0x60, 0x0, 0x00, 0x00, 0x0, 0x3, 0x0, 0xb, 0xf4, 0x0, 0x50, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x9, 0xff, 0x0, 0x50, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x7, 0x8, 0x1, 0x50, 0x2, 0x0, 0x0, 0x0, 0x0, 0x0, 0x7, 0xf, 0x1, 0x44, 0x75, 0x6d, 0x6d, 0x79, 0x53, 0x69, 0x6d, 0x70, 0x6c, 0x65, 0x0, 0x43, 0x68, 0x69, 0x6c, 0x64, 0x41, 0x72, 0x72, 0x61, 0x79, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x49, 0x64, 0x0, 0x53, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x45, 0x6e, 0x61, 0x62, 0x6c, 0x65, 0x64, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x53, 0x61, 0x6d, 0x70}}; /** * @brief MultipartReceive command with END flag set. */ constexpr std::array mRcvInput2End{ {0x00, 0x02, 0x02, 0x00, 0x00, 0x00, 0x57, 0x0, 0x00, 0x00, 0x6c, 0x65, 0x49, 0x6e, 0x74, 0x65, 0x67, 0x65, 0x72, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x53, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x52, 0x65, 0x61, 0x6c, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x0, 0x41, 0x6e, 0x6f, 0x74, 0x68, 0x65, 0x72, 0x42, 0x6f, 0x6f, 0x6c, 0x65, 0x61, 0x6e, 0x0, 0x4c, 0x69, 0x6e, 0x6b, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, 0x0, 0x4c, 0x69, 0x6e, 0x6b, 0x44, 0x6f, 0x77, 0x6e, 0x0, 0x4c, 0x69, 0x6e, 0x6b, 0x55, 0x70, 0x0, 0x4e, 0x6f, 0x4c, 0x69, 0x6e, 0x6b, 0x0, 0x0, 0x8c, 0x87, 0xed, 0x74}}; /** * @brief RDEOperationInit command with encoded json/dummysimple.json as the * payload. */ constexpr std::array mInitOp{ {0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x04, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x60, 0x00, 0x00, 0x00, 0x0, 0xf0, 0xf0, 0xf1, 0x0, 0x0, 0x0, 0x1, 0x0, 0x0, 0x1, 0x54, 0x1, 0x5, 0x1, 0x2, 0x50, 0x1, 0x9, 0x44, 0x75, 0x6d, 0x6d, 0x79, 0x20, 0x49, 0x44, 0x0, 0x1, 0x6, 0x20, 0x1, 0x0, 0x1, 0x8, 0x60, 0x1, 0xb, 0x1, 0x2, 0x38, 0xea, 0x1, 0x0, 0x2, 0xa3, 0x23, 0x1, 0x0, 0x1, 0x4, 0x70, 0x1, 0x1, 0x0, 0x1, 0x0, 0x10, 0x1, 0x24, 0x1, 0x2, 0x1, 0x0, 0x0, 0x1, 0xf, 0x1, 0x2, 0x1, 0x0, 0x70, 0x1, 0x1, 0x1, 0x1, 0x2, 0x40, 0x1, 0x2, 0x1, 0x2, 0x1, 0x2, 0x0, 0x1, 0x9, 0x1, 0x1, 0x1, 0x2, 0x40, 0x1, 0x2, 0x1, 0x2}}; class MockExternalStorer : public ExternalStorerInterface { public: MOCK_METHOD(bool, publishJson, (std::string_view jsonStr), (override)); }; class RdeHandlerTest : public ::testing::Test { public: RdeHandlerTest() : mockExStorer(std::make_unique()) { mockExStorerPtr = dynamic_cast(mockExStorer.get()); rdeH = std::make_unique(std::move(mockExStorer)); } protected: std::unique_ptr mockExStorer; std::unique_ptr rdeH; MockExternalStorer* mockExStorerPtr; const std::string exJson = R"({"Id":"Dummy ID","SampleIntegerProperty":null,"SampleRealProperty":-5576.9123,"SampleEnabledProperty":false,"ChildArrayProperty":[{"AnotherBoolean":true,"LinkStatus":"NoLink"},{"LinkStatus":"NoLink"}]})"; }; TEST_F(RdeHandlerTest, DictionaryStartAndEndTest) { // Send a payload with START_AND_END flag. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvInput0StartAndEnd), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); EXPECT_THAT(rdeH->getDictionaryCount(), 1); // Send annotation dictionary. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvDummyAnnotation), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); EXPECT_THAT(rdeH->getDictionaryCount(), 2); // Send the encoded payload. EXPECT_CALL(*mockExStorerPtr, publishJson(exJson)).WillOnce(Return(true)); EXPECT_THAT(rdeH->decodeRdeCommand(std::span(mInitOp), RdeCommandType::RdeOperationInitRequest), RdeDecodeStatus::RdeOk); } TEST_F(RdeHandlerTest, DictionaryStartThenEndTest) { // Send a payload with START flag. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvInput1Start), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); // We didn't send END. So dictionary count should be 0. EXPECT_THAT(rdeH->getDictionaryCount(), 0); // Send a payload with END flag. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvInput1End), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); EXPECT_THAT(rdeH->getDictionaryCount(), 1); // Send annotation dictionary. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvDummyAnnotation), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); EXPECT_THAT(rdeH->getDictionaryCount(), 2); // Send the encoded payload. EXPECT_CALL(*mockExStorerPtr, publishJson(exJson)).WillOnce(Return(true)); EXPECT_THAT(rdeH->decodeRdeCommand(std::span(mInitOp), RdeCommandType::RdeOperationInitRequest), RdeDecodeStatus::RdeOk); // Sending the START again for same resource ID should decrease the // dictionary count. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvInput1Start), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); EXPECT_THAT(rdeH->getDictionaryCount(), 1); } TEST_F(RdeHandlerTest, DictionaryStartMidEndTest) { // Send a payload with START flag. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvInput2Start), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); // We didn't send END. So dictionary count should be 0. EXPECT_THAT(rdeH->getDictionaryCount(), 0); // Send a payload with MIDDLE flag. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvInput2Mid), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeOk); // We didn't send END. So dictionary count should be 0. EXPECT_THAT(rdeH->getDictionaryCount(), 0); // Send a payload with END flag. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvInput2End), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); EXPECT_THAT(rdeH->getDictionaryCount(), 1); // Send annotation dictionary. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvDummyAnnotation), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); EXPECT_THAT(rdeH->getDictionaryCount(), 2); // Send the encoded payload. EXPECT_CALL(*mockExStorerPtr, publishJson(exJson)).WillOnce(Return(true)); EXPECT_THAT(rdeH->decodeRdeCommand(std::span(mInitOp), RdeCommandType::RdeOperationInitRequest), RdeDecodeStatus::RdeOk); } TEST_F(RdeHandlerTest, InvalidDictionaryFlowTest) { // Send a payload with MIDDLE flag before START and it should fail. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvInput2Mid), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeInvalidPktOrder); // Send a payload with END flag before START and it should fail. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvInput2End), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeInvalidPktOrder); } TEST_F(RdeHandlerTest, MissingDictionaryTest) { // Try decoding without any dictionaries. EXPECT_THAT(rdeH->decodeRdeCommand(std::span(mInitOp), RdeCommandType::RdeOperationInitRequest), RdeDecodeStatus::RdeNoDictionary); // Try decoding just with annotation dictionary. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvDummyAnnotation), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeStopFlagReceived); EXPECT_THAT(rdeH->decodeRdeCommand(std::span(mInitOp), RdeCommandType::RdeOperationInitRequest), RdeDecodeStatus::RdeNoDictionary); } TEST_F(RdeHandlerTest, InvalidDictionaryChecksumTest) { // Send a dictionary with an invalid checksum. EXPECT_THAT( rdeH->decodeRdeCommand(std::span(mRcvDummyInvalidChecksum), RdeCommandType::RdeMultiPartReceiveResponse), RdeDecodeStatus::RdeInvalidChecksum); } } // namespace rde } // namespace bios_bmc_smm_error_logger