3 namespace Drupal\Tests\migrate\Kernel;
5 use Drupal\migrate\Event\MigrateImportEvent;
6 use Drupal\migrate\Event\MigrateMapDeleteEvent;
7 use Drupal\migrate\Event\MigrateMapSaveEvent;
8 use Drupal\migrate\Event\MigratePostRowSaveEvent;
9 use Drupal\migrate\Event\MigratePreRowSaveEvent;
10 use Drupal\migrate\Event\MigrateEvents;
11 use Drupal\migrate\MigrateExecutable;
12 use Drupal\KernelTests\KernelTestBase;
15 * Tests events fired on migrations.
19 class MigrateEventsTest extends KernelTestBase {
22 * State service for recording information received by event listeners.
24 * @var \Drupal\Core\State\State
33 public static $modules = ['migrate', 'migrate_events_test'];
38 protected function setUp() {
40 $this->state = \Drupal::state();
41 \Drupal::service('event_dispatcher')->addListener(MigrateEvents::MAP_SAVE,
42 [$this, 'mapSaveEventRecorder']);
43 \Drupal::service('event_dispatcher')->addListener(MigrateEvents::MAP_DELETE,
44 [$this, 'mapDeleteEventRecorder']);
45 \Drupal::service('event_dispatcher')->addListener(MigrateEvents::PRE_IMPORT,
46 [$this, 'preImportEventRecorder']);
47 \Drupal::service('event_dispatcher')->addListener(MigrateEvents::POST_IMPORT,
48 [$this, 'postImportEventRecorder']);
49 \Drupal::service('event_dispatcher')->addListener(MigrateEvents::PRE_ROW_SAVE,
50 [$this, 'preRowSaveEventRecorder']);
51 \Drupal::service('event_dispatcher')->addListener(MigrateEvents::POST_ROW_SAVE,
52 [$this, 'postRowSaveEventRecorder']);
56 * Tests migration events.
58 public function testMigrateEvents() {
59 // Run a simple little migration, which should trigger one of each event
60 // other than map_delete.
62 'migration_tags' => ['Event test'],
64 'plugin' => 'embedded_data',
66 ['data' => 'dummy value'],
69 'data' => ['type' => 'string'],
72 'process' => ['value' => 'data'],
73 'destination' => ['plugin' => 'dummy'],
76 $migration = \Drupal::service('plugin.manager.migration')->createStubMigration($definition);
78 $executable = new MigrateExecutable($migration);
79 // As the import runs, events will be dispatched, recording the received
80 // information in state.
81 $executable->import();
83 // Validate from the recorded state that the events were received.
84 $event = $this->state->get('migrate_events_test.pre_import_event', []);
85 $this->assertIdentical($event['event_name'], MigrateEvents::PRE_IMPORT);
86 $this->assertIdentical($event['migration']->id(), $migration->id());
88 $event = $this->state->get('migrate_events_test.post_import_event', []);
89 $this->assertIdentical($event['event_name'], MigrateEvents::POST_IMPORT);
90 $this->assertIdentical($event['migration']->id(), $migration->id());
92 $event = $this->state->get('migrate_events_test.map_save_event', []);
93 $this->assertIdentical($event['event_name'], MigrateEvents::MAP_SAVE);
94 // Validating the last row processed.
95 $this->assertIdentical($event['fields']['sourceid1'], 'dummy value');
96 $this->assertIdentical($event['fields']['destid1'], 'dummy value');
97 $this->assertIdentical($event['fields']['source_row_status'], 0);
99 $event = $this->state->get('migrate_events_test.map_delete_event', []);
100 $this->assertIdentical($event, []);
102 $event = $this->state->get('migrate_events_test.pre_row_save_event', []);
103 $this->assertIdentical($event['event_name'], MigrateEvents::PRE_ROW_SAVE);
104 $this->assertIdentical($event['migration']->id(), $migration->id());
105 // Validating the last row processed.
106 $this->assertIdentical($event['row']->getSourceProperty('data'), 'dummy value');
108 $event = $this->state->get('migrate_events_test.post_row_save_event', []);
109 $this->assertIdentical($event['event_name'], MigrateEvents::POST_ROW_SAVE);
110 $this->assertIdentical($event['migration']->id(), $migration->id());
111 // Validating the last row processed.
112 $this->assertIdentical($event['row']->getSourceProperty('data'), 'dummy value');
113 $this->assertIdentical($event['destination_id_values']['value'], 'dummy value');
115 // Generate a map delete event.
116 $migration->getIdMap()->delete(['data' => 'dummy value']);
117 $event = $this->state->get('migrate_events_test.map_delete_event', []);
118 $this->assertIdentical($event['event_name'], MigrateEvents::MAP_DELETE);
119 $this->assertIdentical($event['source_id'], ['data' => 'dummy value']);
123 * Reacts to map save event.
125 * @param \Drupal\Migrate\Event\MigrateMapSaveEvent $event
126 * The migration event.
127 * @param string $name
130 public function mapSaveEventRecorder(MigrateMapSaveEvent $event, $name) {
131 $this->state->set('migrate_events_test.map_save_event', [
132 'event_name' => $name,
133 'map' => $event->getMap(),
134 'fields' => $event->getFields(),
139 * Reacts to map delete event.
141 * @param \Drupal\Migrate\Event\MigrateMapDeleteEvent $event
142 * The migration event.
143 * @param string $name
146 public function mapDeleteEventRecorder(MigrateMapDeleteEvent $event, $name) {
147 $this->state->set('migrate_events_test.map_delete_event', [
148 'event_name' => $name,
149 'map' => $event->getMap(),
150 'source_id' => $event->getSourceId(),
155 * Reacts to pre-import event.
157 * @param \Drupal\Migrate\Event\MigrateImportEvent $event
158 * The migration event.
159 * @param string $name
162 public function preImportEventRecorder(MigrateImportEvent $event, $name) {
163 $this->state->set('migrate_events_test.pre_import_event', [
164 'event_name' => $name,
165 'migration' => $event->getMigration(),
170 * Reacts to post-import event.
172 * @param \Drupal\Migrate\Event\MigrateImportEvent $event
173 * The migration event.
174 * @param string $name
177 public function postImportEventRecorder(MigrateImportEvent $event, $name) {
178 $this->state->set('migrate_events_test.post_import_event', [
179 'event_name' => $name,
180 'migration' => $event->getMigration(),
185 * Reacts to pre-row-save event.
187 * @param \Drupal\Migrate\Event\MigratePreRowSaveEvent $event
188 * The migration event.
189 * @param string $name
192 public function preRowSaveEventRecorder(MigratePreRowSaveEvent $event, $name) {
193 $this->state->set('migrate_events_test.pre_row_save_event', [
194 'event_name' => $name,
195 'migration' => $event->getMigration(),
196 'row' => $event->getRow(),
201 * Reacts to post-row-save event.
203 * @param \Drupal\Migrate\Event\MigratePostRowSaveEvent $event
204 * The migration event.
205 * @param string $name
208 public function postRowSaveEventRecorder(MigratePostRowSaveEvent $event, $name) {
209 $this->state->set('migrate_events_test.post_row_save_event', [
210 'event_name' => $name,
211 'migration' => $event->getMigration(),
212 'row' => $event->getRow(),
213 'destination_id_values' => $event->getDestinationIdValues(),