Drupal6SqlBaseTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\migrate_drupal\Unit\source\d6;

use Drupal\Tests\migrate\Unit\MigrateTestCase;
// cspell:ignore throttleable

/**
 * Tests the D6 SQL base class.
 *
 * @group migrate_drupal
 */
class Drupal6SqlBaseTest extends MigrateTestCase {
    
    /**
     * Define bare minimum migration configuration.
     */
    protected $migrationConfiguration = [
        'id' => 'Drupal6SqlBase',
    ];
    
    /**
     * @var \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase
     */
    protected $base;
    
    /**
     * Minimum database contents needed to test Drupal6SqlBase.
     */
    protected $databaseContents = [
        'system' => [
            [
                'filename' => 'sites/all/modules/module1',
                'name' => 'module1',
                'type' => 'module',
                'status' => 1,
                'schema_version' => -1,
            ],
            [
                'filename' => 'sites/all/modules/module2',
                'name' => 'module2',
                'type' => 'module',
                'status' => 0,
                'schema_version' => 7201,
            ],
            [
                'filename' => 'sites/all/modules/test2',
                'name' => 'test2',
                'type' => 'theme',
                'status' => 1,
                'schema_version' => -1,
            ],
        ],
        'variable' => [
            [
                'name' => 'my_variable',
                'value' => 'b:1;',
            ],
        ],
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $plugin = 'placeholder_id';
        
        /** @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');
        $this->base = new TestDrupal6SqlBase($this->migrationConfiguration, $plugin, [], $this->getMigration(), $state, $entity_type_manager);
        $this->base
            ->setDatabase($this->getDatabase($this->databaseContents));
    }
    
    /**
     * Tests for Drupal6SqlBase::getSystemData().
     */
    public function testGetSystemData() : void {
        $system_data = $this->base
            ->getSystemData();
        // Should be 1 theme and 2 modules.
        $this->assertCount(1, $system_data['theme']);
        $this->assertCount(2, $system_data['module']);
        // Calling again should be identical.
        $this->assertSame($system_data, $this->base
            ->getSystemData());
    }
    
    /**
     * Tests for Drupal6SqlBase::moduleExists().
     */
    public function testDrupal6ModuleExists() : void {
        // This module should exist.
        $this->assertTrue($this->base
            ->moduleExistsWrapper('module1'));
        // These modules should not exist.
        $this->assertFalse($this->base
            ->moduleExistsWrapper('module2'));
        $this->assertFalse($this->base
            ->moduleExistsWrapper('module3'));
    }
    
    /**
     * Tests for Drupal6SqlBase::getModuleSchemaVersion().
     */
    public function testGetModuleSchemaVersion() : void {
        // Non-existent module.
        $this->assertFalse($this->base
            ->getModuleSchemaVersionWrapper('module3'));
        // Disabled module should still return schema version.
        $this->assertEquals(7201, $this->base
            ->getModuleSchemaVersionWrapper('module2'));
        // Enabled module.
        $this->assertEquals(-1, $this->base
            ->getModuleSchemaVersionWrapper('module1'));
    }
    
    /**
     * Tests for Drupal6SqlBase::variableGet().
     */
    public function testVariableGet() : void {
        // Test default value.
        $this->assertEquals('my_default', $this->base
            ->variableGetWrapper('non_existent_variable', 'my_default'));
        // Test non-default.
        $this->assertTrue($this->base
            ->variableGetWrapper('my_variable', FALSE));
    }

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

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

/**
 * Extends the Drupal6SqlBase abstract class.
 */
class TestDrupal6SqlBase extends DrupalSqlBase {
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        return [
            'filename' => $this->t('The path of the primary file for this item.'),
            'name' => $this->t('The name of the item; e.g. node.'),
            'type' => $this->t('The type of the item, either module, theme, or theme_engine.'),
            'owner' => $this->t("A theme's 'parent'. Can be either a theme or an engine."),
            'status' => $this->t('Boolean indicating whether or not this item is enabled.'),
            'throttle' => $this->t('Boolean indicating whether this item is disabled when the throttle.module disables throttleable items.'),
            'bootstrap' => $this->t("Boolean indicating whether this module is loaded during Drupal's early bootstrapping phase (e.g. even before the page cache is consulted)."),
            'schema_version' => $this->t("The module's database schema version number."),
            'weight' => $this->t("The order in which this module's hooks should be invoked."),
            'info' => $this->t("A serialized array containing information from the module's .info file."),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $query = $this->database
            ->select('system', 's')
            ->fields('s', [
            'filename',
            'name',
            'schema_version',
        ]);
        return $query;
    }
    
    /**
     * Tweaks Drupal6SqlBase to set a new database connection for tests.
     *
     * @param \Drupal\Core\Database\Connection $database
     *   The new connection to use.
     *
     * @see \Drupal\Tests\migrate\Unit\MigrateSqlTestCase
     */
    public function setDatabase(Connection $database) {
        $this->database = $database;
    }
    
    /**
     * Tweaks Drupal6SqlBase to set a new module handler for tests.
     *
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The new module handler to use.
     *
     * @see \Drupal\Tests\migrate\Unit\MigrateSqlTestCase
     */
    public function setModuleHandler(ModuleHandlerInterface $module_handler) {
        $this->moduleHandler = $module_handler;
    }
    
    /**
     * Wrapper method to test protected method moduleExists().
     */
    public function moduleExistsWrapper($module) {
        return parent::moduleExists($module);
    }
    
    /**
     * Wrapper method to test protected method getModuleSchemaVersion().
     */
    public function getModuleSchemaVersionWrapper($module) {
        return parent::getModuleSchemaVersion($module);
    }
    
    /**
     * Wrapper method to test protected method variableGet().
     */
    public function variableGetWrapper($name, $default) {
        return parent::variableGet($name, $default);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        return [];
    }

}