Updated to Drupal 8.5. Core Media not yet in use.

[yaffs-website] / web / core / modules / layout_builder / tests / src / Kernel / FieldBlockTest.php

diff --git a/web/core/modules/layout_builder/tests/src/Kernel/FieldBlockTest.php b/web/core/modules/layout_builder/tests/src/Kernel/FieldBlockTest.php
new file mode 100644 (file)
index 0000000..8c529cc
--- /dev/null
+++ b/web/core/modules/layout_builder/tests/src/Kernel/FieldBlockTest.php
@@ -0,0 +1,199 @@
+<?php
+
+namespace Drupal\Tests\layout_builder\Kernel;
+
+use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Entity\EntityFieldManagerInterface;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\FieldableEntityInterface;
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\Core\Field\FieldItemListInterface;
+use Drupal\Core\Field\FormatterPluginManager;
+use Drupal\Core\Plugin\Context\ContextDefinition;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\KernelTests\Core\Entity\EntityKernelTestBase;
+use Drupal\layout_builder\Plugin\Block\FieldBlock;
+use Prophecy\Prophecy\ProphecyInterface;
+
+/**
+ * @coversDefaultClass \Drupal\layout_builder\Plugin\Block\FieldBlock
+ * @group Field
+ */
+class FieldBlockTest extends EntityKernelTestBase {
+
+  /**
+   * Tests entity access.
+   *
+   * @covers ::blockAccess
+   * @dataProvider providerTestBlockAccessNotAllowed
+   */
+  public function testBlockAccessEntityNotAllowed($expected, $entity_access) {
+    $entity = $this->prophesize(FieldableEntityInterface::class);
+    $block = $this->getTestBlock($entity);
+
+    $account = $this->prophesize(AccountInterface::class);
+    $entity->access('view', $account->reveal(), TRUE)->willReturn($entity_access);
+    $entity->hasField()->shouldNotBeCalled();
+
+    $access = $block->access($account->reveal(), TRUE);
+    $this->assertSame($expected, $access->isAllowed());
+  }
+
+  /**
+   * Provides test data for ::testBlockAccessEntityNotAllowed().
+   */
+  public function providerTestBlockAccessNotAllowed() {
+    $data = [];
+    $data['entity_forbidden'] = [
+      FALSE,
+      AccessResult::forbidden(),
+    ];
+    $data['entity_neutral'] = [
+      FALSE,
+      AccessResult::neutral(),
+    ];
+    return $data;
+  }
+
+  /**
+   * Tests unfieldable entity.
+   *
+   * @covers ::blockAccess
+   */
+  public function testBlockAccessEntityAllowedNotFieldable() {
+    $entity = $this->prophesize(EntityInterface::class);
+    $block = $this->getTestBlock($entity);
+
+    $account = $this->prophesize(AccountInterface::class);
+    $entity->access('view', $account->reveal(), TRUE)->willReturn(AccessResult::allowed());
+
+    $access = $block->access($account->reveal(), TRUE);
+    $this->assertSame(FALSE, $access->isAllowed());
+  }
+
+  /**
+   * Tests fieldable entity without a particular field.
+   *
+   * @covers ::blockAccess
+   */
+  public function testBlockAccessEntityAllowedNoField() {
+    $entity = $this->prophesize(FieldableEntityInterface::class);
+    $block = $this->getTestBlock($entity);
+
+    $account = $this->prophesize(AccountInterface::class);
+    $entity->access('view', $account->reveal(), TRUE)->willReturn(AccessResult::allowed());
+    $entity->hasField('the_field_name')->willReturn(FALSE);
+    $entity->get('the_field_name')->shouldNotBeCalled();
+
+    $access = $block->access($account->reveal(), TRUE);
+    $this->assertSame(FALSE, $access->isAllowed());
+  }
+
+  /**
+   * Tests field access.
+   *
+   * @covers ::blockAccess
+   * @dataProvider providerTestBlockAccessNotAllowed
+   */
+  public function testBlockAccessEntityAllowedFieldNotAllowed($expected, $field_access) {
+    $entity = $this->prophesize(FieldableEntityInterface::class);
+    $block = $this->getTestBlock($entity);
+
+    $account = $this->prophesize(AccountInterface::class);
+    $entity->access('view', $account->reveal(), TRUE)->willReturn(AccessResult::allowed());
+    $entity->hasField('the_field_name')->willReturn(TRUE);
+    $field = $this->prophesize(FieldItemListInterface::class);
+    $entity->get('the_field_name')->willReturn($field->reveal());
+
+    $field->access('view', $account->reveal(), TRUE)->willReturn($field_access);
+    $field->isEmpty()->shouldNotBeCalled();
+
+    $access = $block->access($account->reveal(), TRUE);
+    $this->assertSame($expected, $access->isAllowed());
+  }
+
+  /**
+   * Tests populated vs empty build.
+   *
+   * @covers ::blockAccess
+   * @covers ::build
+   * @dataProvider providerTestBlockAccessEntityAllowedFieldHasValue
+   */
+  public function testBlockAccessEntityAllowedFieldHasValue($expected, $is_empty) {
+    $entity = $this->prophesize(FieldableEntityInterface::class);
+    $block = $this->getTestBlock($entity);
+
+    $account = $this->prophesize(AccountInterface::class);
+    $entity->access('view', $account->reveal(), TRUE)->willReturn(AccessResult::allowed());
+    $entity->hasField('the_field_name')->willReturn(TRUE);
+    $field = $this->prophesize(FieldItemListInterface::class);
+    $entity->get('the_field_name')->willReturn($field->reveal());
+
+    $field->access('view', $account->reveal(), TRUE)->willReturn(AccessResult::allowed());
+    $field->isEmpty()->willReturn($is_empty)->shouldBeCalled();
+
+    $access = $block->access($account->reveal(), TRUE);
+    $this->assertSame($expected, $access->isAllowed());
+  }
+
+  /**
+   * Provides test data for ::testBlockAccessEntityAllowedFieldHasValue().
+   */
+  public function providerTestBlockAccessEntityAllowedFieldHasValue() {
+    $data = [];
+    $data['empty'] = [
+      FALSE,
+      TRUE,
+    ];
+    $data['populated'] = [
+      TRUE,
+      FALSE,
+    ];
+    return $data;
+  }
+
+  /**
+   * Instantiates a block for testing.
+   *
+   * @param \Prophecy\Prophecy\ProphecyInterface $entity_prophecy
+   *   An entity prophecy for use as an entity context value.
+   * @param array $configuration
+   *   A configuration array containing information about the plugin instance.
+   * @param array $plugin_definition
+   *   The plugin implementation definition.
+   *
+   * @return \Drupal\layout_builder\Plugin\Block\FieldBlock
+   *   The block to test.
+   */
+  protected function getTestBlock(ProphecyInterface $entity_prophecy, array $configuration = [], array $plugin_definition = []) {
+    $entity_prophecy->getCacheContexts()->willReturn([]);
+    $entity_prophecy->getCacheTags()->willReturn([]);
+    $entity_prophecy->getCacheMaxAge()->willReturn(0);
+
+    $plugin_definition += [
+      'provider' => 'test',
+      'default_formatter' => '',
+      'category' => 'Test',
+      'admin_label' => 'Test Block',
+      'bundles' => ['entity_test'],
+      'context' => [
+        'entity' => new ContextDefinition('entity:entity_test', 'Test', TRUE),
+      ],
+    ];
+    $entity_field_manager = $this->prophesize(EntityFieldManagerInterface::class);
+    $formatter_manager = $this->prophesize(FormatterPluginManager::class);
+    $module_handler = $this->prophesize(ModuleHandlerInterface::class);
+
+    $block = new FieldBlock(
+      $configuration,
+      'field_block:entity_test:entity_test:the_field_name',
+      $plugin_definition,
+      $entity_field_manager->reveal(),
+      $formatter_manager->reveal(),
+      $module_handler->reveal()
+    );
+    $block->setContextValue('entity', $entity_prophecy->reveal());
+    return $block;
+  }
+
+}