class LayoutEntityHelperTraitTest in Drupal 9

@coversDefaultClass \Drupal\layout_builder\LayoutEntityHelperTrait

@group layout_builder

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitCompatibilityTrait, PhpUnitWarnings
  • class \Drupal\Tests\layout_builder\Unit\LayoutEntityHelperTraitTest

File

core/modules/layout_builder/tests/src/Unit/LayoutEntityHelperTraitTest.php, line 18

Namespace

Drupal\Tests\layout_builder\Unit

class LayoutEntityHelperTraitTest extends UnitTestCase {

  /**
   * Data provider method for tests that need sections with inline blocks.
   */
  public function providerSectionsWithInlineComponents() {
    $components = [];

    // Ensure a non-derivative component is not returned.
    $non_derivative_component = $this
      ->prophesize(SectionComponent::class);
    $non_derivative_component
      ->getPlugin()
      ->willReturn($this
      ->prophesize(PluginInspectionInterface::class)
      ->reveal());
    $components[] = $non_derivative_component
      ->reveal();

    // Ensure a derivative component with a different base Id is not returned.
    $derivative_non_inline_component = $this
      ->prophesize(SectionComponent::class);
    $plugin = $this
      ->prophesize(DerivativeInspectionInterface::class);
    $plugin
      ->getBaseId()
      ->willReturn('some_other_base_id_which_we_do_not_care_about_but_it_is_nothing_personal');
    $derivative_non_inline_component
      ->getPlugin()
      ->willReturn($plugin);
    $components[] = $derivative_non_inline_component
      ->reveal();

    // Ensure that inline block component is returned.
    $inline_component = $this
      ->prophesize(SectionComponent::class);
    $inline_plugin = $this
      ->prophesize(DerivativeInspectionInterface::class)
      ->willImplement(ConfigurableInterface::class);
    $inline_plugin
      ->getBaseId()
      ->willReturn('inline_block');
    $inline_plugin
      ->getConfiguration()
      ->willReturn([
      'block_revision_id' => 'the_revision_id',
    ]);
    $inline_component
      ->getPlugin()
      ->willReturn($inline_plugin
      ->reveal());
    $inline_component = $inline_component
      ->reveal();
    $components[] = $inline_component;

    // Ensure that inline block component without revision is returned.
    $inline_component_without_revision_id = $this
      ->prophesize(SectionComponent::class);
    $inline_plugin_without_revision_id = $this
      ->prophesize(DerivativeInspectionInterface::class)
      ->willImplement(ConfigurableInterface::class);
    $inline_plugin_without_revision_id
      ->getBaseId()
      ->willReturn('inline_block');
    $inline_plugin_without_revision_id
      ->getConfiguration()
      ->willReturn([
      'other_key' => 'other_value',
    ]);
    $inline_component_without_revision_id
      ->getPlugin()
      ->willReturn($inline_plugin_without_revision_id
      ->reveal());
    $inline_component_without_revision_id = $inline_component_without_revision_id
      ->reveal();
    $components[] = $inline_component_without_revision_id;
    $section = $this
      ->prophesize(Section::class);
    $section
      ->getComponents()
      ->willReturn($components);
    $components = [];

    // Ensure that inline block components in all sections are returned.
    $inline_component2 = $this
      ->prophesize(SectionComponent::class);
    $inline_plugin2 = $this
      ->prophesize(DerivativeInspectionInterface::class)
      ->willImplement(ConfigurableInterface::class);
    $inline_plugin2
      ->getBaseId()
      ->willReturn('inline_block');
    $inline_plugin2
      ->getConfiguration()
      ->willReturn([
      'block_revision_id' => 'the_other_revision_id',
    ]);
    $inline_component2
      ->getPlugin()
      ->willReturn($inline_plugin2
      ->reveal());
    $inline_component2 = $inline_component2
      ->reveal();
    $components[] = $inline_component2;
    $section2 = $this
      ->prophesize(Section::class);
    $section2
      ->getComponents()
      ->willReturn($components);
    return [
      [
        [
          $section
            ->reveal(),
          $section2
            ->reveal(),
        ],
        // getInlineBlockComponents() should return inline blocks even if they
        // have no revision Id.
        [
          $inline_component,
          $inline_component_without_revision_id,
          $inline_component2,
        ],
        // getInlineBlockRevisionIdsInSections should just the revision Ids.
        [
          'the_revision_id',
          'the_other_revision_id',
        ],
      ],
    ];
  }

  /**
   * @covers ::getInlineBlockComponents
   *
   * @dataProvider providerSectionsWithInlineComponents
   */
  public function testGetInlineBlockComponents($sections, $expected_components) {
    $test_class = new TestClass();
    $this
      ->assertSame($expected_components, $test_class
      ->getInlineBlockComponents($sections));
  }

  /**
   * @covers ::getInlineBlockRevisionIdsInSections
   *
   * @dataProvider providerSectionsWithInlineComponents
   */
  public function testGetInlineBlockRevisionIdsInSections($sections, $components, $expected_revision_ids) {
    $test_class = new TestClass();
    $this
      ->assertSame($expected_revision_ids, $test_class
      ->getInlineBlockRevisionIdsInSections($sections));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LayoutEntityHelperTraitTest::providerSectionsWithInlineComponents	public	function	Data provider method for tests that need sections with inline blocks.
LayoutEntityHelperTraitTest::testGetInlineBlockComponents	public	function	@covers ::getInlineBlockComponents
LayoutEntityHelperTraitTest::testGetInlineBlockRevisionIdsInSections	public	function	@covers ::getInlineBlockRevisionIdsInSections
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals Deprecated	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUp	protected	function		308
UnitTestCase::setUpBeforeClass	public static	function