class GoodUnitTest in Coder 8.3.x

Unit test class for all good files that must not throw errors/warnings.

Hierarchy

• class \Drupal\Test\CoderSniffUnitTest extends \Drupal\Test\PhpunitCompatibilityTestCase
  • class \DrupalPractice\Test\good\GoodUnitTest

File

tests/DrupalPractice/good/GoodUnitTest.php, line 13

Namespace

DrupalPractice\Test\good

class GoodUnitTest extends CoderSniffUnitTest {

  /**
   * 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.
   *
   * @param string $testFile The name of the file being tested.
   *
   * @return array<int, int>
   */
  protected function getErrorList(string $testFile) : array {
    return [];
  }

  //end getErrorList()

  /**
   * 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.
   *
   * @param string $testFile The name of the file being tested.
   *
   * @return array<int, int>
   */
  protected function getWarningList(string $testFile) : array {
    return [];
  }

  //end getWarningList()

  /**
   * Returns a list of test files that should be checked.
   *
   * @param string $testFileBase The base path that the unit tests files will have.
   *
   * @return array<string>
   */
  protected function getTestFiles($testFileBase) : array {
    return [
      __DIR__ . '/good.php',
    ];
  }

  //end getTestFiles()

  /**
   * False if just the current sniff should be checked, true if all sniffs should be checked.
   *
   * @return bool
   */
  protected function checkAllSniffCodes() {

    // We want to test all sniffs defined in the standard.
    return true;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CoderSniffUnitTest::$backupGlobals	protected	property	Enable or disable the backup and restoration of the $GLOBALS array. Overwrite this attribute in a child class of TestCase. Setting this attribute in setUp() has no effect!
CoderSniffUnitTest::$rootDir	private	property	The path to the root folder of Coder.
CoderSniffUnitTest::$standardsDir	public	property	The path to the standard's main directory.
CoderSniffUnitTest::$testsDir	public	property	The path to the standard's test directory.
CoderSniffUnitTest::compatibleSetUp	protected	function	Sets up this unit test.
CoderSniffUnitTest::generateFailureMessages	public	function	Generate a list of test failures for a given sniffed file.
CoderSniffUnitTest::setCliValues	public	function	Set a list of CLI values before the file is tested.
CoderSniffUnitTest::shouldSkipTest	protected	function	Should this test be skipped for some reason.
CoderSniffUnitTest::testSniff	final public	function	Tests the extending classes Sniff class.
GoodUnitTest::checkAllSniffCodes	protected	function	False if just the current sniff should be checked, true if all sniffs should be checked. Overrides CoderSniffUnitTest::checkAllSniffCodes
GoodUnitTest::getErrorList	protected	function	Returns the lines where errors should occur. Overrides CoderSniffUnitTest::getErrorList
GoodUnitTest::getTestFiles	protected	function	Returns a list of test files that should be checked. Overrides CoderSniffUnitTest::getTestFiles
GoodUnitTest::getWarningList	protected	function	Returns the lines where warnings should occur. Overrides CoderSniffUnitTest::getWarningList