LayoutBuilderCompatibilityTestBase.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\layout_builder\Kernel;

use Drupal\Core\Entity\Entity\EntityViewDisplay;
use Drupal\Core\Entity\EntityInterface;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\KernelTests\Core\Entity\EntityKernelTestBase;

/**
 * Tests Layout Builder's compatibility with existing systems.
 */
abstract class LayoutBuilderCompatibilityTestBase extends EntityKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'layout_discovery',
    ];
    
    /**
     * The entity view display.
     *
     * @var \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface
     */
    protected $display;
    
    /**
     * The entity being rendered.
     *
     * @var \Drupal\Core\Entity\FieldableEntityInterface
     */
    protected $entity;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('entity_test_base_field_display');
        $this->installConfig([
            'filter',
        ]);
        // Set up a non-admin user that is allowed to view test entities.
        \Drupal::currentUser()->setAccount($this->createUser([
            'view test entity',
        ], NULL, FALSE, [
            'uid' => 2,
        ]));
        \Drupal::service('theme_installer')->install([
            'starterkit_theme',
        ]);
        $this->config('system.theme')
            ->set('default', 'starterkit_theme')
            ->save();
        $field_storage = FieldStorageConfig::create([
            'entity_type' => 'entity_test_base_field_display',
            'field_name' => 'test_field_display_configurable',
            'type' => 'boolean',
        ]);
        $field_storage->save();
        FieldConfig::create([
            'field_storage' => $field_storage,
            'bundle' => 'entity_test_base_field_display',
            'label' => 'FieldConfig with configurable display',
        ])->save();
        $this->display = EntityViewDisplay::create([
            'targetEntityType' => 'entity_test_base_field_display',
            'bundle' => 'entity_test_base_field_display',
            'mode' => 'default',
            'status' => TRUE,
        ]);
        $this->display
            ->setComponent('test_field_display_configurable', [
            'weight' => 5,
        ])
            ->save();
        // Create an entity with fields that are configurable and non-configurable.
        $entity_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('entity_test_base_field_display');
        // @todo Remove langcode workarounds after resolving
        //   https://www.drupal.org/node/2915034.
        $this->entity = $entity_storage->createWithSampleValues('entity_test_base_field_display', [
            'langcode' => 'en',
            'langcode_default' => TRUE,
        ]);
        $this->entity
            ->save();
    }
    
    /**
     * Installs the Layout Builder.
     *
     * Also configures and reloads the entity display.
     */
    protected function installLayoutBuilder() {
        $this->container
            ->get('module_installer')
            ->install([
            'layout_builder',
        ]);
        $this->refreshServices();
        $this->display = $this->reloadEntity($this->display);
        $this->display
            ->enableLayoutBuilder()
            ->save();
        $this->entity = $this->reloadEntity($this->entity);
    }
    
    /**
     * Enables overrides for the display and reloads the entity.
     */
    protected function enableOverrides() {
        $this->display
            ->setOverridable()
            ->save();
        $this->entity = $this->reloadEntity($this->entity);
    }
    
    /**
     * Asserts that the rendered entity has the correct fields.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity to render.
     * @param array $attributes
     *   An array of field attributes to assert.
     */
    protected function assertFieldAttributes(EntityInterface $entity, array $attributes) {
        $view_builder = $this->container
            ->get('entity_type.manager')
            ->getViewBuilder($entity->getEntityTypeId());
        $build = $view_builder->view($entity);
        $this->render($build);
        $actual = array_map(function (\SimpleXMLElement $element) {
            return (string) $element->attributes();
        }, $this->cssSelect('.field'));
        $this->assertSame($attributes, $actual);
    }

}