Upgrade7Test.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\migrate_drupal_ui\Functional\d7;

use Drupal\node\Entity\Node;
use Drupal\Tests\migrate_drupal_ui\Functional\MigrateUpgradeExecuteTestBase;
use Drupal\user\Entity\User;
// cspell:ignore Filefield Multiupload Imagefield

/**
 * Tests Drupal 7 upgrade using the migrate UI.
 *
 * The test method is provided by the MigrateUpgradeTestBase class.
 *
 * @group migrate_drupal_ui
 * @group #slow
 */
class Upgrade7Test extends MigrateUpgradeExecuteTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'config_translation',
        'content_translation',
        'datetime_range',
        'language',
        'migrate_drupal_ui',
        'telephone',
    ];
    
    /**
     * The entity storage for node.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $nodeStorage;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // @todo remove in https://www.drupal.org/project/drupal/issues/3267040
        // Delete the existing content made to test the ID Conflict form. Migrations
        // are to be done on a site without content. The test of the ID Conflict
        // form is being moved to its own issue which will remove the deletion
        // of the created nodes.
        // See https://www.drupal.org/project/drupal/issues/3087061.
        $this->nodeStorage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $this->nodeStorage
            ->delete($this->nodeStorage
            ->loadMultiple());
        $this->loadFixture($this->getModulePath('migrate_drupal') . '/tests/fixtures/drupal7.php');
        $this->expectedLoggedErrors = 27;
        // If saving the logs, then set the admin user.
        if ($this->outputLogs) {
            $this->migratedAdminUserName = 'admin';
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getSourceBasePath() : string {
        return __DIR__ . '/files';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEntityCounts() : array {
        return [
            'block' => 27,
            'block_content' => 1,
            'block_content_type' => 1,
            'comment' => 4,
            // The 'standard' profile provides the 'comment' comment type, and the
            // migration creates 6 comment types, one per node type.
'comment_type' => 9,
            // Module 'language' comes with 'en', 'und', 'zxx'. Migration adds 'is'
            // and 'fr'.
'configurable_language' => 5,
            'contact_form' => 3,
            'contact_message' => 0,
            'editor' => 2,
            'field_config' => 90,
            'field_storage_config' => 69,
            'file' => 3,
            'filter_format' => 7,
            'image_style' => 7,
            'language_content_settings' => 24,
            'node' => 7,
            'node_type' => 8,
            'search_page' => 3,
            'shortcut' => 6,
            'shortcut_set' => 2,
            'action' => 24,
            'menu' => 7,
            'taxonomy_term' => 25,
            'taxonomy_vocabulary' => 8,
            'path_alias' => 8,
            'user' => 4,
            'user_role' => 4,
            'menu_link_content' => 12,
            'view' => 14,
            'date_format' => 12,
            'entity_form_display' => 23,
            'entity_form_mode' => 1,
            'entity_view_display' => 33,
            'entity_view_mode' => 11,
            'base_field_override' => 2,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEntityCountsIncremental() {
        $counts = $this->getEntityCounts();
        $counts['block_content'] = 2;
        $counts['comment'] = 5;
        $counts['file'] = 4;
        $counts['menu_link_content'] = 13;
        $counts['node'] = 8;
        $counts['taxonomy_term'] = 26;
        $counts['user'] = 5;
        return $counts;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getAvailablePaths() : array {
        return [
            'Block languages',
            'Block',
            'Chaos tools',
            'Comment',
            'Contact',
            'Content translation',
            'Database logging',
            'Date',
            'Email',
            'Entity Reference',
            'Entity Translation',
            'Field SQL storage',
            'Field translation',
            'Field',
            'File',
            'Filter',
            'Image',
            'Internationalization',
            'Locale',
            'Link',
            'List',
            'Menu',
            'Menu translation',
            'Multiupload Filefield Widget',
            'Multiupload Imagefield Widget',
            'Node',
            'Node Reference',
            'Number',
            'Options',
            'Path',
            'Phone',
            'Search',
            'Shortcut',
            'String translation',
            'Synchronize translations',
            'System',
            'Taxonomy translation',
            'Taxonomy',
            'Telephone',
            'Text',
            'Title',
            'User',
            'User Reference',
            'Variable translation',
            // Include modules that do not have an upgrade path and are enabled in the
            // source database.
'Blog',
            'Contextual links',
            'Date API',
            'Entity API',
            'Field UI',
            'Help',
            'PHP filter',
            'Testing',
            'Toolbar',
            'Trigger',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getMissingPaths() : array {
        return [
            'Aggregator',
            'Book',
            'Color',
            'Forum',
            'RDF',
            'References',
            'Statistics',
            'Translation sets',
            'Variable realm',
            'Variable store',
            'Variable',
            // These modules are in the missing path list because they are installed
            // on the source site but they are not installed on the destination site.
'Syslog',
            'Tracker',
            'Update manager',
        ];
    }
    
    /**
     * Executes all steps of migrations upgrade.
     */
    public function testUpgradeAndIncremental() : void {
        // Perform upgrade followed by an incremental upgrade.
        $this->doUpgradeAndIncremental();
        // Ensure a migrated user can log in.
        $this->assertUserLogIn(2, 'a password');
        $this->assertFollowUpMigrationResults();
        $this->assertEntityRevisionsCount('node', 19);
        $this->assertEmailsSent();
        $this->assertLogError();
    }
    
    /**
     * Tests that follow-up migrations have been run successfully.
     *
     * @internal
     */
    protected function assertFollowUpMigrationResults() : void {
        $node = Node::load(2);
        $this->assertSame('4', $node->get('field_reference')->target_id);
        $this->assertSame('6', $node->get('field_reference_2')->target_id);
        $translation = $node->getTranslation('is');
        $this->assertSame('4', $translation->get('field_reference')->target_id);
        $this->assertSame('4', $translation->get('field_reference_2')->target_id);
        $node = Node::load(4);
        $this->assertSame('2', $node->get('field_reference')->target_id);
        $this->assertSame('2', $node->get('field_reference_2')->target_id);
        $translation = $node->getTranslation('en');
        $this->assertSame('2', $translation->get('field_reference')->target_id);
        $this->assertSame('2', $translation->get('field_reference_2')->target_id);
        $user = User::load(2);
        $this->assertSame('2', $user->get('field_reference')->target_id);
    }

}