fix flaky user agent test #2530
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The previous test was matching against a fixed list of options. The problem arised when a new type of user agent was added to the locales. Because the generator randomly picks an user agent, the previous test was very flaky. The generator should return a string even if the vendor is not available or the argument is invalid. So we can simply verify that the agent is present. There's no need to validate it against a regex, because we would have to keep this regex updated whenever a new user agent is added to the locale.
There was a problem hiding this comment.
Thanks! I agree that matching for strings here will always be prone to having those tests failing as it's easy to forget keeping them updated.
Have you considered adding the following scenario?
def test_bot_user_agent_with_no_argument
assert @tester.bot_user_agent(vendor: nil)
end
Even though is not invalid, I feel like it's a good documentation to keep here.
good idea! Added your suggestion to the list of valid argument tests. |
thdaraujo
force-pushed
the
ta/fix-flaky-user-agent-test
branch
from
d771973 to
e1c1dce
Compare
thdaraujo
force-pushed
the
ta/fix-flaky-user-agent-test
branch
from
e1c1dce to
ec9136e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue#
Fixes #2521
Description:
Fixes some flaky tests on
test_faker_internet.rbrelated to bot_user_agent generation.These previous test were matching against a fixed list of options for user agents and bot user agents.
The problem appeared when a new type of user agent was added to the locales. Because the generator randomly picks an user agent, the previous test would fail at random when the agent picked didn't match the regex.
But the generator should return a string even if the vendor is not available or the argument is invalid.
We can simply verify that the agent is present. Otherwise, we would have to keep the regex and these tests updated whenever a new user agent is added to the locale.