PHP Classes

File: doc/1_quick_start.md

Recommend this page to a friend!
  Classes of Alexandre  >  Doubles  >  doc/1_quick_start.md  >  Download  
File: doc/1_quick_start.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: Doubles
Create mock objects by doubling a given class
Author: By
Last change:
Date: 2 years ago
Size: 3,192 bytes
 

Contents

Class file image Download

Getting started

Creating a compatible test case

In order to run PhpUnit test cases with this library, your test class should extend the Doubles\TestCase class. This class extends the PHPUnit\Framework\TestCase class so you can still use the PhpUnit methods normally. Here is what a test class should look like :

use \Doubles\TestCase;

class MyTestClass extends TestCase {

    function testMyFirstTest(){
        // your test here ...
    }
    

}

This will make sure the Doubles\Double::close() method is executed after each test. The next step is to create class double of the class we want to test.

Creating a double

Creating a "dummy" double

A double is called a "dummy" when all the methods of the original class are overwritten to return null. If you are not sure what doubles of type "dummy" are, you can get more details on the introduction page. To get a "dummy" double, use the dummy method class :

   
use \Doubles\Double;
use \Doubles\TestCase;

class MyTestClass extends TestCase {
    
    function testMyFirstTest(){
        // Get a double instance of type "dummy" for class "Foo"
        $double = Double::dummy(Foo::class)->getInstance();
    }
    
}

Creating a "mock" double

A double is called a "mock" when all the methods of the original class are overwritten to behave the same as in the original class. If you are not sure what doubles of type "mock" are, you can get more details on the introduction page. To get a "mock" double instance, use the mock method :

use \Doubles\Double;
use \Doubles\TestCase;

class MyTestClass extends TestCase {
    
    function testMyFirstTest(){
        // Get a double instance of type "mock" for class "Foo"
        $double = Double::mock(Foo::class)->getInstance();
    }
    
}

Testing a double

First use the Double::_method method to define which method you are going to test or change. Then use the following methods depending on what you want to do :

  • To test how many times a double method is called : use the `count` method.
  • To test the values of the arguments passed to a double method : use the `args` method.
  • To change a method's behaviour : use the `return` method.

Here is a full working example :

use \Doubles\Double;
use \Doubles\TestCase;

class MyTestClass extends TestCase {

    function testMyFirstTest(){

        /Get a double instance of type "dummy" for class "Foo"/
        $double = Double::dummy(Foo::class)->getInstance();

        /Set double test expectations for method "myMethod"/
        $double::_method('myMethod')
            ->count('>=1') // Test that the method is called a least one time
            ->args(['value1', 'value2']); // Test that the given arguments are "value1" and "value2"
            ->return('hello'); // Make the method return "hello"

        /We can now test the "ClassToTest" class injecting our "Foo" class double/
        $class_to_test = new ClassToTest($double);
        $result = $class_to_test->methodToTest();
        
        /Test the result with PhpUnit/
        $this->assertEquals('result', $result);

    }
}
For more information send a message to info at phpclasses dot org.