Writing PHPUnit Test Cases for Drupal Migration Suite

Ensuring the integrity of your Drupal migrations is crucial, and PHPUnit is a powerful tool to help you automate and validate these migrations. Below are some example PHPUnit test cases that cover different aspects of Drupal migrations, including node content migration, field mapping accuracy, and duplicate entry checks.

Setting Up PHPUnit for Drupal

Before writing your test cases, make sure PHPUnit is installed and configured for your Drupal project. You can follow the official Drupal documentation for setting up PHPUnit.

Example Test Cases

Test Case: Node Content Migration

use PHPUnit\Framework\TestCase;
use Drupal\node\Entity\Node;

class NodeMigrationTest extends TestCase
{
    /**
     * Test node content migration.
     */
    public function testNodeMigration()
    {
        // Run the migration.
        // This should be replaced with the actual command to run your migration.
        $migration_result = $this->runMigration('node_migration');

        // Check if the migration ran successfully.
        $this->assertTrue($migration_result['status'], 'Migration did not run successfully.');

        // Validate the migrated data.
        $migrated_node = Node::load($migration_result['entity_id']);
        $this->assertNotNull($migrated_node, 'Migrated node not found.');
        $this->assertEquals('Expected Title', $migrated_node->getTitle(), 'Node title does not match.');
        $this->assertEquals('Expected Body', $migrated_node->get('body')->value, 'Node body does not match.');
    }

    /**
     * Run the migration and return the result.
     *
     * @param string $migration_id
     *   The ID of the migration to run.
     *
     * @return array
     *   The result of the migration.
     */
    protected function runMigration($migration_id)
    {
        // Implement the logic to run the migration and return the result.
        // This is a placeholder function and needs to be implemented.
        return [
            'status' => true,
            'entity_id' => 1, // Replace with the actual entity ID.
        ];
    }
}
        

Test Case: Field Mapping Accuracy

use PHPUnit\Framework\TestCase;
use Drupal\node\Entity\Node;

class FieldMappingTest extends TestCase
{
    /**
     * Test field mapping accuracy.
     */
    public function testFieldMapping()
    {
        // Run the migration.
        $migration_result = $this->runMigration('field_mapping_migration');

        // Validate the migrated data.
        $migrated_node = Node::load($migration_result['entity_id']);
        $this->assertNotNull($migrated_node, 'Migrated node not found.');
        
        // Check field mappings.
        $this->assertEquals('Expected Value', $migrated_node->get('field_example')->value, 'Field mapping does not match.');
    }

    protected function runMigration($migration_id)
    {
        // Implement the logic to run the migration and return the result.
        return [
            'status' => true,
            'entity_id' => 1,
        ];
    }
}
        

Test Case: Duplicate Entries Check

use PHPUnit\Framework\TestCase;
use Drupal\node\Entity\Node;

class DuplicateEntryTest extends TestCase
{
    /**
     * Test for duplicate entries after migration.
     */
    public function testDuplicateEntries()
    {
        // Run the migration.
        $migration_result = $this->runMigration('duplicate_entry_migration');

        // Validate the migrated data.
        $migrated_node = Node::load($migration_result['entity_id']);
        $this->assertNotNull($migrated_node, 'Migrated node not found.');
        
        // Check for duplicate entries.
        $duplicate_nodes = \Drupal::entityTypeManager()->getStorage('node')->loadByProperties([
            'title' => 'Expected Title',
        ]);
        $this->assertCount(1, $duplicate_nodes, 'Duplicate entries found.');
    }

    protected function runMigration($migration_id)
    {
        // Implement the logic to run the migration and return the result.
        return [
            'status' => true,
            'entity_id' => 1,
        ];
    }
}
        

Running the Tests

To run your PHPUnit test cases, execute the following command from your Drupal root directory:

phpunit --testsuite=your_test_suite_name        

Make sure to replace your_test_suite_name with the actual name of your test suite.

Conclusion

Writing PHPUnit test cases for your Drupal migrations ensures that your data is accurately and reliably migrated. By automating these tests, you can catch errors early, maintain data integrity, and build confidence in your migration processes. Start incorporating these test cases into your workflow to enhance the quality of your Drupal migrations.

By implementing these test cases, you’ll be able to ensure smoother and more reliable Drupal migrations. Happy testing!