sinevia/php-library-testify

Testify makes writing unit tests fun again. It has an elegant syntax and keeps things simple

v1.6.0 2019-06-25 05:52 UTC

This package is auto-updated.

Last update: 2022-04-25 13:14:47 UTC


README

Testify is a micro unit testing framework for PHP.

No Dependencies Build status GitHub stars HitCount

Features

  • No external dependencies
  • Testing your code is no longer a chore - it's fun again
  • Strives for elegance instead of a feature bloat

Requirements

  • PHP 5.3+ is required

Installation

composer require sinevia/php-library-testify
  • Manually. Download and add to your project

Usage

Here is an example for a test suite with two test cases:

require 'vendor/autoload.php';

use Math\MyCalc;
use Testify\Testify;

$tf = new Testify("MyCalc Test Suite");

$tf->beforeEach(function($tf) {
    $tf->data->calc = new MyCalc(10);
});

$tf->test("Testing the add() method", function($tf) {
    $calc = $tf->data->calc;

    $calc->add(4);
    $tf->assert($calc->result() == 14);

    $calc->add(-6);
    $tf->assertEquals($calc->result(), 8);
});

$tf->test("Testing the mul() method", function($tf) {
    $calc = $tf->data->calc;

    $calc->mul(1.5);
    $tf->assertEquals($calc->result(), 12);

    $calc->mul(-1);
    $tf->assertEquals($calc->result(), -12);
});

$tf();

Documentation

  • __construct( string $title ) - The constructor
  • test( string $name, [Closure $testCase = null] ) - Add a test case.
  • before( Closure $callback ) - Executed once before the test cases are run
  • after( Closure $callback ) - Executed once after the test cases are run
  • beforeEach( Closure $callback ) - Executed for every test case, before it is run
  • afterEach( Closure $callback ) - Executed for every test case, after it is run
  • run( ) - Run all the tests and before / after functions. Calls report() to generate the HTML report page
  • assert( boolean $arg, [string $message = ''] ) - Alias for assertTrue() method
  • assertArray( mixed $arg, [string $message = ''] ) - Passes if $arg is an array
  • assertArrayHasKey( mixed $array, array $key, [string $message = ''] ) - Passes if $array has a $key
  • assertArray( mixed $arg, [string $message = ''] ) - Passes if $arg is an array
  • assertEquals( mixed $arg1, mixed $arg2, string [string $message = ''] ) - Passes if $arg1 == $arg2
  • assertException( object $classInstance, string $methodName, [string $message = ''] ) - Passes if method throws Exception
  • assertFalse( boolean $arg, [string $message = ''] ) - Passes if given a falsy expression
  • assertInArray( mixed $arg, array $arr, string [string $message = ''] ) - Passes if $arg is an element of $arr
  • assertJson( string $arg, string [string $message = ''] ) - Passes if $arg is a JSON string
  • assertNotArray( mixed $arg, [string $message = ''] ) - Passes if $arg is not an array
  • assertNotEquals( mixed $arg1, mixed $arg2, string [string $message = ''] ) - Passes if $arg1 != $arg2
  • assertNotArrayHasKey( mixed $array, array $key, [string $message = ''] ) - Passes if $array has not a $key
  • assertNotInArray( mixed $arg, array $arr, string [string $message = ''] ) - Passes if $arg is not an element of $arr
  • assertNotJson( string $arg, string [string $message = ''] ) - Passes if $arg is not a JSON string
  • assertNotNull( string $arg, string [string $message = ''] ) - Passes if $arg is not a NULL
  • assertNotSame( mixed $arg1, mixed $arg2, string [string $message = ''] ) - Passes if $arg1 !== $arg2
  • assertNotStringContainsString( string $string, string $substring, [string $message = ''] ) - Passes if $string has no $substring
  • assertNotStringContainsStringIgnoringCase( string $string, string $substring, [string $message = ''] ) - Passes if $string has no $substring regardless of case
  • assertNull( string $arg, string [string $message = ''] ) - Passes if $arg is a NULL
  • assertRegExpr( string $arg1, string $arg2, [string $message = ''] ) - Passes if $arg1 is matched in $arg2
  • assertStringContainsString( string $string, string $substring, [string $message = ''] ) - Passes if $string has $substring
  • assertStringContainsStringIgnoringCase( string $string, string $substring, [string $message = ''] ) - Passes if $string has $substring regardless of case
  • assertSame( mixed $arg1, mixed $arg2, string [string $message = ''] ) - Passes if $arg1 === $arg2
  • assertTrue( boolean $arg, [string $message = ''] ) - Passes if given a truthfull expression
  • pass( string [string $message = ''] ) - Unconditional pass
  • fail( string [string $message = ''] ) - Unconditional fail
  • report( ) - Generates a pretty CLI or HTML5 report of the test suite status. Called implicitly by run()
  • __invoke( ) - Alias for run() method