pytest-slack

https://img.shields.io/pypi/v/pytest-slack.svg https://img.shields.io/travis/pytest-dev/pytest-slack.svg https://codecov.io/gh/pytest-dev/pytest-slack/branch/master/graph/badge.svg Documentation Status Updates

Pytest to Slack reporting plugin

Requirements

  • Requests

Installation

You can install “pytest-slack” via pip:

$ pip install pytest-slack

Usage

  • Setup slack hook
  • Use this plugin by running pytest normally and use the following options to customize report:
>>> slack:
  --slack_channel=SLACK_CHANNEL
                        Set the channel name to report
  --slack_hook=SLACK_HOOK
                        Used for reporting to slack
  --slack_report_link=SLACK_REPORT_LINK
                        Set the report link
  --slack_username=SLACK_USERNAME
                        Set the reporter name
  --slack_timeout=SLACK_TIMEOUT [DEFAULT = 10s ]
                        Set the timeout for sending results in seconds
  --slack_success_emoji=SLACK_SUCCESS_EMOJI [default = :thumbsup:]
                        Set emoji for a successful run
  --slack_failed_emoji=SLACK_FAILED_EMOJI [default = :thumbsdown:]
                        Set emoji for a failed run
  --slack_success_icon=SLACK_SUCCESS_ICON [default = None]
                        Set icon (a url) for a successful run. Overrides SLACK_SUCCESS_EMOJI
  --slack_failed_icon=SLACK_FAILED_ICON [default = None]
                        Set icon (a url) for a failed run. Overrides SLACK_FAILED_EMOJI

Example

$ pytest tests –slack_hook=https://hooks.slack.com/services/… –slack_channel=test_report_channel –slack_username=”Regression testing results”

All kind of problems:

https://raw.githubusercontent.com/pytest-dev/pytest-slack/master/img/failed.png

Passed test:

https://raw.githubusercontent.com/pytest-dev/pytest-slack/master/img/success.png

$ pytest tests –slack_hook=https://hooks.slack.com/services/… –slack_channel=test_report_channel –slack_username=”Regression testing results” –slack_report_link=http://any_address

Passed test with link:

https://raw.githubusercontent.com/pytest-dev/pytest-slack/master/img/success_link.png

Issues

If you encounter any problems, please file an issue along with a detailed description.