Updated Drupal to 8.6. This goes with the following updates because it's possible...

[yaffs-website] / web / core / modules / block_content / tests / src / Kernel / BlockContentEntityReferenceSelectionTest.php

diff --git a/web/core/modules/block_content/tests/src/Kernel/BlockContentEntityReferenceSelectionTest.php b/web/core/modules/block_content/tests/src/Kernel/BlockContentEntityReferenceSelectionTest.php
new file mode 100644 (file)
index 0000000..e593336
--- /dev/null
+++ b/web/core/modules/block_content/tests/src/Kernel/BlockContentEntityReferenceSelectionTest.php
@@ -0,0 +1,189 @@
+<?php
+
+namespace Drupal\Tests\block_content\Kernel;
+
+use Drupal\block_content\Entity\BlockContent;
+use Drupal\block_content\Entity\BlockContentType;
+use Drupal\block_content_test\Plugin\EntityReferenceSelection\TestSelection;
+use Drupal\KernelTests\KernelTestBase;
+
+/**
+ * Tests EntityReference selection handlers don't return non-reusable blocks.
+ *
+ * @see block_content_query_entity_reference_alter()
+ *
+ * @group block_content
+ */
+class BlockContentEntityReferenceSelectionTest extends KernelTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = [
+    'block',
+    'block_content',
+    'block_content_test',
+    'system',
+    'user',
+  ];
+
+  /**
+   * The entity type manager.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * Test reusable block.
+   *
+   * @var \Drupal\block_content\BlockContentInterface
+   */
+  protected $blockReusable;
+
+  /**
+   * Test non-reusable block.
+   *
+   * @var \Drupal\block_content\BlockContentInterface
+   */
+  protected $blockNonReusable;
+
+  /**
+   * Test selection handler.
+   *
+   * @var \Drupal\block_content_test\Plugin\EntityReferenceSelection\TestSelection
+   */
+  protected $selectionHandler;
+
+  /**
+   * Test block expectations.
+   *
+   * @var array
+   */
+  protected $expectations;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setUp() {
+    parent::setUp();
+    $this->installSchema('system', ['sequence']);
+    $this->installSchema('system', ['sequences']);
+    $this->installEntitySchema('user');
+    $this->installEntitySchema('block_content');
+
+    // Create a block content type.
+    $block_content_type = BlockContentType::create([
+      'id' => 'spiffy',
+      'label' => 'Mucho spiffy',
+      'description' => "Provides a block type that increases your site's spiffiness by up to 11%",
+    ]);
+    $block_content_type->save();
+    $this->entityTypeManager = $this->container->get('entity_type.manager');
+
+    // And reusable block content entities.
+    $this->blockReusable = BlockContent::create([
+      'info' => 'Reusable Block',
+      'type' => 'spiffy',
+    ]);
+    $this->blockReusable->save();
+    $this->blockNonReusable = BlockContent::create([
+      'info' => 'Non-reusable Block',
+      'type' => 'spiffy',
+      'reusable' => FALSE,
+    ]);
+    $this->blockNonReusable->save();
+
+    $configuration = [
+      'target_type' => 'block_content',
+      'target_bundles' => ['spiffy' => 'spiffy'],
+      'sort' => ['field' => '_none'],
+    ];
+    $this->selectionHandler = new TestSelection($configuration, '', '', $this->container->get('entity.manager'), $this->container->get('module_handler'), \Drupal::currentUser());
+
+    // Setup the 3 expectation cases.
+    $this->expectations = [
+      'both_blocks' => [
+        'spiffy' => [
+          $this->blockReusable->id() => $this->blockReusable->label(),
+          $this->blockNonReusable->id() => $this->blockNonReusable->label(),
+        ],
+      ],
+      'block_reusable' => ['spiffy' => [$this->blockReusable->id() => $this->blockReusable->label()]],
+      'block_non_reusable' => ['spiffy' => [$this->blockNonReusable->id() => $this->blockNonReusable->label()]],
+    ];
+  }
+
+  /**
+   * Tests to make sure queries without the expected tags are not altered.
+   *
+   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
+   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
+   */
+  public function testQueriesNotAltered() {
+    // Ensure that queries without all the tags are not altered.
+    $query = $this->entityTypeManager->getStorage('block_content')->getQuery();
+    $this->assertCount(2, $query->execute());
+
+    $query = $this->entityTypeManager->getStorage('block_content')->getQuery();
+    $query->addTag('block_content_access');
+    $this->assertCount(2, $query->execute());
+
+    $query = $this->entityTypeManager->getStorage('block_content')->getQuery();
+    $query->addTag('entity_query_block_content');
+    $this->assertCount(2, $query->execute());
+  }
+
+  /**
+   * Test with no conditions set.
+   *
+   * @throws \Drupal\Core\Entity\EntityStorageException
+   */
+  public function testNoConditions() {
+    $this->assertEquals(
+      $this->expectations['block_reusable'],
+      $this->selectionHandler->getReferenceableEntities()
+    );
+
+    $this->blockNonReusable->setReusable();
+    $this->blockNonReusable->save();
+
+    // Ensure that the block is now returned as a referenceable entity.
+    $this->assertEquals(
+      $this->expectations['both_blocks'],
+      $this->selectionHandler->getReferenceableEntities()
+    );
+  }
+
+  /**
+   * Tests setting 'reusable' condition on different levels.
+   *
+   * @dataProvider fieldConditionProvider
+   *
+   * @throws \Exception
+   */
+  public function testFieldConditions($condition_type, $is_reusable) {
+    $this->selectionHandler->setTestMode($condition_type, $is_reusable);
+    $this->assertEquals(
+      $is_reusable ? $this->expectations['block_reusable'] : $this->expectations['block_non_reusable'],
+      $this->selectionHandler->getReferenceableEntities()
+    );
+  }
+
+  /**
+   * Provides possible fields and condition types.
+   */
+  public function fieldConditionProvider() {
+    $cases = [];
+    foreach (['base', 'group', 'nested_group'] as $condition_type) {
+      foreach ([TRUE, FALSE] as $reusable) {
+        $cases["$condition_type:" . ($reusable ? 'reusable' : 'non-reusable')] = [
+          $condition_type,
+          $reusable,
+        ];
+      }
+    }
+    return $cases;
+  }
+
+}