comparison core/modules/migrate/tests/src/Kernel/MigrateEventsTest.php @ 0:4c8ae668cc8c

Initial import (non-working)

+<?php
+
+namespace Drupal\Tests\migrate\Kernel;
+
+use Drupal\migrate\Event\MigrateImportEvent;
+use Drupal\migrate\Event\MigrateMapDeleteEvent;
+use Drupal\migrate\Event\MigrateMapSaveEvent;
+use Drupal\migrate\Event\MigratePostRowSaveEvent;
+use Drupal\migrate\Event\MigratePreRowSaveEvent;
+use Drupal\migrate\MigrateMessage;
+use Drupal\migrate\Event\MigrateEvents;
+use Drupal\migrate\MigrateExecutable;
+use Drupal\KernelTests\KernelTestBase;
+
+/**
+ * Tests events fired on migrations.
+ *
+ * @group migrate
+ */
+class MigrateEventsTest extends KernelTestBase {
+
+  /**
+   * State service for recording information received by event listeners.
+   *
+   * @var \Drupal\Core\State\State
+   */
+  protected $state;
+
+  /**
+   * Modules to enable.
+   *
+   * @var array
+   */
+  public static $modules = ['migrate', 'migrate_events_test'];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+    $this->state = \Drupal::state();
+    \Drupal::service('event_dispatcher')->addListener(MigrateEvents::MAP_SAVE,
+      [$this, 'mapSaveEventRecorder']);
+    \Drupal::service('event_dispatcher')->addListener(MigrateEvents::MAP_DELETE,
+      [$this, 'mapDeleteEventRecorder']);
+    \Drupal::service('event_dispatcher')->addListener(MigrateEvents::PRE_IMPORT,
+      [$this, 'preImportEventRecorder']);
+    \Drupal::service('event_dispatcher')->addListener(MigrateEvents::POST_IMPORT,
+      [$this, 'postImportEventRecorder']);
+    \Drupal::service('event_dispatcher')->addListener(MigrateEvents::PRE_ROW_SAVE,
+      [$this, 'preRowSaveEventRecorder']);
+    \Drupal::service('event_dispatcher')->addListener(MigrateEvents::POST_ROW_SAVE,
+      [$this, 'postRowSaveEventRecorder']);
+  }
+
+  /**
+   * Tests migration events.
+   */
+  public function testMigrateEvents() {
+    // Run a simple little migration, which should trigger one of each event
+    // other than map_delete.
+    $definition = [
+      'migration_tags' => ['Event test'],
+      'source' => [
+        'plugin' => 'embedded_data',
+        'data_rows' => [
+          ['data' => 'dummy value'],
+        ],
+        'ids' => [
+          'data' => ['type' => 'string'],
+        ],
+      ],
+      'process' => ['value' => 'data'],
+      'destination' => ['plugin' => 'dummy'],
+    ];
+
+    $migration = \Drupal::service('plugin.manager.migration')->createStubMigration($definition);
+
+    $executable = new MigrateExecutable($migration, new MigrateMessage());
+    // As the import runs, events will be dispatched, recording the received
+    // information in state.
+    $executable->import();
+
+    // Validate from the recorded state that the events were received.
+    $event = $this->state->get('migrate_events_test.pre_import_event', []);
+    $this->assertIdentical($event['event_name'], MigrateEvents::PRE_IMPORT);
+    $this->assertIdentical($event['migration']->id(), $migration->id());
+
+    $event = $this->state->get('migrate_events_test.post_import_event', []);
+    $this->assertIdentical($event['event_name'], MigrateEvents::POST_IMPORT);
+    $this->assertIdentical($event['migration']->id(), $migration->id());
+
+    $event = $this->state->get('migrate_events_test.map_save_event', []);
+    $this->assertIdentical($event['event_name'], MigrateEvents::MAP_SAVE);
+    // Validating the last row processed.
+    $this->assertIdentical($event['fields']['sourceid1'], 'dummy value');
+    $this->assertIdentical($event['fields']['destid1'], 'dummy value');
+    $this->assertIdentical($event['fields']['source_row_status'], 0);
+
+    $event = $this->state->get('migrate_events_test.map_delete_event', []);
+    $this->assertIdentical($event, []);
+
+    $event = $this->state->get('migrate_events_test.pre_row_save_event', []);
+    $this->assertIdentical($event['event_name'], MigrateEvents::PRE_ROW_SAVE);
+    $this->assertIdentical($event['migration']->id(), $migration->id());
+    // Validating the last row processed.
+    $this->assertIdentical($event['row']->getSourceProperty('data'), 'dummy value');
+
+    $event = $this->state->get('migrate_events_test.post_row_save_event', []);
+    $this->assertIdentical($event['event_name'], MigrateEvents::POST_ROW_SAVE);
+    $this->assertIdentical($event['migration']->id(), $migration->id());
+    // Validating the last row processed.
+    $this->assertIdentical($event['row']->getSourceProperty('data'), 'dummy value');
+    $this->assertIdentical($event['destination_id_values']['value'], 'dummy value');
+
+    // Generate a map delete event.
+    $migration->getIdMap()->delete(['data' => 'dummy value']);
+    $event = $this->state->get('migrate_events_test.map_delete_event', []);
+    $this->assertIdentical($event['event_name'], MigrateEvents::MAP_DELETE);
+    $this->assertIdentical($event['source_id'], ['data' => 'dummy value']);
+  }
+
+  /**
+   * Reacts to map save event.
+   *
+   * @param \Drupal\Migrate\Event\MigrateMapSaveEvent $event
+   *   The migration event.
+   * @param string $name
+   *   The event name.
+   */
+  public function mapSaveEventRecorder(MigrateMapSaveEvent $event, $name) {
+    $this->state->set('migrate_events_test.map_save_event', [
+      'event_name' => $name,
+      'map' => $event->getMap(),
+      'fields' => $event->getFields(),
+    ]);
+  }
+
+  /**
+   * Reacts to map delete event.
+   *
+   * @param \Drupal\Migrate\Event\MigrateMapDeleteEvent $event
+   *   The migration event.
+   * @param string $name
+   *   The event name.
+   */
+  public function mapDeleteEventRecorder(MigrateMapDeleteEvent $event, $name) {
+    $this->state->set('migrate_events_test.map_delete_event', [
+      'event_name' => $name,
+      'map' => $event->getMap(),
+      'source_id' => $event->getSourceId(),
+    ]);
+  }
+
+  /**
+   * Reacts to pre-import event.
+   *
+   * @param \Drupal\Migrate\Event\MigrateImportEvent $event
+   *   The migration event.
+   * @param string $name
+   *   The event name.
+   */
+  public function preImportEventRecorder(MigrateImportEvent $event, $name) {
+    $this->state->set('migrate_events_test.pre_import_event', [
+      'event_name' => $name,
+      'migration' => $event->getMigration(),
+    ]);
+  }
+
+  /**
+   * Reacts to post-import event.
+   *
+   * @param \Drupal\Migrate\Event\MigrateImportEvent $event
+   *   The migration event.
+   * @param string $name
+   *   The event name.
+   */
+  public function postImportEventRecorder(MigrateImportEvent $event, $name) {
+    $this->state->set('migrate_events_test.post_import_event', [
+      'event_name' => $name,
+      'migration' => $event->getMigration(),
+    ]);
+  }
+
+  /**
+   * Reacts to pre-row-save event.
+   *
+   * @param \Drupal\Migrate\Event\MigratePreRowSaveEvent $event
+   *   The migration event.
+   * @param string $name
+   *   The event name.
+   */
+  public function preRowSaveEventRecorder(MigratePreRowSaveEvent $event, $name) {
+    $this->state->set('migrate_events_test.pre_row_save_event', [
+      'event_name' => $name,
+      'migration' => $event->getMigration(),
+      'row' => $event->getRow(),
+    ]);
+  }
+
+  /**
+   * Reacts to post-row-save event.
+   *
+   * @param \Drupal\Migrate\Event\MigratePostRowSaveEvent $event
+   *   The migration event.
+   * @param string $name
+   *   The event name.
+   */
+  public function postRowSaveEventRecorder(MigratePostRowSaveEvent $event, $name) {
+    $this->state->set('migrate_events_test.post_row_save_event', [
+      'event_name' => $name,
+      'migration' => $event->getMigration(),
+      'row' => $event->getRow(),
+      'destination_id_values' => $event->getDestinationIdValues(),
+    ]);
+  }
+
+}