GeezerVison is showing github.com — codeception.github.com/quickstart.html at master · programming-kid/codeception.github.com

Expand file tree

quickstart.html

Copy path

More file actions

Latest commit

History

159 lines (142 loc) · 5.32 KB

quickstart.html

Copy path

File metadata and controls

159 lines (142 loc) · 5.32 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

---

layout: bootstrap

title: Quick Start Codeception

---

<h1>Codeception Quickstart Guide</h1>

</div>

<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="panel-heading"><h4 class="panel-title">1. Download</h4></div>

<p>Download and save the

<b>phar</b> archive to the root of your web application. </p>

<a class="btn btn-lg btn-success" href="/thanks" target="_blank">Download Codeception</a>

<p class="text-muted">alternatively download it from console</p>

<div>

<pre><code>wget http://codeception.com/codecept.phar</code></pre>

</div>

Install via Composer

<pre><code>php composer.phar require "codeception/codeception:*"</code></pre>

<p>Use <code>./vendor/bin/codecept</code> instead of codecept.phar in this tutorial.</p>

</div>

<div class="panel-heading"><h4 class="panel-title">2. Install</h4></div>

<p>Open console directory where you saved codecept.phar file and execute:</p>

<div>

<p>

<pre><code>php codecept.phar bootstrap</code></pre>

</p>

</div>

<p class="text-muted">This creates

<b>codeception.yml</b> file and  

<b>tests</b> directory.</p>

</div>

<div class="panel-heading"><h4 class="panel-title">3. Create Test</h4></div>

<p>Generate your first acceptance test. Acceptance tests emulate behavior

of a real user visiting your site.</p>

<div>

<p>

<pre><code>php codecept.phar generate:cept acceptance Welcome</code></pre>

</p>

</div>

<p class="text-muted">Codeception scenario tests are called Cepts.</p>

</div>

<div class="panel-heading"><h4 class="panel-title">4. Write Basic Test</h4></div>

<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 WebGuy($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

</div>

<div class="panel-heading"><h4 class="panel-title">5. Configure Acceptance Tests</h4></div>

<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: WebGuy

modules:

enabled: [PhpBrowser, WebHelper]

config:

PhpBrowser:

url: '<b>{YOUR APP'S URL}</b>'

</pre>

</div>

<p>Codeception are executed with 'run' command</p>

<div>

<p>

<pre><code>php codecept.phar run</code></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>Selenium2</b> module.</p>

</div>

<div class="panel-heading">If you did everything right and your app has "Home" text on frontpage you

will see this in output</div>

<pre><code>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></code></pre>

</div>

<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>

<a class="list-group-item" href="/docs/02-GettingStarted">A Complete Getting Started Guide</a>

<a class="list-group-item active" href="/docs/04-AcceptanceTests">Contrinue with Acceptance Tests</a>

<a class="list-group-item" href="/docs/01-Introduction">The difference  between Acceptance Tests and Unit Tests</a>

</div>