abstract class CoderSniffUnitTest in Coder 7.2

An abstract class that all sniff unit tests must extend.

This is a modified copy of AbstractSniffUnitTest used in PHP_CodeSniffer.

Hierarchy

• class \CoderSniffUnitTest extends \PHPUnit_Framework_TestCase

File

coder_sniffer/Test/CoderSniffUnitTest.php, line 11

abstract class CoderSniffUnitTest extends PHPUnit_Framework_TestCase {

  /**
   * The PHP_CodeSniffer object used for testing.
   *
   * @var PHP_CodeSniffer
   */
  protected static $phpcs = null;

  /**
   * Sets up this unit test.
   *
   * @return void
   */
  protected function setUp() {
    if (self::$phpcs === null) {
      self::$phpcs = new PHP_CodeSniffer();
    }
  }

  //end setUp()

  /**
   * Should this test be skipped for some reason.
   *
   * @return void
   */
  protected function shouldSkipTest() {
    return false;
  }

  //end shouldSkipTest()

  /**
   * Tests the extending classes Sniff class.
   */
  public final function testSniff() {

    // Skip this test if we can't run in this environment.
    if ($this
      ->shouldSkipTest() === true) {
      $this
        ->markTestSkipped();
    }
    $testFiles = $this
      ->getTestFiles();
    $sniffCodes = $this
      ->getSniffCodes();
    self::$phpcs
      ->process(array(), 'coder_sniffer/Drupal', $sniffCodes);
    $failureMessages = array();
    foreach ($testFiles as $testFile) {
      try {
        $phpcsFile = self::$phpcs
          ->processFile($testFile);
      } catch (Exception $e) {
        $this
          ->fail('An unexpected exception has been caught: ' . $e
          ->getMessage());
      }
      $failures = $this
        ->generateFailureMessages($phpcsFile);
      $failureMessages = array_merge($failureMessages, $failures);
    }

    //end foreach
    if (empty($failureMessages) === false) {
      $this
        ->fail(implode(PHP_EOL, $failureMessages));
    }
  }

  //end testSniff()

  /**
   * Returns a list of test files that should be checked.
   *
   * @return array The list of test files.
   */
  protected function getTestFiles() {

    // The basis for determining file locations.
    $basename = substr(get_class($this), 0, -8);
    $parts = explode('_', $basename);

    // The name of the dummy file we are testing.
    $testFileBase = dirname(__FILE__) . DIRECTORY_SEPARATOR . $parts[2] . DIRECTORY_SEPARATOR . $parts[3] . 'UnitTest.';

    // Get a list of all test files to check. These will have the same base
    // name but different extensions. We ignore the .php file as it is the class.
    $testFiles = array();
    $dir = substr($testFileBase, 0, strrpos($testFileBase, DIRECTORY_SEPARATOR));
    $di = new DirectoryIterator($dir);
    foreach ($di as $file) {
      $path = $file
        ->getPathname();
      if (substr($path, 0, strlen($testFileBase)) === $testFileBase) {
        if ($path !== $testFileBase . 'php') {
          $testFiles[] = $path;
        }
      }
    }

    // Get them in order.
    sort($testFiles);
    return $testFiles;
  }

  /**
   * Returns a list of sniff codes that should be checked in this test.
   *
   * @return array The list of sniff codes.
   */
  protected function getSniffCodes() {

    // The basis for determining file locations.
    $basename = substr(get_class($this), 0, -8);

    // The code of the sniff we are testing.
    $parts = explode('_', $basename);
    return array(
      $parts[0] . '.' . $parts[2] . '.' . $parts[3],
    );
  }

