Documentation

This class is compatible with PHP_CodeSniffer 2.x as well as 3.x.

This class is compatible with PHPUnit 4.5 - 8.x providing the PHPCSUtils autoload file is included in the test bootstrap.

To allow for testing of tab vs space content, the tabWidth is set to 4 by default.

Typical usage:

Test case file path/to/ClassUnderTestUnitTest.inc:

<?php

/* testTestCaseDescription * /
const BAR = false;

Test file path/to/ClassUnderTestUnitTest.php:

<?php

use PHPCSUtils\TestUtils\UtilityMethodTestCase;
use YourStandard\ClassUnderTest;

class ClassUnderTestUnitTest extends UtilityMethodTestCase {

    /**
     * Testing utility method MyMethod.
     *
     * @dataProvider dataMyMethod
     *
     * @covers \YourStandard\ClassUnderTest::MyMethod
     *
     * @param string $commentString The comment which prefaces the target token in the test file.
     * @param string $expected      The expected return value.
     *
     * @return void
     * /
   public function testMyMethod($commentString, $expected)
   {
       $stackPtr = $this->getTargetToken($commentString, [\T_TOKEN_CONSTANT, \T_ANOTHER_TOKEN]);
       $class    = new ClassUnderTest();
       $result   = $class->MyMethod(self::$phpcsFile, $stackPtr);
       // Or for static utility methods:
       $result   = ClassUnderTest::MyMethod(self::$phpcsFile, $stackPtr);

       $this->assertSame($expected, $result);
   }

   /**
    * Data Provider.
    *
    * @see testMyMethod() For the array format.
    *
    * @return array
    * /
   public function dataMyMethod()
   {
       return array(
           array('/* testTestCaseDescription * /', false),
       );
   }
}

Note:

• Remove the space between the comment closers * / for a working example.
• Each test case separator comment MUST start with /* test. This is to allow the getTargetToken() method to distinquish between the test separation comments and comments which may be part of the test case.
• The test case file and unit test file should be placed in the same directory.
• For working examples using this abstract class, have a look at the unit tests for the PHPCSUtils utility functions themselves.