You are here

Home » API reference » Zircon Profile 8 » BlockViewBuilderTest.php

class BlockViewBuilderTest in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/block/src/Tests/BlockViewBuilderTest.php \Drupal\block\Tests\BlockViewBuilderTest

Tests the block view builder.

@group block

Hierarchy

Expanded class hierarchy of BlockViewBuilderTest

File

core/modules/block/src/Tests/BlockViewBuilderTest.php, line 21
Contains \Drupal\block\Tests\BlockViewBuilderTest.

Namespace

Drupal\block\Tests
View source 
class BlockViewBuilderTest extends KernelTestBase {

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = array(
    'block',
    'block_test',
    'system',
    'user',
  );

  /**
   * The block being tested.
   *
   * @var \Drupal\block\Entity\BlockInterface
   */
  protected $block;

  /**
   * The block storage.
   *
   * @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
   */
  protected $controller;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->controller = $this->container
      ->get('entity.manager')
      ->getStorage('block');
    \Drupal::state()
      ->set('block_test.content', 'Llamas > unicorns!');

    // Create a block with only required values.
    $this->block = $this->controller
      ->create(array(
      'id' => 'test_block',
      'theme' => 'stark',
      'plugin' => 'test_cache',
    ));
    $this->block
      ->save();
    $this->container
      ->get('cache.render')
      ->deleteAll();
    $this->renderer = $this->container
      ->get('renderer');
  }

  /**
   * Tests the rendering of blocks.
   */
  public function testBasicRendering() {
    \Drupal::state()
      ->set('block_test.content', '');
    $entity = $this->controller
      ->create(array(
      'id' => 'test_block1',
      'theme' => 'stark',
      'plugin' => 'test_html',
    ));
    $entity
      ->save();

    // Test the rendering of a block.
    $entity = Block::load('test_block1');
    $output = entity_view($entity, 'block');
    $expected = array();
    $expected[] = '<div id="block-test-block1">';
    $expected[] = '  ';
    $expected[] = '    ';
    $expected[] = '      ';
    $expected[] = '  </div>';
    $expected[] = '';
    $expected_output = implode("\n", $expected);
    $this
      ->assertEqual($this->renderer
      ->renderRoot($output), $expected_output);

    // Reset the HTML IDs so that the next render is not affected.
    Html::resetSeenIds();

    // Test the rendering of a block with a given title.
    $entity = $this->controller
      ->create(array(
      'id' => 'test_block2',
      'theme' => 'stark',
      'plugin' => 'test_html',
      'settings' => array(
        'label' => 'Powered by Bananas',
      ),
    ));
    $entity
      ->save();
    $output = entity_view($entity, 'block');
    $expected = array();
    $expected[] = '<div id="block-test-block2">';
    $expected[] = '  ';
    $expected[] = '      <h2>Powered by Bananas</h2>';
    $expected[] = '    ';
    $expected[] = '      ';
    $expected[] = '  </div>';
    $expected[] = '';
    $expected_output = implode("\n", $expected);
    $this
      ->assertEqual($this->renderer
      ->renderRoot($output), $expected_output);
  }

  /**
   * Tests block render cache handling.
   */
  public function testBlockViewBuilderCache() {

    // Verify cache handling for a non-empty block.
    $this
      ->verifyRenderCacheHandling();

    // Create an empty block.
    $this->block = $this->controller
      ->create(array(
      'id' => 'test_block',
      'theme' => 'stark',
      'plugin' => 'test_cache',
    ));
    $this->block
      ->save();
    \Drupal::state()
      ->set('block_test.content', NULL);

    // Verify cache handling for an empty block.
    $this
      ->verifyRenderCacheHandling();
  }

  /**
   * Verifies render cache handling of the block being tested.
   *
   * @see ::testBlockViewBuilderCache()
   */
  protected function verifyRenderCacheHandling() {

    // Force a request via GET so we can test the render cache.
    $request = \Drupal::request();
    $request_method = $request->server
      ->get('REQUEST_METHOD');
    $request
      ->setMethod('GET');

    // Test that a cache entry is created.
    $build = $this
      ->getBlockRenderArray();
    $cid = 'entity_view:block:test_block:' . implode(':', \Drupal::service('cache_contexts_manager')
      ->convertTokensToKeys([
      'languages:' . LanguageInterface::TYPE_INTERFACE,
      'theme',
      'user.permissions',
    ])
      ->getKeys());
    $this->renderer
      ->renderRoot($build);
    $this
      ->assertTrue($this->container
      ->get('cache.render')
      ->get($cid), 'The block render element has been cached.');

    // Re-save the block and check that the cache entry has been deleted.
    $this->block
      ->save();
    $this
      ->assertFalse($this->container
      ->get('cache.render')
      ->get($cid), 'The block render cache entry has been cleared when the block was saved.');

    // Rebuild the render array (creating a new cache entry in the process) and
    // delete the block to check the cache entry is deleted.
    unset($build['#printed']);

    // Re-add the block because \Drupal\block\BlockViewBuilder::buildBlock()
    // removes it.
    $build['#block'] = $this->block;
    $this->renderer
      ->renderRoot($build);
    $this
      ->assertTrue($this->container
      ->get('cache.render')
      ->get($cid), 'The block render element has been cached.');
    $this->block
      ->delete();
    $this
      ->assertFalse($this->container
      ->get('cache.render')
      ->get($cid), 'The block render cache entry has been cleared when the block was deleted.');

    // Restore the previous request method.
    $request
      ->setMethod($request_method);
  }

  /**
   * Tests block view altering.
   *
   * @see hook_block_view_alter()
   * @see hook_block_view_BASE_BLOCK_ID_alter()
   */
  public function testBlockViewBuilderViewAlter() {

    // Establish baseline.
    $build = $this
      ->getBlockRenderArray();
    $this
      ->setRawContent((string) $this->renderer
      ->renderRoot($build));
    $this
      ->assertIdentical(trim((string) $this
      ->cssSelect('div')[0]), 'Llamas > unicorns!');

    // Enable the block view alter hook that adds a foo=bar attribute.
    \Drupal::state()
      ->set('block_test_view_alter_suffix', TRUE);
    Cache::invalidateTags($this->block
      ->getCacheTagsToInvalidate());
    $build = $this
      ->getBlockRenderArray();
    $this
      ->setRawContent((string) $this->renderer
      ->renderRoot($build));
    $this
      ->assertIdentical(trim((string) $this
      ->cssSelect('[foo=bar]')[0]), 'Llamas > unicorns!');
    \Drupal::state()
      ->set('block_test_view_alter_suffix', FALSE);
    \Drupal::state()
      ->set('block_test.content', NULL);
    Cache::invalidateTags($this->block
      ->getCacheTagsToInvalidate());

    // Advanced: cached block, but an alter hook adds a #pre_render callback to
    // alter the eventual content.
    \Drupal::state()
      ->set('block_test_view_alter_append_pre_render_prefix', TRUE);
    $build = $this
      ->getBlockRenderArray();
    $this
      ->assertFalse(isset($build['#prefix']), 'The appended #pre_render callback has not yet run before rendering.');
    $this
      ->assertIdentical((string) $this->renderer
      ->renderRoot($build), 'Hiya!<br>');
    $this
      ->assertTrue(isset($build['#prefix']) && $build['#prefix'] === 'Hiya!<br>', 'A cached block without content is altered.');
  }

  /**
   * Tests block build altering.
   *
   * @see hook_block_build_alter()
   * @see hook_block_build_BASE_BLOCK_ID_alter()
   */
  public function testBlockViewBuilderBuildAlter() {

    // Force a request via GET so we can test the render cache.
    $request = \Drupal::request();
    $request_method = $request->server
      ->get('REQUEST_METHOD');
    $request
      ->setMethod('GET');
    $default_keys = [
      'entity_view',
      'block',
      'test_block',
    ];
    $default_contexts = [];
    $default_tags = [
      'block_view',
      'config:block.block.test_block',
    ];
    $default_max_age = Cache::PERMANENT;

    // hook_block_build_alter() adds an additional cache key.
    $alter_add_key = $this
      ->randomMachineName();
    \Drupal::state()
      ->set('block_test_block_alter_cache_key', $alter_add_key);
    $this
      ->assertBlockRenderedWithExpectedCacheability(array_merge($default_keys, [
      $alter_add_key,
    ]), $default_contexts, $default_tags, $default_max_age);
    \Drupal::state()
      ->set('block_test_block_alter_cache_key', NULL);

    // hook_block_build_alter() adds an additional cache context.
    $alter_add_context = 'url.query_args:' . $this
      ->randomMachineName();
    \Drupal::state()
      ->set('block_test_block_alter_cache_context', $alter_add_context);
    $this
      ->assertBlockRenderedWithExpectedCacheability($default_keys, Cache::mergeContexts($default_contexts, [
      $alter_add_context,
    ]), $default_tags, $default_max_age);
    \Drupal::state()
      ->set('block_test_block_alter_cache_context', NULL);

    // hook_block_build_alter() adds an additional cache tag.
    $alter_add_tag = $this
      ->randomMachineName();
    \Drupal::state()
      ->set('block_test_block_alter_cache_tag', $alter_add_tag);
    $this
      ->assertBlockRenderedWithExpectedCacheability($default_keys, $default_contexts, Cache::mergeTags($default_tags, [
      $alter_add_tag,
    ]), $default_max_age);
    \Drupal::state()
      ->set('block_test_block_alter_cache_tag', NULL);

    // hook_block_build_alter() alters the max-age.
    $alter_max_age = 300;
    \Drupal::state()
      ->set('block_test_block_alter_cache_max_age', $alter_max_age);
    $this
      ->assertBlockRenderedWithExpectedCacheability($default_keys, $default_contexts, $default_tags, $alter_max_age);
    \Drupal::state()
      ->set('block_test_block_alter_cache_max_age', NULL);

    // hook_block_build_alter() alters cache keys, contexts, tags and max-age.
    \Drupal::state()
      ->set('block_test_block_alter_cache_key', $alter_add_key);
    \Drupal::state()
      ->set('block_test_block_alter_cache_context', $alter_add_context);
    \Drupal::state()
      ->set('block_test_block_alter_cache_tag', $alter_add_tag);
    \Drupal::state()
      ->set('block_test_block_alter_cache_max_age', $alter_max_age);
    $this
      ->assertBlockRenderedWithExpectedCacheability(array_merge($default_keys, [
      $alter_add_key,
    ]), Cache::mergeContexts($default_contexts, [
      $alter_add_context,
    ]), Cache::mergeTags($default_tags, [
      $alter_add_tag,
    ]), $alter_max_age);
    \Drupal::state()
      ->set('block_test_block_alter_cache_key', NULL);
    \Drupal::state()
      ->set('block_test_block_alter_cache_context', NULL);
    \Drupal::state()
      ->set('block_test_block_alter_cache_tag', NULL);
    \Drupal::state()
      ->set('block_test_block_alter_cache_max_age', NULL);

    // hook_block_build_alter() sets #create_placeholder.
    foreach ([
      TRUE,
      FALSE,
    ] as $value) {
      \Drupal::state()
        ->set('block_test_block_alter_create_placeholder', $value);
      $build = $this
        ->getBlockRenderArray();
      $this
        ->assertTrue(isset($build['#create_placeholder']));
      $this
        ->assertIdentical($value, $build['#create_placeholder']);
    }
    \Drupal::state()
      ->set('block_test_block_alter_create_placeholder', NULL);

    // Restore the previous request method.
    $request
      ->setMethod($request_method);
  }

  /**
   * Asserts that a block is built/rendered/cached with expected cacheability.
   *
   * @param string[] $expected_keys
   *   The expected cache keys.
   * @param string[] $expected_contexts
   *   The expected cache contexts.
   * @param string[] $expected_tags
   *   The expected cache tags.
   * @param int $expected_max_age
   *   The expected max-age.
   */
  protected function assertBlockRenderedWithExpectedCacheability(array $expected_keys, array $expected_contexts, array $expected_tags, $expected_max_age) {
    $required_cache_contexts = [
      'languages:' . LanguageInterface::TYPE_INTERFACE,
      'theme',
      'user.permissions',
    ];

    // Check that the expected cacheability metadata is present in:
    // - the built render array;
    $this
      ->pass('Built render array');
    $build = $this
      ->getBlockRenderArray();
    $this
      ->assertIdentical($expected_keys, $build['#cache']['keys']);
    $this
      ->assertIdentical($expected_contexts, $build['#cache']['contexts']);
    $this
      ->assertIdentical($expected_tags, $build['#cache']['tags']);
    $this
      ->assertIdentical($expected_max_age, $build['#cache']['max-age']);
    $this
      ->assertFalse(isset($build['#create_placeholder']));

    // - the rendered render array;
    $this
      ->pass('Rendered render array');
    $this->renderer
      ->renderRoot($build);

    // - the render cache item.
    $this
      ->pass('Render cache item');
    $final_cache_contexts = Cache::mergeContexts($expected_contexts, $required_cache_contexts);
    $cid = implode(':', $expected_keys) . ':' . implode(':', \Drupal::service('cache_contexts_manager')
      ->convertTokensToKeys($final_cache_contexts)
      ->getKeys());
    $cache_item = $this->container
      ->get('cache.render')
      ->get($cid);
    $this
      ->assertTrue($cache_item, 'The block render element has been cached with the expected cache ID.');
    $this
      ->assertIdentical(Cache::mergeTags($expected_tags, [
      'rendered',
    ]), $cache_item->tags);
    $this
      ->assertIdentical($final_cache_contexts, $cache_item->data['#cache']['contexts']);
    $this
      ->assertIdentical($expected_tags, $cache_item->data['#cache']['tags']);
    $this
      ->assertIdentical($expected_max_age, $cache_item->data['#cache']['max-age']);
    $this->container
      ->get('cache.render')
      ->delete($cid);
  }

  /**
   * Get a fully built render array for a block.
   *
   * @return array
   *   The render array.
   */
  protected function getBlockRenderArray() {
    return $this->container
      ->get('entity.manager')
      ->getViewBuilder('block')
      ->view($this->block, 'block');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 2
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected function Casts MarkupInterface objects into strings.
BlockViewBuilderTest::$block protected property The block being tested.
BlockViewBuilderTest::$controller protected property The block storage.
BlockViewBuilderTest::$modules public static property Modules to install. Overrides KernelTestBase::$modules
BlockViewBuilderTest::$renderer protected property The renderer.
BlockViewBuilderTest::assertBlockRenderedWithExpectedCacheability protected function Asserts that a block is built/rendered/cached with expected cacheability.
BlockViewBuilderTest::getBlockRenderArray protected function Get a fully built render array for a block.
BlockViewBuilderTest::setUp protected function Performs setup tasks before each individual test method is run. Overrides KernelTestBase::setUp
BlockViewBuilderTest::testBasicRendering public function Tests the rendering of blocks.
BlockViewBuilderTest::testBlockViewBuilderBuildAlter public function Tests block build altering.
BlockViewBuilderTest::testBlockViewBuilderCache public function Tests block render cache handling.
BlockViewBuilderTest::testBlockViewBuilderViewAlter public function Tests block view altering.
BlockViewBuilderTest::verifyRenderCacheHandling protected function Verifies render cache handling of the block being tested.
KernelTestBase::$configDirectories protected property The configuration directories for this test run.
KernelTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles private property
KernelTestBase::$streamWrappers protected property Array of registered stream wrappers.
KernelTestBase::$themeFiles private property
KernelTestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::containerBuild public function Sets up the base service container for this test. 12
KernelTestBase::defaultLanguageData protected function Provides the data for setting the default language on the container. 1
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
KernelTestBase::registerStreamWrapper protected function Registers a stream wrapper for this test.
KernelTestBase::render protected function Renders a render array.
KernelTestBase::tearDown protected function Performs cleanup tasks after each individual test method has been run. Overrides TestBase::tearDown
KernelTestBase::__construct function Constructor for Test. Overrides TestBase::__construct
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$kernel protected property The DrupalKernel instance used in the test. 1
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks. 1
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$originalUser protected property The original user, before testing began. 1
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
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::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.