  /**
   * Generate a list of test failures for a given sniffed file.
   *
   * @param PHP_CodeSniffer_File $file The file being tested.
   *
   * @return array
   * @throws PHP_CodeSniffer_Exception
   */
  public function generateFailureMessages(PHP_CodeSniffer_File $file) {
    $testFile = $file
      ->getFilename();
    $foundErrors = $file
      ->getErrors();
    $foundWarnings = $file
      ->getWarnings();
    $expectedErrors = $this
      ->getErrorList(basename($testFile));
    $expectedWarnings = $this
      ->getWarningList(basename($testFile));
    if (is_array($expectedErrors) === false) {
      throw new PHP_CodeSniffer_Exception('getErrorList() must return an array');
    }
    if (is_array($expectedWarnings) === false) {
      throw new PHP_CodeSniffer_Exception('getWarningList() must return an array');
    }

    /*
     We merge errors and warnings together to make it easier
     to iterate over them and produce the errors string. In this way,
     we can report on errors and warnings in the same line even though
     it's not really structured to allow that.
    */
    $allProblems = array();
    $failureMessages = array();
    foreach ($foundErrors as $line => $lineErrors) {
      foreach ($lineErrors as $column => $errors) {
        if (isset($allProblems[$line]) === false) {
          $allProblems[$line] = array(
            'expected_errors' => 0,
            'expected_warnings' => 0,
            'found_errors' => array(),
            'found_warnings' => array(),
          );
        }
        $foundErrorsTemp = array();
        foreach ($allProblems[$line]['found_errors'] as $foundError) {
          $foundErrorsTemp[] = $foundError;
        }
        $errorsTemp = array();
        foreach ($errors as $foundError) {
          $errorsTemp[] = $foundError['message'];
        }
        $allProblems[$line]['found_errors'] = array_merge($foundErrorsTemp, $errorsTemp);
      }
      if (isset($expectedErrors[$line]) === true) {
        $allProblems[$line]['expected_errors'] = $expectedErrors[$line];
      }
      else {
        $allProblems[$line]['expected_errors'] = 0;
      }
      unset($expectedErrors[$line]);
    }

    //end foreach
    foreach ($expectedErrors as $line => $numErrors) {
      if (isset($allProblems[$line]) === false) {
        $allProblems[$line] = array(
          'expected_errors' => 0,
          'expected_warnings' => 0,
          'found_errors' => array(),
          'found_warnings' => array(),
        );
      }
      $allProblems[$line]['expected_errors'] = $numErrors;
    }
    foreach ($foundWarnings as $line => $lineWarnings) {
      foreach ($lineWarnings as $column => $warnings) {
        if (isset($allProblems[$line]) === false) {
          $allProblems[$line] = array(
            'expected_errors' => 0,
            'expected_warnings' => 0,
            'found_errors' => array(),
            'found_warnings' => array(),
          );
        }
        $foundWarningsTemp = array();
        foreach ($allProblems[$line]['found_warnings'] as $foundWarning) {
          $foundWarningsTemp[] = $foundWarning;
        }
        $warningsTemp = array();
        foreach ($warnings as $warning) {
          $warningsTemp[] = $warning['message'];
        }
        $allProblems[$line]['found_warnings'] = array_merge($foundWarningsTemp, $warningsTemp);
      }
      if (isset($expectedWarnings[$line]) === true) {
        $allProblems[$line]['expected_warnings'] = $expectedWarnings[$line];
      }
      else {
        $allProblems[$line]['expected_warnings'] = 0;
      }
      unset($expectedWarnings[$line]);
    }

    //end foreach
    foreach ($expectedWarnings as $line => $numWarnings) {
      if (isset($allProblems[$line]) === false) {
        $allProblems[$line] = array(
          'expected_errors' => 0,
          'expected_warnings' => 0,
          'found_errors' => array(),
          'found_warnings' => array(),
        );
      }
      $allProblems[$line]['expected_warnings'] = $numWarnings;
    }

    // Order the messages by line number.
    ksort($allProblems);
    foreach ($allProblems as $line => $problems) {
      $numErrors = count($problems['found_errors']);
      $numWarnings = count($problems['found_warnings']);
      $expectedErrors = $problems['expected_errors'];
      $expectedWarnings = $problems['expected_warnings'];

      // Uncomment the following generate line error pairs for the bad unit
      // test.

      /*if ($numErrors) {
            print "$line => " . $numErrors . ",\n";
        }
        if ($numWarnings) {
            print "$line => " . $numWarnings . ",\n";
        }*/
      $errors = '';
      $foundString = '';
      if ($expectedErrors !== $numErrors || $expectedWarnings !== $numWarnings) {
        $lineMessage = "[LINE {$line}]";
        $expectedMessage = 'Expected ';
        $foundMessage = 'in ' . basename($testFile) . ' but found ';
        if ($expectedErrors !== $numErrors) {
          $expectedMessage .= "{$expectedErrors} error(s)";
          $foundMessage .= "{$numErrors} error(s)";
          if ($numErrors !== 0) {
            $foundString .= 'error(s)';
            $errors .= implode(PHP_EOL . ' -> ', $problems['found_errors']);
          }
          if ($expectedWarnings !== $numWarnings) {
            $expectedMessage .= ' and ';
            $foundMessage .= ' and ';
            if ($numWarnings !== 0) {
              if ($foundString !== '') {
                $foundString .= ' and ';
              }
            }
          }
        }
        if ($expectedWarnings !== $numWarnings) {
          $expectedMessage .= "{$expectedWarnings} warning(s)";
          $foundMessage .= "{$numWarnings} warning(s)";
          if ($numWarnings !== 0) {
            $foundString .= 'warning(s)';
            if (empty($errors) === false) {
              $errors .= PHP_EOL . ' -> ';
            }
            $errors .= implode(PHP_EOL . ' -> ', $problems['found_warnings']);
          }
        }
        $fullMessage = "{$lineMessage} {$expectedMessage} {$foundMessage}.";
        if ($errors !== '') {
          $fullMessage .= " The {$foundString} found were:" . PHP_EOL . " -> {$errors}";
        }
        $failureMessages[] = $fullMessage;
      }

      //end if
    }

    //end foreach
    return $failureMessages;
  }

  //end generateFailureMessages()

  /**
   * Returns the lines where errors should occur.
   *
   * The key of the array should represent the line number and the value
   * should represent the number of errors that should occur on that line.
   *
   * @return array(int => int)
   */
  protected abstract function getErrorList($testFile);

  /**
   * Returns the lines where warnings should occur.
   *
   * The key of the array should represent the line number and the value
   * should represent the number of warnings that should occur on that line.
   *
   * @return array(int => int)
   */
  protected abstract function getWarningList($testFile);

}

Members

Name	Modifiers	Type	Description	Overrides
CoderSniffUnitTest::$phpcs	protected static	property	The PHP_CodeSniffer object used for testing.
CoderSniffUnitTest::generateFailureMessages	public	function	Generate a list of test failures for a given sniffed file.
CoderSniffUnitTest::getErrorList	abstract protected	function	Returns the lines where errors should occur.	3
CoderSniffUnitTest::getSniffCodes	protected	function	Returns a list of sniff codes that should be checked in this test.	2
CoderSniffUnitTest::getTestFiles	protected	function	Returns a list of test files that should be checked.	2
CoderSniffUnitTest::getWarningList	abstract protected	function	Returns the lines where warnings should occur.	3
CoderSniffUnitTest::setUp	protected	function	Sets up this unit test.
CoderSniffUnitTest::shouldSkipTest	protected	function	Should this test be skipped for some reason.
CoderSniffUnitTest::testSniff	final public	function	Tests the extending classes Sniff class.