class ViewsHooksTest

Tests that views hooks are registered when defined in $module.views.inc.

Hierarchy

Expanded class hierarchy of ViewsHooksTest

See also

views_hook_info().

field_hook_info().

File

drupal/core/modules/views/lib/Drupal/views/Tests/ViewsHooksTest.php, line 16
Contains \Drupal\views\Tests\ViewsHooksTest.

Namespace

Drupal\views\Tests
View source
class ViewsHooksTest extends ViewUnitTestBase {

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = array(
    'test_view',
  );

  /**
   * An array of available views hooks to test.
   *
   * @var array
   */
  protected static $hooks = array(
    'views_data' => 'all',
    'views_data_alter' => 'alter',
    'views_query_substitutions' => 'view',
    'views_form_substitutions' => 'view',
    'views_analyze' => 'view',
    'views_pre_view' => 'view',
    'views_pre_build' => 'view',
    'views_post_build' => 'view',
    'views_pre_execute' => 'view',
    'views_post_execute' => 'view',
    'views_pre_render' => 'view',
    'views_post_render' => 'view',
    'views_query_alter' => 'view',
    'views_invalidate_cache' => 'all',
  );

  /**
   * The module handler to use for invoking hooks.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;
  public static function getInfo() {
    return array(
      'name' => 'Views hooks',
      'description' => 'Tests that views hooks are registered when defined in $module.views.inc.',
      'group' => 'Views',
    );
  }
  protected function setUp() {
    parent::setUp();
    $this->moduleHandler = $this->container
      ->get('module_handler');
  }

  /**
   * Tests the hooks.
   */
  public function testHooks() {
    $view = views_get_view('test_view');

    // Test each hook is found in the implementations array and is invoked.
    foreach (static::$hooks as $hook => $type) {
      $this
        ->assertTrue($this->moduleHandler
        ->implementsHook('views_test_data', $hook), format_string('The hook @hook was registered.', array(
        '@hook' => $hook,
      )));
      switch ($type) {
        case 'view':
          $this->moduleHandler
            ->invoke('views_test_data', $hook, array(
            $view,
          ));
          break;
        case 'alter':
          $data = array();
          $this->moduleHandler
            ->invoke('views_test_data', $hook, array(
            $data,
          ));
          break;
        default:
          $this->moduleHandler
            ->invoke('views_test_data', $hook);
      }
      $this
        ->assertTrue($this->container
        ->get('state')
        ->get('views_hook_test_' . $hook), format_string('The %hook hook was invoked.', array(
        '%hook' => $hook,
      )));

      // Reset the module implementations cache, so we ensure that the
      // .views.inc file is loaded actively.
      $this->moduleHandler
        ->resetImplementations();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalUnitTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
DrupalUnitTestBase::$moduleFiles private property
DrupalUnitTestBase::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::containerBuild public function Sets up the base service container for this test. 1
DrupalUnitTestBase::disableModules protected function Disables modules for this test.
DrupalUnitTestBase::enableModules protected function Enables modules for this test.
DrupalUnitTestBase::installConfig protected function Installs default configuration for a given list of modules.
DrupalUnitTestBase::installSchema protected function Installs a specific table from a module schema definition.
DrupalUnitTestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. Overrides TestBase::tearDown 2
DrupalUnitTestBase::__construct function Overrides \Drupal\simpletest\UnitTestBase::__construct(). Overrides UnitTestBase::__construct
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 1
TestBase::$container protected property The dependency injection container used in the test. 1
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::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSettings protected property The settings array.
TestBase::$public_files_directory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$verbose protected 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::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or 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::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 (not an empty string, 0, NULL, or FALSE).
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 4
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 1
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. 1
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::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
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::prepareConfigDirectories protected function Create and set new configuration directories. 1
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::rebuildContainer protected function Rebuild drupal_container(). 1
TestBase::run public function Run all tests in this class.
TestBase::settingsSet protected function Changes in memory settings.
TestBase::verbose protected function Logs verbose message in a text file.
UnitTestBase::$configDirectories protected property
ViewsHooksTest::$hooks protected static property An array of available views hooks to test.
ViewsHooksTest::$moduleHandler protected property The module handler to use for invoking hooks.
ViewsHooksTest::$testViews public static property Views used by this test.
ViewsHooksTest::getInfo public static function
ViewsHooksTest::setUp protected function Sets up Drupal unit test environment. Overrides ViewUnitTestBase::setUp
ViewsHooksTest::testHooks public function Tests the hooks.
ViewUnitTestBase::$modules public static property Modules to enable. Overrides DrupalUnitTestBase::$modules 21
ViewUnitTestBase::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewUnitTestBase::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewUnitTestBase::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewUnitTestBase::dataSet protected function Returns a very simple test dataset. 7
ViewUnitTestBase::executeView protected function Executes a view with debugging.
ViewUnitTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewUnitTestBase::schemaDefinition protected function Returns the schema definition. 4
ViewUnitTestBase::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. 2
ViewUnitTestBase::viewsData protected function Returns the views data definition. 19