class PluginInstanceTest

Checks general plugin data and instances for all plugin types.

Hierarchy

Expanded class hierarchy of PluginInstanceTest

File

drupal/core/modules/views/lib/Drupal/views/Tests/PluginInstanceTest.php, line 13
Definition of Drupal\views\Tests\PluginInstanceTest.

Namespace

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

  /**
   * All views plugin types.
   *
   * @var array
   */
  protected $pluginTypes = array(
    'access',
    'area',
    'argument',
    'argument_default',
    'argument_validator',
    'cache',
    'display_extender',
    'display',
    'exposed_form',
    'field',
    'filter',
    'join',
    'pager',
    'query',
    'relationship',
    'row',
    'sort',
    'style',
    'wizard',
  );

  /**
   * An array of plugin definitions, keyed by plugin type.
   *
   * @var array
   */
  protected $definitions;
  public static function getInfo() {
    return array(
      'name' => 'Plugin instantiation',
      'description' => 'Tests that an instance of all views plugins can be created.',
      'group' => 'Views',
    );
  }
  protected function setUp() {
    parent::setUp();
    $this->definitions = views_get_plugin_definitions();
  }

  /**
   * Confirms that there is plugin data for all views plugin types.
   */
  public function testPluginData() {

    // Check that we have an array of data.
    $this
      ->assertTrue(is_array($this->definitions), 'Plugin data is an array.');

    // Check all plugin types.
    foreach ($this->pluginTypes as $type) {
      $this
        ->assertTrue(array_key_exists($type, $this->definitions), format_string('Key for plugin type @type found.', array(
        '@type' => $type,
      )));
      $this
        ->assertTrue(is_array($this->definitions[$type]) && !empty($this->definitions[$type]), format_string('Plugin type @type has an array of plugins.', array(
        '@type' => $type,
      )));
    }

    // Tests that the plugin list has not missed any types.
    $diff = array_diff(array_keys($this->definitions), $this->pluginTypes);
    $this
      ->assertTrue(empty($diff), 'All plugins were found and matched.');
  }

  /**
   * Tests creating instances of every views plugin.
   *
   * This will iterate through all plugins from _views_fetch_plugin_data().
   */
  public function testPluginInstances() {
    $container = drupal_container();
    foreach ($this->definitions as $type => $plugins) {

      // Get a plugin manager for this type.
      $manager = $container
        ->get("plugin.manager.views.{$type}");
      foreach ($plugins as $id => $definition) {

        // Get a reflection class for this plugin.
        // We only want to test true plugins, i.e. They extend PluginBase.
        $reflection = new \ReflectionClass($definition['class']);
        if ($reflection
          ->isSubclassOf('Drupal\\views\\Plugin\\views\\PluginBase')) {

          // Create a plugin instance and check what it is. This is not just
          // good to check they can be created but for throwing any notices for
          // method signatures etc... too.
          $instance = $manager
            ->createInstance($id);
          $this
            ->assertTrue($instance instanceof $definition['class'], format_string('Instance of @type:@id created', array(
            '@type' => $type,
            '@id' => $id,
          )));
        }
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalUnitTestBase::$moduleFiles private property
DrupalUnitTestBase::$moduleList private property Fixed module list being used by this test.
DrupalUnitTestBase::$modules public static property Modules to enable. 6
DrupalUnitTestBase::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::containerBuild public function Sets up the base service container for this test.
DrupalUnitTestBase::enableModules protected function Enables modules for this test.
DrupalUnitTestBase::installSchema protected function Installs a specific table from a module schema definition.
PluginInstanceTest::$definitions protected property An array of plugin definitions, keyed by plugin type.
PluginInstanceTest::$pluginTypes protected property All views plugin types.
PluginInstanceTest::getInfo public static function
PluginInstanceTest::setUp protected function Sets up Drupal unit test environment. Overrides ViewUnitTestBase::setUp
PluginInstanceTest::testPluginData public function Confirms that there is plugin data for all views plugin types.
PluginInstanceTest::testPluginInstances public function Tests creating instances of every views plugin.
TestBase::$assertions protected property Assertions thrown in that test case.
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::$originalPrefix protected property The original database prefix when running inside Simpletest.
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. 3
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::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().
TestBase::run public function Run all tests in this class.
TestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. 10
TestBase::verbose protected function Logs verbose message in a text file.
UnitTestBase::$configDirectories protected property
UnitTestBase::__construct function Constructor for UnitTestBase. Overrides TestBase::__construct 6
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. 6
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::viewsData protected function Returns the views data definition. 17