Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaced nlunit-test with pw_unit_test in src/lib/format/ #33063

Merged
merged 3 commits into from
Apr 23, 2024
Merged

Replaced nlunit-test with pw_unit_test in src/lib/format/ #33063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0046d04
Replaced nlunit-test with pw_unit_test in src/lib/format/
mbknust Apr 19, 2024
66d13bf
Restyled by clang-format
restyled-commits Apr 19, 2024
6051688
Use EXPECT_STREQ
mbknust Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions src/lib/format/tests/BUILD.gn
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@

import("//build_overrides/build.gni")
import("//build_overrides/chip.gni")
import("//build_overrides/nlunit_test.gni")

import("${chip_root}/build/chip/chip_test_suite.gni")
import("${chip_root}/build/chip/fuzz_test.gni")

chip_test_suite_using_nltest("tests") {
chip_test_suite("tests") {
output_name = "libFormatTests"

test_sources = [
Expand All @@ -40,8 +39,6 @@ chip_test_suite_using_nltest("tests") {
"${chip_root}/src/lib/format:flat-tree",
"${chip_root}/src/lib/format:protocol-decoder",
"${chip_root}/src/lib/format:protocol-tlv-metadata",
"${chip_root}/src/lib/support:testing_nlunit",
"${nlunit_test_root}:nlunit-test",
]
}

Expand Down
125 changes: 50 additions & 75 deletions src/lib/format/tests/TestDecoding.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,11 @@
#include <lib/core/TLVWriter.h>
#include <lib/format/protocol_decoder.h>
#include <lib/support/StringBuilder.h>
#include <lib/support/UnitTestRegistration.h>

#include <tlv/meta/clusters_meta.h>
#include <tlv/meta/protocols_meta.h>

#include <nlunit-test.h>
#include <gtest/gtest.h>

#include "sample_data.h"

Expand Down Expand Up @@ -57,8 +56,7 @@ const std::array<const Node<ItemInfo>, 53 + 2> fake_protocols_meta = { {
{ 2, _FakeProtocolData },
} };

void TestSampleData(nlTestSuite * inSuite, const PayloadDecoderInitParams & params, const SamplePayload & data,
const char * expectation)
void TestSampleData(const PayloadDecoderInitParams & params, const SamplePayload & data, const char * expectation)
{
chip::Decoders::PayloadDecoder<64, 128> decoder(
PayloadDecoderInitParams(params).SetProtocol(data.protocolId).SetMessageType(data.messageType));
Expand Down Expand Up @@ -130,48 +128,48 @@ void TestSampleData(nlTestSuite * inSuite, const PayloadDecoderInitParams & para
printf("ACTUAL: '%s'\n", partial.Reset().Add(output_builder.c_str() + idx).AddMarkerIfOverflow().c_str());
}

NL_TEST_ASSERT(inSuite, strcmp(output_builder.c_str(), expectation) == 0);
EXPECT_STREQ(output_builder.c_str(), expectation);
}

void TestFullDataDecoding(nlTestSuite * inSuite, void * inContext)
TEST(TestDecoding, TestFullDataDecoding)
{
PayloadDecoderInitParams params;

params.SetProtocolDecodeTree(chip::TLVMeta::protocols_meta).SetClusterDecodeTree(chip::TLVMeta::clusters_meta);

TestSampleData(inSuite, params, secure_channel_mrp_ack, "mrp_ack: EMPTY\n");
TestSampleData(inSuite, params, secure_channel_pkbdf_param_request,
TestSampleData(params, secure_channel_mrp_ack, "mrp_ack: EMPTY\n");
TestSampleData(params, secure_channel_pkbdf_param_request,
"pbkdf_param_request\n"
" initiator_random: hex:7C8698755B8E9866BB4FFDC27B733F3B6EF7F83D43FBE0CA6AD2B8C52C8F4236\n"
" initiator_session_id: 37677\n"
" passcode_id: 0\n"
" has_pbkdf_parameters: false\n");
TestSampleData(inSuite, params, secure_channel_pkbdf_param_response,
TestSampleData(params, secure_channel_pkbdf_param_response,
"pbkdf_param_response\n"
" initiator_random: hex:7C8698755B8E9866BB4FFDC27B733F3B6EF7F83D43FBE0CA6AD2B8C52C8F4236\n"
" responder_random: hex:A44EB3E1A751A88A32BAB59EF16EB9764C20E1A9DDBEF6EFE3F588C943C58424\n"
" responder_session_id: 40168\n"
" pbkdf_parameters\n"
" iterations: 1000\n"
" salt: hex:E8FC1E6FD0023422B3CA7ECEDD344444551C814D3D0B0EB9C096F00E8A8051B2\n");
TestSampleData(inSuite, params, secure_channel_pase_pake1,
TestSampleData(params, secure_channel_pase_pake1,
// clang-format off
"pase_pake1\n"
" pA: hex:0422ABC7A84352850456BD4A510905FE6BB782A0863A9382550E1228020801B22EEC4102C60F80082842B9739705FCD37F134651442A41E3723DFFE0...\n"
// clang-format on
);
TestSampleData(inSuite, params, secure_channel_pase_pake2,
TestSampleData(params, secure_channel_pase_pake2,
// clang-format off
"pase_pake2\n"
" pB: hex:04B6A44A3347C6B77900A3674CA19F40F25F056F8CB344EC1B4FA7888B9E6B570B7010431C5D0BE4021FE74A96C40721765FDA6802BE8DFDF5624332...\n"
" cB: hex:40E7452275E38AEBAF0E0F6FAB33A1B0CB5AEB5E824230DD40D0071DC7E55C87\n"
// clang-format on
);
TestSampleData(inSuite, params, secure_channel_pase_pake3,
TestSampleData(params, secure_channel_pase_pake3,
"pase_pake3\n"
" cA: hex:6008C72EDEC9D25D4A36522F0BF23058F9378EFE38CBBCCE8C6853900169BC38\n");
TestSampleData(inSuite, params, secure_channel_status_report, "status_report: BINARY DATA\n");
TestSampleData(inSuite, params, im_protocol_read_request,
TestSampleData(params, secure_channel_status_report, "status_report: BINARY DATA\n");
TestSampleData(params, im_protocol_read_request,
"read_request\n"
" attribute_requests\n"
" Anonymous<>\n"
Expand Down Expand Up @@ -206,7 +204,7 @@ void TestFullDataDecoding(nlTestSuite * inSuite, void * inContext)
" attribute_id: 3 == 'connectMaxTimeSeconds'\n"
" fabric_filtered: false\n"
" interaction_model_revison: 1\n");
TestSampleData(inSuite, params, im_protocol_report_data,
TestSampleData(params, im_protocol_report_data,
"report_data\n"
" attribute_reports\n"
" Anonymous<>\n"
Expand Down Expand Up @@ -279,7 +277,7 @@ void TestFullDataDecoding(nlTestSuite * inSuite, void * inContext)
" interaction_model_revison: 1\n");

// Different content
TestSampleData(inSuite, params, im_protocol_report_data_acl,
TestSampleData(params, im_protocol_report_data_acl,
"report_data\n"
" attribute_reports\n"
" Anonymous<>\n"
Expand All @@ -301,7 +299,7 @@ void TestFullDataDecoding(nlTestSuite * inSuite, void * inContext)
" interaction_model_revison: 1\n");

TestSampleData(
inSuite, params, im_protocol_report_data_window_covering,
params, im_protocol_report_data_window_covering,
"report_data\n"
" attribute_reports\n"
" Anonymous<>\n"
Expand All @@ -315,7 +313,7 @@ void TestFullDataDecoding(nlTestSuite * inSuite, void * inContext)
" suppress_response: true\n"
" interaction_model_revison: 1\n");

TestSampleData(inSuite, params, im_protocol_invoke_request,
TestSampleData(params, im_protocol_invoke_request,
"invoke_request\n"
" suppress_response: false\n"
" timed_request: false\n"
Expand All @@ -328,7 +326,7 @@ void TestFullDataDecoding(nlTestSuite * inSuite, void * inContext)
" OnOff::Toggle\n"
" interaction_model_revison: 1\n");

TestSampleData(inSuite, params, im_protocol_invoke_response,
TestSampleData(params, im_protocol_invoke_response,
"invoke_response\n"
" suppress_response: false\n"
" invoke_responses\n"
Expand All @@ -342,7 +340,7 @@ void TestFullDataDecoding(nlTestSuite * inSuite, void * inContext)
" status: 0 == kSuccess\n"
" interaction_model_revison: 1\n");

TestSampleData(inSuite, params, im_protocol_invoke_request_change_channel,
TestSampleData(params, im_protocol_invoke_request_change_channel,
"invoke_request\n"
" suppress_response: false\n"
" timed_request: false\n"
Expand All @@ -356,7 +354,7 @@ void TestFullDataDecoding(nlTestSuite * inSuite, void * inContext)
" match: \"channel name\"\n"
" interaction_model_revison: 1\n");

TestSampleData(inSuite, params, im_protocol_event_software_fault,
TestSampleData(params, im_protocol_event_software_fault,
"report_data\n"
" event_reports\n"
" Anonymous<>\n"
Expand All @@ -375,7 +373,7 @@ void TestFullDataDecoding(nlTestSuite * inSuite, void * inContext)
" suppress_response: true\n"
" interaction_model_revison: 1\n");

TestSampleData(inSuite, params, im_protocol_event_multipress,
TestSampleData(params, im_protocol_event_multipress,
"report_data\n"
" event_reports\n"
" Anonymous<>\n"
Expand All @@ -394,22 +392,22 @@ void TestFullDataDecoding(nlTestSuite * inSuite, void * inContext)
" interaction_model_revison: 1\n");
}

void TestMetaDataOnlyDecoding(nlTestSuite * inSuite, void * inContext)
TEST(TestDecoding, TestMetaDataOnlyDecoding)
{
PayloadDecoderInitParams params;

// NO CLUSTER DECODE TREE
params.SetProtocolDecodeTree(chip::TLVMeta::protocols_meta);

TestSampleData(inSuite, params, secure_channel_mrp_ack, "mrp_ack: EMPTY\n");
TestSampleData(inSuite, params, secure_channel_pkbdf_param_request,
TestSampleData(params, secure_channel_mrp_ack, "mrp_ack: EMPTY\n");
TestSampleData(params, secure_channel_pkbdf_param_request,
"pbkdf_param_request\n"
" initiator_random: hex:7C8698755B8E9866BB4FFDC27B733F3B6EF7F83D43FBE0CA6AD2B8C52C8F4236\n"
" initiator_session_id: 37677\n"
" passcode_id: 0\n"
" has_pbkdf_parameters: false\n");

TestSampleData(inSuite, params, im_protocol_read_request,
TestSampleData(params, im_protocol_read_request,
"read_request\n"
" attribute_requests\n"
" Anonymous<>\n"
Expand Down Expand Up @@ -444,7 +442,7 @@ void TestMetaDataOnlyDecoding(nlTestSuite * inSuite, void * inContext)
" attribute_id: 3\n"
" fabric_filtered: false\n"
" interaction_model_revison: 1\n");
TestSampleData(inSuite, params, im_protocol_report_data,
TestSampleData(params, im_protocol_report_data,
"report_data\n"
" attribute_reports\n"
" Anonymous<>\n"
Expand Down Expand Up @@ -515,7 +513,7 @@ void TestMetaDataOnlyDecoding(nlTestSuite * inSuite, void * inContext)
" interaction_model_revison: 1\n");

// Different content
TestSampleData(inSuite, params, im_protocol_report_data_acl,
TestSampleData(params, im_protocol_report_data_acl,
"report_data\n"
" attribute_reports\n"
" Anonymous<>\n"
Expand All @@ -530,14 +528,14 @@ void TestMetaDataOnlyDecoding(nlTestSuite * inSuite, void * inContext)
" interaction_model_revison: 1\n");
}

void TestEmptyClusterMetaDataDecode(nlTestSuite * inSuite, void * inContext)
TEST(TestDecoding, TestEmptyClusterMetaDataDecode)
{
PayloadDecoderInitParams params;

params.SetProtocolDecodeTree(chip::TLVMeta::protocols_meta).SetClusterDecodeTree(empty_meta);

TestSampleData(inSuite, params, secure_channel_mrp_ack, "mrp_ack: EMPTY\n");
TestSampleData(inSuite, params, im_protocol_report_data_acl,
TestSampleData(params, secure_channel_mrp_ack, "mrp_ack: EMPTY\n");
TestSampleData(params, im_protocol_report_data_acl,
"report_data\n"
" attribute_reports\n"
" Anonymous<>\n"
Expand All @@ -559,24 +557,24 @@ void TestEmptyClusterMetaDataDecode(nlTestSuite * inSuite, void * inContext)
" interaction_model_revison: 1\n");
}

void TestMissingDecodeData(nlTestSuite * inSuite, void * inContext)
TEST(TestDecoding, TestMissingDecodeData)
{
PayloadDecoderInitParams params;

params.SetProtocolDecodeTree(empty_meta).SetClusterDecodeTree(empty_meta);

TestSampleData(inSuite, params, secure_channel_mrp_ack, "PROTO(0x0, 0x10): UNKNOWN\n");
TestSampleData(inSuite, params, im_protocol_report_data_acl, "PROTO(0x1, 0x5): UNKNOWN\n");
TestSampleData(params, secure_channel_mrp_ack, "PROTO(0x0, 0x10): UNKNOWN\n");
TestSampleData(params, im_protocol_report_data_acl, "PROTO(0x1, 0x5): UNKNOWN\n");
}

void TestWrongDecodeData(nlTestSuite * inSuite, void * inContext)
TEST(TestDecoding, TestWrongDecodeData)
{
PayloadDecoderInitParams params;

params.SetProtocolDecodeTree(fake_protocols_meta).SetClusterDecodeTree(empty_meta);

TestSampleData(inSuite, params, secure_channel_mrp_ack, "proto16: EMPTY\n");
TestSampleData(inSuite, params, im_protocol_report_data_acl,
TestSampleData(params, secure_channel_mrp_ack, "proto16: EMPTY\n");
TestSampleData(params, im_protocol_report_data_acl,
"proto5\n"
" ContextTag(0x1)\n"
" AnonymousTag()\n"
Expand All @@ -598,7 +596,7 @@ void TestWrongDecodeData(nlTestSuite * inSuite, void * inContext)
" ContextTag(0xFF): 1\n");
}

void TestNestingOverflow(nlTestSuite * inSuite, void * inContext)
TEST(TestDecoding, TestNestingOverflow)
{
PayloadDecoderInitParams params;
params.SetProtocolDecodeTree(fake_protocols_meta).SetClusterDecodeTree(empty_meta);
Expand All @@ -611,65 +609,62 @@ void TestNestingOverflow(nlTestSuite * inSuite, void * inContext)
chip::TLV::TLVType unusedType;

// Protocols start with an anonymous tagged structure, after which lists can be of any tags
NL_TEST_ASSERT(inSuite, writer.StartContainer(AnonymousTag(), kTLVType_Structure, unusedType) == CHIP_NO_ERROR);
EXPECT_EQ(writer.StartContainer(AnonymousTag(), kTLVType_Structure, unusedType), CHIP_NO_ERROR);

// nesting overflow here
for (uint8_t i = 0; i < 32; i++)
{
NL_TEST_ASSERT(inSuite, writer.StartContainer(ContextTag(i), kTLVType_List, unusedType) == CHIP_NO_ERROR);
EXPECT_EQ(writer.StartContainer(ContextTag(i), kTLVType_List, unusedType), CHIP_NO_ERROR);
}
// Go back to 24 (still too much nesting)
for (uint8_t i = 0; i < 8; i++)
{
NL_TEST_ASSERT(inSuite, writer.EndContainer(kTLVType_List) == CHIP_NO_ERROR);
EXPECT_EQ(writer.EndContainer(kTLVType_List), CHIP_NO_ERROR);
}
for (uint8_t i = 0; i < 4; i++)
{
NL_TEST_ASSERT(
inSuite, writer.StartContainer(ContextTag(static_cast<uint8_t>(i + 0x10)), kTLVType_List, unusedType) == CHIP_NO_ERROR);
EXPECT_EQ(writer.StartContainer(ContextTag(static_cast<uint8_t>(i + 0x10)), kTLVType_List, unusedType), CHIP_NO_ERROR);
}
for (uint8_t i = 0; i < 4; i++)
{
NL_TEST_ASSERT(inSuite, writer.EndContainer(kTLVType_List) == CHIP_NO_ERROR);
EXPECT_EQ(writer.EndContainer(kTLVType_List), CHIP_NO_ERROR);
}
// Go back to 8
for (uint8_t i = 0; i < 16; i++)
{
NL_TEST_ASSERT(inSuite, writer.EndContainer(kTLVType_List) == CHIP_NO_ERROR);
EXPECT_EQ(writer.EndContainer(kTLVType_List), CHIP_NO_ERROR);
}
for (uint8_t i = 0; i < 4; i++)
{
NL_TEST_ASSERT(
inSuite, writer.StartContainer(ContextTag(static_cast<uint8_t>(i + 0x20)), kTLVType_List, unusedType) == CHIP_NO_ERROR);
EXPECT_EQ(writer.StartContainer(ContextTag(static_cast<uint8_t>(i + 0x20)), kTLVType_List, unusedType), CHIP_NO_ERROR);
}
for (uint8_t i = 0; i < 4; i++)
{
NL_TEST_ASSERT(inSuite, writer.EndContainer(kTLVType_List) == CHIP_NO_ERROR);
EXPECT_EQ(writer.EndContainer(kTLVType_List), CHIP_NO_ERROR);
}
// Go back to 4
for (uint8_t i = 0; i < 4; i++)
{
NL_TEST_ASSERT(inSuite, writer.EndContainer(kTLVType_List) == CHIP_NO_ERROR);
EXPECT_EQ(writer.EndContainer(kTLVType_List), CHIP_NO_ERROR);
}
for (uint8_t i = 0; i < 4; i++)
{
NL_TEST_ASSERT(
inSuite, writer.StartContainer(ContextTag(static_cast<uint8_t>(i + 0x30)), kTLVType_List, unusedType) == CHIP_NO_ERROR);
EXPECT_EQ(writer.StartContainer(ContextTag(static_cast<uint8_t>(i + 0x30)), kTLVType_List, unusedType), CHIP_NO_ERROR);
}
for (uint8_t i = 0; i < 4; i++)
{
NL_TEST_ASSERT(inSuite, writer.EndContainer(kTLVType_List) == CHIP_NO_ERROR);
EXPECT_EQ(writer.EndContainer(kTLVType_List), CHIP_NO_ERROR);
}
// close everything
for (uint8_t i = 0; i < 4; i++)
{
NL_TEST_ASSERT(inSuite, writer.EndContainer(kTLVType_List) == CHIP_NO_ERROR);
EXPECT_EQ(writer.EndContainer(kTLVType_List), CHIP_NO_ERROR);
}
NL_TEST_ASSERT(inSuite, writer.EndContainer(kTLVType_Structure) == CHIP_NO_ERROR);
EXPECT_EQ(writer.EndContainer(kTLVType_Structure), CHIP_NO_ERROR);

SamplePayload fake_payload{ chip::Protocols::InteractionModel::Id, 5, chip::ByteSpan(data_buffer, writer.GetLengthWritten()) };

TestSampleData(inSuite, params, fake_payload,
TestSampleData(params, fake_payload,
"proto5\n"
" ContextTag(0x0)\n"
" ContextTag(0x1)\n"
Expand All @@ -696,24 +691,4 @@ void TestNestingOverflow(nlTestSuite * inSuite, void * inContext)
" ContextTag(0x32)\n"
" ContextTag(0x33)\n");
}

const nlTest sTests[] = {
NL_TEST_DEF("TestFullDataDecoding", TestFullDataDecoding), //
NL_TEST_DEF("TestMetaDataOnlyDecoding", TestMetaDataOnlyDecoding), //
NL_TEST_DEF("TestEmptyClusterMetaDataDecode", TestEmptyClusterMetaDataDecode), //
NL_TEST_DEF("TestMissingDecodeData", TestMissingDecodeData), //
NL_TEST_DEF("TestWrongDecodeData", TestWrongDecodeData), //
NL_TEST_DEF("TestNestingOverflow", TestNestingOverflow), //
NL_TEST_SENTINEL() //
};

} // namespace

int TestDecode()
{
nlTestSuite theSuite = { "TestDecode", sTests, nullptr, nullptr };
nlTestRunner(&theSuite, nullptr);
return nlTestRunnerStats(&theSuite);
}

CHIP_REGISTER_TEST_SUITE(TestDecode)
Loading
Loading