abstract class TestBase in Drupal 7 to 8/9 Module Upgrader 8

Base class for all DMU tests, providing a useful environment:

• A module called foo, mocked in memory using vfsStream. The actual module files are empty and should be filled in by subclasses.
• A TargetInterface instance for the foo module.
• A Drupal database connection to an empty in-memory SQLite database.
• A container with mocked string_translation and logger.factory services.

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\drupalmoduleupgrader\Unit\TestBase uses ContainerMockTrait, ModuleMockerTrait, SQLiteDatabaseTrait, PhpunitCompatibilityTrait

15 files declare their use of TestBase

AnalyzerTestBase.php in tests/src/Unit/Plugin/DMU/Analyzer/AnalyzerTestBase.php

CreateClassTest.php in tests/src/Unit/Plugin/DMU/Fixer/CreateClassTest.php

DefineTest.php in tests/src/Unit/Plugin/DMU/Fixer/DefineTest.php

DeleteTest.php in tests/src/Unit/Plugin/DMU/Fixer/DeleteTest.php

DisableTest.php in tests/src/Unit/Plugin/DMU/Fixer/DisableTest.php

... See full list

File

tests/src/Unit/TestBase.php, line 18

Namespace

Drupal\Tests\drupalmoduleupgrader\Unit

abstract class TestBase extends UnitTestCase {
  use ContainerMockTrait;
  use SQLiteDatabaseTrait;
  use ModuleMockerTrait;
  use PhpunitCompatibilityTrait;

  /**
   * The parsed annotations for the test class and method being executed.
   *
   * @var array
   */
  protected $info;

  /**
   * @var \org\bovigo\vfs\vfsStreamDirectory
   */
  protected $dir;

  /**
   * @var \Drupal\drupalmoduleupgrader\TargetInterface
   */
  protected $target;

  /**
   * Mocks an entire module, called foo, in a virtual file system.
   */
  public function setUp() {
    $this->info = $this
      ->getAnnotations();
    $this->dir = $this
      ->mockModule('foo');
    $this
      ->mockContainer();
    $this
      ->mockTranslator();
    $this
      ->mockLogger();
    $this
      ->initDB();

    // At the time of this writing, Target will pull the indexer manager out
    // of the container right away, so let's mock it.
    $indexers = $this
      ->createMock('\\Drupal\\Component\\Plugin\\PluginManagerInterface');
    $this->container
      ->set('plugin.manager.drupalmoduleupgrader.indexer', $indexers);
    $this->target = new Target($this->dir
      ->url(), $this->container);
  }

  /**
   * Instantiates the plugin class covered by this test (as indicated by the
   * @covers annotation). The plugin instance is given a randomly generated
   * ID and description. Dependencies will be pulled from $this->container,
   * so this should only be called once the mock container is ready.
   *
   * @param array $configuration
   *   Additional configuration to pass to the instance.
   * @param array $plugin_definition
   *   Additional definition info to pass to the instance.
   *
   * @return object
   *   A plugin instance.
   */
  protected function getPlugin(array $configuration = [], $plugin_definition = []) {
    $plugin_definition['description'] = $this
      ->getRandomGenerator()
      ->sentences(4);
    $class = $this->info['class']['covers'][0];
    return $class::create($this->container, $configuration, $this
      ->randomMachineName(), $plugin_definition);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerMockTrait::$container	protected	property
ContainerMockTrait::mockContainer	protected	function
ContainerMockTrait::mockLogger	protected	function
ContainerMockTrait::mockTranslator	protected	function
ModuleMockerTrait::mockModule	protected	function
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
SQLiteDatabaseTrait::$db	protected	property
SQLiteDatabaseTrait::initDB	protected	function
TestBase::$dir	protected	property
TestBase::$info	protected	property	The parsed annotations for the test class and method being executed.
TestBase::$target	protected	property
TestBase::getPlugin	protected	function	Instantiates the plugin class covered by this test (as indicated by the @covers annotation). The plugin instance is given a randomly generated ID and description. Dependencies will be pulled from $this->container, so this should only be called once…	1
TestBase::setUp	public	function	Mocks an entire module, called foo, in a virtual file system. Overrides UnitTestCase::setUp	17
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.