Drupal 8.0.0 beta 12. More info: https://www.drupal.org/node/2514176

core/modules/migrate/src/Tests/MigrateTestBase.php

@@ -0,0 +1,167 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\migrate\Tests\MigrateTestBase.
+ */
+
+namespace Drupal\migrate\Tests;
+
+use Drupal\Core\Database\Database;
+use Drupal\migrate\Entity\MigrationInterface;
+use Drupal\migrate\MigrateMessageInterface;
+use Drupal\migrate\Row;
+use Drupal\simpletest\KernelTestBase;
+
+/**
+ * Base class for migration tests.
+ */
+abstract class MigrateTestBase extends KernelTestBase implements MigrateMessageInterface {
+
+  /**
+   * The file path(s) to the dumped database(s) to load into the child site.
+   *
+   * @var array
+   */
+  public $databaseDumpFiles = array();
+
+
+  /**
+   * TRUE to collect messages instead of displaying them.
+   *
+   * @var bool
+   */
+  protected $collectMessages = FALSE;
+
+  /**
+   * A two dimensional array of messages.
+   *
+   * The first key is the type of message, the second is just numeric. Values
+   * are the messages.
+   *
+   * @var array
+   */
+  protected $migrateMessages;
+
+  public static $modules = array('migrate');
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    $connection_info = Database::getConnectionInfo('default');
+    foreach ($connection_info as $target => $value) {
+      $prefix = is_array($value['prefix']) ? $value['prefix']['default'] : $value['prefix'];
+      // Simpletest uses 7 character prefixes at most so this can't cause
+      // collisions.
+      $connection_info[$target]['prefix']['default'] = $prefix . '0';
+
+      // Add the original simpletest prefix so SQLite can attach its database.
+      // @see \Drupal\Core\Database\Driver\sqlite\Connection::init()
+      $connection_info[$target]['prefix'][$value['prefix']['default']] = $value['prefix']['default'];
+    }
+    Database::addConnectionInfo('migrate', 'default', $connection_info['default']);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function tearDown() {
+    Database::removeConnection('migrate');
+    parent::tearDown();
+  }
+
+  /**
+   * Prepare the migration.
+   *
+   * @param \Drupal\migrate\Entity\MigrationInterface $migration
+   *   The migration object.
+   * @param array $files
+   *   An array of files.
+   */
+  protected function prepare(MigrationInterface $migration, array $files = array()) {
+    $this->loadDumps($files);
+    if ($this instanceof MigrateDumpAlterInterface) {
+      static::migrateDumpAlter($this);
+    }
+  }
+
+  /**
+   * Load Drupal 6 database dumps to be used.
+   *
+   * @param array $files
+   *   An array of files.
+   * @param string $method
+   *   The name of the method in the dump class to use. Defaults to load.
+   */
+  protected function loadDumps($files, $method = 'load') {
+    // Load the database from the portable PHP dump.
+    // The files may be gzipped.
+    foreach ($files as $file) {
+      if (substr($file, -3) == '.gz') {
+        $file = "compress.zlib://$file";
+        require $file;
+      }
+      preg_match('/^namespace (.*);$/m', file_get_contents($file), $matches);
+      $class = $matches[1] . '\\' . basename($file, '.php');
+      (new $class(Database::getConnection('default', 'migrate')))->$method();
+    }
+  }
+
+  /**
+   * Prepare any dependent migrations.
+   *
+   * @param array $id_mappings
+   *   A list of id mappings keyed by migration ids. Each id mapping is a list
+   *   of two arrays, the first are source ids and the second are destination
+   *   ids.
+   */
+  protected function prepareMigrations(array $id_mappings) {
+    /** @var \Drupal\migrate\Entity\MigrationInterface[] $migrations */
+    $migrations = entity_load_multiple('migration', array_keys($id_mappings));
+    foreach ($id_mappings as $migration_id => $data) {
+      $migration = $migrations[$migration_id];
+
+      // Mark the dependent migrations as complete.
+      $migration->setMigrationResult(MigrationInterface::RESULT_COMPLETED);
+
+      $id_map = $migration->getIdMap();
+      $id_map->setMessage($this);
+      $source_ids = $migration->getSourcePlugin()->getIds();
+      foreach ($data as $id_mapping) {
+        $row = new Row(array_combine(array_keys($source_ids), $id_mapping[0]), $source_ids);
+        $id_map->saveIdMapping($row, $id_mapping[1]);
+      }
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function display($message, $type = 'status') {
+    if ($this->collectMessages) {
+      $this->migrateMessages[$type][] = $message;
+    }
+    else {
+      $this->assert($type == 'status', $message, 'migrate');
+    }
+  }
+
+  /**
+   * Start collecting messages and erase previous messages.
+   */
+  public function startCollectingMessages() {
+    $this->collectMessages = TRUE;
+    $this->migrateMessages = array();
+  }
+
+  /**
+   * Stop collecting messages.
+   */
+  public function stopCollectingMessages() {
+    $this->collectMessages = FALSE;
+  }
+
+}