test_support-1.0.x-dev/tests/src/Kernel/Installs/InstallsFieldsTest.php

<?php

namespace Drupal\Tests\test_support\Kernel\Installs;

use Drupal\KernelTests\KernelTestBase;
use Drupal\node\NodeInterface;
use Drupal\Tests\test_support\Traits\Installs\InstallsEntityTypes;
use Drupal\Tests\test_support\Traits\Installs\InstallsFields;

class InstallsFieldsTest extends KernelTestBase
{
    use InstallsEntityTypes;
    use InstallsFields;

    /** @var string[] */
    protected static $modules = [
        'system',
        'node',
        'user',
    ];

    protected function setUp(): void
    {
        parent::setUp();

        $this->installEntitySchema('user');
        $this->installEntitySchema('node');
    }

    /** @test */
    public function installing_field_sets_up_dependencies(): void
    {
        $this->assertFalse($this->container->get('module_handler')->moduleExists('field'));

        $this->enableModules([
            'text',
        ]);

        $this->setConfigDirectory(__DIR__ . '/__fixtures__/config/sync/node/bundles');
        $this->installBundles('node', 'page');

        $this->setConfigDirectory(__DIR__ . '/__fixtures__/config/sync/node/fields');

        $nodeStorage = $this->container->get('entity_type.manager')->getStorage('node');

        $node = $nodeStorage->create([
            'nid' => 1,
            'type' => 'page',
            'title' => 'Node',
        ]);
        $node->save();

        $this->installField('body', 'node', 'page');

        $this->assertTrue($this->loadNode(1)->hasField('body'));

        $this->assertTrue($this->container->get('module_handler')->moduleExists('field'));
    }

    /** @test */
    public function install_single_field(): void
    {
        $this->enableModules([
            'text',
        ]);

        $this->setConfigDirectory(__DIR__ . '/__fixtures__/config/sync/node/bundles');
        $this->installBundles('node', 'page');

        $this->setConfigDirectory(__DIR__ . '/__fixtures__/config/sync/node/fields');

        $nodeStorage = $this->container->get('entity_type.manager')->getStorage('node');

        $node = $nodeStorage->create([
            'nid' => 1,
            'type' => 'page',
            'title' => 'Node',
        ]);
        $node->save();

        $this->assertFalse($node->hasField('body'));

        $this->installField('body', 'node', 'page');

        $this->assertTrue($this->loadNode(1)->hasField('body'));
    }

    /** @test */
    public function install_multiple_fields(): void
    {
        $this->enableModules([
            'text',
        ]);

        $this->setConfigDirectory(__DIR__ . '/__fixtures__/config/sync/node/bundles');
        $this->installBundles('node', 'page');

        $this->setConfigDirectory(__DIR__ . '/__fixtures__/config/sync/node/fields');

        $nodeStorage = $this->container->get('entity_type.manager')->getStorage('node');

        $node = $nodeStorage->create([
            'nid' => 1,
            'type' => 'page',
            'title' => 'Node',
        ]);
        $node->save();

        $this->assertFalse($node->hasField('body'));
        $this->assertFalse($node->hasField('field_boolean'));

        $this->installFields([
            'body',
            'field_boolean_field',
        ], 'node', 'page');

        $this->assertTrue($this->loadNode(1)->hasField('body'));
        $this->assertTrue($this->loadNode(1)->hasField('field_boolean_field'));
    }

    /** @test */
    public function install_all_fields_for_entity(): void
    {
        $this->enableModules([
            'text',
        ]);

        $this->setConfigDirectory(__DIR__ . '/__fixtures__/config/sync/node/bundles');
        $this->installBundles('node', 'page');

        $this->setConfigDirectory(__DIR__ . '/__fixtures__/config/sync/node/fields');

        $nodeStorage = $this->container->get('entity_type.manager')->getStorage('node');

        $node = $nodeStorage->create([
            'nid' => 1,
            'type' => 'page',
            'title' => 'Node',
        ]);
        $node->save();

        $this->assertFalse($node->hasField('body'));
        $this->assertFalse($node->hasField('field_boolean'));

        $this->installAllFieldsForEntity('node', 'page');

        $this->assertTrue($this->loadNode(1)->hasField('body'));
        $this->assertTrue($this->loadNode(1)->hasField('field_boolean_field'));
    }

    /** @return NodeInterface<mixed> */
    private function loadNode(int $nodeId): NodeInterface
    {
        $node = $this->container->get('entity_type.manager')->getStorage('node')->load($nodeId);

        if ($node instanceof NodeInterface === false) {
            $this->fail('Could not load node with ID: ' . $nodeId);
        }

        return $node;
    }
}