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.

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

[stream info] [test] Fix broken StreamInfoImpl test #37619

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

krinkinmu
Copy link
Contributor

Commit Message:

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 until we have a good alternative solution I'm fixing this test and add some comments in the check to give folks a clue as to why sizeof(StreamInfoImpl) may return different values and, consequently, how to change this test after changes to StreamInfoImpl.

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 contains a duplicate, so I cleaned the list and reduced it to 3 values. One thing in mind, is that I didn't test it on ARM platforms - from all I know it should not make a difference, but it's something to keep in mind.

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

Additional Description:
Risk Level: Low
Testing:

bazel test //test/common/stream_info:stream_info_impl_test --config=docker-clang
bazel test //test/common/stream_info:stream_info_impl_test --config=docker-msan
bazel test //test/common/stream_info:stream_info_impl_test --config=docker-clang-libc++

With -c opt and -c dbg to make sure that optimization don't affect the ABI (which is expected, but just in case).

Docs Changes: N/A
Release Notes: N/A
Platform Specific Features: N/A
Fixes commit #35650

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
envoyproxy#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]>
@krinkinmu krinkinmu force-pushed the fix-assert-stream-info-size branch from 399a7a1 to a9ccb02 Compare December 11, 2024 17:03
@krinkinmu
Copy link
Contributor Author

/retest the failed test seem to have timed out, plus I only change a test here and the failed test is not the test I changed, so it looks like a flake.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant