MigrateCommentTypeTest.php

Same filename in this branch
  1. 10 core/modules/comment/tests/src/Kernel/Migrate/d6/MigrateCommentTypeTest.php
Same filename in other branches
  1. 9 core/modules/comment/tests/src/Kernel/Migrate/d6/MigrateCommentTypeTest.php
  2. 9 core/modules/comment/tests/src/Kernel/Migrate/d7/MigrateCommentTypeTest.php
  3. 8.9.x core/modules/comment/tests/src/Kernel/Migrate/d6/MigrateCommentTypeTest.php
  4. 8.9.x core/modules/comment/tests/src/Kernel/Migrate/d7/MigrateCommentTypeTest.php
  5. 11.x core/modules/comment/tests/src/Kernel/Migrate/d6/MigrateCommentTypeTest.php
  6. 11.x core/modules/comment/tests/src/Kernel/Migrate/d7/MigrateCommentTypeTest.php

Namespace

Drupal\Tests\comment\Kernel\Migrate\d7

File

core/modules/comment/tests/src/Kernel/Migrate/d7/MigrateCommentTypeTest.php

View source
<?php

declare (strict_types=1);
namespace Drupal\Tests\comment\Kernel\Migrate\d7;

use Drupal\comment\Entity\CommentType;
use Drupal\Tests\migrate_drupal\Kernel\d7\MigrateDrupal7TestBase;

/**
 * Tests the migration of comment types from Drupal 7.
 *
 * @group comment
 * @group migrate_drupal_7
 */
class MigrateCommentTypeTest extends MigrateDrupal7TestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'comment',
        'text',
    ];
    
    /**
     * Asserts a comment type entity.
     *
     * @param string $id
     *   The entity ID.
     * @param string $label
     *   The entity label.
     *
     * @internal
     */
    protected function assertEntity(string $id, string $label) : void {
        $entity = CommentType::load($id);
        $this->assertInstanceOf(CommentType::class, $entity);
        $this->assertSame($label, $entity->label());
        $this->assertSame('node', $entity->getTargetEntityTypeId());
    }
    
    /**
     * Tests the migrated comment types.
     */
    public function testMigration() : void {
        $this->migrateCommentTypes();
        $comment_fields = [
            'comment' => 'Default comment setting',
            'comment_default_mode' => 'Default display mode',
            'comment_default_per_page' => 'Default comments per page',
            'comment_anonymous' => 'Anonymous commenting',
            'comment_subject_field' => 'Comment subject field',
            'comment_preview' => 'Preview comment',
            'comment_form_location' => 'Location of comment submission form',
        ];
        foreach ($comment_fields as $field => $description) {
            $this->assertEquals($description, $this->migration
                ->getSourcePlugin()
                ->fields()[$field]);
        }
        $this->assertEntity('comment_node_article', 'Article comment');
        $this->assertEntity('comment_node_blog', 'Blog entry comment');
        $this->assertEntity('comment_node_book', 'Book page comment');
        $this->assertEntity('comment_forum', 'Forum topic comment');
        $this->assertEntity('comment_node_page', 'Basic page comment');
        $this->assertEntity('comment_node_test_content_type', 'Test content type comment');
        $this->assertEntity('comment_node_a_thirty_two_char', 'Test long name comment');
    }
    
    /**
     * Tests comment type migration without node or / and comment on source.
     *
     * Usually, MigrateDumpAlterInterface::migrateDumpAlter() should be used when
     * the source fixture needs to be changed in a Migrate kernel test, but that
     * would end in three additional tests and an extra overhead in maintenance.
     *
     * @param string[] $disabled_source_modules
     *   List of the modules to disable in the source Drupal database.
     * @param string[][] $expected_messages
     *   List of the expected migration messages, keyed by the message type.
     *   Message type should be "status" "warning" or "error".
     *
     * @dataProvider providerTestNoCommentTypeMigration
     */
    public function testNoCommentTypeMigration(array $disabled_source_modules, array $expected_messages) : void {
        if (!empty($disabled_source_modules)) {
            $this->sourceDatabase
                ->update('system')
                ->condition('name', $disabled_source_modules, 'IN')
                ->fields([
                'status' => 0,
            ])
                ->execute();
        }
        $this->startCollectingMessages();
        $this->migrateCommentTypes();
        $expected_messages += [
            'status' => [],
            'warning' => [],
            'error' => [],
        ];
        $actual_messages = $this->migrateMessages + [
            'status' => [],
            'warning' => [],
            'error' => [],
        ];
        foreach ($expected_messages as $type => $expected_messages_by_type) {
            $this->assertSameSize($expected_messages_by_type, $actual_messages[$type]);
            // Cast the actual messages to string.
            $actual_messages_by_type = array_reduce($actual_messages[$type], function (array $carry, $actual_message) {
                $carry[] = (string) $actual_message;
                return $carry;
            }, []);
            $missing_expected_messages_by_type = array_diff($expected_messages_by_type, $actual_messages_by_type);
            $unexpected_messages_by_type = array_diff($actual_messages_by_type, $expected_messages_by_type);
            $this->assertEmpty($unexpected_messages_by_type, sprintf('No additional messages are present with type "%s". This expectation is wrong, because there are additional messages present: "%s"', $type, implode('", "', $unexpected_messages_by_type)));
            $this->assertEmpty($missing_expected_messages_by_type, sprintf('Every expected messages are present with type "%s". This expectation is wrong, because the following messages aren\'t present: "%s"', $type, implode('", "', $missing_expected_messages_by_type)));
        }
        $this->assertEmpty(CommentType::loadMultiple());
    }
    
    /**
     * Provides test cases for ::testNoCommentTypeMigration().
     */
    public static function providerTestNoCommentTypeMigration() {
        return [
            'Node module is disabled in source' => [
                'disabled_source_modules' => [
                    'node',
                ],
                'expected_messages' => [
                    'error' => [
                        'Migration d7_comment_type did not meet the requirements. The node module is not enabled in the source site.',
                    ],
                ],
            ],
            'Comment module is disabled in source' => [
                'disabled_source_modules' => [
                    'comment',
                ],
                'expected_messages' => [
                    'error' => [
                        'Migration d7_comment_type did not meet the requirements. The module comment is not enabled in the source site.',
                    ],
                ],
            ],
            'Node and comment modules are disabled in source' => [
                'disabled_source_modules' => [
                    'comment',
                    'node',
                ],
                'expected_messages' => [
                    'error' => [
                        'Migration d7_comment_type did not meet the requirements. The module comment is not enabled in the source site.',
                    ],
                ],
            ],
        ];
    }

}

Classes

Title Deprecated Summary
MigrateCommentTypeTest Tests the migration of comment types from Drupal 7.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.