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.

Sign up for GitHub

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

chore: rephrase flaky warning message for PRs #490

Merged
merged 1 commit into from
Feb 7, 2024
Merged

chore: rephrase flaky warning message for PRs #490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/continuous-integration.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
# The 'FAILED_TESTS_ARE_FLAKY' variable is used to print a warning messages if flaky tests are
# re-run. By default, we do not want to print this warning
# rerun. By default, we do not want to print this warning
FAILED_TESTS_ARE_FLAKY: "false"

jobs:
Expand Down Expand Up @@ -690,7 +690,7 @@ jobs:
# If only some test files were changed, this step is skipped and each associated tests will be
# run individually in a following step (pytest_modified_tests_only)
# If regular tests failed, a following script checks for flaky tests. If all failed tests
# are known flaky tests, they are re-run. Otherwise, the step exits with status 1.
# are known flaky tests, they are rerun. Otherwise, the step exits with status 1.
# The 'bash +e {0}' is added here in order to make sure that the step does not exit directly
# if 'make pytest' fails
- name: PyTest Source Code (regular)
Expand Down Expand Up @@ -729,7 +729,7 @@ jobs:

echo "FAILED_TESTS_ARE_FLAKY=${FAILED_TESTS_ARE_FLAKY}" >> "$GITHUB_ENV"

# If all failed tests are known flaky tests, try to re-run them
# If all failed tests are known flaky tests, try to rerun them
if [[ "${FAILED_TESTS_ARE_FLAKY}" == "true" ]]; then
make pytest_run_last_failed

Expand All @@ -739,7 +739,7 @@ jobs:
fi
fi

# If regular tests passed but at least one known flaky test have been re-run, a warning
# If regular tests passed but at least one known flaky test have been rerun, a warning
# comment is published in the PR and all flaky tests that initially failed are listed
- name: Warn PR with flaky tests
uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31
Expand Down
13 changes: 7 additions & 6 deletions script/actions_utils/pytest_failed_test_report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,17 @@ def write_failed_tests_comment(failed_tests_comment_path: Path, failed_tests_rep

# Write the comment's title and main header
if failed_tests_report["all_failed_tests_are_flaky"]:
f.write("## :warning: Known flaky tests have been re-run :warning:\n\n")
f.write("## :warning: Known flaky tests have been rerun :warning:\n\n")
failed_tests_header = (
"One or several tests initially failed but were detected as known flaky tests. "
"They therefore have been re-run and passed. See below for more details.\n\n"
"One or several tests initially failed but were identified as known flaky. "
"tests. Therefore, they have been rerun and passed. See below for more "
"details.\n\n"
)
else:
f.write("## ❌ Some tests failed after re-run ❌\n\n")
f.write("## ❌ Some tests failed after rerun ❌\n\n")
failed_tests_header = (
"At least one of the following tests initially failed. They therefore have "
"been re-run but failed again. See below for more details.\n\n"
"At least one of the following tests initially failed. They have therefore"
"been rerun but failed again. See below for more details.\n\n"
)

f.writelines(failed_tests_header)
Expand Down
Loading