MigrateSqlIdMapEnsureTablesTest.php

<?php

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

use Drupal\migrate\Plugin\MigrateIdMapInterface;

/**
 * Tests the SQL ID map plugin ensureTables() method.
 *
 * @group migrate
 */
class MigrateSqlIdMapEnsureTablesTest extends MigrateTestCase {
    
    /**
     * The migration configuration, initialized to set the ID and destination IDs.
     *
     * @var array
     */
    protected $migrationConfiguration = [
        'id' => 'sql_idmap_test',
    ];
    
    /**
     * Tests the ensureTables method when the tables do not exist.
     */
    public function testEnsureTablesNotExist() : void {
        $fields['source_ids_hash'] = [
            'type' => 'varchar',
            'length' => 64,
            'not null' => 1,
            'description' => 'Hash of source ids. Used as primary key',
        ];
        $fields['sourceid1'] = [
            'type' => 'int',
            'not null' => TRUE,
        ];
        $fields['sourceid2'] = [
            'type' => 'int',
            'not null' => TRUE,
        ];
        $fields['destid1'] = [
            'type' => 'varchar',
            'length' => 255,
            'not null' => FALSE,
        ];
        $fields['source_row_status'] = [
            'type' => 'int',
            'size' => 'tiny',
            'unsigned' => TRUE,
            'not null' => TRUE,
            'default' => MigrateIdMapInterface::STATUS_IMPORTED,
            'description' => 'Indicates current status of the source row',
        ];
        $fields['rollback_action'] = [
            'type' => 'int',
            'size' => 'tiny',
            'unsigned' => TRUE,
            'not null' => TRUE,
            'default' => MigrateIdMapInterface::ROLLBACK_DELETE,
            'description' => 'Flag indicating what to do for this item on rollback',
        ];
        $fields['last_imported'] = [
            'type' => 'int',
            'unsigned' => TRUE,
            'not null' => TRUE,
            'default' => 0,
            'description' => 'UNIX timestamp of the last time this row was imported',
            'size' => 'big',
        ];
        $fields['hash'] = [
            'type' => 'varchar',
            'length' => '64',
            'not null' => FALSE,
            'description' => 'Hash of source row data, for detecting changes',
        ];
        $map_table_schema = [
            'description' => 'Mappings from source identifier value(s) to destination identifier value(s).',
            'fields' => $fields,
            'primary key' => [
                'source_ids_hash',
            ],
            'indexes' => [
                'source' => [
                    'sourceid1',
                    'sourceid2',
                ],
            ],
        ];
        // Now do the message table.
        $fields = [];
        $fields['msgid'] = [
            'type' => 'serial',
            'unsigned' => TRUE,
            'not null' => TRUE,
        ];
        $fields['source_ids_hash'] = [
            'type' => 'varchar',
            'length' => 64,
            'not null' => 1,
            'description' => 'Hash of source ids. Used as primary key',
        ];
        $fields['level'] = [
            'type' => 'int',
            'unsigned' => TRUE,
            'not null' => TRUE,
            'default' => 1,
        ];
        $fields['message'] = [
            'type' => 'text',
            'size' => 'medium',
            'not null' => TRUE,
        ];
        $table_schema = [
            'description' => 'Messages generated during a migration process',
            'fields' => $fields,
            'primary key' => [
                'msgid',
            ],
            'indexes' => [
                'source_ids_hash' => [
                    'source_ids_hash',
                ],
            ],
        ];
        $schema = $this->prophesize('Drupal\\Core\\Database\\Schema');
        $schema->tableExists('migrate_map_sql_idmap_test')
            ->willReturn(FALSE);
        $schema->tableExists('migrate_message_sql_idmap_test')
            ->willReturn(FALSE);
        $schema->createTable('migrate_map_sql_idmap_test', $map_table_schema)
            ->shouldBeCalled();
        $schema->createTable('migrate_message_sql_idmap_test', $table_schema)
            ->shouldBeCalled();
        $this->runEnsureTablesTest($schema->reveal());
    }
    
    /**
     * Tests the ensureTables method when the tables exist.
     */
    public function testEnsureTablesExist() : void {
        $schema = $this->prophesize('Drupal\\Core\\Database\\Schema');
        $schema->tableExists('migrate_map_sql_idmap_test')
            ->willReturn(TRUE);
        $schema->fieldExists('migrate_map_sql_idmap_test', 'rollback_action')
            ->willReturn(FALSE);
        $schema->fieldExists('migrate_map_sql_idmap_test', 'hash')
            ->willReturn(FALSE);
        $schema->fieldExists('migrate_map_sql_idmap_test', 'source_ids_hash')
            ->willReturn(FALSE);
        $schema->addField('migrate_map_sql_idmap_test', 'rollback_action', [
            'type' => 'int',
            'size' => 'tiny',
            'unsigned' => TRUE,
            'not null' => TRUE,
            'default' => 0,
            'description' => 'Flag indicating what to do for this item on rollback',
        ])
            ->shouldBeCalled();
        $schema->addField('migrate_map_sql_idmap_test', 'hash', [
            'type' => 'varchar',
            'length' => '64',
            'not null' => FALSE,
            'description' => 'Hash of source row data, for detecting changes',
        ])
            ->shouldBeCalled();
        $schema->addField('migrate_map_sql_idmap_test', 'source_ids_hash', [
            'type' => 'varchar',
            'length' => '64',
            'not null' => TRUE,
            'description' => 'Hash of source ids. Used as primary key',
        ])
            ->shouldBeCalled();
        $this->runEnsureTablesTest($schema->reveal());
    }
    
    /**
     * Actually run the test.
     *
     * @param array $schema
     *   The mock schema object with expectations set. The Sql constructor calls
     *   ensureTables() which in turn calls this object and the expectations on
     *   it are the actual test and there are no additional asserts added.
     */
    protected function runEnsureTablesTest($schema) {
        $database = $this->getMockBuilder('Drupal\\Core\\Database\\Connection')
            ->disableOriginalConstructor()
            ->getMock();
        $database->expects($this->any())
            ->method('schema')
            ->willReturn($schema);
        $database->expects($this->any())
            ->method('getPrefix')
            ->willReturn('');
        $migration = $this->getMigration();
        $plugin = $this->createMock('Drupal\\migrate\\Plugin\\MigrateSourceInterface');
        $plugin->expects($this->any())
            ->method('getIds')
            ->willReturn([
            'source_id_property' => [
                'type' => 'integer',
            ],
            'source_id_property_2' => [
                'type' => 'integer',
            ],
        ]);
        $migration->expects($this->any())
            ->method('getSourcePlugin')
            ->willReturn($plugin);
        $plugin = $this->createMock('Drupal\\migrate\\Plugin\\MigrateSourceInterface');
        $plugin->expects($this->any())
            ->method('getIds')
            ->willReturn([
            'destination_id_property' => [
                'type' => 'string',
            ],
        ]);
        $migration->expects($this->any())
            ->method('getDestinationPlugin')
            ->willReturn($plugin);
        
        /** @var \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $event_dispatcher */
        $event_dispatcher = $this->createMock('Symfony\\Contracts\\EventDispatcher\\EventDispatcherInterface');
        $migration_manager = $this->createMock('Drupal\\migrate\\Plugin\\MigrationPluginManagerInterface');
        $map = new TestSqlIdMap($database, [], 'sql', [], $migration, $event_dispatcher, $migration_manager);
        $map->getDatabase();
    }

}