atoum/atoum-bundle

Bundle around atoum unit testing framework

Wednesday, July 19, 2017
by steph_py
Repository
19 Watchers
42 Stars
183,218 Installations

PHP
17 Dependents
0 Suggesters
31 Forks
16 Open issues
19 Versions
3 % Grown

The README.md

AtoumBundle

, _(*1)

This bundle provides a (very) simple integration of atoum, the simple, modern and intuitive unit testing framework for PHP, from mageekguy into Symfony2., _(*2)

Installation

1 - With composer

{
    "require": {
        "atoum/atoum-bundle": "^1.4"
    }
}

In most of the cases you don't need AtoumBundle in your production environment., _(*3)

{
    "require-dev": {
        "atoum/atoum-bundle": "^1.4"
    }
}

2 - Command

AtoumBundle is provided with a Symfony command. You can launch atoum tests on specific bundles., _(*4)

2-a Registering in the kernel

You have to define AtoumBundle on AppKernel, _(*5)

if (in_array($this->getEnvironment(), array('dev', 'test'))) {
    //.....
    $bundles[] = new atoum\AtoumBundle\AtoumAtoumBundle();
}

2-b Configuration

Define your bundles on configuration (if you want to use it only in test environment, in config_test.yml only):, _(*6)

atoum:
    bundles:
        # note that the full name, including vendor, is required
        AcmeFooBundle: ~ # FooBundle is defined with directories Tests/Units, Tests/Controller
        MeBarBundle:
            directories: [Tests/Units, Tests/Functional, ...]

2-c Command-line usage

Then you can use:, _(*7)

$ php app/console atoum FooBundle --env=test # launch tests of FooBundle
$ php app/console atoum FooBundle BarBundle --env=test # launch tests of FooBundle and BarBundle
$ php app/console atoum acme_foo --env=test # launch tests of bundle where alias is acme_foo
$ php app/console atoum --env=test # launch tests from configuration.

Simple Usage

Make your test class extend the atoum\AtoumBundle\Test\Units\Test class of the bundle., _(*8)

Don't forget to load this class with your favorite method (require, autoload, ...) if you don't use composer., _(*9)

<?php

// src/Acme/MyBundle/Tests/Units/Entity/HelloWorld.php

namespace Acme\MyBundle\Tests\Units\Entity;
// if you don't use a bootstrap file, (or composer) you need to require the application autoload
//require __DIR__ . '/../../../../../../app/autoload.php';

// use path of the atoum.phar as bellow if you don't want to use atoum via composer
//require_once __DIR__ . '/../../../../../vendor/mageekguy.atoum.phar';

use atoum\AtoumBundle\Test\Units;

class helloWorld extends Units\Test
{
}

Web test case

You can easily create a kernel environment:, _(*10)

<?php

require __DIR__ . '/../../../../../../../app/autoload.php';

use atoum\AtoumBundle\Test\Units;

class helloWorld extends Units\WebTestCase
{
    public function testMyTralala()
    {
        $client = $this->createClient();
    }
}

Command test case

You can also easily test a command:, _(*11)

<?php

namespace My\Bundle\FoobarBundle\Tests\Units\Command;

use atoum\AtoumBundle\Test\Units as AtoumBundle;
use mageekguy\atoum;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Tester\CommandTester;

// Assuming that this command will display "Success" if succes, and returns a boolean
use My\Bundle\FoobarBundle\Command\FoobarCommand as Base;

class FoobarCommand extends AtoumBundle\CommandTestCase
{
    public function testExecute()
    {
        $this
            ->given(
                $command = new Base()
            )
            ->if($commandTester = $this->createCommandTester($command))
            ->then
                ->boolean($commandTester->execute())
                    ->isTrue()
                ->string($commandTester->getDisplay())
                    ->contains("Success")
        ;
    }
}

Known issues

The path of the AppKernel cannot be found, override the method getKernelDirectory and add the path to your app directory.

Test a controller

