Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-19 00:41:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpiutil] Fix DynamicStruct string handling (#6253)

Browse Source 
Dynamic structs had a few major issues.

In C++, if the string was the last definition in the schema, attempting to set a string would trigger an assertion. This has been fixed

Setting a string value could truncate the string actually stored in the struct, if the definition was shorter than the string to set.
There was no way to detect if this case occurred. The set string function now returns a bool if the string was fully written or not.

Reading a string that had a value shorter than the schema definition would result in embedded trailing nulls in the string. This would make comparing string equality basically impossible, as those embedded nulls count for the length of the string.

The above truncating didn't take into account UTF8 code points. This means a truncation could happen in the middle of a unicode character. Depending on the language this had different behavior, but unpaired code points are problematic to detect in any case. On the decoding side, detect if a split UTF8 code point has occurred by the writer, and if so just ignore it and treat it as not part of the string. Doing this on the receive side means a newer receive side is all that is needed to fix this, which is generally a better option then requiring all senders to update.

Actual DynamicStruct instances have 0 units tests for them. Added a bunch of unit tests around strings to ensure things work properly.
This commit is contained in:
Thad House
2024-01-19 22:24:54 -08:00
committed by GitHub
parent 4b15c73f64
commit 0e5eb3f35c
6 changed files with 413 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
wpiutil/src/test/native/cpp/struct/DynamicStructTest.cpp
View File

@@ -269,6 +269,179 @@ TEST_F(DynamicStructTest, DuplicateFieldName) {
ASSERT_EQ(err, "duplicate field a");
}
TEST_F(DynamicStructTest, StringAllZeros) {
auto desc = db.Add("test", "char a[32]", &err);
uint8_t data[32];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_EQ(dynamic.GetStringField(field), "");
}
TEST_F(DynamicStructTest, StringRoundTrip) {
auto desc = db.Add("test", "char a[32]", &err);
uint8_t data[32];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_TRUE(dynamic.SetStringField(field, "abc"));
EXPECT_EQ(dynamic.GetStringField(field), "abc");
}
TEST_F(DynamicStructTest, StringRoundTripEmbeddedNull) {
auto desc = db.Add("test", "char a[32]", &err);
uint8_t data[32];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
std::string check{"ab\0c", 4};
ASSERT_EQ(check.size(), 4u);
EXPECT_TRUE(dynamic.SetStringField(field, check));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, check);
EXPECT_EQ(4u, get.size());
}
TEST_F(DynamicStructTest, StringRoundTripTooLong) {
auto desc = db.Add("test", "char a[2]", &err);
uint8_t data[2];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_FALSE(dynamic.SetStringField(field, "abc"));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, "ab");
EXPECT_EQ(2u, get.size());
}
TEST_F(DynamicStructTest, StringRoundTripPartial2ByteUtf8) {
auto desc = db.Add("test", "char a[2]", &err);
uint8_t data[2];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_FALSE(dynamic.SetStringField(field, "a\u0234"));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, "a");
EXPECT_EQ(1u, get.size());
}
TEST_F(DynamicStructTest, StringRoundTrip2ByteUtf8) {
auto desc = db.Add("test", "char a[3]", &err);
uint8_t data[3];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_TRUE(dynamic.SetStringField(field, "a\u0234"));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, "a\u0234");
EXPECT_EQ(3u, get.size());
}
TEST_F(DynamicStructTest, StringRoundTrip3ByteUtf8) {
auto desc = db.Add("test", "char a[4]", &err);
uint8_t data[4];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_TRUE(dynamic.SetStringField(field, "a\u1234"));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, "a\u1234");
EXPECT_EQ(4u, get.size());
}
TEST_F(DynamicStructTest, StringRoundTrip3ByteUtf8PartialFirstByte) {
auto desc = db.Add("test", "char a[2]", &err);
uint8_t data[2];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_FALSE(dynamic.SetStringField(field, "a\u1234"));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, "a");
EXPECT_EQ(1u, get.size());
}
TEST_F(DynamicStructTest, StringRoundTrip3ByteUtf8PartialSecondByte) {
auto desc = db.Add("test", "char a[3]", &err);
uint8_t data[3];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_FALSE(dynamic.SetStringField(field, "a\u1234"));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, "a");
EXPECT_EQ(1u, get.size());
}
// MSVC and GCC do surrogate pairs differently.
// Manually construct the 4 byte string
static constexpr char buffer[] = {
static_cast<char>(0x61), static_cast<char>(0xf0), static_cast<char>(0x9f),
static_cast<char>(0x90), static_cast<char>(0x80), static_cast<char>(0x00)};
static constexpr std::string_view fourByteUtf8String{buffer};
TEST_F(DynamicStructTest, StringRoundTrip4ByteUtf8) {
auto desc = db.Add("test", "char a[5]", &err);
uint8_t data[5];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_TRUE(dynamic.SetStringField(field, fourByteUtf8String));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, fourByteUtf8String);
EXPECT_EQ(5u, get.size());
}
TEST_F(DynamicStructTest, StringRoundTrip4ByteUtf8PartialFirstByte) {
auto desc = db.Add("test", "char a[2]", &err);
uint8_t data[2];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_FALSE(dynamic.SetStringField(field, fourByteUtf8String));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, "a");
EXPECT_EQ(1u, get.size());
}
TEST_F(DynamicStructTest, StringRoundTrip4ByteUtf8PartialSecondByte) {
auto desc = db.Add("test", "char a[3]", &err);
uint8_t data[3];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_FALSE(dynamic.SetStringField(field, fourByteUtf8String));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, "a");
EXPECT_EQ(1u, get.size());
}
TEST_F(DynamicStructTest, StringRoundTrip4ByteUtf8PartialThirdByte) {
auto desc = db.Add("test", "char a[4]", &err);
uint8_t data[4];
std::memset(data, 0, sizeof(data));
ASSERT_EQ(desc->GetSize(), sizeof(data) / sizeof(data[0]));
wpi::MutableDynamicStruct dynamic{desc, data};
auto field = desc->FindFieldByName("a");
EXPECT_FALSE(dynamic.SetStringField(field, fourByteUtf8String));
auto get = dynamic.GetStringField(field);
EXPECT_EQ(get, "a");
EXPECT_EQ(1u, get.size());
}
struct SimpleTestParam {
const char* schema;
size_t size;