quickstart.html

---
layout: bootstrap
title: Quick Start Codeception
---

<div class="page-header">
  <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.&nbsp;</p>
<div class="row">
  <div class="panel panel-info">      
      <div class="panel-heading"><h4 class="panel-title">1. Download</h4></div>
      <div class="panel-body">

      <div class="container">
        <div class="col-sm-6 col-lg-6">

      <p>Download and save the
        <b>phar</b> archive to the root of your web application.&nbsp;</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>


        </div>
        <div class="col-sm-6 col-lg-6">
          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>


    </div>
  </div>
  <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><code>php codecept.phar bootstrap</code></pre>
        </p>
      </div>
      <p class="text-muted">This creates
        <b>codeception.yml</b> file and &nbsp;
        <b>tests</b> directory.</p>
    </div>
  </div>
  <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><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>
    <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 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
          <b>Home</b> in it.</p>
      </div>
    </div>
    <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. &nbsp;Put application URL into:&nbsp;
          <b>tests/acceptance.suite.yml</b>&nbsp;</p>
        <div>
          <pre>class_name: WebGuy 
modules: 
enabled: [PhpBrowser, WebHelper]
config: 
  PhpBrowser:
      url: '<b>{YOUR APP'S URL}</b>'
          </pre>
        </div>
      </div>
    </div>
    <div class="panel panel-info">        
        <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><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>
</div>
<div class="container">
<div class="row">

  <div class="col-sm-8 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><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>
</div>
</div>


  <div class="col-sm-4 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/04-AcceptanceTests">Contrinue with Acceptance Tests</a>
        <a class="list-group-item" href="/docs/01-Introduction">The difference &nbsp;between Acceptance Tests and Unit Tests</a>
    </div>
  </div>
</div>
  </div>