Getting Started

…

Installation

The library can be installed easily via Composer.

Define the dependencies in your composer.json file:

{
    "require": {
        "qa-tools/qa-tools": "~1.0"
    }
}

Install/update your vendors:

$ curl http://getcomposer.org/installer | php
$ php composer.phar install

To verify successful installation look for the qa-tools/qa-tools folder within /vendor/ folder of your project.

Configuration

The library can be optionally configured using following approach:

<?php
use Behat\Mink\Driver\Selenium2Driver;
use Behat\Mink\Session;
use QATools\QATools\PageObject\Config\Config;
use QATools\QATools\PageObject\Container;
use QATools\QATools\PageObject\PageFactory;

// 1. Obtain/create Mink's session object:
$session = new Session(new Selenium2Driver());

// 2a. Either configure page factory via Config class:
$config = new Config(array(
    'base_url' => 'http://www.example.com',
));
$page_factory = new PageFactory($session, $config);

// 2b. Or configure page factory via dependency injection container:
$container = new Container();
$container['config_options'] = array(
    'base_url' => 'http://www.example.com',
);
$page_factory = new PageFactory($session, $container);

Then created PageFactory class instance can be used to spawn Page class instances at will.

Note

If several Mink’s sessions are used (e.g. for different browsers), then separate PageFactory class instance needs to be created for each of them. Configuration setting can be shared across different PageFactory class instances, when same container is used to create them.

Configuration Options

The following configuration options are available:

base_url - allows to specify Base URL to be used to transform all relative urls from @page-url annotations into absolute urls.
page_namespace_prefix - array of namespaces in which the DefaultPageLocator will search for page classes. Defaults to:
```
array('\\')
```

page_url_matchers - array of classes, that are used to detect if given Page is currently opened. Defaults to:

array(
    '\\QATools\\QATools\\PageObject\\PageUrlMatcher\\ExactPageUrlMatcher',
    '\\QATools\\QATools\\PageObject\\PageUrlMatcher\\RegexpPageUrlMatcher',
    '\\QATools\\QATools\\PageObject\\PageUrlMatcher\\ComponentPageUrlMatcher',
)

If port is specified as part of base_url then it will be used in every built url unless specified explicitly in the @page-url annotation.

Connecting to Behat

Note

Throughout this tutorial it’s assumed that working Behat with MinkExtension is configured and connected to a project that needs to be tested.

To use library with Behat you are required to also install https://github.com/qa-tools/behat-extension.

Connecting to PHPUnit

Note

Throughout this tutorial it’s assumed that working PHPUnit is configured and connected to a project that needs to be tested.

To use library with PHPUnit you are required to also install https://github.com/qa-tools/phpunit-extension.

Important

TODO: Write about the obtaining Mink session need for PageFactory and that it can be easily done using PHPUnit-Mink.

Connecting PHPUnit-Mink

…

Creating Test Case File

…