status-go/_docs/policies/tests.md

status-go Test Policy

• Creating Tests
• Flaky Tests

Creating Tests

• All new functionality MUST be introduced with tests that:
  • Prove that the functionality performs as described
  • Can be falsified
  • Are resistant to fuzzing
• All new integration tests MUST BE validated via a minimum of 1000 tests.
  • This can be achieved using the -count or -test.count flag with the test command eg: -count 1000 / -test.count 1000
  • Where the CI can not support this work flow automatically, the developer MUST perform validation tests via local testing.
    • TODO Add link to issue for CI automation of validation test runs of new integration tests.
  • Ensuring that the test passes consistently every time gives confidence that the test is not flaky.

Flaky Tests

Flaky tests are defined as tests that fail intermittently.

• All flaky tests / failing tests MUST be resolved.
• No flaky tests may be introduced into the codebase.

Steps to resolving or reporting flaky tests

Is it me?

Determine who caused the flaky test.

• Is a new test you’ve written flaky or failing?
  • It was you.
  • You MUST fix the test before merge is acceptable.
• Has an existing test become flaky?
  • Check rerun reports. TODO add link to rerun reports
    • If the test does not appear in https://github.com/status-im/status-go/labels/E%3AFlaky%20Test or in the last three nightly test runs, it is most likely that the flakiness was introduced by your changes and needs to be addressed before proceeding with the merge.
    • Else the test is already documented as a flaky test (appears in the GitHub issues or in the nightly test runs), proceed to below.

flowchart TB
    A([PR ready for merge]) --> B{Have any test failed?}
    B -->|No| C[🎉 Proceed with merge 🪄]
    B -->|Yes| D{
        Is the failing test introduced
        or altered by this PR?
    }
    D -->|No| E[Check rerun reports.]
    D -->|Yes| F[
        It is likely your changes introduced the flakiness.
        You MUST fix the test before merge is acceptable.
    ]
    F --> A
    E --> G{Does the test appear in `E:Flaky Test` issues<br/> or in the last three nightly test runs?<br/>}
    G -->|Yes| I[The flakiness needs reporting]
    G -->|No| F
    I --> J([Proceed to Reporting flow])

Reporting Flaky Tests

If an old test fails and/or seems flaky either locally or in CI, you MUST report the event.

• Check the status-go GitHub repo issues for the test name(s) failing.
• If the test appears in the list of flaky test issues
  • If the issue is open
    • Add a comment to the issue
    • Detail that you have experienced the test being flaky and in what context (local vs CI, link to the PR or branch).
  • If the issue is closed
    • Reopen the issue OR create a new issue referencing the previous issue
      • Either is fine, use your best judgement in this case.
    • Detail that you have experienced the test being flaky and in what context (local vs CI, link to the PR or branch).
• If the test does not appear in the list of flaky test issues
  • create a new issue
    • The issue title should include the flaky test name
    • The issue should use the https://github.com/status-im/status-go/labels/E%3AFlaky%20Test label
  • Detail that you have experienced the test being flaky and in what context (local vs CI, link to the PR or branch).

flowchart TB
    A([Ready to report a flaky test]) --> B[Check the `status-go` GitHub repo<br/>issues for the test name failing.]
    B --> C{Does the test appear in<br/>the list of `E: Flaky Test` issues?}
    C -->|No| D[
	    Create a new issue
      - The issue title should include the flaky test name
      - The issue should use the `E:Flaky Test` label
    ]
    D --> E[
	    Detail which test is flaky and in what context:
	    local vs CI, link to the PR or branch.
    ]
    E --> J
    C -->|Yes| F{Is the issue open?}
    F -->|No| G((Either))
    H --> E
    G --> I[Reopen the issue]
    G --> D
    I --> H
    F -->|Yes| H[Add a comment to the issue]
    J([End])