amqp module updated and module stability docs added

Author: Davert

bin/update_docs.php

@@ -22,6 +22,8 @@ function clean_doc($doc, $indent = 3)
     $moduleName = basename(substr($module, 0, -4));
     $text = '# ' . $moduleName . " Module\n";
 
+    $text .= "**For additional reference,, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/$moduleName)**";
+
     $className = '\Codeception\Module\\' . $moduleName;
     $class = new ReflectionClass($className);
 

codeception.yml

@@ -22,11 +22,8 @@ modules:
             username: 'guest'
             password: 'guest'
             vhost: '/'
-            routes:
-                - exchange: Exchange1
-                  queue: Queue1
-                - exchange: Exchange1
-                  queue: Queue2
+            queues: [queue1, queue2]
+
 coverage:
     enabled: true
     include:

docs/modules/AMQP.md

@@ -1,22 +1,98 @@
 # AMQP Module
-
+**For additional reference,, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/AMQP)**
 This module interacts with message broker software that implements
-the Advanced Message Queuing Protocol (AMQP) standard. For example, RabbitMQ.
+the Advanced Message Queuing Protocol (AMQP) standard. For example, RabbitMQ (tested).
 Use it to cleanup the queue between tests.
 
+## Status
+* Maintainer: **davert**, **tiger-seo**
+* Stability: **alpha**
+* Contact: codecept@davert.mail.ua
+* Contact: tiger.seo@gmail.com
+
+*Please review the code of non-stable modules and provide patches if you have issues.*
+
 ## Config
 
+* host: localhost - host to connect
+* username: guest - username to connect
+* password: guest - password to connect
+* vhost: '/' - vhost to connect
 * cleanup: true - defined queues will be purged before running every test.
+* queues: [mail, twitter] - queues to cleanup
+
+Example:
+
+modules:
+     enabled: [AMQP]
+     config:
+        AMQP:
+           host: 'localhost'
+           port: '5672'
+           username: 'guest'
+           password: 'guest'
+           vhost: '/'
+           queues: [queue1, queue2]
+
+## Public Properties
 
-## Other
+* connection - AMQPConnection - current connection
+* channel - AMQPChannel - current channel
 
  * available since version 1.1.2
  * author tiger.seo@gmail.com
+ * author davert
 
 ## Actions
 
 
-### cleanupAMQP
+### pushToExchange
+
+
+Sends message to exchange
+
+``` php
+<?php
+$I->pushToExchange('exchange.emails', 'thanks');
+$I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'));
+?>
+```
+
+ * param $exchange
+ * param $message string|AMQPMessage
+
+
+### pushToQueue
+
+
+Sends message to queue
+
+``` php
+<?php
+$I->pushToQueue('queue.jobs', 'create user');
+$I->pushToQueue('queue.jobs', new AMQPMessage('create'));
+?>
+```
+
+ * param $queue
+ * param $message string|AMQPMessage
+
+
+### seeMessageInQueue
+
+
+Checks if message containing text received.
+
+**This method drops message from queue**
+**This method will wait for message. If none is sent the script will stuck**.
+**Purges queue in the end**
 
+``` php
+<?php
+$I->pushToQueue('queue.emails', 'Hello, davert');
+$I->seeMessageInQueue('queue.emails','davert');
+?>
+```
 
-Cleans up queue.
+ * param $queue
+ * param $message

docs/modules/Cli.md

@@ -1,18 +1,37 @@
 # Cli Module
+**For additional reference,, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/Cli)**
+Wrapper for basic shell commands and shell output
+
+## Responsibility
+* Maintainer: **davert**
+* Status: **stable**
+* Contact: codecept@davert.mail.ua
+
+*Please review the code of non-stable modules and provide patches if you have issues.*
 
 ## Actions
 
 
 ### dontSeeInShellOutput
 
-__not documented__
+
+Checks that output from latest command doesn't contain text
+
+ * param $text
+
 
 
 ### runShellCommmand
 
-__not documented__
+
+Executes a shell command
+
+ * param $command
 
 
 ### seeInShellOutput
 
-__not documented__
+
+Checks that output from last executed command contains text
+
+ * param $text

docs/modules/Db.md

@@ -1,5 +1,5 @@
 # Db Module
-
+**For additional reference,, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/Db)**
 Works with SQL dabatase.
 
 The most important function of this module is cleaning database before each test.
@@ -29,6 +29,19 @@ Supported but not tested.
 Connection is done by database Drivers, which are stored in Codeception\Util\Driver namespace.
 Check out drivers if you get problems loading dumps and cleaning databases.
 
+## Status
+
+* Maintainer: **davert**
+* stability:
+    - Mysql: stable
+    - SQLite: stable
+    - Postgres: beta
+    - MSSQL: alpha
+    - Oracle: alpha
+* Contact: codecept@davert.mail.ua
+
+*Please review the code of non-stable modules and provide patches if you have issues.*
+
 ## Config
 
 * dsn *required* - PDO DSN

docs/modules/Dbh.md

@@ -1,5 +1,5 @@
 # Dbh Module
-
+**For additional reference,, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/Dbh)**
 This module replaces Db module for functional and unit testing, and requires PDO instance to be set.
 Be default it will cover all database queries into transaction and rollback it afterwards.
 The database should support nested transactions, in order to make cleanup work as expected.
@@ -19,6 +19,16 @@ This will make all queries in this connection run withing transaction and rolled
 Note, that you can't use this module with MySQL. Or perhaps you don't use transactions in your project, then it's ok.
 Otherwise consider using ORMs like Doctrine, that emulate nested transactions, or switch to Db module.
 
+## Status
+
+* Maintainer: **davert**
+* stability: stable
+* Contact: codecept@davert.mail.ua
+
+This module despite of it's stability may act unstable because of transactions issue. If test fails with fatal error and transaction is not finished, it may affect other transactions.
+
+*Please review the code of non-stable modules and provide patches if you have issues.*
+
 ### Configuration
 
 * cleanup: true - enable cleanups by covering all queries inside transaction.

docs/modules/Doctrine1.md

@@ -1,11 +1,17 @@
 # Doctrine1 Module
-
+**For additional reference,, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/Doctrine1)**
 Performs DB operations with Doctrine ORM 1.x
 
 Uses active Doctrine connection. If none can be found will fail.
 
 This module cleans all cached data after each test.
 
+## Status
+
+* Maintainer: **davert**
+* stability: stable
+* Contact: codecept@davert.mail.ua
+
 ## Config
 * cleanup: true - all doctrine queries will be run in transaction, which will be rolled back at the end of test.
 

docs/modules/Doctrine2.md

@@ -1,5 +1,5 @@
 # Doctrine2 Module
-
+**For additional reference,, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/Doctrine2)**
 Allows integration and testing for projects with Doctrine2 ORM.
 
 Doctrine2 uses EntityManager to perform all database operations.
@@ -13,6 +13,11 @@ It can be done in bootstrap file, by setting static $em property:
 \Codeception\Module\Doctrine2::$em = $em
 
 ```
+## Status
+
+* Maintainer: **davert**
+* stability: stable
+* Contact: codecept@davert.mail.ua
 
 ## Config
 

docs/modules/Filesystem.md

@@ -1,8 +1,14 @@
 # Filesystem Module
-
+**For additional reference,, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/Filesystem)**
 Module for testing local filesystem.
 Fork it to extend the module for FTP, Amazon S3, others.
 
+## Status
+
+* Maintainer: **davert**
+* stability: stable
+* Contact: codecept@davert.mail.ua
+
 Module was developed to test Codeception itself.
 
 ## Actions

docs/modules/Kohana.md

@@ -1,9 +1,14 @@
 # Kohana Module
-
+**For additional reference,, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/Kohana)**
 This module provides integration with [Kohana](http://kohanaframework.org/) v3.
-Current status is PRE ALFA=)
 Functional tests can be run inside Kohana. All commands of this module are just the same as in other modules that share Framework interface.
 
+## Status
+
+* Maintainer: **Nikita Groshin**
+* stability: alpha
+* Contact: nike-17@ya.ru
+
 ### Installation
 
 This module sets $_SERVER['KOHANA_ENV'] = 'testing'