klei/phut

A small and simple unit testing framework for PHP 5.3+

Phut

Phut is a small unit test framework for PHP 5.3+, inspired by NUnit, _(*1)

Build status

• master
• develop

What is Phut

Phunit is a PHP Unit Test framework which uses annotations to mimic the behavior of NUnit for .Net., _(*2)

Why another unit testing framework?

I was tired searching for a unit testing framework for PHP that:, _(*3)

• Fully supports namespaces
• Is easy to setup
• Works on Windows without a hassle

So finally, when I didn't find a single framework that did all of the above, I decided to do it myself., _(*4)

Installation

You can install Phut using one of the following methods., _(*5)

Using Composer

One simple way to install Phut is to use Composer. First create or modify your composer.json file in the project root to include:, _(*6)

{
    "require": {
        "klei/phut": "*"
    },
    "config": {
        "bin-dir": "bin/"
    }
}

Then download composer.phar from http://getcomposer.org/ and run:, _(*7)

php composer.phar install

Or using git

You could also clone the Phut repository with:, _(*8)

git clone git://github.com/klei-dev/phut.git

Then download composer.phar as above and execute the following:, _(*9)

php composer.phar install

Writing your first test

As mentioned above Phut uses annotations to work. The name of the annotations is directly inspired by the NUnit framework for .Net. I.e. a test class must be annotated with @TestFixture and each test with @Test., _(*10)

A simple test could therefore look like this:, _(*11)

<?php
use Klei\Phut\TestFixture;
use Klei\Phut\Test;
use Klei\Phut\Assert;

/**
 * @TestFixture
 */
class MyFirstTests {
    /**
     * @Test
     */
    public function MultiplyOperator_Multiply2by4_ShouldGive8()
    {
        // Given
        $number1 = 2;
        $number2 = 4;

        // When
        $result = $number1 * $number2;

        // Then
        Assert::areIdentical($result, 8);
    }
}

You can then run your test with the command:, _(*12)

bin/phut [<test-folder-name>|<test-file-name>]

If no folder (<test-folder-name>) or file (<test-file-name>) is specified, the runner defaults to the folder tests/., _(*13)

The future for Phut

Stuff for future releases:, _(*14)

• More extensive Assert-class
• @TestCase annotation to write parameterized tests
• Optional Category parameter for the @Test annotation to be able to categorize tests and run only certain categories

Copyright

Copyright © 2012, Joakim Bengtson. See LICENSE., _(*15)

Questions?

You can find me here at GitHub and via twitter at @joakimbeng., _(*16)