UpdateApiEntityDefinitionUpdateTest.php

<?php

namespace Drupal\Tests\system\Functional\Entity\Update;

use Drupal\entity_test\Entity\EntityTest;
use Drupal\Tests\BrowserTestBase;
use Drupal\Tests\system\Functional\Entity\Traits\EntityDefinitionTestTrait;
use Drupal\Tests\system\Functional\Update\DbUpdatesTrait;

/**
 * Tests performing entity updates through the Update API.
 *
 * @group Entity
 */
class UpdateApiEntityDefinitionUpdateTest extends BrowserTestBase {
    use DbUpdatesTrait;
    use EntityDefinitionTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        $admin = $this->drupalCreateUser([], FALSE, TRUE);
        $this->drupalLogin($admin);
    }
    
    /**
     * Tests that individual updates applied sequentially work as expected.
     */
    public function testSingleUpdates() {
        // Create a test entity.
        $user_ids = [
            mt_rand(),
            mt_rand(),
        ];
        $entity = EntityTest::create([
            'name' => $this->randomString(),
            'user_id' => $user_ids,
        ]);
        $entity->save();
        // Check that only a single value is stored for 'user_id'.
        $entity = $this->reloadEntity($entity);
        $this->assertCount(1, $entity->user_id);
        $this->assertEqual($entity->user_id->target_id, $user_ids[0]);
        // Make 'user_id' multiple by applying updates.
        $this->enableUpdates('entity_test', 'entity_definition_updates', 8001);
        $this->applyUpdates();
        // Ensure the 'entity_test__user_id' table got created.
        $this->assertTrue(\Drupal::database()->schema()
            ->tableExists('entity_test__user_id'));
        // Check that data was correctly migrated.
        $entity = $this->reloadEntity($entity);
        $this->assertCount(1, $entity->user_id);
        $this->assertEqual($entity->user_id->target_id, $user_ids[0]);
        // Store multiple data and check it is correctly stored.
        $entity->user_id = $user_ids;
        $entity->save();
        $entity = $this->reloadEntity($entity);
        $this->assertCount(2, $entity->user_id);
        $this->assertEqual($entity->user_id[0]->target_id, $user_ids[0]);
        $this->assertEqual($entity->user_id[1]->target_id, $user_ids[1]);
        // Make 'user_id' single again by applying updates.
        $this->enableUpdates('entity_test', 'entity_definition_updates', 8002);
        $this->applyUpdates();
        // Check that data was correctly migrated/dropped.
        $entity = $this->reloadEntity($entity);
        $this->assertCount(1, $entity->user_id);
        $this->assertEqual($entity->user_id->target_id, $user_ids[0]);
        // Check that only a single value is stored for 'user_id' again.
        $entity->user_id = $user_ids;
        $entity->save();
        $entity = $this->reloadEntity($entity);
        $this->assertCount(1, $entity->user_id);
        $this->assertEqual($entity->user_id[0]->target_id, $user_ids[0]);
    }
    
    /**
     * Tests that multiple updates applied in bulk work as expected.
     */
    public function testMultipleUpdates() {
        // Create a test entity.
        $user_ids = [
            mt_rand(),
            mt_rand(),
        ];
        $entity = EntityTest::create([
            'name' => $this->randomString(),
            'user_id' => $user_ids,
        ]);
        $entity->save();
        // Check that only a single value is stored for 'user_id'.
        $entity = $this->reloadEntity($entity);
        $this->assertCount(1, $entity->user_id);
        $this->assertEqual($entity->user_id->target_id, $user_ids[0]);
        // Make 'user_id' multiple and then single again by applying updates.
        $this->enableUpdates('entity_test', 'entity_definition_updates', 8002);
        $this->applyUpdates();
        // Check that data was correctly migrated back and forth.
        $entity = $this->reloadEntity($entity);
        $this->assertCount(1, $entity->user_id);
        $this->assertEqual($entity->user_id->target_id, $user_ids[0]);
        // Check that only a single value is stored for 'user_id' again.
        $entity->user_id = $user_ids;
        $entity->save();
        $entity = $this->reloadEntity($entity);
        $this->assertCount(1, $entity->user_id);
        $this->assertEqual($entity->user_id[0]->target_id, $user_ids[0]);
    }
    
    /**
     * Tests that entity updates are correctly reported in the status report page.
     */
    public function testStatusReport() {
        // Create a test entity.
        $entity = EntityTest::create([
            'name' => $this->randomString(),
            'user_id' => mt_rand(),
        ]);
        $entity->save();
        // Check that the status report initially displays no error.
        $this->drupalGet('admin/reports/status');
        $this->assertNoRaw('Out of date');
        $this->assertNoRaw('Mismatched entity and/or field definitions');
        // Enable an entity update and check that we have a dedicated status report
        // item.
        $this->container
            ->get('state')
            ->set('entity_test.remove_name_field', TRUE);
        $this->drupalGet('admin/reports/status');
        $this->assertNoRaw('Out of date');
        $this->assertRaw('Mismatched entity and/or field definitions');
        // Enable a db update and check that now the entity update status report
        // item is no longer displayed. We assume an update function will fix the
        // mismatch.
        $this->enableUpdates('entity_test', 'status_report', 8001);
        $this->drupalGet('admin/reports/status');
        $this->assertRaw('Out of date');
        $this->assertRaw('Mismatched entity and/or field definitions');
        // Apply db updates and check that entity updates were not applied.
        $this->applyUpdates();
        $this->drupalGet('admin/reports/status');
        $this->assertNoRaw('Out of date');
        $this->assertRaw('Mismatched entity and/or field definitions');
        // Apply the entity updates and check that the entity update status report
        // item is no longer displayed.
        $this->applyEntityUpdates();
        $this->drupalGet('admin/reports/status');
        $this->assertNoRaw('Out of date');
        $this->assertNoRaw('Mismatched entity and/or field definitions');
    }
    
    /**
     * Reloads the specified entity.
     *
     * @param \Drupal\entity_test\Entity\EntityTest $entity
     *   An entity object.
     *
     * @return \Drupal\entity_test\Entity\EntityTest
     *   The reloaded entity object.
     */
    protected function reloadEntity(EntityTest $entity) {
        \Drupal::entityTypeManager()->useCaches(FALSE);
        \Drupal::service('entity_field.manager')->useCaches(FALSE);
        return EntityTest::load($entity->id());
    }

}