You are here

Home » API reference » Drupal 7 to 8/9 Module Upgrader 8 » UnitTests.php

class UnitTests in Drupal 7 to 8/9 Module Upgrader 8

Plugin annotation


@Converter(
 id = "unit_tests",
 description = @Translation("Modifies unit test classes.")
)

Hierarchy

Expanded class hierarchy of UnitTests

File

src/Plugin/DMU/Converter/UnitTests.php, line 17

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Converter
View source 
class UnitTests extends ConverterBase {

  /**
   * {@inheritdoc}
   */
  public function isExecutable(TargetInterface $target) {
    return $target
      ->getIndexer('class')
      ->getQuery()
      ->condition('parent', 'DrupalUnitTestCase')
      ->countQuery()
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function convert(TargetInterface $target) {
    $unit_tests = [];
    $test_files = $target
      ->getIndexer('class')
      ->getQuery([
      'file',
    ])
      ->condition('parent', 'DrupalUnitTestCase')
      ->execute()
      ->fetchCol();
    foreach ($test_files as $test_file) {

      /** @var \Pharborist\Objects\Classnode[] $tests */
      $tests = $target
        ->open($test_file)
        ->find(Filter::isInstanceOf('\\Pharborist\\Objects\\SingleInheritanceNode'))
        ->toArray();
      foreach ($tests as $test) {
        if ((string) $test
          ->getExtends() === 'DrupalUnitTestCase') {
          $unit_tests[] = $test;
        }
      }
    }

    /** @var \Pharborist\Objects\ClassNode $unit_test */
    foreach ($unit_tests as $unit_test) {
      $unit_test
        ->setExtends('\\Drupal\\Tests\\UnitTestCase');
      $comment_text = <<<END
@FIXME
Unit tests are now written for the PHPUnit framework. You will need to refactor
this test in order for it to work properly.
END;
      $comment = DocCommentNode::create($comment_text);
      $unit_test
        ->setDocComment($comment);
      $ns = 'Drupal\\Tests\\' . $target
        ->id() . '\\Unit';
      $doc = RootNode::create($ns)
        ->getNamespace($ns)
        ->append($unit_test
        ->remove());
      WhitespaceNode::create("\n\n")
        ->insertBefore($unit_test);
      $this
        ->write($target, 'tests/src/Unit/' . $unit_test
        ->getName() . '.php', "<?php\n\n{$doc}");
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConverterBase::buildFixMe protected function Builds a FIXME notice using either the text in the plugin definition, or passed-in text.
ConverterBase::DOC_COMMENT constant
ConverterBase::executeHook protected function Executes the target module's implementation of the specified hook, and returns the result.
ConverterBase::implement protected function Creates an empty implementation of a hook.
ConverterBase::LINE_COMMENT constant
ConverterBase::parse protected function Parses a generated class into a syntax tree.
ConverterBase::rewriteFunction protected function Parametrically rewrites a function.
ConverterBase::write public function Writes a file to the target module's directory.
ConverterBase::writeClass public function Writes a class to the target module's PSR-4 root.
ConverterBase::writeInfo protected function Writes out arbitrary data in YAML format.
ConverterBase::writeService protected function Writes a service definition to the target module's services.yml file.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$log protected property
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 11
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UnitTests::convert public function Performs required conversions. Overrides ConverterInterface::convert
UnitTests::isExecutable public function Returns if this conversion applies to the target module. If FALSE, the convert() method will not be called. Overrides ConverterBase::isExecutable