abstract class UnitTestBase

Base test case class for unit tests.

These tests can not access the database nor files. Calling any Drupal function that needs the database will throw exceptions. These include watchdog(), module_implements(), module_invoke_all() etc.

Hierarchy

Expanded class hierarchy of UnitTestBase

56 files declare their use of UnitTestBase
AjaxCommandsUnitTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Ajax/AjaxCommandsUnitTest.php
Definition of Drupal\system\Tests\Ajax\AjaxCommandsUnitTest.
ArrayUnitTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Common/ArrayUnitTest.php
Definition of Drupal\system\Tests\Common\ArrayUnitTest.
AttributesUnitTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Common/AttributesUnitTest.php
Definition of Drupal\system\Tests\Common\AttributesUnitTest.
AutocompleteTagsUnitTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Common/AutocompleteTagsUnitTest.php
Definition of Drupal\system\Tests\Common\AutocompleteTagsUnitTest.
BackendChainImplementationUnitTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Cache/BackendChainImplementationUnitTest.php
Definition of Drupal\system\Tests\Cache\BackendChainImplementationUnitTest.

... See full list

File

drupal/core/modules/simpletest/lib/Drupal/simpletest/UnitTestBase.php, line 20
Definition of Drupal\simpletest\UnitTestBase.

Namespace

Drupal\simpletest
View source
abstract class UnitTestBase extends TestBase {

  /**
   * @var array
   */
  protected $configDirectories;

  /**
   * Constructor for UnitTestBase.
   */
  function __construct($test_id = NULL) {
    parent::__construct($test_id);
    $this->skipClasses[__CLASS__] = TRUE;
  }

  /**
   * Sets up unit test environment.
   *
   * Unlike Drupal\simpletest\WebTestBase::setUp(), UnitTestBase::setUp() does not
   * install modules because tests are performed without accessing the database.
   * Any required files must be explicitly included by the child class setUp()
   * method.
   */
  protected function setUp() {
    global $conf;

    // Create the database prefix for this test.
    $this
      ->prepareDatabasePrefix();

    // Prepare the environment for running tests.
    $this
      ->prepareEnvironment();
    if (!$this->setupEnvironment) {
      return FALSE;
    }

    // Reset all statics and variables to perform tests in a clean environment.
    $conf = array();
    drupal_static_reset();

    // Enforce an empty module list.
    module_list(NULL, array());
    $conf['file_public_path'] = $this->public_files_directory;

    // Change the database prefix.
    // All static variables need to be reset before the database prefix is
    // changed, since Drupal\Core\Utility\CacheArray implementations attempt to
    // write back to persistent caches when they are destructed.
    $this
      ->changeDatabasePrefix();
    if (!$this->setupDatabasePrefix) {
      return FALSE;
    }

    // Set user agent to be consistent with WebTestBase.
    $_SERVER['HTTP_USER_AGENT'] = $this->databasePrefix;
    $this->setup = TRUE;
  }

}

Members

Name Modifierssort descending Type Description Overrides
UnitTestBase::__construct function Constructor for UnitTestBase. Overrides TestBase::__construct 6
UnitTestBase::setUp protected function Sets up unit test environment. 22
TestBase::checkRequirements protected function Checks the matching requirements for Test. 3
TestBase::assert protected function Internal helper: stores the assert.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
TestBase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::error protected function Fire an error assertion. 1
TestBase::verbose protected function Logs verbose message in a text file.
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::rebuildContainer protected function Rebuild drupal_container().
TestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. 10
TestBase::exceptionHandler protected function Handle exceptions.
UnitTestBase::$configDirectories protected property
TestBase::$testId protected property The test run ID.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$verbose protected property TRUE if verbose debugging is enabled.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::run public function Run all tests in this class.
TestBase::errorHandler public function Handle errors during test runs.
TestBase::$results public property Current results of this test case.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().