EntityViewControllerTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Functional\Entity;

use Drupal\entity_test\Entity\EntityTest;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests EntityViewController functionality.
 *
 * @group Entity
 */
class EntityViewControllerTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'starterkit_theme';
    
    /**
     * Array of test entities.
     *
     * @var array
     */
    protected $entities = [];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create some dummy entity_test entities.
        for ($i = 0; $i < 2; $i++) {
            $entity_test = $this->createTestEntity('entity_test', 'view revision');
            $entity_test->save();
            $this->entities[] = $entity_test;
        }
        $this->drupalLogin($this->drupalCreateUser([
            'view test entity',
        ]));
    }
    
    /**
     * Tests EntityViewController.
     */
    public function testEntityViewController() : void {
        $get_label_markup = function ($label) {
            return '<h1 class="page-title">
            <div class="field field--name-name field--type-string field--label-hidden field__item">' . $label . '</div>
      </h1>';
        };
        foreach ($this->entities as $entity) {
            $this->drupalGet('entity_test/' . $entity->id());
            $this->assertSession()
                ->pageTextContains($entity->label());
            $this->assertSession()
                ->responseContains($get_label_markup($entity->label()));
            $this->assertSession()
                ->pageTextContains('full');
            $this->drupalGet('entity_test_converter/' . $entity->id());
            $this->assertSession()
                ->pageTextContains($entity->label());
            $this->assertSession()
                ->pageTextContains('full');
            $this->drupalGet('entity_test_no_view_mode/' . $entity->id());
            $this->assertSession()
                ->pageTextContains($entity->label());
            $this->assertSession()
                ->pageTextContains('full');
        }
        // Test viewing a revisionable entity.
        $entity_test_rev = $this->createTestEntity('entity_test_rev');
        $entity_test_rev->save();
        $entity_test_rev->name->value = 'rev 2';
        $entity_test_rev->setNewRevision(TRUE);
        $entity_test_rev->isDefaultRevision(TRUE);
        $entity_test_rev->save();
        $this->drupalGet($entity_test_rev->toUrl('revision'));
        $this->assertSession()
            ->pageTextContains($entity_test_rev->label());
        $this->assertSession()
            ->responseContains($get_label_markup($entity_test_rev->label()));
        // As entity_test IDs must be integers, make sure requests for non-integer
        // IDs return a page not found error.
        $this->drupalGet('entity_test/invalid');
        $this->assertSession()
            ->statusCodeEquals(404);
    }
    
    /**
     * Tests field item attributes.
     */
    public function testFieldItemAttributes() : void {
        // Make sure the test field will be rendered.
        \Drupal::service('entity_display.repository')->getViewDisplay('entity_test', 'entity_test')
            ->setComponent('field_test_text', [
            'type' => 'text_default',
        ])
            ->save();
        // Create an entity and save test value in field_test_text.
        $test_value = $this->randomMachineName();
        $entity = EntityTest::create();
        $entity->field_test_text = $test_value;
        $entity->save();
        // Browse to the entity and verify that the attribute is rendered in the
        // field item HTML markup.
        $this->drupalGet('entity_test/' . $entity->id());
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@data-field-item-attr="foobar" and @property="schema:text"]/p', $test_value);
    }
    
    /**
     * Tests that a view builder can successfully override the view builder.
     */
    public function testEntityViewControllerViewBuilder() : void {
        $entity_test = $this->createTestEntity('entity_test_view_builder');
        $entity_test->save();
        $this->drupalGet('entity_test_view_builder/' . $entity_test->id());
        $this->assertSession()
            ->pageTextContains($entity_test->label());
    }
    
    /**
     * Creates an entity for testing.
     *
     * @param string $entity_type
     *   The entity type.
     * @param string|null $name
     *   The entity name, or NULL to generate random name.
     *
     * @return \Drupal\Core\Entity\EntityInterface
     *   The created entity.
     */
    protected function createTestEntity($entity_type, $name = NULL) {
        $data = [
            'bundle' => $entity_type,
            'name' => $name ?? $this->randomMachineName(),
        ];
        return $this->container
            ->get('entity_type.manager')
            ->getStorage($entity_type)
            ->create($data);
    }

}