PHPackages                             nathanmac/im-codeception-module - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing & Quality](/categories/testing)
4. /
5. nathanmac/im-codeception-module

ActiveLibrary[Testing & Quality](/categories/testing)

nathanmac/im-codeception-module
===============================

Test messaging services in your Codeception acceptance tests

v1.1(11y ago)3318MITPHP

Since Oct 23Pushed 11y ago1 watchersCompare

[ Source](https://github.com/nathanmac/im-codeception-module)[ Packagist](https://packagist.org/packages/nathanmac/im-codeception-module)[ RSS](/packages/nathanmac-im-codeception-module/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (1)Versions (3)Used By (0)

Codeception Instant Messaging (IM) Module
=========================================

[](#codeception-instant-messaging-im-module)

[![Latest Stable Version](https://camo.githubusercontent.com/c8a462ebf2b20c111779823854469ecd454ee485932563ba5625725dc9bea57a/68747470733a2f2f706f7365722e707567782e6f72672f6e617468616e6d61632f696d2d636f646563657074696f6e2d6d6f64756c652f762f737461626c652e737667)](https://packagist.org/packages/nathanmac/im-codeception-module)[![License](https://camo.githubusercontent.com/d12fa0ff58292eaf2980d1bc9e3e21eb69fc04f9542846b80041083453efdb3b/68747470733a2f2f706f7365722e707567782e6f72672f6e617468616e6d61632f696d2d636f646563657074696f6e2d6d6f64756c652f6c6963656e73652e737667)](https://packagist.org/packages/nathanmac/im-codeception-module)

This module will let you test messages that are sent during your Codeception acceptance tests.

Installation
------------

[](#installation)

Begin by installing this package through Composer. Edit your project's `composer.json` file to require `nathanmac/im-codeception-module`.

```
{
    "require-dev": {
        "codeception/codeception": "*",
        "nathanmac/im-codeception-module": "~1.0"
    }
}

```

Next, update Composer from the Terminal:

```
composer update

```

Then enable it in your suite configuration with the following settings

Configuration
-------------

[](#configuration)

The configuration settings depending on which queueing service is being used, all the options are listed here. Refer to the configuration examples below to identify the configuration options required for your chosen service.

- service - the messaging service.
- token - API token and/or Access Token.
- room - The room/channel id for the messaging service.

> N.B. The API key for HipChat must be an users API token in order to provide sufficient access the last messages in a given room, however if you are just looking to send a messages to the service a room API token will be sufficient to send the message. Consult the HipChat API documentation for clarification on this topic.

Examples
--------

[](#examples)

### Example Configuration (hipchat)

[](#example-configuration-hipchat)

```
 modules:
   enabled: [IM]
    config:
       IM:
          service: 'hipchat'
          token: API_TOKEN
          room: ROOM_ID

```

### Example Usage

[](#example-usage)

```