DrupalSqlBaseTest.php

<?php

namespace Drupal\Tests\migrate_drupal\Unit\source;

use Drupal\Tests\migrate\Unit\MigrateTestCase;
use Drupal\migrate\Exception\RequirementsException;

/**
 * @coversDefaultClass Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase
 * @group migrate_drupal
 */
class DrupalSqlBaseTest extends MigrateTestCase {
    
    /**
     * Define bare minimum migration configuration.
     */
    protected $migrationConfiguration = [
        'id' => 'DrupalSqlBase',
    ];
    
    /**
     * @var \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase
     */
    protected $base;
    
    /**
     * Minimum database contents needed to test DrupalSqlBase.
     */
    protected $databaseContents = [
        'system' => [
            [
                'filename' => 'sites/all/modules/module1',
                'name' => 'module1',
                'type' => 'module',
                'status' => 0,
                'schema_version' => -1,
            ],
        ],
    ];
    
    /**
     * @covers ::checkRequirements
     */
    public function testSourceProviderNotActive() {
        $plugin_definition['requirements_met'] = TRUE;
        $plugin_definition['source_module'] = 'module1';
        
        /** @var \Drupal\Core\State\StateInterface $state */
        $state = $this->createMock('Drupal\\Core\\State\\StateInterface');
        
        /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */
        $entity_type_manager = $this->createMock('Drupal\\Core\\Entity\\EntityTypeManagerInterface');
        $plugin = new TestDrupalSqlBase([], 'placeholder_id', $plugin_definition, $this->getMigration(), $state, $entity_type_manager);
        $plugin->setDatabase($this->getDatabase($this->databaseContents));
        $system_data = $plugin->getSystemData();
        $this->expectException(RequirementsException::class);
        $this->expectExceptionMessage('The module module1 is not enabled in the source site.');
        try {
            $plugin->checkRequirements();
        } catch (RequirementsException $e) {
            // Ensure requirements are set on the exception.
            $this->assertEquals([
                'source_module' => 'module1',
            ], $e->getRequirements());
            // Re-throw so PHPUnit can assert the exception.
            throw $e;
        }
    }
    
    /**
     * @covers ::checkRequirements
     */
    public function testSourceDatabaseError() {
        $plugin_definition['requirements_met'] = TRUE;
        $plugin_definition['source_module'] = 'module1';
        
        /** @var \Drupal\Core\State\StateInterface $state */
        $state = $this->createMock('Drupal\\Core\\State\\StateInterface');
        
        /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager */
        $entity_manager = $this->createMock('Drupal\\Core\\Entity\\EntityTypeManagerInterface');
        $plugin = new TestDrupalSqlBase([], 'test', $plugin_definition, $this->getMigration(), $state, $entity_manager);
        $system_data = $plugin->getSystemData();
        $this->expectException(RequirementsException::class);
        $this->expectExceptionMessage('No database connection configured for source plugin test');
        $plugin->checkRequirements();
    }

}
namespace Drupal\Tests\migrate_drupal\Unit\source;

use Drupal\Core\Database\Connection;
use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;

/**
 * Extends the DrupalSqlBase abstract class.
 */
class TestDrupalSqlBase extends DrupalSqlBase {
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
    }
    
    /**
     * Tweaks DrupalSqlBase to set a new database connection for tests.
     *
     * @param \Drupal\Core\Database\Connection $database
     *   The new connection to use.
     *
     * @see \Drupal\Tests\migrate\Unit\MigrateSourceSqlTestCase
     */
    public function setDatabase(Connection $database) {
        $this->database = $database;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        return [];
    }

}