Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Step 1: File a flaky bug ticket in Github:

Old flaky_test tickets still need to be migrated from Jira to Github.

  • As of Oct 8, 2024, the flaky-test label is being added in https://github.com/openedx/repo-tools/pull/566, but had not yet landed.

    1. Check if someone is already following this flaky test process at the same time:

      1. Search for an existing Github ticket about this issue using the flaky-test label. (TODO get this label set up)

        1. Github search for flaky tests.

      2. Search on Github to see if the test was already deleted.

    2. Create (or update) a Github issue:

      1. Create a new issue in the repo containing the test code

      2. Title: [Flaky test] `path/to/test.py::class::method`

      3. Labels: flaky-test (TODO get this label set up)

      4. Description: Paste the following template:

        Code Block
        This test fails intermittently and will be deleted according to the Flaky Test Process in <https://github.com/openedx/edx-platform/pull/___PENDING___>
        
        See docs on [how to address flaky tests](https://openedx.atlassian.net/wiki/spaces/AC/pages/4306337795/Flaky+Test+Process#Handling-a-flaky-test-Github-issue) for why this should be fixed and how to go about it.
        
        - Failing CI run: https://...
        - Subsequent Passing CI run: https://...
        
        Failure output:
        ```
        ...test failure...
        ```

        …and fill out these placeholders:

        • URL of failed test run in GitHub Actions.

        • URL of passing run for the same commit.

        • Output from the failing test, including error message, stack trace, and anything else needed to recognize the same failure again. Build logs aren’t kept forever, and this also makes the text searchable.

    3. Now we can remove the test!

    ...