Updated to Drupal 8.5. Core Media not yet in use.
[yaffs-website] / web / core / modules / layout_builder / tests / src / Unit / DefaultsSectionStorageTest.php
diff --git a/web/core/modules/layout_builder/tests/src/Unit/DefaultsSectionStorageTest.php b/web/core/modules/layout_builder/tests/src/Unit/DefaultsSectionStorageTest.php
new file mode 100644 (file)
index 0000000..995483f
--- /dev/null
@@ -0,0 +1,356 @@
+<?php
+
+namespace Drupal\Tests\layout_builder\Unit;
+
+use Drupal\Core\Entity\EntityStorageInterface;
+use Drupal\Core\Entity\EntityType;
+use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
+use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Entity\FieldableEntityInterface;
+use Drupal\layout_builder\Entity\LayoutBuilderSampleEntityGenerator;
+use Drupal\layout_builder\Plugin\SectionStorage\DefaultsSectionStorage;
+use Drupal\layout_builder\SectionStorage\SectionStorageDefinition;
+use Drupal\Tests\UnitTestCase;
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * @coversDefaultClass \Drupal\layout_builder\Plugin\SectionStorage\DefaultsSectionStorage
+ *
+ * @group layout_builder
+ */
+class DefaultsSectionStorageTest extends UnitTestCase {
+
+  /**
+   * The plugin.
+   *
+   * @var \Drupal\layout_builder\Plugin\SectionStorage\DefaultsSectionStorage
+   */
+  protected $plugin;
+
+  /**
+   * The entity manager.
+   *
+   * @var \Drupal\Core\Entity\EntityManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    $this->entityTypeManager = $this->prophesize(EntityTypeManagerInterface::class);
+    $entity_type_bundle_info = $this->prophesize(EntityTypeBundleInfoInterface::class);
+    $sample_entity_generator = $this->prophesize(LayoutBuilderSampleEntityGenerator::class);
+
+    $definition = new SectionStorageDefinition([
+      'id' => 'defaults',
+      'class' => DefaultsSectionStorage::class,
+    ]);
+    $this->plugin = new DefaultsSectionStorage([], '', $definition, $this->entityTypeManager->reveal(), $entity_type_bundle_info->reveal(), $sample_entity_generator->reveal());
+  }
+
+  /**
+   * @covers ::extractIdFromRoute
+   *
+   * @dataProvider providerTestExtractIdFromRoute
+   */
+  public function testExtractIdFromRoute($expected, $value, array $defaults) {
+    $result = $this->plugin->extractIdFromRoute($value, [], 'the_parameter_name', $defaults);
+    $this->assertSame($expected, $result);
+  }
+
+  /**
+   * Provides data for ::testExtractIdFromRoute().
+   */
+  public function providerTestExtractIdFromRoute() {
+    $data = [];
+    $data['with value'] = [
+      'foo.bar.baz',
+      'foo.bar.baz',
+      [],
+    ];
+    $data['empty value, without bundle'] = [
+      'my_entity_type.bundle_name.default',
+      '',
+      [
+        'entity_type_id' => 'my_entity_type',
+        'view_mode_name' => 'default',
+        'bundle_key' => 'my_bundle',
+        'my_bundle' => 'bundle_name',
+      ],
+    ];
+    $data['empty value, with bundle'] = [
+      'my_entity_type.bundle_name.default',
+      '',
+      [
+        'entity_type_id' => 'my_entity_type',
+        'view_mode_name' => 'default',
+        'bundle' => 'bundle_name',
+      ],
+    ];
+    $data['without value, empty defaults'] = [
+      NULL,
+      '',
+      [],
+    ];
+    return $data;
+  }
+
+  /**
+   * @covers ::getSectionListFromId
+   *
+   * @dataProvider providerTestGetSectionListFromId
+   */
+  public function testGetSectionListFromId($success, $expected_entity_id, $value) {
+    if ($expected_entity_id) {
+      $entity_storage = $this->prophesize(EntityStorageInterface::class);
+      $entity_storage->load($expected_entity_id)->willReturn('the_return_value');
+
+      $this->entityTypeManager->getDefinition('entity_view_display')->willReturn(new EntityType(['id' => 'entity_view_display']));
+      $this->entityTypeManager->getStorage('entity_view_display')->willReturn($entity_storage->reveal());
+    }
+    else {
+      $this->entityTypeManager->getDefinition('entity_view_display')->shouldNotBeCalled();
+      $this->entityTypeManager->getStorage('entity_view_display')->shouldNotBeCalled();
+    }
+
+    if (!$success) {
+      $this->setExpectedException(\InvalidArgumentException::class);
+    }
+
+    $result = $this->plugin->getSectionListFromId($value);
+    if ($success) {
+      $this->assertEquals('the_return_value', $result);
+    }
+  }
+
+  /**
+   * Provides data for ::testGetSectionListFromId().
+   */
+  public function providerTestGetSectionListFromId() {
+    $data = [];
+    $data['with value'] = [
+      TRUE,
+      'foo.bar.baz',
+      'foo.bar.baz',
+    ];
+    $data['without value, empty defaults'] = [
+      FALSE,
+      NULL,
+      '',
+    ];
+    return $data;
+  }
+
+  /**
+   * @covers ::getSectionListFromId
+   */
+  public function testGetSectionListFromIdCreate() {
+    $expected = 'the_return_value';
+    $value = 'foo.bar.baz';
+    $expected_create_values = [
+      'targetEntityType' => 'foo',
+      'bundle' => 'bar',
+      'mode' => 'baz',
+      'status' => TRUE,
+    ];
+    $entity_storage = $this->prophesize(EntityStorageInterface::class);
+    $entity_storage->load($value)->willReturn(NULL);
+    $entity_storage->create($expected_create_values)->willReturn($expected);
+
+    $this->entityTypeManager->getDefinition('entity_view_display')->willReturn(new EntityType(['id' => 'entity_view_display']));
+    $this->entityTypeManager->getStorage('entity_view_display')->willReturn($entity_storage->reveal());
+
+    $result = $this->plugin->getSectionListFromId($value);
+    $this->assertSame($expected, $result);
+  }
+
+  /**
+   * @covers ::buildRoutes
+   * @covers ::getEntityTypes
+   */
+  public function testBuildRoutes() {
+    $entity_types = [];
+
+    $not_fieldable = $this->prophesize(EntityTypeInterface::class);
+    $not_fieldable->entityClassImplements(FieldableEntityInterface::class)->willReturn(FALSE);
+    $entity_types['not_fieldable'] = $not_fieldable->reveal();
+
+    $no_view_builder = $this->prophesize(EntityTypeInterface::class);
+    $no_view_builder->entityClassImplements(FieldableEntityInterface::class)->willReturn(TRUE);
+    $no_view_builder->hasViewBuilderClass()->willReturn(FALSE);
+    $entity_types['no_view_builder'] = $no_view_builder->reveal();
+
+    $no_field_ui_route = $this->prophesize(EntityTypeInterface::class);
+    $no_field_ui_route->entityClassImplements(FieldableEntityInterface::class)->willReturn(TRUE);
+    $no_field_ui_route->hasViewBuilderClass()->willReturn(TRUE);
+    $no_field_ui_route->get('field_ui_base_route')->willReturn(NULL);
+    $entity_types['no_field_ui_route'] = $no_field_ui_route->reveal();
+
+    $unknown_field_ui_route = $this->prophesize(EntityTypeInterface::class);
+    $unknown_field_ui_route->entityClassImplements(FieldableEntityInterface::class)->willReturn(TRUE);
+    $unknown_field_ui_route->hasViewBuilderClass()->willReturn(TRUE);
+    $unknown_field_ui_route->get('field_ui_base_route')->willReturn('unknown');
+    $entity_types['unknown_field_ui_route'] = $unknown_field_ui_route->reveal();
+
+    $with_bundle_key = $this->prophesize(EntityTypeInterface::class);
+    $with_bundle_key->entityClassImplements(FieldableEntityInterface::class)->willReturn(TRUE);
+    $with_bundle_key->hasViewBuilderClass()->willReturn(TRUE);
+    $with_bundle_key->get('field_ui_base_route')->willReturn('known');
+    $with_bundle_key->hasKey('bundle')->willReturn(TRUE);
+    $with_bundle_key->getBundleEntityType()->willReturn('my_bundle_type');
+    $entity_types['with_bundle_key'] = $with_bundle_key->reveal();
+
+    $with_bundle_parameter = $this->prophesize(EntityTypeInterface::class);
+    $with_bundle_parameter->entityClassImplements(FieldableEntityInterface::class)->willReturn(TRUE);
+    $with_bundle_parameter->hasViewBuilderClass()->willReturn(TRUE);
+    $with_bundle_parameter->get('field_ui_base_route')->willReturn('with_bundle');
+    $entity_types['with_bundle_parameter'] = $with_bundle_parameter->reveal();
+    $this->entityTypeManager->getDefinitions()->willReturn($entity_types);
+
+    $expected = [
+      'known' => new Route('/admin/entity/whatever', [], [], ['_admin_route' => TRUE]),
+      'with_bundle' => new Route('/admin/entity/{bundle}'),
+      'layout_builder.defaults.with_bundle_key.view' => new Route(
+        '/admin/entity/whatever/display-layout/{view_mode_name}',
+        [
+          'entity_type_id' => 'with_bundle_key',
+          'bundle_key' => 'my_bundle_type',
+          'section_storage_type' => 'defaults',
+          'section_storage' => '',
+          'is_rebuilding' => FALSE,
+          '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout',
+          '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title',
+        ],
+        [
+          '_field_ui_view_mode_access' => 'administer with_bundle_key display',
+          '_has_layout_section' => 'true',
+        ],
+        [
+          'parameters' => [
+            'section_storage' => ['layout_builder_tempstore' => TRUE],
+          ],
+          '_layout_builder' => TRUE,
+          '_admin_route' => FALSE,
+        ]
+      ),
+      'layout_builder.defaults.with_bundle_key.save' => new Route(
+        '/admin/entity/whatever/display-layout/{view_mode_name}/save',
+        [
+          'entity_type_id' => 'with_bundle_key',
+          'bundle_key' => 'my_bundle_type',
+          'section_storage_type' => 'defaults',
+          'section_storage' => '',
+          '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout',
+        ],
+        [
+          '_field_ui_view_mode_access' => 'administer with_bundle_key display',
+          '_has_layout_section' => 'true',
+        ],
+        [
+          'parameters' => [
+            'section_storage' => ['layout_builder_tempstore' => TRUE],
+          ],
+          '_layout_builder' => TRUE,
+          '_admin_route' => FALSE,
+        ]
+      ),
+      'layout_builder.defaults.with_bundle_key.cancel' => new Route(
+        '/admin/entity/whatever/display-layout/{view_mode_name}/cancel',
+        [
+          'entity_type_id' => 'with_bundle_key',
+          'bundle_key' => 'my_bundle_type',
+          'section_storage_type' => 'defaults',
+          'section_storage' => '',
+          '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout',
+        ],
+        [
+          '_field_ui_view_mode_access' => 'administer with_bundle_key display',
+          '_has_layout_section' => 'true',
+        ],
+        [
+          'parameters' => [
+            'section_storage' => ['layout_builder_tempstore' => TRUE],
+          ],
+          '_layout_builder' => TRUE,
+          '_admin_route' => FALSE,
+        ]
+      ),
+      'layout_builder.defaults.with_bundle_parameter.view' => new Route(
+        '/admin/entity/{bundle}/display-layout/{view_mode_name}',
+        [
+          'entity_type_id' => 'with_bundle_parameter',
+          'section_storage_type' => 'defaults',
+          'section_storage' => '',
+          'is_rebuilding' => FALSE,
+          '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout',
+          '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title',
+        ],
+        [
+          '_field_ui_view_mode_access' => 'administer with_bundle_parameter display',
+          '_has_layout_section' => 'true',
+        ],
+        [
+          'parameters' => [
+            'section_storage' => ['layout_builder_tempstore' => TRUE],
+          ],
+          '_layout_builder' => TRUE,
+          '_admin_route' => FALSE,
+        ]
+      ),
+      'layout_builder.defaults.with_bundle_parameter.save' => new Route(
+        '/admin/entity/{bundle}/display-layout/{view_mode_name}/save',
+        [
+          'entity_type_id' => 'with_bundle_parameter',
+          'section_storage_type' => 'defaults',
+          'section_storage' => '',
+          '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout',
+        ],
+        [
+          '_field_ui_view_mode_access' => 'administer with_bundle_parameter display',
+          '_has_layout_section' => 'true',
+        ],
+        [
+          'parameters' => [
+            'section_storage' => ['layout_builder_tempstore' => TRUE],
+          ],
+          '_layout_builder' => TRUE,
+          '_admin_route' => FALSE,
+        ]
+      ),
+      'layout_builder.defaults.with_bundle_parameter.cancel' => new Route(
+        '/admin/entity/{bundle}/display-layout/{view_mode_name}/cancel',
+        [
+          'entity_type_id' => 'with_bundle_parameter',
+          'section_storage_type' => 'defaults',
+          'section_storage' => '',
+          '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout',
+        ],
+        [
+          '_field_ui_view_mode_access' => 'administer with_bundle_parameter display',
+          '_has_layout_section' => 'true',
+        ],
+        [
+          'parameters' => [
+            'section_storage' => ['layout_builder_tempstore' => TRUE],
+          ],
+          '_layout_builder' => TRUE,
+          '_admin_route' => FALSE,
+        ]
+      ),
+    ];
+
+    $collection = new RouteCollection();
+    $collection->add('known', new Route('/admin/entity/whatever', [], [], ['_admin_route' => TRUE]));
+    $collection->add('with_bundle', new Route('/admin/entity/{bundle}'));
+
+    $this->plugin->buildRoutes($collection);
+    $this->assertEquals($expected, $collection->all());
+    $this->assertSame(array_keys($expected), array_keys($collection->all()));
+  }
+
+}