DrushTest.php in Migrate Tools 8.4

Namespace

Drupal\Tests\migrate_tools\Kernel

File

tests/src/Kernel/DrushTest.php

<?php

namespace Drupal\Tests\migrate_tools\Kernel;

use Drupal\migrate_tools\Commands\MigrateToolsCommands;
use Drupal\migrate_tools\MigrateTools;
use Drupal\Tests\migrate\Kernel\MigrateTestBase;
use Drupal\migrate\Plugin\MigrationInterface;

/**
 * Tests for the Drush 9 commands.
 *
 * @group migrate_tools
 */
class DrushTest extends MigrateTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'migrate_tools_test',
    'migrate_tools',
    'migrate_plus',
    'taxonomy',
    'text',
    'system',
    'user',
  ];

  /**
   * Base options array for import.
   *
   * @var array
   */
  protected $importBaseOptions = [
    'all' => NULL,
    'group' => NULL,
    'tag' => NULL,
    'limit' => NULL,
    'feedback' => NULL,
    'idlist' => NULL,
    'idlist-delimiter' => MigrateTools::DEFAULT_ID_LIST_DELIMITER,
    'update' => NULL,
    'force' => NULL,
    'execute-dependencies' => NULL,
    'skip-progress-bar' => FALSE,
    'continue-on-failure' => FALSE,
    'sync' => FALSE,
  ];

  /**
   * The Migrate Tools Command drush service.
   *
   * @var \Drupal\migrate_tools\Commands\MigrateToolsCommands
   */
  protected $commands;

  /**
   * The migration plugin manager.
   *
   * @var \Drupal\migrate\Plugin\MigrationPluginManagerInterface
   */
  protected $migrationPluginManager;

  /**
   * The logger.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installConfig('migrate_plus');
    $this
      ->installConfig('migrate_tools_test');
    $this
      ->installEntitySchema('taxonomy_term');
    $this
      ->installEntitySchema('user');
    $this
      ->installSchema('system', [
      'key_value',
      'key_value_expire',
    ]);
    $this
      ->installSchema('user', [
      'users_data',
    ]);
    $this->migrationPluginManager = $this->container
      ->get('plugin.manager.migration');
    $this->logger = $this->container
      ->get('logger.channel.migrate_tools');
    $this->commands = new MigrateToolsCommands($this->migrationPluginManager, $this->container
      ->get('date.formatter'), $this->container
      ->get('entity_type.manager'), $this->container
      ->get('keyvalue'));
    $this->commands
      ->setLogger($this->logger);
  }

  /**
   * Tests drush ms.
   */
  public function testStatus() {
    $this
      ->executeMigration('fruit_terms');

    /** @var \Consolidation\OutputFormatters\StructuredData\RowsOfFields $result */
    $result = $this->commands
      ->status('fruit_terms', [
      'group' => NULL,
      'tag' => NULL,
      'names-only' => FALSE,
    ]);
    $rows = $result
      ->getArrayCopy();
    $this
      ->assertCount(1, $rows);
    $row = reset($rows);
    $this
      ->assertSame('fruit_terms', $row['id']);
    $this
      ->assertSame(3, $row['total']);
    $this
      ->assertSame(3, $row['imported']);
    $this
      ->assertSame('Idle', $row['status']);

    // Migrate status should not display migrate_drupal migrations if no source
    // database is defined.
    \Drupal::service('module_installer')
      ->uninstall([
      'migrate_tools_test',
    ]);
    $this
      ->enableModules([
      'migrate_drupal',
    ]);
    \Drupal::configFactory()
      ->getEditable('migrate_plus.migration.fruit_terms')
      ->delete();
    $rows = $this->commands
      ->status();
    $this
      ->assertEmpty($rows);
  }

  /**
   * Tests that a failing status throws an exception (i.e. exit code).
   */
  public function testFailingStatusThrowsException() {
    $this
      ->expectException(\Exception::class);
    $this
      ->expectExceptionMessage('The "does_not_exist" plugin does not exist.');
    $this->commands
      ->status('invalid_plugin');
  }

  /**
   * Tests drush mim.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  public function testImport() {

    /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
    $migration = $this->migrationPluginManager
      ->createInstance('fruit_terms');
    $id_map = $migration
      ->getIdMap();
    $this->commands
      ->import('fruit_terms', array_merge($this->importBaseOptions, [
      'idlist' => 'Apple',
    ]));
    $this
      ->assertSame(1, $id_map
      ->importedCount());
    $this->commands
      ->import('fruit_terms', $this->importBaseOptions);
    $this
      ->assertSame(3, $id_map
      ->importedCount());
    $this->commands
      ->import('fruit_terms', array_merge($this->importBaseOptions, [
      'idlist' => 'Apple',
      'update' => TRUE,
    ]));
    $this
      ->assertCount(0, $id_map
      ->getRowsNeedingUpdate(100));
  }

  /**
   * Tests that a failing import throws an exception (i.e. exit code).
   */
  public function testFailingImportThrowsException() {
    $this
      ->expectException(\Exception::class);
    $this
      ->expectExceptionMessage('source_exception migration failed.');
    $this->commands
      ->import('source_exception', $this->importBaseOptions);
  }

  /**
   * Tests drush mmsg.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  public function testMessages() {
    $this
      ->executeMigration('fruit_terms');
    $message = $this
      ->getRandomGenerator()
      ->string(16);

    /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
    $migration = $this->migrationPluginManager
      ->createInstance('fruit_terms');
    $id_map = $migration
      ->getIdMap();
    $id_map
      ->saveMessage([
      'name' => 'Apple',
    ], $message);

    /** @var \Consolidation\OutputFormatters\StructuredData\RowsOfFields $result */
    $result = $this->commands
      ->messages('fruit_terms', [
      'csv' => FALSE,
      'idlist' => NULL,
      'idlist-delimiter' => MigrateTools::DEFAULT_ID_LIST_DELIMITER,
    ]);
    $rows = $result
      ->getArrayCopy();
    $this
      ->assertSame($message, $rows[0]['message']);
  }

  /**
   * Tests that a failing messages throws an exception (i.e. exit code).
   */
  public function testFailingMessagesThrowsException() {
    $this
      ->expectException(\Exception::class);
    $this
      ->expectExceptionMessage('Migration does_not_exist does not exist');
    $this->commands
      ->messages('does_not_exist', [
      'csv' => FALSE,
      'idlist' => NULL,
      'idlist-delimiter' => MigrateTools::DEFAULT_ID_LIST_DELIMITER,
    ]);
  }

  /**
   * Tests drush mr.
   */
  public function testRollback() {
    $this
      ->executeMigration('fruit_terms');

    /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
    $migration = $this->migrationPluginManager
      ->createInstance('fruit_terms');
    $id_map = $migration
      ->getIdMap();
    $this
      ->assertSame(3, $id_map
      ->importedCount());
    $this->commands
      ->rollback('fruit_terms', $this->importBaseOptions);
    $this
      ->assertSame(0, $id_map
      ->importedCount());
  }

  /**
   * Tests that a failing rollback throws an exception (i.e. exit code).
   */
  public function testFailingRollbackThrowsException() {
    $this
      ->expectException(\Exception::class);
    $this
      ->expectExceptionMessage('source_exception migration failed');

    /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
    $migration = $this->migrationPluginManager
      ->createInstance('source_exception');
    $migration
      ->setStatus(MigrationInterface::STATUS_IMPORTING);
    $this->commands
      ->rollback('source_exception', $this->importBaseOptions);
  }

  /**
   * Tests drush mrs.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  public function testReset() {

    /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
    $migration = $this->migrationPluginManager
      ->createInstance('fruit_terms');
    $migration
      ->setStatus(MigrationInterface::STATUS_IMPORTING);
    $status = $this->commands
      ->status('fruit_terms', [
      'group' => NULL,
      'tag' => NULL,
      'names-only' => FALSE,
    ])
      ->getArrayCopy()[0]['status'];
    $this
      ->assertSame('Importing', $status);
    $this->commands
      ->resetStatus('fruit_terms');
    $this
      ->assertSame(MigrationInterface::STATUS_IDLE, $migration
      ->getStatus());
  }

  /**
   * Tests that a failing reset status throws an exception (i.e. exit code).
   */
  public function testFailingResetStatusThrowsException() {
    $this
      ->expectException(\Exception::class);
    $this
      ->expectExceptionMessage('Migration does_not_exist does not exist');
    $this->commands
      ->resetStatus('does_not_exist');
  }

  /**
   * Tests drush mst.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  public function testStop() {

    /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
    $migration = $this->migrationPluginManager
      ->createInstance('fruit_terms');
    $migration
      ->setStatus(MigrationInterface::STATUS_IMPORTING);
    $this->commands
      ->stop('fruit_terms');
    $this
      ->assertSame(MigrationInterface::STATUS_STOPPING, $migration
      ->getStatus());
  }

  /**
   * Tests that a failing stop throws an exception (i.e. exit code).
   */
  public function testFailingStopThrowsException() {
    $this
      ->expectException(\Exception::class);
    $this
      ->expectExceptionMessage('Migration does_not_exist does not exist');
    $this->commands
      ->stop('does_not_exist');
  }

  /**
   * Tests drush mfs.
   */
  public function testFieldsSource() {

    /** @var \Consolidation\OutputFormatters\StructuredData\RowsOfFields $result */
    $result = $this->commands
      ->fieldsSource('fruit_terms');
    $rows = $result
      ->getArrayCopy();
    $this
      ->assertCount(1, $rows);
    $this
      ->assertSame('name', $rows[0]['machine_name']);
    $this
      ->assertSame('name', $rows[0]['description']);
  }

  /**
   * Tests that a failing fields source throws an exception (i.e. exit code).
   */
  public function testFailingFieldsSourceThrowsException() {
    $this
      ->expectException(\Exception::class);
    $this
      ->expectExceptionMessage('Migration does_not_exist does not exist');
    $this->commands
      ->fieldsSource('does_not_exist');
  }

}
namespace Drupal\migrate_tools\Commands;


/**
 * Stub for drush_op.
 *
 * @param callable $callable
 *   The function to call.
 */
function drush_op(callable $callable) {
  $args = func_get_args();
  array_shift($args);
  return call_user_func_array($callable, $args);
}

/**
 * Stub for dt().
 *
 * @param string $text
 *   The text.
 * @param array $args
 *   An associative array of replacement items.
 *
 * @return string
 *   The text.
 */
function dt($text, array $args = []) {
  foreach ($args as $before => $after) {
    $text = str_replace($before, $after, $text);
  }
  return $text;
}

Functions

Name	Description
drush_op	Stub for drush_op.
dt	Stub for dt().

Classes

Name	Description
DrushTest	Tests for the Drush 9 commands.