Skip to content

Added a section of how to deal with flakey tests to the developer guide.#4868

Merged
dblock merged 1 commit intoopensearch-project:mainfrom
dblock:flakey-tests-dev-guide
Oct 21, 2022
Merged

Added a section of how to deal with flakey tests to the developer guide.#4868
dblock merged 1 commit intoopensearch-project:mainfrom
dblock:flakey-tests-dev-guide

Conversation

@dblock
Copy link
Copy Markdown
Member

@dblock dblock commented Oct 21, 2022

Signed-off-by: Daniel (dB.) Doubrovkine dblock@amazon.com

Description

Have a permalink to explain to contributors what to do when they encounter a flakey test.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@dblock dblock requested review from a team and reta as code owners October 21, 2022 16:14
@dblock dblock force-pushed the flakey-tests-dev-guide branch 3 times, most recently from ad5cce6 to b9e2ca4 Compare October 21, 2022 16:18
@github-actions
Copy link
Copy Markdown
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Copy Markdown
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Copy Markdown
Contributor

Gradle Check (Jenkins) Run Completed with:

3. Search through [issues](https://github.com/opensearch-project/OpenSearch/issues?q=is%3Aopen+is%3Aissue+label%3A%22Flakey+Random+Test+Failure%22) using the name of the failed test for whether this is a known flakey test.
5. If an existing issue is found, paste a link to the known issue in a comment to your PR.
6. If no existing issue is found, open one.
7. Push an update to your PR to retry CI.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The gradle check github action can be retried directly without changing your commit, right?

Next to the failed action click: Details -> Re-run jobs -> Re-run failed jobs

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't you have to be a maintainer on the project to do so? Or can PR authors do it?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed it to "Retry CI via the GitHub UX or by pushing an update to your PR."

Copy link
Copy Markdown
Contributor

@adnapibar adnapibar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: Daniel (dB.) Doubrovkine <dblock@amazon.com>
@dblock dblock force-pushed the flakey-tests-dev-guide branch from b9e2ca4 to 4da1df7 Compare October 21, 2022 16:30
@github-actions
Copy link
Copy Markdown
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Copy Markdown
Contributor

Gradle Check (Jenkins) Run Completed with:

@dblock dblock merged commit b36906f into opensearch-project:main Oct 21, 2022
@dblock dblock deleted the flakey-tests-dev-guide branch October 21, 2022 17:32
@dblock dblock added the backport 2.x Backport to 2.x branch label Oct 21, 2022
@opensearch-trigger-bot
Copy link
Copy Markdown
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-4868-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 b36906ffb2f81722e882752f35ee59eb8827a8c5
# Push it to GitHub
git push --set-upstream origin backport/backport-4868-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-4868-to-2.x.

snuyanzin pushed a commit to snuyanzin/OpenSearch that referenced this pull request Oct 28, 2022
…de. (opensearch-project#4868)

Signed-off-by: Daniel (dB.) Doubrovkine <dblock@amazon.com>

Signed-off-by: Daniel (dB.) Doubrovkine <dblock@amazon.com>
ashking94 pushed a commit to ashking94/OpenSearch that referenced this pull request Nov 7, 2022
…de. (opensearch-project#4868)

Signed-off-by: Daniel (dB.) Doubrovkine <dblock@amazon.com>

Signed-off-by: Daniel (dB.) Doubrovkine <dblock@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 2.x Backport to 2.x branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants