Repository navigation
Expand file tree
/
Copy pathquickstart.html.orig
More file actions
326 lines (288 loc) · 10.6 KB
/
Copy pathquickstart.html.orig
File metadata and controls
326 lines (288 loc) · 10.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
---
layout: bootstrap
title: Quick Start Codeception
---
<div class="container">
<<<<<<< HEAD
</div></div>
<div class="hero" style="background-image: url(/images/backgrounds/quickstart.jpg); ">
<div class="wide">
<div class="container-fluid">
<div class="row">
<div class="col-lg-12 col-sm-12 text-center">
<h1>Codeception<br> Quickstart Guide</h1>
</div>
</div>
</div>
</div>
</div>
<div class="wide">
<div class="container-fluid">
<div class="row">
<div class="col-xs-12 col-lg-8">
<div class="page">
<p class="lead">Codeception PHP Testing Framework is designed to work just out of the box.
This means its installation requires minimal steps and no external dependencies
preinstalled (except PHP, of course). Only one configuration step should
be taken and you are ready to test your web application from an eye of
actual user.</p>
=======
<div class="row">
<div class="col-xs-12 col-md-9">
<h1>Codeception Quickstart Guide</h1>
<p class="lead">Codeception PHP Testing Framework is designed to work just out of the box. This means its installation requires minimal steps and no external dependencies preinstalled (except PHP, of course). Only one configuration step should be taken and you are ready to test your web application from an eye of actual user.</p>
>>>>>>> master
<p>
<strong class="text-info text-uppercase">Requirements: PHP 5.4, CURL enabled</strong>
</p>
<<<<<<< HEAD
</div>
<div class="panel panel-info">
<div class="panel-heading"><h4 class="panel-title">1. Download</h4></div>
<div class="panel-body">
<div class="">
<p class="lead">Install via Composer</p>
<pre>$ composer require "codeception/codeception" <span class="text-muted">// ./vendor/bin/codecept</span></pre>
<p><code class="text-muted">$ alias codecept='./vendor/bin/codecept'</code></p>
</div>
=======
</div> <!-- /.col -->
</div> <!-- /.row -->
<div class="row">
<div class="col-xs-12 col-md-9">
<div class="panel panel-info">
<div class="panel-heading"><h4 class="panel-title">1. Download</h4></div>
<div class="panel-body">
<div class="">
<p class="lead">Install via Composer</p>
<pre>$ composer require "codeception/codeception" <span class="text-muted">// ./vendor/bin/codecept</span></pre>
<p><code class="text-muted">$ alias codecept='./vendor/bin/codecept'</code></p>
</div>
>>>>>>> master
<hr>
<p class="lead">Install PHAR locally</p>
<!-- phar -->
<pre>$ wget http://codeception.com/codecept.phar<a href="/thanks" style="float:right" target="_blank">download <span class="glyphicon glyphicon-download"></span></a></pre>
<!-- phar php54 -->
<pre>$ wget http://codeception.com/php54/codecept.phar <span class="text-muted">// PHP 5.4 and 5.5</span><a href="/thanks_php54" style="float:right" target="_blank">download <span class="glyphicon glyphicon-download"></span></a></pre>
<p><code class="text-muted">$ alias codecept='codecept.phar'</code></p>
<hr>
<<<<<<< HEAD
<p class="lead">Install PHAR globally</p>
<pre>sudo curl -LsS http://codeception.com/codecept.phar -o /usr/local/bin/codecept</pre>
<pre>sudo chmod a+x /usr/local/bin/codecept</pre>
<p><code class="text-muted">$ codecept</code></p>
<hr>
<p><a href="/install">Alternative Installations</a></p>
<!-- <p>Use <code>codecept</code> instead of codecept.phar in this case.</p> -->
</div> <!-- /.panel-body -->
</div> <!-- /.panel -->
<div class="panel panel-info">
<div class="panel-heading"><h4 class="panel-title">2. Install</h4></div>
<div class="panel-body">
<p>Execute:</p>
<div>
<p>
<pre>codecept bootstrap</pre>
</p>
</div>
<p class="text-muted">This creates
<b>codeception.yml</b> file and <b>tests</b> directory.</p>
</div> <!-- /.panel-body -->
</div> <!-- /.panel -->
<div class="panel panel-info">
<div class="panel-heading"><h4 class="panel-title">3. Create Test</h4></div>
<div class="panel-body">
<p>Generate your first acceptance test. Acceptance tests emulate behavior
of a real user visiting your site.</p>
<div>
<p>
<pre>codecept generate:cept acceptance Welcome</pre>
</p>
</div>
<p class="text-muted">Codeception scenario tests are called Cepts.</p>
</div> <!-- /.panel-body -->
</div> <!-- /.panel -->
=======
<p class="lead">Install PHAR globally</p>
<pre>sudo curl -LsS http://codeception.com/codecept.phar -o /usr/local/bin/codecept</pre>
<pre>sudo chmod a+x /usr/local/bin/codecept</pre>
<p><code class="text-muted">$ codecept</code></p>
<!-- <p>Use <code>codecept</code> instead of codecept.phar in this case.</p> -->
</div> <!-- /.panel-body -->
</div> <!-- /.panel -->
<div class="panel panel-info">
<div class="panel-heading"><h4 class="panel-title">2. Install</h4></div>
<div class="panel-body">
<p>Open console directory where you saved codecept.phar file and execute:</p>
<div>
<p>
<pre>$ codecept bootstrap</pre>
</p>
</div>
<p class="text-muted">This creates
<b>codeception.yml</b> file and <b>tests</b> directory.</p>
</div> <!-- /.panel-body -->
</div> <!-- /.panel -->
>>>>>>> master
<div class="panel panel-info">
<div class="panel-heading"><h4 class="panel-title">3. Create Test</h4></div>
<div class="panel-body">
<p>Generate your first acceptance test. Acceptance tests emulate behavior
of a real user visiting your site.</p>
<div>
<p>
<pre>$ codecept generate:cept acceptance Welcome</pre>
</p>
</div>
<p class="text-muted">Codeception scenario tests are called Cepts.</p>
</div> <!-- /.panel-body -->
</div> <!-- /.panel -->
<div class="panel panel-info">
<div class="panel-heading">
<h4 class="panel-title">4. Write Basic Test</h4>
</div>
<div class="panel-body">
<p>It's now time to write your first test. Edit the file we've just created
<b>tests/acceptance/WelcomeCept.php</b>
</p>
<div>
{% highlight php %}
<?php
$I = new AcceptanceTester($scenario);
$I->wantTo('ensure that frontpage works');
$I->amOnPage('/');
$I->see('Home');
?>
{% endhighlight %}
</div>
<p class="text-muted">It will check that your frontpage contains the word <b>Home</b> in it.</p>
</div> <!-- /.panel-body -->
</div> <!-- /.panel -->
<div class="panel panel-info">
<div class="panel-heading"><h4 class="panel-title">
5. Configure Acceptance Tests</h4>
</div>
<div class="panel-body">
<p>Please make sure your local
<b>dev server</b>is running. Put application URL into:
<b>tests/acceptance.suite.yml</b> </p>
<div>
<pre>
class_name: AcceptanceTester
modules:
<<<<<<< HEAD
enabled:
- PhpBrowser:
url: {YOUR APP'S URL}
- \Helper\Acceptance
=======
enabled:
- PhpBrowser:
url: {YOUR APP'S URL}
- \Helper\Acceptance
>>>>>>> master
</pre>
</div>
</div> <!-- /.panel-body -->
</div> <!-- /.panel -->
<div class="panel panel-info">
<<<<<<< HEAD
<div class="panel-heading"><h4 class="panel-title">6. Run!</h4></div>
<div class="panel-body">
<p>Codeception are executed with 'run' command</p>
<div>
<p>
<pre>codecept run</pre>
</p>
</div>
<p class="text-muted">This will execute our Welcome test with
<b>PhpBrowser</b>. It's PHP script that can check HTML page contents, click
links, fill forms, and submit POST and GET requests. For more complex tests
that require a browser use Selenium with
<b>WebDriver</b> module.</p>
</div> <!-- /.panel-body -->
</div> <!-- /.panel -->
=======
<div class="panel-heading"><h4 class="panel-title">6. Run!</h4></div>
<div class="panel-body">
<p>Codeception are executed with 'run' command</p>
<div>
<p>
<pre>$ codecept run</pre>
</p>
</div>
<p class="text-muted">This will execute our Welcome test with
<b>PhpBrowser</b>. It's PHP script that can check HTML page contents, click
links, fill forms, and submit POST and GET requests. For more complex tests
that require a browser use Selenium with
<b>WebDriver</b> module.</p>
</div> <!-- /.panel-body -->
</div> <!-- /.panel -->
>>>>>>> master
</div> <!-- /.col -->
<div class="col-sm-12 col-lg-4">
<h3>Quick Start For</h3>
{% include for.html %}
</div>
</div> <!-- /.row -->
<<<<<<< HEAD
<div class="row">
<div class="col-sm-12 col-lg-8">
<div class="panel panel-success">
<div class="panel-heading">If you did everything right and your app has "Home" text on frontpage you
will see this in output</div>
<div class="panel-body">
<pre>
Acceptance Tests (1) -------------------------------
✓ <b>WelcomeCept: Ensure that frontpage works</b>
Functional Tests -----------------------------------
Unit Tests -----------------------------------------
Time: 1 second, Memory: 21.00Mb
<b>OK (1 test, 1 assertions)</b></pre>
</div> <!-- /.panel-body -->
=======
<div class="row">
<div class="col-sm-9 col-lg-9">
<div class="panel panel-success">
<div class="panel-heading">If you did everything right and your app has "Home" text on frontpage you
will see this in output</div>
<div class="panel-body">
<pre>Suite acceptance started
Trying to <b>ensure that frontpage works</b> (WelcomeCept.php) - Ok
Suite functional started
Suite unit started
Time: 1 second, Memory: 21.00Mb
<b>OK (1 test, 1 assertions)</b></pre>
</div> <!-- /.panel-body -->
>>>>>>> master
</div> <!-- /.panel -->
</div> <!-- /.col -->
<<<<<<< HEAD
<div class="col-sm-12 col-lg-4">
<p>Follow the Acceptance Testing chapter to learn how to test your
web application by clicking links, filling forms, as your regular users
do.</p>
<div class="list-group">
<a class="list-group-item" href="/docs/02-GettingStarted">A Complete Getting Started Guide</a>
<a class="list-group-item active" href="/docs/03-AcceptanceTests">Continue with Acceptance Tests</a>
<a class="list-group-item" href="/docs/01-Introduction">The difference between Acceptance Tests and Unit Tests</a>
</div>
</div>
</div>
</div>
</div>
=======
<div class="col-sm-3 col-lg-3">
<p>Follow the Acceptance Testing chapter to learn how to test your
web application by clicking links, filling forms, as your regular users
do.</p>
<div class="list-group">
<a class="list-group-item" href="/docs/02-GettingStarted">A Complete Getting Started Guide</a>
<a class="list-group-item active" href="/docs/03-AcceptanceTests">Continue with Acceptance Tests</a>
<a class="list-group-item" href="/docs/01-Introduction">The difference between Acceptance Tests and Unit Tests</a>
</div> <!-- /.list-group -->
</div> <!-- /.col -->
</div> <!-- /.row -->
</div> <!-- /.container -->
>>>>>>> master