Skip to content

Commit

Permalink
[stream info] Fix broken StreamInfoImpl test
Browse files Browse the repository at this point in the history
I'm not fully familiar with the background of the assertStreamInfoSize,
but it appears that the purpose of this check is to make sure that changes
to StreamInfoImpl aren't going to break setFromForRecreateStream or setFrom.

Ideally we would not rely on such a test and instead test
setFromForRecreateStream functionality directly, but I understand that it
might be difficult to come up with a good test that covers all the cases.

However, this test was apprently broken by
#35650. This PR addedd a new field
to the StreamInfoImpl changing the layout of the structure and with that the
test.

Interestingly enough, the same PR actually updated StreamInfoImpl::setFrom
function (which the test reminds us to do every time we change StreamInfoImpl),
but at the same time it didn't change the test.

Anyways, keeping the status quo around while I don't have a good alternative
solution in mind yet I fix this test and add some comments in the check to
give folks a clue as to why sizeof(StreamInfoImpl) may return different values.

I also noticed that the list of possible values for the size of StreamInfoImpl
is way too long (we don't have that many different ABIs) and even contains a
duplicate, so I cleaned it up as well and reduced the list to just 3 values.

I will see in free time if I can replace this test with something else that
does not rely on a specific layout of the StreamInfoImpl structure.

Signed-off-by: Mikhail Krinkin <[email protected]>
  • Loading branch information
krinkinmu committed Dec 11, 2024
1 parent 8609d17 commit a9ccb02
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
11 changes: 6 additions & 5 deletions test/common/stream_info/stream_info_impl_test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,12 @@ class StreamInfoImplTest : public testing::Test {
protected:
void assertStreamInfoSize(StreamInfoImpl stream_info) {
ASSERT_TRUE(
sizeof(stream_info) == 840 || sizeof(stream_info) == 856 || sizeof(stream_info) == 888 ||
sizeof(stream_info) == 776 || sizeof(stream_info) == 728 || sizeof(stream_info) == 744 ||
sizeof(stream_info) == 680 || sizeof(stream_info) == 696 || sizeof(stream_info) == 688 ||
sizeof(stream_info) == 736 || sizeof(stream_info) == 728 || sizeof(stream_info) == 712 ||
sizeof(stream_info) == 704)
// with --config=docker-msan
sizeof(stream_info) == 712 ||
// with --config=docker-clang
sizeof(stream_info) == 720 ||
// with --config=docker-clang-libc++
sizeof(stream_info) == 688)
<< "If adding fields to StreamInfoImpl, please check to see if you "
"need to add them to setFromForRecreateStream or setFrom! Current size "
<< sizeof(stream_info);
Expand Down
1 change: 1 addition & 0 deletions tools/spelling/spelling_dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,7 @@ ODCDS
middlewildcard
monostate
mpd
msan
mutators
mybucket
myobject
Expand Down

0 comments on commit a9ccb02

Please sign in to comment.