You can test your controller with the ControllerTest class (it extends WebTestCase - each file must correspond to a Symfony2 controller):, _(*12)

<?php

namespace vendor\FooBundle\Tests\Controller;

use atoum\AtoumBundle\Test\Units\WebTestCase;
use atoum\AtoumBundle\Test\Controller\ControllerTest;

class BarController extends ControllerTest
{
    public function testGet()
    {
        $this
            ->request(array('debug' => true))
                ->GET('/demo/' . uniqid())
                    ->hasStatus(404)
                    ->hasCharset('UTF-8')
                    ->hasVersion('1.1')
                ->POST('/demo/contact')
                    ->hasStatus(200)
                    ->hasHeader('Content-Type', 'text/html; charset=UTF-8')
                    ->crawler
                        ->hasElement('#contact_form')
                            ->hasChild('input')->exactly(3)->end()
                            ->hasChild('input')
                                ->withAttribute('type', 'email')
                                ->withAttribute('name', 'contact[email]')
                            ->end()
                            ->hasChild('input[type=submit]')
                                ->withAttribute('value', 'Send')
                            ->end()
                            ->hasChild('textarea')->end()
                        ->end()
                        ->hasElement('li')
                            ->withContent('The CSRF token is invalid. Please try to resubmit the form.')
                            ->exactly(1)
                        ->end()
                        ->hasElement('title')
                            ->hasNoChild()
                        ->end()
                        ->hasElement('meta')
                            ->hasNoContent()
                        ->end()
                        ->hasElement('link')
                            ->isEmpty()
                        ->end()
        ;
    }
}

Test a form type

You can test your form types with the FormTestCase class as the official symfony 2 documentation shows it. But as the official documentation fits the PHPUnit testing framework, here comes this documentation first example atoum-translated :, _(*13)

<?php

namespace Acme\DemoBundle\Tests\Form;

use Acme\DemoBundle\Entity\TestEntity;
use atoum\AtoumBundle\Test\Form;
use Acme\DemoBundle\Form\TestEntityType as MyTypeToTest;

class TestEntityType extends Form\FormTestCase{

    public function testToutCourt()
    {
        $formData = array(
            'texte1' => 'test 1',
            'texte2' => 'test 2',
        );

        $type = new MyTypeToTest();
        $form = $this->factory->create($type);

        $object = new TestEntity();
        $object->fromArray($formData);

        // submit the data to the form directly
        $form->submit($formData);

        $this->boolean($form->isSynchronized())->isTrue();
        $this->variable($object)->isEqualTo($form->getData());

        $view = $form->createView();
        $children = $view->children;

        foreach (array_keys($formData) as $key) {
            $this->array($formData)->hasKey($key);
        }
    }

}

Faker data

AtoumBundle integrates with Faker library., _(*14)

In your tests classes, you have access to a Faker\Generator instance with the faker asserter., _(*15)

public function testMyAmazingFeature()
{
    //.....
    $randomName = $this->faker->name;

    $dateTimeBetweenYesterdayAndNow = $this->faker->dateTimeBetween('-1 day', 'now');
    //.....
}

See Faker's documentation about its usage., _(*16)

The Versions

19/07 2017

dev-master

9999999-dev https://github.com/atoum/AtoumBundle

Bundle around atoum unit testing framework

symfony-bundle atoum-bundle

Bundle around atoum unit testing framework

atoum/atoum-bundle

The README.md

AtoumBundle

Installation

1 - With composer

2 - Command

2-a Registering in the kernel

2-b Configuration

2-c Command-line usage

Simple Usage

Web test case

Command test case

Known issues

Test a controller

Test a form type

Faker data

The Versions

dev-master

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

2.0.0

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

dev-fix-env-matrix

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

1.6.0

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

1.5.0

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

dev-php-doc

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

dev-atoum-default-bootstrap

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

dev-loop-mode

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

1.4.1

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

1.4.0

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

1.2.1

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

1.3.0

The Requires

The Development Requires

by Community contributors

by Florian Lonqueu-Brochard

1.2.0