FieldEntityTest.php

<?php

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

use Drupal\comment\Tests\CommentTestTrait;
use Drupal\Core\Logger\LoggerChannelFactoryInterface;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\node\Entity\Node;
use Drupal\node\NodeInterface;
use Drupal\user\Entity\User;
use Drupal\Tests\views\Functional\ViewTestBase;
use Drupal\views\Tests\ViewTestData;
use Drupal\views\Views;
use Drupal\comment\Entity\Comment;

/**
 * Tests the field plugin base integration with the entity system.
 *
 * @group views
 */
class FieldEntityTest extends ViewTestBase {
    use CommentTestTrait;
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_field_get_entity',
        'test_field_get_entity_null',
    ];
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'node',
        'comment',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp(FALSE, $modules);
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        $this->addDefaultCommentField('node', 'page');
        // Add an entity reference field for the test_field_get_entity_null view.
        FieldStorageConfig::create([
            'field_name' => 'field_test_reference',
            'type' => 'entity_reference',
            'entity_type' => 'node',
            'cardinality' => 1,
            'settings' => [
                'target_type' => 'node',
            ],
        ])->save();
        FieldConfig::create([
            'field_name' => 'field_test_reference',
            'entity_type' => 'node',
            'bundle' => 'page',
            'label' => 'field_test_reference',
            'settings' => [
                'handler' => 'default',
                'handler_settings' => [
                    'target_bundles' => [
                        'page' => 'page',
                    ],
                ],
            ],
        ])->save();
        ViewTestData::createTestViews(static::class, $modules);
    }
    
    /**
     * Tests the getEntity method.
     */
    public function testGetEntity() : void {
        // The view is a view of comments, their nodes and their authors, so there
        // are three layers of entities.
        $account = User::create([
            'name' => $this->randomMachineName(),
            'bundle' => 'user',
        ]);
        $account->save();
        $node = Node::create([
            'uid' => $account->id(),
            'type' => 'page',
            'title' => $this->randomString(),
        ]);
        $node->save();
        $comment = Comment::create([
            'uid' => $account->id(),
            'entity_id' => $node->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
        ]);
        $comment->save();
        $user = $this->drupalCreateUser([
            'access comments',
        ]);
        $this->drupalLogin($user);
        $view = Views::getView('test_field_get_entity');
        $this->executeView($view);
        $row = $view->result[0];
        // Tests entities on the base level.
        $entity = $view->field['cid']
            ->getEntity($row);
        $this->assertEquals($comment->id(), $entity->id(), 'Make sure the right comment entity got loaded.');
        // Tests entities as relationship on first level.
        $entity = $view->field['nid']
            ->getEntity($row);
        $this->assertEquals($node->id(), $entity->id(), 'Make sure the right node entity got loaded.');
        // Tests entities as relationships on second level.
        $entity = $view->field['uid']
            ->getEntity($row);
        $this->assertEquals($account->id(), $entity->id(), 'Make sure the right user entity got loaded.');
    }
    
    /**
     * Tests the getEntity method returning NULL for an optional relationship.
     */
    public function testGetEntityNullEntityOptionalRelationship() : void {
        $nodeReference = Node::create([
            'type' => 'page',
            'title' => $this->randomString(),
            'status' => NodeInterface::PUBLISHED,
        ]);
        $nodeReference->save();
        $node = Node::create([
            'type' => 'page',
            'title' => $this->randomString(),
            'status' => NodeInterface::PUBLISHED,
            'field_test_reference' => [
                'target_id' => $nodeReference->id(),
            ],
        ]);
        $node->save();
        $this->drupalLogin($this->drupalCreateUser([
            'access content',
        ]));
        $view = Views::getView('test_field_get_entity_null');
        $this->executeView($view);
        // Second row will be $node.
        $row = $view->result[1];
        $entity = $view->field['nid']
            ->getEntity($row);
        $this->assertEquals($nodeReference->id(), $entity->id());
        // Tests optional relationships with NULL entities don't log an error.
        $nodeReference->delete();
        // Use a mock logger so we can check that no errors were logged.
        $loggerFactory = $this->createMock(LoggerChannelFactoryInterface::class);
        $loggerFactory->expects($this->never())
            ->method('get');
        $container = \Drupal::getContainer();
        $container->set('logger.factory', $loggerFactory);
        \Drupal::setContainer($container);
        $view = Views::getView('test_field_get_entity_null');
        $this->executeView($view);
        // First row will be $node since the other is now deleted.
        $row = $view->result[0];
        $this->assertNull($view->field['nid']
            ->getEntity($row));
    }

}