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

[7.17](backport #41358) x-pack/filebeat/input/{cel,httpjson}: fix flaky test #41405

Merged
merged 2 commits into from
Oct 24, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 23, 2024

Proposed commit message

Do not use uncontrolled randomisation in tests where it is not necessary. The retry tests in the httpjson and cel packages were using a randomised 5xx HTTP status code to trigger the retry behaviour of the the go-retryablehttp package. This had the unfortunate consequence of causing 2% of test runs to fail.

The reason for this is given in the go-retryablehttp documentation[1]:

Mainly, if an error is returned by the client (connection errors, etc.), or if a 500-range response code is received (except 501), then a retry is invoked after a wait period.

Since the package is already tested, and is documented to accept all 5xx status codes except 501 to cause a retry, just use 500.

[1]https://pkg.go.dev/github.com/hashicorp/[email protected]#section-readme

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Disruptive User Impact

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs


This is an automatic backport of pull request #41358 done by [Mergify](https://mergify.com).

Do not use uncontrolled randomisation in tests where it is not necessary. The
retry tests in the httpjson and cel packages were using a randomised 5xx HTTP
status code to trigger the retry behaviour of the the go-retryablehttp
package. This has the unfortunate consequence of causing 2% of test runs to
fail.

The reason for this is given in the go-retryablehttp documentation[1]:

	Mainly, if an error is returned by the client (connection errors,
	etc.), or if a 500-range response code is received (except 501),
	then a retry is invoked after a wait period.

Since the package is already tested, and is documented to accept all 5xx
status codes except 501 to cause a retry, just use 500.

[1]https://pkg.go.dev/github.com/hashicorp/[email protected]#section-readme

(cherry picked from commit 794b832)

# Conflicts:
#	x-pack/filebeat/input/cel/input_test.go
#	x-pack/filebeat/input/httpjson/input_test.go
@mergify mergify bot added backport conflicts There is a conflict in the backported pull request labels Oct 23, 2024
@mergify mergify bot requested review from a team as code owners October 23, 2024 19:33
@mergify mergify bot assigned efd6 Oct 23, 2024
@mergify mergify bot requested review from faec and khushijain21 and removed request for a team October 23, 2024 19:33
Copy link
Contributor Author

mergify bot commented Oct 23, 2024

Cherry-pick of 794b832 has failed:

On branch mergify/bp/7.17/pr-41358
Your branch is up to date with 'origin/7.17'.

You are currently cherry-picking commit 794b832932.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   CHANGELOG-developer.next.asciidoc

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   x-pack/filebeat/input/cel/input_test.go
	both modified:   x-pack/filebeat/input/httpjson/input_test.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Oct 23, 2024
@botelastic
Copy link

botelastic bot commented Oct 23, 2024

This pull request doesn't have a Team:<team> label.

CHANGELOG-developer.next.asciidoc Outdated Show resolved Hide resolved
x-pack/filebeat/input/httpjson/input_test.go Outdated Show resolved Hide resolved
* redundant changelog entries
* cel tests
* conflicts in httpjson tests
@efd6 efd6 enabled auto-merge (squash) October 24, 2024 01:45
@efd6 efd6 merged commit de060ab into 7.17 Oct 24, 2024
18 of 21 checks passed
@efd6 efd6 deleted the mergify/bp/7.17/pr-41358 branch October 24, 2024 02:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport conflicts There is a conflict in the backported pull request needs_team Indicates that the issue/PR needs a Team:* label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant