Skip to content

Commit 5f7c838

Browse files
committed
improved robofile
1 parent e7c75fb commit 5f7c838

42 files changed

Lines changed: 6802 additions & 5485 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

RoboFile.php

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ class RoboFile extends \Robo\Tasks {
1111
public function release()
1212
{
1313
$this->say("CODECEPTION RELEASE: ".\Codeception\Codecept::VERSION);
14+
$this->update();
1415
$this->buildDocs();
1516
$this->publishSite();
1617
$this->buildPhar();
@@ -398,8 +399,11 @@ protected function cloneSite()
398399

399400
protected function publishSite()
400401
{
401-
$this->taskExec('git commit')->args('-m "auto updated documentation"')->run();
402-
$this->taskExec('git push')->run();
402+
$this->taskGit()
403+
->add('docs/*')
404+
->commit("auto updated documentation")
405+
->push()
406+
->run();
403407

404408
chdir('..');
405409
sleep(2);

composer.lock

Lines changed: 77 additions & 78 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/modules/AMQP.md

Lines changed: 69 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# AMQP Module
22

33
**For additional reference, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/AMQP.php)**
4+
## Codeception\Module\AMQP
5+
6+
* *Extends* `Codeception\Module`
47

58
This module interacts with message broker software that implements
69
the Advanced Message Queuing Protocol (AMQP) standard. For example, RabbitMQ (tested).
@@ -48,20 +51,26 @@ To use this module with Composer you need <em>"videlalvaro/php-amqplib": "*"</em
4851
@author tiger.seo@gmail.com
4952
@author davert
5053

51-
## Actions
54+
#### *public* connection* `var` AMQPConnection
5255

53-
### grabMessageFromQueue
5456

55-
Takes last message from queue.
57+
#### *public static* includeInheritedActionsBy setting it to false module wan't inherit methods of parent class.
5658

57-
$message = $I->grabMessageFromQueue('queue.emails');
59+
* `var` bool
60+
#### *public static* onlyActionsAllows to explicitly set what methods have this class.
61+
62+
* `var` array
63+
#### *public static* excludeActionsAllows to explicitly exclude actions from module.
64+
65+
* `var` array
66+
#### *public static* aliasesAllows to rename actions
67+
68+
* `var` array
5869

59-
* param $queue
60-
* return AMQPMessage
6170

62-
### pushToExchange
6371

64-
Sends message to exchange
72+
### pushToExchange
73+
#### *public* pushToExchange($exchange, $message)Sends message to exchange
6574

6675
``` php
6776
<?php
@@ -70,12 +79,10 @@ $I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'));
7079
?>
7180
```
7281

73-
* param $exchange
74-
* param $message string|AMQPMessage
75-
82+
* `param` $exchange
83+
* `param` $message string|AMQPMessage
7684
### pushToQueue
77-
78-
Sends message to queue
85+
#### *public* pushToQueue($queue, $message)Sends message to queue
7986

8087
``` php
8188
<?php
@@ -84,12 +91,10 @@ $I->pushToQueue('queue.jobs', new AMQPMessage('create'));
8491
?>
8592
```
8693

87-
* param $queue
88-
* param $message string|AMQPMessage
89-
94+
* `param` $queue
95+
* `param` $message string|AMQPMessage
9096
### seeMessageInQueueContainsText
91-
92-
Checks if message containing text received.
97+
#### *public* seeMessageInQueueContainsText($queue, $text)Checks if message containing text received.
9398

9499
**This method drops message from queue**
95100
**This method will wait for message. If none is sent the script will stuck**.
@@ -101,6 +106,50 @@ $I->seeMessageInQueueContainsText('queue.emails','davert');
101106
?>
102107
```
103108

104-
* param $queue
105-
* param $text
109+
* `param` $queue
110+
* `param` $text
111+
### grabMessageFromQueue
112+
#### *public* grabMessageFromQueue($queue)Takes last message from queue.
113+
114+
$message = $I->grabMessageFromQueue('queue.emails');
115+
116+
* `param` $queue
117+
* `return` AMQPMessage
118+
119+
120+
121+
122+
123+
124+
125+
126+
127+
128+
129+
130+
131+
132+
133+
134+
135+
136+
137+
138+
139+
140+
141+
142+
143+
144+
145+
146+
147+
148+
149+
150+
151+
152+
153+
154+
106155

docs/modules/Asserts.md

Lines changed: 86 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,137 @@
11
# Asserts Module
22

33
**For additional reference, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/Asserts.php)**
4+
## Codeception\Module\Asserts
5+
6+
* *Extends* `Codeception\Module`
7+
* *Uses* `Codeception\Util\Shared\Asserts`
48

59
Special module for using asserts in your tests.
610

711
Class Asserts
812
@package Codeception\Module
13+
#### *public static* includeInheritedActionsBy setting it to false module wan't inherit methods of parent class.
14+
15+
* `var` bool
16+
#### *public static* onlyActionsAllows to explicitly set what methods have this class.
17+
18+
* `var` array
19+
#### *public static* excludeActionsAllows to explicitly exclude actions from module.
20+
21+
* `var` array
22+
#### *public static* aliasesAllows to rename actions
23+
24+
* `var` array
25+
26+
27+
28+
29+
30+
931

10-
## Actions
1132

12-
### dontSeeContains
1333

14-
Checks that haystack doesn't contain needle.
1534

16-
* param $needle
17-
* param $haystack
18-
* param string $message
1935

20-
### dontSeeEmpty
2136

22-
Checks that variable is not empty.
2337

24-
* param $actual
25-
* param string $message
2638

27-
### dontSeeEquals
2839

29-
Checks that two variables are not equal
3040

31-
* param $expected
32-
* param $actual
33-
* param string $message
3441

35-
### dontSeeNull
3642

37-
Checks that variable is not NULL
3843

39-
* param $actual
40-
* param string $message
4144

42-
### fail
4345

44-
Fails the test with message.
4546

46-
* param $message
4747

48-
### seeContains
4948

50-
Checks that haystack contains needle
5149

52-
* param $needle
53-
* param $haystack
54-
* param string $message
5550

56-
### seeEmpty
5751

58-
Checks that variable is empty.
5952

60-
* param $actual
61-
* param string $message
6253

63-
### seeEquals
6454

65-
Checks that two variables are equal.
6655

67-
* param $expected
68-
* param $actual
69-
* param string $message
7056

71-
* return mixed
7257

73-
### seeFalse
7458

75-
Checks that condition is negative.
7659

77-
* param $condition
78-
* param string $message
7960

80-
### seeGreaterThen
8161

82-
Checks that expected is greater then actual
8362

84-
* param $expected
85-
* param $actual
86-
* param string $message
8763

64+
65+
66+
### fail
67+
#### *public* fail($message)Fails the test with message.
68+
69+
* `param` $message
70+
### seeEquals
71+
#### *public* seeEquals($expected, $actual, $message = null)Checks that two variables are equal.
72+
73+
* `param` $expected
74+
* `param` $actual
75+
* `param` string $message
76+
77+
* `return` mixed
78+
### dontSeeEquals
79+
#### *public* dontSeeEquals($expected, $actual, $message = null)Checks that two variables are not equal
80+
81+
* `param` $expected
82+
* `param` $actual
83+
* `param` string $message
84+
### seeGreaterThen
85+
#### *public* seeGreaterThen($expected, $actual, $message = null)Checks that expected is greater then actual
86+
87+
* `param` $expected
88+
* `param` $actual
89+
* `param` string $message
8890
### seeGreaterThenOrEqual
91+
#### *public* seeGreaterThenOrEqual($expected, $actual, $message = null)Checks that expected is greater or equal then actual
8992

90-
Checks that expected is greater or equal then actual
93+
* `param` $expected
94+
* `param` $actual
95+
* `param` string $message
96+
### seeContains
97+
#### *public* seeContains($needle, $haystack, $message = null)Checks that haystack contains needle
9198

92-
* param $expected
93-
* param $actual
94-
* param string $message
99+
* `param` $needle
100+
* `param` $haystack
101+
* `param` string $message
102+
### dontSeeContains
103+
#### *public* dontSeeContains($needle, $haystack, $message = null)Checks that haystack doesn't contain needle.
95104

96-
### seeNull
105+
* `param` $needle
106+
* `param` $haystack
107+
* `param` string $message
108+
### seeEmpty
109+
#### *public* seeEmpty($actual, $message = null)Checks that variable is empty.
110+
111+
* `param` $actual
112+
* `param` string $message
113+
### dontSeeEmpty
114+
#### *public* dontSeeEmpty($actual, $message = null)Checks that variable is not empty.
97115

98-
Checks that variable is NULL
116+
* `param` $actual
117+
* `param` string $message
118+
### seeNull
119+
#### *public* seeNull($actual, $message = null)Checks that variable is NULL
99120

100-
* param $actual
101-
* param string $message
121+
* `param` $actual
122+
* `param` string $message
123+
### dontSeeNull
124+
#### *public* dontSeeNull($actual, $message = null)Checks that variable is not NULL
102125

126+
* `param` $actual
127+
* `param` string $message
103128
### seeTrue
129+
#### *public* seeTrue($condition, $message = null)Checks that condition is positive.
104130

105-
Checks that condition is positive.
106-
107-
* param $condition
108-
* param string $message
131+
* `param` $condition
132+
* `param` string $message
133+
### seeFalse
134+
#### *public* seeFalse($condition, $message = null)Checks that condition is negative.
109135

136+
* `param` $condition
137+
* `param` string $message

0 commit comments

Comments
 (0)