|
3 | 3 | title: Quick Start Codeception |
4 | 4 | --- |
5 | 5 |
|
6 | | -</div> |
7 | 6 | <div class="hero hero--quickstart"> |
8 | 7 | <div class="wide"> |
9 | | - <div class="container-fluid"> |
10 | | - <div class="row"> |
11 | | - <div class="col-lg-12 col-sm-12 text-center"> |
12 | | - <h1> |
13 | | - Quickstart |
14 | | - </h1> |
| 8 | + <div class="container-fluid"> |
| 9 | + <div class="row"> |
| 10 | + <div class="col-lg-12 col-sm-12 text-center"> |
| 11 | + <h1> |
| 12 | + Quickstart |
| 13 | + </h1> |
| 14 | + </div> |
15 | 15 | </div> |
16 | 16 | </div> |
17 | 17 | </div> |
18 | 18 | </div> |
19 | | -</div> |
20 | 19 |
|
21 | 20 | <div class="wide"> |
22 | | -<div class="container-fluid"> |
23 | | -<div class="row"> |
24 | | - <div class="col-xs-12 col-lg-6 col-lg-offset-3"> |
25 | | - <div class="panel panel-info quickstart-panel"> |
26 | | - <div class="panel-heading"> |
27 | | -<a href="/install">Alternative Installations »</a> |
28 | | - <h4 class="panel-title">1.Install</h4></div> |
29 | | - <div class="panel-body text-center"> |
30 | | - <div class=""> |
31 | | - Install via Composer |
32 | | - <div class="highlight"> |
33 | | - <pre>composer require "codeception/codeception" --dev</pre> |
| 21 | + <div class="container-fluid"> |
| 22 | + <div class="row"> |
| 23 | + <div class="col-xs-12 col-lg-6 col-lg-offset-3"> |
| 24 | + <div class="panel panel-info quickstart-panel"> |
| 25 | + <div class="panel-heading"> |
| 26 | + <a href="/install">Alternative Installations »</a> |
| 27 | + <h4 class="panel-title">1.Install</h4></div> |
| 28 | + <div class="panel-body text-center"> |
| 29 | + <div class=""> |
| 30 | + Install via Composer |
| 31 | + <div class="highlight"> |
| 32 | + <pre>composer require "codeception/codeception" --dev</pre> |
| 33 | + </div> |
| 34 | + <p> |
34 | 35 | </div> |
35 | | - <p> |
36 | | - </div> |
37 | | - <!-- <p>Use <code>codecept</code> instead of codecept.phar in this case.</p> --> |
38 | | - </div> <!-- /.panel-body --> |
39 | | - </div> <!-- /.panel --> |
| 36 | + <!-- <p>Use <code>codecept</code> instead of codecept.phar in this case.</p> --> |
| 37 | + </div> <!-- /.panel-body --> |
| 38 | + </div> <!-- /.panel --> |
40 | 39 | </div> <!-- /.col --> |
41 | 40 |
|
42 | | -</div> |
43 | | -<div class="row"> |
44 | | -<div class="col-sm-12 col-md-6"> |
45 | | - <div class="panel panel-info"> |
46 | | - <div class="panel-heading"><h4 class="panel-title">2. Setup</h4></div> |
47 | | - <div class="panel-body"> |
48 | | - <p>Execute:</p> |
49 | | - <div class="highlight"> |
50 | | - <p> |
| 41 | + </div> |
| 42 | + <div class="row"> |
| 43 | + <div class="col-sm-12 col-md-6"> |
| 44 | + <div class="panel panel-info"> |
| 45 | + <div class="panel-heading"><h4 class="panel-title">2. Setup</h4></div> |
| 46 | + <div class="panel-body"> |
| 47 | + <p>Execute:</p> |
| 48 | + <div class="highlight"> |
| 49 | + <p> |
51 | 50 | <pre>php vendor/bin/codecept bootstrap</pre> |
52 | | - </div> |
53 | | - <p class="text-muted">This creates configuration file |
54 | | - <b>codeception.yml</b> and <b>tests</b> directory and default test suites. |
| 51 | + </div> |
| 52 | + <p class="text-muted">This creates configuration file |
| 53 | + <b>codeception.yml</b> and <b>tests</b> directory and default test suites. |
55 | 54 | </p> |
56 | 55 |
|
57 | | -<a class="btn btn-primary" role="button" data-toggle="collapse" href="#bootstrap-demo" aria-expanded="false" aria-controls="collapseExample"> |
58 | | - See Demo |
59 | | -</a> |
| 56 | + <a class="btn btn-primary" role="button" data-toggle="collapse" href="#bootstrap-demo" aria-expanded="false" |
| 57 | + aria-controls="collapseExample"> |
| 58 | + See Demo |
| 59 | + </a> |
60 | 60 |
|
61 | | -<p class="collapse" id="bootstrap-demo"><img src="/images/codecept_bootstrap.gif" alt=""></p> |
62 | | - </div> <!-- /.panel-body --> |
63 | | - </div> <!-- /.panel --> |
| 61 | + <p class="collapse" id="bootstrap-demo"><img src="/images/codecept_bootstrap.gif" alt=""></p> |
| 62 | + </div> <!-- /.panel-body --> |
| 63 | + </div> <!-- /.panel --> |
64 | 64 |
|
65 | 65 | <div class="panel panel-info"> |
66 | 66 | <div class="panel-heading"><h4 class="panel-title">3. Create Test</h4></div> |
67 | 67 | <div class="panel-body"> |
68 | 68 | <p>Generate your first acceptance test. Acceptance tests emulate behavior |
69 | 69 | of a real user visiting your site.</p> |
70 | | - <div class="highlight"> |
71 | | - <p> |
72 | | - <pre>php vendor/bin/codecept generate:cest acceptance First</pre> |
73 | | - </div> |
74 | | - </div> <!-- /.panel-body --> |
75 | | - </div> <!-- /.panel --> |
76 | | - |
77 | | -<div class="panel panel-info"> |
78 | | -<div class="panel-heading"><h4 class="panel-title">4. Configure Acceptance Tests</h4></div> |
79 | | -<div class="panel-body"> |
80 | | - <p>Please make sure your local |
81 | | - <b>development server</b> is running. Put application URL into: |
82 | | - <b>tests/acceptance.suite.yml</b> </p> |
83 | | - <div class="highlight"> |
84 | | -<pre> |
85 | | -actor: AcceptanceTester |
86 | | -modules: |
87 | | - enabled: |
88 | | - - PhpBrowser: |
89 | | - url: {YOUR APP'S URL} |
90 | | - - \Helper\Acceptance |
91 | | -</pre> |
92 | | - </div> |
93 | | - </div> <!-- /.panel-body --> |
94 | | - </div> <!-- /.panel --> |
| 70 | + <div class="highlight"> |
| 71 | + <p> |
| 72 | + <pre>php vendor/bin/codecept generate:cest acceptance First</pre> |
| 73 | + </div> |
| 74 | + </div> <!-- /.panel-body --> |
| 75 | + </div> <!-- /.panel --> |
95 | 76 |
|
96 | | - <div class="panel panel-info"> |
97 | | - <div class="panel-heading"> |
98 | | - <h4 class="panel-title">5. Write a Basic Test</h4> |
99 | | - </div> |
100 | | - <div class="panel-body"> |
101 | | - <p>It's now time to write your first test. Edit the file we've just created |
102 | | - <b>tests/acceptance/FirstCest.php</b> |
103 | | - </p> |
104 | | - <div> |
105 | | -{% highlight php %} |
106 | | -<?php |
| 77 | + <div class="panel panel-info"> |
| 78 | + <div class="panel-heading"><h4 class="panel-title">4. Configure Acceptance Tests</h4></div> |
| 79 | + <div class="panel-body"> |
| 80 | + <p>Please make sure your local |
| 81 | + <b>development server</b> is running. Put application URL into: |
| 82 | + <b>tests/acceptance.suite.yml</b> </p> |
| 83 | + <div class="highlight"> |
| 84 | + <pre> |
| 85 | + actor: AcceptanceTester |
| 86 | + modules: |
| 87 | + enabled: |
| 88 | + - PhpBrowser: |
| 89 | + url: {YOUR APP'S URL} |
| 90 | + - \Helper\Acceptance |
| 91 | + </pre> |
| 92 | + </div> |
| 93 | + </div> <!-- /.panel-body --> |
| 94 | + </div> <!-- /.panel --> |
| 95 | + |
| 96 | + <div class="panel panel-info"> |
| 97 | + <div class="panel-heading"> |
| 98 | + <h4 class="panel-title">5. Write a Basic Test</h4> |
| 99 | + </div> |
| 100 | + <div class="panel-body"> |
| 101 | + <p>It's now time to write your first test. Edit the file we've just created |
| 102 | + <b>tests/acceptance/FirstCest.php</b> |
| 103 | + </p> |
| 104 | + <div> |
| 105 | + {% highlight php %} |
| 106 | + <?php |
107 | 107 | class FirstCest |
108 | 108 | { |
109 | 109 | public function frontpageWorks(AcceptanceTester $I) |
110 | 110 | { |
111 | 111 | $I->amOnPage('/'); |
112 | | - $I->see('Home'); |
113 | | - } |
114 | | -} |
115 | | -{% endhighlight %} |
116 | | - </div> |
117 | | - <p class="text-muted">It will check that your frontpage contains the word <b>Home</b> in it.</p> |
118 | | - </div> <!-- /.panel-body --> |
119 | | - </div> <!-- /.panel --> |
120 | | - |
121 | | -<div class="panel panel-info"> |
122 | | - <div class="panel-heading"><h4 class="panel-title">6. Run!</h4></div> |
123 | | - <div class="panel-body"> |
124 | | - <p>Tests are executed with 'run' command</p> |
125 | | - <div class="highlight"> |
126 | | - <p> |
127 | | - <pre>php vendor/bin/codecept run --steps</pre> |
128 | | - </div> |
129 | | - <p class="text-muted">This will execute our Welcome test with |
130 | | - <b>PhpBrowser</b>. It's PHP script that can check HTML page contents, click |
131 | | - links, fill forms, and submit POST and GET requests. For more complex tests |
132 | | - that require a browser use Selenium with |
133 | | - <b>WebDriver</b> module.</p> |
134 | | - </div> <!-- /.panel-body --> |
135 | | - </div> <!-- /.panel --> |
| 112 | + $I->see('Home'); |
| 113 | + } |
| 114 | + } |
| 115 | + {% endhighlight %} |
| 116 | + </div> |
| 117 | + <p class="text-muted">It will check that your frontpage contains the word <b>Home</b> in it.</p> |
| 118 | + </div> <!-- /.panel-body --> |
| 119 | + </div> <!-- /.panel --> |
136 | 120 |
|
137 | | -</div> <!-- /.row --> |
| 121 | + <div class="panel panel-info"> |
| 122 | + <div class="panel-heading"><h4 class="panel-title">6. Run!</h4></div> |
| 123 | + <div class="panel-body"> |
| 124 | + <p>Tests are executed with 'run' command</p> |
| 125 | + <div class="highlight"> |
| 126 | + <p> |
| 127 | + <pre>php vendor/bin/codecept run --steps</pre> |
| 128 | + </div> |
| 129 | + <p class="text-muted">This will execute our Welcome test with |
| 130 | + <b>PhpBrowser</b>. It's PHP script that can check HTML page contents, click |
| 131 | + links, fill forms, and submit POST and GET requests. For more complex tests |
| 132 | + that require a browser use Selenium with |
| 133 | + <b>WebDriver</b> module.</p> |
| 134 | + </div> <!-- /.panel-body --> |
| 135 | + </div> <!-- /.panel --> |
138 | 136 |
|
139 | | -<div class="col-sm-12 col-md-6"> |
140 | | -<div class="page"> |
| 137 | + </div> <!-- /.row --> |
141 | 138 |
|
142 | | -<h3>Simplified Setup</h3> |
| 139 | + <div class="col-sm-12 col-md-6"> |
| 140 | + <div class="page"> |
143 | 141 |
|
144 | | -<p>Use predefined installation templates for common use cases. |
145 | | -Run them instead of <code>bootstrap</code> command. |
146 | | -</p> |
| 142 | + <h3>Simplified Setup</h3> |
147 | 143 |
|
148 | | -<h4>Acceptance Testing (only)</h4> |
| 144 | + <p>Use predefined installation templates for common use cases. |
| 145 | + Run them instead of <code>bootstrap</code> command. |
| 146 | + </p> |
149 | 147 |
|
150 | | -<div class="highlight"> |
151 | | - <pre>php vendor/bin/codecept init acceptance</pre> |
152 | | -</div> |
| 148 | + <h4>Acceptance Testing (only)</h4> |
153 | 149 |
|
154 | | -<a class="btn btn-primary" role="button" data-toggle="collapse" href="#acceptance-demo" aria-expanded="false" aria-controls="collapseExample"> |
155 | | - See Demo |
156 | | -</a> <a href="/docs/03-AcceptanceTests" class="btn btn-secondary">Acceptance Testing Guide »</a> |
| 150 | + <div class="highlight"> |
| 151 | + <pre>php vendor/bin/codecept init acceptance</pre> |
| 152 | + </div> |
157 | 153 |
|
158 | | -<p class="collapse" id="acceptance-demo"><img src="/images/codecept_acceptance.gif" alt=""></p> |
| 154 | + <a class="btn btn-primary" role="button" data-toggle="collapse" href="#acceptance-demo" aria-expanded="false" |
| 155 | + aria-controls="collapseExample"> |
| 156 | + See Demo |
| 157 | + </a> <a href="/docs/03-AcceptanceTests" class="btn btn-secondary">Acceptance Testing Guide »</a> |
159 | 158 |
|
160 | | -<hr> |
| 159 | + <p class="collapse" id="acceptance-demo"><img src="/images/codecept_acceptance.gif" alt=""></p> |
161 | 160 |
|
162 | | -<h4>REST API Testing (only)</h4> |
| 161 | + <hr> |
163 | 162 |
|
164 | | -<div class="highlight"> |
165 | | - <pre>php vendor/bin/codecept init api</pre> |
166 | | -</div> |
| 163 | + <h4>REST API Testing (only)</h4> |
167 | 164 |
|
| 165 | + <div class="highlight"> |
| 166 | + <pre>php vendor/bin/codecept init api</pre> |
| 167 | + </div> |
168 | 168 |
|
169 | | -<a class="btn btn-primary" role="button" data-toggle="collapse" href="#api-demo" aria-expanded="false" aria-controls="collapseExample"> |
170 | | - See Demo |
171 | | -</a> |
172 | 169 |
|
173 | | - <a href="/docs/10-APITesting" class="btn btn-secondary">REST API Testing Guide »</a> |
| 170 | + <a class="btn btn-primary" role="button" data-toggle="collapse" href="#api-demo" aria-expanded="false" |
| 171 | + aria-controls="collapseExample"> |
| 172 | + See Demo |
| 173 | + </a> |
174 | 174 |
|
175 | | -<p class="collapse" id="api-demo"><img src="/images/codecept_api.gif" alt=""></p> |
| 175 | + <a href="/docs/10-APITesting" class="btn btn-secondary">REST API Testing Guide »</a> |
176 | 176 |
|
177 | | -<hr> |
| 177 | + <p class="collapse" id="api-demo"><img src="/images/codecept_api.gif" alt=""></p> |
178 | 178 |
|
179 | | -<h4>Unit Testing (only)</h4> |
| 179 | + <hr> |
180 | 180 |
|
181 | | -<div class="highlight"> |
182 | | - <pre>php vendor/bin/codecept init unit</pre> |
183 | | -</div> |
| 181 | + <h4>Unit Testing (only)</h4> |
184 | 182 |
|
185 | | -<a class="btn btn-primary" role="button" data-toggle="collapse" href="#unit-demo" aria-expanded="false" aria-controls="collapseExample"> |
186 | | - See Demo |
187 | | -</a> |
| 183 | + <div class="highlight"> |
| 184 | + <pre>php vendor/bin/codecept init unit</pre> |
| 185 | + </div> |
188 | 186 |
|
189 | | -<a href="/docs/05-UnitTests" class="btn btn-secondary">Unit Testing Guide »</a> |
| 187 | + <a class="btn btn-primary" role="button" data-toggle="collapse" href="#unit-demo" aria-expanded="false" |
| 188 | + aria-controls="collapseExample"> |
| 189 | + See Demo |
| 190 | + </a> |
190 | 191 |
|
191 | | -<p class="collapse" id="unit-demo"><img src="/images/codecept_unit.gif" alt=""></p> |
| 192 | + <a href="/docs/05-UnitTests" class="btn btn-secondary">Unit Testing Guide »</a> |
192 | 193 |
|
193 | | -</div> |
| 194 | + <p class="collapse" id="unit-demo"><img src="/images/codecept_unit.gif" alt=""></p> |
194 | 195 |
|
195 | | -</div> |
196 | | -</div> |
| 196 | + </div> |
197 | 197 |
|
198 | | - <div class="row"> |
199 | | -<div class="col-sm-12 col-md-6"> |
200 | | -<div class="panel panel-success"> |
201 | | -<img src="/images/codecept_run.gif" alt=""> |
202 | | -</div> |
203 | | -</div> |
204 | | -<div class="col-sm-12 col-md-6"> |
| 198 | + </div> |
| 199 | + </div> |
| 200 | + |
| 201 | + <div class="row"> |
| 202 | + <div class="col-sm-12 col-md-6"> |
| 203 | + <div class="panel panel-success"> |
| 204 | + <img src="/images/codecept_run.gif" alt=""> |
| 205 | + </div> |
| 206 | + </div> |
| 207 | + <div class="col-sm-12 col-md-6"> |
205 | 208 |
|
206 | | -<div class="page"> |
| 209 | + <div class="page"> |
207 | 210 |
|
208 | | -<h4>» Next!</h4> |
| 211 | + <h4>» Next!</h4> |
209 | 212 |
|
210 | | -<p>Read Codeception Guides to learn how to use it.</p> |
211 | | - <div class="list-group"> |
212 | | - <a class="list-group-item active" href="/docs/02-GettingStarted">A Complete Getting Started Guide</a> |
213 | | - <a class="list-group-item" href="/docs/03-AcceptanceTests">Continue with Acceptance Tests</a> |
214 | | - <a class="list-group-item" href="/docs/01-Introduction">The difference between Acceptance Tests and Unit Tests</a> |
215 | | - </div> |
216 | | -</div> |
217 | | - </div> |
| 213 | + <p>Read Codeception Guides to learn how to use it.</p> |
| 214 | + <div class="list-group"> |
| 215 | + <a class="list-group-item active" href="/docs/02-GettingStarted">A Complete Getting Started Guide</a> |
| 216 | + <a class="list-group-item" href="/docs/03-AcceptanceTests">Continue with Acceptance Tests</a> |
| 217 | + <a class="list-group-item" href="/docs/01-Introduction">The difference between Acceptance Tests and |
| 218 | + Unit Tests</a> |
| 219 | + </div> |
| 220 | + </div> |
| 221 | + </div> |
| 222 | + </div> |
218 | 223 | </div> |
219 | 224 | </div> |
220 | | -</div> |
|
0 commit comments