https://github.com/ngraf/slack-codeception-extension

Provides an extension for Codeception to broadcast test results in Slack messenger
https://github.com/ngraf/slack-codeception-extension

codeception extension php slack

Last synced: 2 days ago
JSON representation

Provides an extension for Codeception to broadcast test results in Slack messenger

• Host: GitHub
• URL: https://github.com/ngraf/slack-codeception-extension
• Owner: ngraf
• License: mit
• Created: 2016-12-30T08:55:48.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2020-05-12T15:11:07.000Z (over 5 years ago)
• Last Synced: 2025-09-17T10:55:38.511Z (4 months ago)
• Topics: codeception, extension, php, slack
• Language: PHP
• Size: 42 KB
• Stars: 6
• Watchers: 1
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
slack-codeception-extension

=============================

This package provides an extension for Codeception to send test results to Slack channels and/or users.

Pre-requisites

-------------

- a pre-configured webhook from the Slack integration "Incoming Webhook"

(see https://api.slack.com/incoming-webhooks for more information)

Installation

-----------

Add the package `ngraf/slack-codeception-extension` to `composer.json` manually or type this in console:

    composer require ngraf/slack-codeception-extension

    

Usage

-----

Enable and configure the extension in your `codeception.yaml`

**Basic** usage:

    extensions:

      enabled:

        - Codeception\Extension\SlackExtension

      config:

        Codeception\Extension\SlackExtension:

           webhook: https://hooks.slack.com/services/...

           

**Advanced** usage:

    extensions:

      enabled:

        - Codeception\Extension\SlackExtension

      config:

        Codeception\Extension\SlackExtension:

          webhook:           https://hooks.slack.com/services/...

           

          # possible notification strategies: always|successonly|failonly|failandrecover|statuschange

          strategy:          always

           

          # If 'true' details about failed tests will be displayed. Default value: 'false'

          extended:          true

           

          # Limit the size of error messages in extended mode. 0 = unlimited. Default value: 80

          extendedMaxLength: 80

           

          # Limit the amount of reported errors in extended mode. 0 = unlimited. Default value: 0

          extendedMaxErrors: 10

           

          # customize your message with additional prefix and/or suffix

           

          messagePrefix:     '*Smoke-Test*'

          messageSuffix:     

          messageSuffixOnFail: 

           

          # optional config keys that will overwrite the default configuration of the webhook

                      

          channel:           '#any-channel,@any-user'

          channelOnFail:     '#any-channel,@any-user'

          username:          CI

          icon:              :ghost:

           

Example

-----

![slack-example](slack-example.png)

Dependencies

-----

This package uses the package [maknz/slack](https://github.com/maknz/slack) to communicate with the Slack API.