.yaml file

With the uploader you can pass a .yaml config file, together with test results, to configure various aspects of TestPulse.

Here is a quick example:

notifications:
  - name: Lone wolf             # team information, see Notifications for more info
    paths:
        - io.testpulse.mypackage.notflakytests.*
    slack_channel: lone-wolf
    emails: lone-wolf@gmail.com
settings:
  flaky:                        # thresholds settings, see Thresholds for more info
    thresholds:
      unit: 1
  broken:
    consecutive_failures:
      unit: 4
  recovery:
    consecutive_passes:
      from_broken:
        unit: 7
      from_flaky:
        unit: 10
  slack_channel: general
  emails: general@gmail.com
  open_github_issue: true
  comment_on_pr: true
  exclude_files_without_coverage:
    - myapp/src/test/*

Notifications

Inside notifications you can specify how you want to receive a notification in case of a test failure. See Notifications for more info.

Settings

With settings you can specify when to consider a test flaky, broken, or back to a good state. See Thresholds for more info.

Furthermore, in case you do not have have teams or do not want to specify them, you can set generic values that will be true for all tests:

  • slack_channel: which channel to notify when a test break
  • emails: which email(s) to notify when a test break
  • open_github_issue: whether to open a GH issue when a test break
  • comment_on_pr: whether to comment on a PR with test results
  • exclude_files_without_coverage: which files to exclude from code coverage