This Bundle provides base classes for functional tests to assist in setting up test-databases, loading fixtures and html5 validation. It also provides a DI aware mock builder for unit tests.
If you plan on loading fixtures with your tests, make sure you have the DoctrineFixturesBundle installed and configured first.
Doctrine Fixtures setup and configuration instructions
-
Add package to
require-dev
incomposer.json
:"require-dev": { "liip/functional-test-bundle": "dev-master" }
-
Install package:
$ php composer.phar install liip/functional-test-bundle
-
Add this bundle to your application's kernel for the test environment:
// application/ApplicationKernel.php public function registerBundles() { // ... if (in_array($this->getEnvironment(), array('test'))) { $bundles[] = new Liip\FunctionalTestBundle\LiipFunctionalTestBundle(); } return $bundles; }
-
Configure the
functionalTest
service, and ensure that the framework is using the filesystem for session storage:# application/config/config_test.yml framework: test: ~ session: storage_id: session.storage.filesystem liip_functional_test: ~
-
Copy the fixtures to your projects functional tests
$ cp Fixtures/LoadUserData.php ..
-
Copy example unit and functional tests to your projects functional tests
$ cp Tests/ExampleUnitTest.php .. $ cp FunctionalTests/ExampleFunctionalTest.php .. $ cp FunctionalTests/ExampleHtml5FunctionalTest.php ..
-
Install local copy of the HTML5 validator
More information see below
In case tests require database access make sure that the DB is created and
proxies are generated. For tests that rely on specific database contents,
write fixture classes and call loadFixtures
from the bundled
Test\WebTestCase
class. This will replace the database configured in
config_test.yml
with the specified fixtures. Please note that you should be
using a designated test-database if you're using test-fixtures, since
loadFixtures
will delete the contents from the database before loading the
fixtures.
-
If you want your tests to run against a completely isolated database (which is recommended for most functional-tests), you can configure your test-environment to use a sqlite-database. This will make your tests run faster and will create a fresh, predictable database for every test you run.
Add this to your
app/config_test.yml
:doctrine: dbal: default_connection: default connections: default: driver: pdo_sqlite path: %kernel.cache_dir%/test.db
-
Use LiipFunctionalBundle's cached database feature, so that your tests run even faster. This will create backups of the initial databases (with all fixtures loaded) and re-load them when required.
Attention: you need Doctrine >= 2.2 to use this feature.
Add this to your
app/config_test.yml
liip_functional_test: cache_sqlite_db: true
-
Load your doctrine fixtures in your tests:
use Liip\FunctionalTestBundle\Test\WebTestCase; class MyControllerTest extends WebTestCase { public function testIndex() { $client = static::createClient(); // add all your doctrine fixtures classes $classes = array( // classes implementing Doctrine\Common\DataFixtures\FixtureInterface 'Bamarni\MainBundle\DataFixtures\ORM\LoadData', 'Me\MyBundle\DataFixtures\ORM\LoadData' ); $this->loadFixtures($classes); // you can now run your functional tests with a populated database // ... } }
-
If you don't need any fixtures to be loaded and just want to start off with an empty database (initialized with your schema), you can simply pass an empty array to
loadFixtures
.use Liip\FunctionalTestBundle\Test\WebTestCase; class MyControllerTest extends WebTestCase { public function testIndex() { $client = static::createClient(); $this->loadFixtures(array()); // you can now run your functional tests with an empty database // ... } }
-
This bundle uses Doctrine ORM by default. If you are using another driver just specify the service id of the registry manager
use Liip\FunctionalTestBundle\Test\WebTestCase; class MyControllerTest extends WebTestCase { public function testIndex() { $client = static::createClient(); $classes = array( 'Me\MyBundle\DataFixtures\MongoDB\LoadData' ); $this->loadFixtures($classes, null, 'doctrine_mongodb'); } }
The on-line validator: http://validator.nu/ The documentation: http://about.validator.nu/ Documentation about the web service: http://wiki.whatwg.org/wiki/Validator.nu_Web_Service_Interface
To run the validator you require the following dependencies:
- A java JDK 5 or later
- Python
- SVN
- Mercurial
Note: The script wants to see a Sun-compatible jar executable. Debian fastjar will not work.
Before starting:
- Set the
JAVA_HOME
environment variable to the root of the installed JDK - Add the location of
javac
to yourPATH
($JAVA_HOME/bin
). - Alternatively you can use the
--javac=/usr/bin/javac
parameter of thebuild.py
script.
Then:
$ mkdir checker
$ cd checker
$ svn co https://whattf.svn.cvsdude.com/build/trunk/ build
$ python build/build.py all
$ python build/build.py all
Note: Yes, the last line is there twice intentionally. Running the script twice tends to fix
a ClassCastException
on the first run.
Note: If at some point for some reason the compilation fails and you are forced to re-run it, it may be necessary to manually remove the htmlparser directory from your disk (the compilation process will complain about that).
This will download the necessary components, compile the validator and run it. This will require about 10 minutes on the first run.
Once the validator is executed it can be reached at http://localhost:8888/
Once the validator has been compiled, it can be run with the following command:
cd checker
python build/build.py run
The Liip\FunctionalTestBundle\Test\Html5WebTestCase
class allows to write functional tests
that validate content against the HTML5 validator. In order to work the validator service must be
running on the machine where the tests are executed.
This class provides the following testing methods:
-
validateHtml5: This runs a validation on the provided content and returns the full messages of the validation service (including warnings and information). This method is not meant as a test method but rather as a helper to access the validator service. Internally the test method below will use this helper to access the validation service.
-
assertIsValidHtml5: This will validate the provided content. If the validation succeeds, execution silently continues, otherwise the calling test will fail and display a list of validation errors.
-
assertIsValidHtml5Snippet: This will validate an HTML5 snippets (i.e. not a full HTML5 document) by wrapping it into an HTML5 document. If the validation succeeds, execution silently continues, otherwise the calling test will fail and display a list of validation errors.
-
assertIsValidHtml5AjaxResponse: This will validate an AJAX response in a specific format (probably not generic enough). If the validation succeeds, execution silently continues, otherwise the calling test will fail and display a list of validation errors.
-
setHtml5Wrapper: Allow to change the default HTML5 code that is used as a wrapper around snippets to validate
To catch pages that use way too many database queries, you can enable the query counter for tests.
This will check the profiler for each request made in the test using the client, and fail the test
if the number of queries executed is larger than the number of queries allowed in the configuration.
To enable the query counter, adjust the config_test.yml
file, setting the
liip_functional_test.query_count.max_query_count
setting, like this:
liip_functional_test:
query_count.max_query_count: 50
That will limit each request executed within a functional test to 50 queries.
The default value set in the config file should be reasonable to catch pages with high query counts which are obviously mistakes. There will be cases where you know and accept that the request will cause a large number of queries, or where you want to specifically require the page to execute less than x queries, regardless of the amount set in the configuration. For those cases you can set an annotation on the test method that will override the default maximum for any requests made in that test.
To do that, include the Liip\FunctionalTestBundle\Annotations\QueryCount namespace and add the
@QueryCount(100)
annotation, where 100 is the maximum amount of queries allowed for each request,
like this:
use Liip\FunctionalTestBundle\Annotations\QueryCount;
class DemoTest extends WebTestCase
{
/**
* @QueryCount(100)
*/
public function testDoDemoStuff()
{
$client = static::createClient();
$crawler = $client->request('GET', '/demoPage');
$this->assertTrue($crawler->filter('html:contains("Demo")')->count() > 0);
}
}
All the functionality of this bundle is primarily for use in the test environment. The query counter
specifically requires services that are only loaded in the test environment, so the service will
only be loaded there. If you want to use the query counter in a different environment, you'll need
to make sure the bundle is loaded in that environment in your AppKernel.php
file, and load the test
services by adding test
to the framework configuration in the config.yml (or the configuration file
for your environment):
framework:
[...]
test: ~
If that's not what you want to do, and you're getting an exception about this, check that you're
really only loading this bundle in your test
environment (See step 3 of the installation)
-
QueryCount annotations currently only work for tests that have a method name of
testFooBla()
(with a test prefix). The@test
annotation isn't supported at the moment. -
Enabling the Query Counter currently breaks PHPUnit's built-in annotations, e.g.
@dataProvider
,@depends
etc. To fix this, you need to hide the appropriate PHPUnit annotation from Doctrine's annotation reader using the@IgnoreAnnotation
annotation:
Liip\FunctionalTestBundle\Test\WebTestCase;
/** * @IgnoreAnnotation("dataProvider") * @IgnoreAnnotation("depends") */ class DemoTest extends WebTestCase { // ... }