public function ConfigEntityTrackingTest::testBlockFieldCustomBlocksTracking in Entity Usage 8.2

Same name and namespace in other branches

1. 8.4 tests/src/FunctionalJavascript/ConfigEntityTrackingTest.php \Drupal\Tests\entity_usage\FunctionalJavascript\ConfigEntityTrackingTest::testBlockFieldCustomBlocksTracking()
2. 8.3 tests/src/FunctionalJavascript/ConfigEntityTrackingTest.php \Drupal\Tests\entity_usage\FunctionalJavascript\ConfigEntityTrackingTest::testBlockFieldCustomBlocksTracking()

Tests block_field / custom_blocks tracking.

File

tests/src/FunctionalJavascript/ConfigEntityTrackingTest.php, line 275

Class

ConfigEntityTrackingTest

Tests tracking of config entities.

Namespace

Drupal\Tests\entity_usage\FunctionalJavascript

Code

public function testBlockFieldCustomBlocksTracking() {

  // Create block field on the node type.
  $storage = FieldStorageConfig::create([
    'field_name' => 'field_eu_test_related_blocks',
    'entity_type' => 'node',
    'type' => 'block_field',
  ]);
  $storage
    ->save();
  FieldConfig::create([
    'bundle' => 'eu_test_ct',
    'entity_type' => 'node',
    'field_name' => 'field_eu_test_related_blocks',
    'label' => 'Related Blocks',
  ])
    ->save();

  // Define our widget and formatter for this field.
  \Drupal::service('entity_display.repository')
    ->getFormDisplay('node', 'eu_test_ct', 'default')
    ->setComponent('field_eu_test_related_blocks', [
    'type' => 'block_field_default',
  ])
    ->save();
  \Drupal::service('entity_display.repository')
    ->getViewDisplay('node', 'eu_test_ct', 'default')
    ->setComponent('field_eu_test_related_blocks', [
    'type' => 'block_field',
  ])
    ->save();
  $this
    ->drupalPlaceBlock('local_tasks_block');
  $session = $this
    ->getSession();
  $page = $session
    ->getPage();
  $assert_session = $this
    ->assertSession();

  // Check some config-entity related settings on the config form.
  $this
    ->drupalGet('/admin/config/entity-usage/settings');

  // We should have a checked checkbox for source/target entity type.
  $sources_fieldset_wrapper = $assert_session
    ->elementExists('css', '#edit-track-enabled-source-entity-types summary');
  $sources_fieldset_wrapper
    ->click();
  $assert_session
    ->fieldExists('track_enabled_source_entity_types[entity_types][block_content]');
  $assert_session
    ->checkboxChecked('track_enabled_source_entity_types[entity_types][block_content]');
  $targets_fieldset_wrapper = $assert_session
    ->elementExists('css', '#edit-track-enabled-target-entity-types summary');
  $targets_fieldset_wrapper
    ->click();
  $assert_session
    ->checkboxChecked('track_enabled_target_entity_types[entity_types][block_content]');

  // Also allow views to have the usage tab visible.
  $block_tab_checkbox = $assert_session
    ->fieldExists('local_task_enabled_entity_types[entity_types][block_content]');
  $block_tab_checkbox
    ->click();

  // Save configuration.
  $page
    ->pressButton('Save configuration');
  $this
    ->saveHtmlOutput();
  $assert_session
    ->pageTextContains('The configuration options have been saved.');

  // Create a new target content block.
  BlockContentType::create([
    'id' => 'basic',
    'label' => 'basic',
    'revision' => TRUE,
  ]);
  $block_content = BlockContent::create([
    'info' => 'My first custom block',
    'type' => 'basic',
    'langcode' => 'en',
  ]);
  $block_content
    ->save();

  // Create a node referencing this block through a Block Field field.
  $this
    ->drupalGet('/node/add/eu_test_ct');
  $page
    ->fillField('title[0][value]', 'Node that points to a custom block');
  $assert_session
    ->optionExists('field_eu_test_related_blocks[0][plugin_id]', "block_content:{$block_content->uuid()}");
  $page
    ->selectFieldOption('field_eu_test_related_blocks[0][plugin_id]', "block_content:{$block_content->uuid()}");
  $assert_session
    ->assertWaitOnAjaxRequest();
  $this
    ->saveHtmlOutput();
  $page
    ->pressButton('Save');
  $this
    ->saveHtmlOutput();
  $this
    ->assertSession()
    ->pageTextContains('eu_test_ct Node that points to a custom block has been created.');

  /** @var \Drupal\node\NodeInterface $host_node */
  $host_node = $this
    ->getLastEntityOfType('node', TRUE);

  // Check that usage for this block is correctly tracked.
  $usage = \Drupal::service('entity_usage.usage')
    ->listSources($block_content);
  $expected = [
    'node' => [
      $host_node
        ->id() => [
        [
          'source_langcode' => $host_node
            ->language()
            ->getId(),
          'source_vid' => $host_node
            ->getRevisionId(),
          'method' => 'block_field',
          'field_name' => 'field_eu_test_related_blocks',
          'count' => 1,
        ],
      ],
    ],
  ];
  $this
    ->assertEquals($expected, $usage);

  // We should also be able to get to the usage page from the block page.
  $this
    ->drupalGet("/block/{$block_content->id()}");
  $assert_session
    ->linkExists('Usage');
  $this
    ->drupalGet("/block/{$block_content->id()}/usage");
  $first_row_title_link = $assert_session
    ->elementExists('xpath', '//table/tbody/tr[1]/td[1]/a');
  $this
    ->assertEquals($host_node
    ->label(), $first_row_title_link
    ->getText());
  $this
    ->assertStringContainsString($host_node
    ->toUrl()
    ->toString(), $first_row_title_link
    ->getAttribute('href'));
  $first_row_type = $this
    ->xpath('//table/tbody/tr[1]/td[2]')[0];
  $this
    ->assertEquals('Content', $first_row_type
    ->getText());
  $first_row_langcode = $this
    ->xpath('//table/tbody/tr[1]/td[3]')[0];
  $this
    ->assertEquals('English', $first_row_langcode
    ->getText());
  $first_row_field_label = $this
    ->xpath('//table/tbody/tr[1]/td[4]')[0];
  $this
    ->assertEquals('Related Blocks', $first_row_field_label
    ->getText());
  $first_row_status = $this
    ->xpath('//table/tbody/tr[1]/td[5]')[0];
  $this
    ->assertEquals('Published', $first_row_status
    ->getText());
}