MigrateMessageTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\migrate\Kernel;

use Drupal\KernelTests\KernelTestBase;
use Drupal\migrate\Plugin\MigrationInterface;
use Drupal\migrate\Event\MigrateEvents;
use Drupal\migrate\Event\MigrateIdMapMessageEvent;
use Drupal\migrate\MigrateExecutable;
use Drupal\migrate\MigrateMessageInterface;
use Drupal\migrate\Plugin\migrate\id_map\Sql;

/**
 * Tests whether idmap messages are sent to message interface when requested.
 *
 * @group migrate
 */
class MigrateMessageTest extends KernelTestBase implements MigrateMessageInterface {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'migrate',
        'system',
    ];
    
    /**
     * Migration to run.
     *
     * @var \Drupal\migrate\Plugin\MigrationInterface
     */
    protected $migration;
    
    /**
     * Messages accumulated during the migration run.
     *
     * @var array
     */
    protected $messages = [];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installConfig([
            'system',
        ]);
        // A simple migration, which will generate a message to the ID map because
        // the concat plugin throws an exception if its source is not an array.
        $definition = [
            'migration_tags' => [
                'Message test',
            ],
            'source' => [
                'plugin' => 'embedded_data',
                'data_rows' => [
                    [
                        'name' => 'source_message',
                        'value' => 'a message',
                    ],
                ],
                'ids' => [
                    'name' => [
                        'type' => 'string',
                    ],
                ],
            ],
            'process' => [
                'message' => [
                    'plugin' => 'concat',
                    'source' => 'value',
                ],
            ],
            'destination' => [
                'plugin' => 'config',
                'config_name' => 'system.maintenance',
            ],
        ];
        $this->migration = \Drupal::service('plugin.manager.migration')->createStubMigration($definition);
    }
    
    /**
     * Tests migration interruptions.
     */
    public function testMessagesNotTeed() : void {
        // We don't ask for messages to be teed, so don't expect any.
        $executable = new MigrateExecutable($this->migration, $this);
        $executable->import();
        $this->assertCount(0, $this->messages);
    }
    
    /**
     * Tests migration interruptions.
     */
    public function testMessagesTeed() : void {
        // Ask to receive any messages sent to the idmap.
        \Drupal::service('event_dispatcher')->addListener(MigrateEvents::IDMAP_MESSAGE, [
            $this,
            'mapMessageRecorder',
        ]);
        $executable = new MigrateExecutable($this->migration, $this);
        $executable->import();
        $this->assertCount(1, $this->messages);
        $id = $this->migration
            ->getPluginId();
        $this->assertSame("source_message: {$id}:message:concat: 'a message' is not an array", reset($this->messages));
    }
    
    /**
     * Tests the return value of getMessages().
     *
     * This method returns an iterator of StdClass objects. Check that these
     * objects have the expected keys.
     */
    public function testGetMessages() : void {
        $id = $this->migration
            ->getPluginId();
        $expected_message = (object) [
            'src_name' => 'source_message',
            'dest_config_name' => NULL,
            'msgid' => '1',
            Sql::SOURCE_IDS_HASH => '170cde81762e22552d1b1578cf3804c89afefe9efbc7cc835185d7141060b032',
            'level' => '1',
            'message' => "{$id}:message:concat: 'a message' is not an array",
        ];
        $executable = new MigrateExecutable($this->migration, $this);
        $executable->import();
        $count = 0;
        foreach ($this->migration
            ->getIdMap()
            ->getMessages() as $message) {
            ++$count;
            $this->assertEquals($expected_message, $message);
        }
        $this->assertEquals(1, $count);
    }
    
    /**
     * Reacts to map message event.
     *
     * @param \Drupal\migrate\Event\MigrateIdMapMessageEvent $event
     *   The migration event.
     * @param string $name
     *   The event name.
     */
    public function mapMessageRecorder(MigrateIdMapMessageEvent $event, $name) {
        if ($event->getLevel() == MigrationInterface::MESSAGE_NOTICE || $event->getLevel() == MigrationInterface::MESSAGE_INFORMATIONAL) {
            $type = 'status';
        }
        else {
            $type = 'error';
        }
        $source_id_string = implode(',', $event->getSourceIdValues());
        $this->display($source_id_string . ': ' . $event->getMessage(), $type);
    }
    
    /**
     * {@inheritdoc}
     */
    public function display($message, $type = 'status') {
        $this->messages[] = $message;
    }

}