You are here

class EntityShareServerFunctionalTest in Entity Share 8.3

Same name and namespace in other branches
  1. 8.2 modules/entity_share_server/tests/src/Functional/EntityShareServerFunctionalTest.php \Drupal\Tests\entity_share_server\Functional\EntityShareServerFunctionalTest

General functional test class.

@group entity_share @group entity_share_server

Hierarchy

Expanded class hierarchy of EntityShareServerFunctionalTest

File

modules/entity_share_server/tests/src/Functional/EntityShareServerFunctionalTest.php, line 19

Namespace

Drupal\Tests\entity_share_server\Functional
View source
class EntityShareServerFunctionalTest extends EntityShareServerFunctionalTestBase {

  /**
   * Test that a channel provides correct URLs.
   */
  public function testBasicChannel() {

    // Prepare a node and its translation.
    $node = $this
      ->createNode([
      'type' => 'es_test',
      'uuid' => 'es_test',
      'title' => 'Entity share test 1 en',
      'status' => NodeInterface::PUBLISHED,
    ]);
    $node
      ->addTranslation('fr', [
      'title' => 'Entity share test 1 fr',
    ]);
    $node
      ->save();

    // Create channels.
    $channel_storage = $this->entityTypeManager
      ->getStorage('channel');
    $es_test_en_channel = $channel_storage
      ->create([
      'id' => 'es_test_en',
      'label' => 'Entity share test en',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $es_test_en_channel
      ->save();
    $es_test_fr_channel = $channel_storage
      ->create([
      'id' => 'es_test_fr',
      'label' => 'Entity share test fr',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'fr',
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $es_test_fr_channel
      ->save();
    $entity_share_entrypoint_url = Url::fromRoute('entity_share_server.resource_list');
    $response = $this
      ->request('GET', $entity_share_entrypoint_url, $this
      ->getAuthenticationRequestOptions($this->channelUser));
    $entity_share_endpoint_response = Json::decode((string) $response
      ->getBody());
    $expected_search_configuration = [
      'label' => [
        'path' => 'title',
        'label' => 'Label',
      ],
    ];

    // Test that the field_mapping entry exists.
    $this
      ->assertTrue(isset($entity_share_endpoint_response['data']['field_mappings']), 'The field mappings has been found');

    // Test the english channel info.
    $this
      ->assertTrue(isset($entity_share_endpoint_response['data']['channels']['es_test_en']), 'The english channel has been found');
    $this
      ->assertEquals($entity_share_endpoint_response['data']['channels']['es_test_en']['label'], $es_test_en_channel
      ->label(), 'The expected channel label has been found.');
    $this
      ->assertEquals($entity_share_endpoint_response['data']['channels']['es_test_en']['channel_entity_type'], $es_test_en_channel
      ->get('channel_entity_type'), 'The expected channel entity type has been found.');
    $this
      ->assertEquals($entity_share_endpoint_response['data']['channels']['es_test_en']['search_configuration'], $expected_search_configuration, 'The expected search configuration had been found.');

    // Test that the node can be found on the channel URL.
    $response = $this
      ->request('GET', Url::fromUri($entity_share_endpoint_response['data']['channels']['es_test_en']['url']), $this
      ->getAuthenticationRequestOptions($this->channelUser));
    $es_test_en_channel_url_response = Json::decode((string) $response
      ->getBody());
    $this
      ->assertEquals($es_test_en_channel_url_response['data'][0]['attributes']['title'], $node
      ->label(), 'The channel url is correct. The created node has been found.');

    // Test that the channel URL uuid contains only changed timestamp.
    $response = $this
      ->request('GET', Url::fromUri($entity_share_endpoint_response['data']['channels']['es_test_en']['url_uuid']), $this
      ->getAuthenticationRequestOptions($this->channelUser));
    $es_test_en_channel_url_uuid_response = Json::decode((string) $response
      ->getBody());
    $this
      ->assertEquals(count($es_test_en_channel_url_uuid_response['data'][0]['attributes']), 1, 'There is only one attribute.');
    $this
      ->assertTrue(isset($es_test_en_channel_url_uuid_response['data'][0]['attributes']['changed']), 'The only attribute is changed.');

    // Test the French channel info.
    $this
      ->assertTrue(isset($entity_share_endpoint_response['data']['channels']['es_test_fr']), 'The French channel has been found');
    $this
      ->assertEquals($entity_share_endpoint_response['data']['channels']['es_test_fr']['label'], $es_test_fr_channel
      ->label(), 'The expected channel label has been found.');
    $this
      ->assertEquals($entity_share_endpoint_response['data']['channels']['es_test_fr']['channel_entity_type'], $es_test_fr_channel
      ->get('channel_entity_type'), 'The expected channel entity type has been found.');
    $this
      ->assertEquals($entity_share_endpoint_response['data']['channels']['es_test_fr']['search_configuration'], $expected_search_configuration, 'The expected search configuration had been found.');

    // Test that the node translation can be found on the channel URL.
    $response = $this
      ->request('GET', Url::fromUri($entity_share_endpoint_response['data']['channels']['es_test_fr']['url']), $this
      ->getAuthenticationRequestOptions($this->channelUser));
    $es_test_fr_channel_url_response = Json::decode((string) $response
      ->getBody());
    $this
      ->assertEquals($es_test_fr_channel_url_response['data'][0]['attributes']['title'], $node
      ->getTranslation('fr')
      ->label(), 'The channel url is correct. The created node has been found.');
  }

  /**
   * Test filters, groups of filters, and sorts.
   */
  public function testFilteringAndSortingOnChannel() {
    $term_storage = $this->entityTypeManager
      ->getStorage('taxonomy_term');
    $channel_storage = $this->entityTypeManager
      ->getStorage('channel');

    /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
    $date_formatter = $this->container
      ->get('date.formatter');
    $timestamp_node_1 = '5000000';
    $timestamp_node_2 = '6000000';
    $timestamp_node_3 = '7000000';

    // @codingStandardsIgnoreStart
    // Expected: node 1.
    $timestamp_smaller_than_value = $timestamp_node_2;

    // Expected: node 1 and node 2.
    $timestamp_smaller_than_or_equal_value = $timestamp_node_2;

    // Expected: node 3.
    $timestamp_greater_than_value = $timestamp_node_2;

    // Expected: node 2 and node 3.
    $timestamp_greater_than_or_equal_value = $timestamp_node_2;

    // @codingStandardsIgnoreEnd
    // Create 3 tags.
    $tag_1 = $term_storage
      ->create([
      'langcode' => 'en',
      'vid' => 'es_test',
      'name' => 'Tag 1',
    ]);
    $tag_1
      ->save();
    $tag_2 = $term_storage
      ->create([
      'langcode' => 'en',
      'vid' => 'es_test',
      'name' => 'Tag 2',
    ]);
    $tag_2
      ->save();
    $tag_3 = $term_storage
      ->create([
      'langcode' => 'en',
      'vid' => 'es_test',
      'name' => 'Tag 3',
    ]);
    $tag_3
      ->save();

    // @codingStandardsIgnoreStart
    // Prepare nodes.
    $this
      ->createNode([
      'type' => 'es_test',
      'uuid' => 'es_test_1',
      'title' => 'Foo Bar Test',
      'status' => NodeInterface::PUBLISHED,
      'promote' => NodeInterface::PROMOTED,
      'sticky' => NodeInterface::STICKY,
      'field_es_test_date' => $date_formatter
        ->format($timestamp_node_1, 'custom', DateTimeItemInterface::DATETIME_STORAGE_FORMAT),
      'field_es_test_number_integer' => 2,
      'field_es_test_taxonomy' => [
        'target_id' => $tag_1
          ->id(),
      ],
      'field_es_test_text_plain' => 'not null',
    ]);
    $this
      ->createNode([
      'type' => 'es_test',
      'uuid' => 'es_test_2',
      'title' => 'Foo Contains Test',
      'status' => NodeInterface::PUBLISHED,
      'promote' => NodeInterface::PROMOTED,
      'sticky' => NodeInterface::NOT_STICKY,
      'field_es_test_date' => $date_formatter
        ->format($timestamp_node_2, 'custom', DateTimeItemInterface::DATETIME_STORAGE_FORMAT),
      'field_es_test_number_integer' => 4,
      'field_es_test_taxonomy' => [
        'target_id' => $tag_2
          ->id(),
      ],
    ]);
    $this
      ->createNode([
      'type' => 'es_test',
      'uuid' => 'es_test_3',
      'title' => 'Bar Test',
      'status' => NodeInterface::PUBLISHED,
      'promote' => NodeInterface::NOT_PROMOTED,
      'sticky' => NodeInterface::STICKY,
      'field_es_test_date' => $date_formatter
        ->format($timestamp_node_3, 'custom', DateTimeItemInterface::DATETIME_STORAGE_FORMAT),
      'field_es_test_number_integer' => 6,
      'field_es_test_taxonomy' => [
        'target_id' => $tag_3
          ->id(),
      ],
    ]);

    // @codingStandardsIgnoreEnd
    // 1: =: Basic field: Promoted node.
    $channel_1 = $channel_storage
      ->create([
      'id' => 'channel_1',
      'label' => 'Channel 1',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'promote' => [
          'path' => 'promote',
          'operator' => '=',
          'value' => [
            NodeInterface::PROMOTED,
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_1
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_1
      ->id(), [
      'es_test_1' => TRUE,
      'es_test_2' => TRUE,
      'es_test_3' => FALSE,
    ]);

    // 2: =: Entity reference: Node with a specific tag.
    $channel_2 = $channel_storage
      ->create([
      'id' => 'channel_2',
      'label' => 'Channel 2',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_taxonomy_entity_name' => [
          'path' => 'field_es_test_taxonomy.entity.name',
          'operator' => '=',
          'value' => [
            'tag 1',
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_2
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_2
      ->id(), [
      'es_test_1' => TRUE,
      'es_test_2' => FALSE,
      'es_test_3' => FALSE,
    ]);

    // 3: <>.
    $channel_3 = $channel_storage
      ->create([
      'id' => 'channel_3',
      'label' => 'Channel 3',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_taxonomy_entity_name' => [
          'path' => 'field_es_test_taxonomy.entity.name',
          'operator' => '<>',
          'value' => [
            'tag 1',
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_3
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_3
      ->id(), [
      'es_test_1' => FALSE,
      'es_test_2' => TRUE,
      'es_test_3' => TRUE,
    ]);

    // @codingStandardsIgnoreStart
    // 4: >.
    $channel_4 = $channel_storage
      ->create([
      'id' => 'channel_4',
      'label' => 'Channel 4',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_date' => [
          'path' => 'field_es_test_date',
          'operator' => '>',
          'value' => [
            $date_formatter
              ->format($timestamp_greater_than_value, 'custom', DateTimeItemInterface::DATETIME_STORAGE_FORMAT),
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_4
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_4
      ->id(), [
      'es_test_1' => FALSE,
      'es_test_2' => FALSE,
      'es_test_3' => TRUE,
    ]);

    // 5: >=.
    $channel_5 = $channel_storage
      ->create([
      'id' => 'channel_5',
      'label' => 'Channel 5',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_date' => [
          'path' => 'field_es_test_date',
          'operator' => '>=',
          'value' => [
            $date_formatter
              ->format($timestamp_greater_than_or_equal_value, 'custom', DateTimeItemInterface::DATETIME_STORAGE_FORMAT),
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_5
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_5
      ->id(), [
      'es_test_1' => FALSE,
      'es_test_2' => TRUE,
      'es_test_3' => TRUE,
    ]);

    // 6: <.
    $channel_6 = $channel_storage
      ->create([
      'id' => 'channel_6',
      'label' => 'Channel 6',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_date' => [
          'path' => 'field_es_test_date',
          'operator' => '<',
          'value' => [
            $date_formatter
              ->format($timestamp_smaller_than_value, 'custom', DateTimeItemInterface::DATETIME_STORAGE_FORMAT),
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_6
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_6
      ->id(), [
      'es_test_1' => TRUE,
      'es_test_2' => FALSE,
      'es_test_3' => FALSE,
    ]);

    // 7: <=.
    $channel_7 = $channel_storage
      ->create([
      'id' => 'channel_7',
      'label' => 'Channel 7',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_date' => [
          'path' => 'field_es_test_date',
          'operator' => '<=',
          'value' => [
            $date_formatter
              ->format($timestamp_smaller_than_or_equal_value, 'custom', DateTimeItemInterface::DATETIME_STORAGE_FORMAT),
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_7
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_7
      ->id(), [
      'es_test_1' => TRUE,
      'es_test_2' => TRUE,
      'es_test_3' => FALSE,
    ]);

    // @codingStandardsIgnoreEnd
    // 8: STARTS_WITH.
    $channel_8 = $channel_storage
      ->create([
      'id' => 'channel_8',
      'label' => 'Channel 8',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'title' => [
          'path' => 'title',
          'operator' => 'STARTS_WITH',
          'value' => [
            'Foo',
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_8
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_8
      ->id(), [
      'es_test_1' => TRUE,
      'es_test_2' => TRUE,
      'es_test_3' => FALSE,
    ]);

    // 9: CONTAINS.
    $channel_9 = $channel_storage
      ->create([
      'id' => 'channel_9',
      'label' => 'Channel 9',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'title' => [
          'path' => 'title',
          'operator' => 'CONTAINS',
          'value' => [
            'Contains',
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_9
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_9
      ->id(), [
      'es_test_1' => FALSE,
      'es_test_2' => TRUE,
      'es_test_3' => FALSE,
    ]);

    // 10: ENDS_WITH.
    $channel_10 = $channel_storage
      ->create([
      'id' => 'channel_10',
      'label' => 'Channel 10',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'title' => [
          'path' => 'title',
          'operator' => 'ENDS_WITH',
          'value' => [
            'Bar Test',
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_10
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_10
      ->id(), [
      'es_test_1' => TRUE,
      'es_test_2' => FALSE,
      'es_test_3' => TRUE,
    ]);

    // 11: IN.
    $channel_11 = $channel_storage
      ->create([
      'id' => 'channel_11',
      'label' => 'Channel 11',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_taxonomy_entity_name' => [
          'path' => 'field_es_test_taxonomy.entity.name',
          'operator' => 'IN',
          'value' => [
            'Tag 1',
            'Tag 2',
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_11
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_11
      ->id(), [
      'es_test_1' => TRUE,
      'es_test_2' => TRUE,
      'es_test_3' => FALSE,
    ]);

    // 12: NOT IN.
    $channel_12 = $channel_storage
      ->create([
      'id' => 'channel_12',
      'label' => 'Channel 12',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_taxonomy_entity_name' => [
          'path' => 'field_es_test_taxonomy.entity.name',
          'operator' => 'NOT IN',
          'value' => [
            'Tag 1',
            'Tag 2',
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_12
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_12
      ->id(), [
      'es_test_1' => FALSE,
      'es_test_2' => FALSE,
      'es_test_3' => TRUE,
    ]);

    // 13: BETWEEN.
    $channel_13 = $channel_storage
      ->create([
      'id' => 'channel_13',
      'label' => 'Channel 13',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_number_integer' => [
          'path' => 'field_es_test_number_integer',
          'operator' => 'BETWEEN',
          'value' => [
            '3',
            '5',
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_13
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_13
      ->id(), [
      'es_test_1' => FALSE,
      'es_test_2' => TRUE,
      'es_test_3' => FALSE,
    ]);

    // 14: NOT BETWEEN.
    $channel_14 = $channel_storage
      ->create([
      'id' => 'channel_14',
      'label' => 'Channel 14',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_number_integer' => [
          'path' => 'field_es_test_number_integer',
          'operator' => 'NOT BETWEEN',
          'value' => [
            '3',
            '5',
          ],
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_14
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_14
      ->id(), [
      'es_test_1' => TRUE,
      'es_test_2' => FALSE,
      'es_test_3' => TRUE,
    ]);

    // 15: IS NULL.
    $channel_15 = $channel_storage
      ->create([
      'id' => 'channel_15',
      'label' => 'Channel 15',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_text_plain' => [
          'path' => 'field_es_test_text_plain',
          'operator' => 'IS NULL',
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_15
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_15
      ->id(), [
      'es_test_1' => FALSE,
      'es_test_2' => TRUE,
      'es_test_3' => TRUE,
    ]);

    // 16: IS NOT NULL.
    $channel_16 = $channel_storage
      ->create([
      'id' => 'channel_16',
      'label' => 'Channel 16',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'field_es_test_text_plain' => [
          'path' => 'field_es_test_text_plain',
          'operator' => 'IS NOT NULL',
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_16
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_16
      ->id(), [
      'es_test_1' => TRUE,
      'es_test_2' => FALSE,
      'es_test_3' => FALSE,
    ]);

    // 17: Grouping grouped filters.
    $channel_17 = $channel_storage
      ->create([
      'id' => 'channel_17',
      'label' => 'Channel 17',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_filters' => [
        'promote' => [
          'path' => 'promote',
          'operator' => '=',
          'value' => [
            NodeInterface::PROMOTED,
          ],
          'memberof' => 'or_group',
        ],
        'sticky' => [
          'path' => 'sticky',
          'operator' => '=',
          'value' => [
            NodeInterface::STICKY,
          ],
          'memberof' => 'or_group',
        ],
        'field_es_test_text_plain' => [
          'path' => 'field_es_test_text_plain',
          'operator' => 'IS NULL',
          'memberof' => 'and_group',
        ],
      ],
      'channel_groups' => [
        'and_group' => [
          'conjunction' => 'AND',
        ],
        'or_group' => [
          'conjunction' => 'OR',
          'memberof' => 'and_group',
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_17
      ->save();
    $this
      ->checkEntitiesOnChannel($channel_17
      ->id(), [
      'es_test_1' => FALSE,
      'es_test_2' => TRUE,
      'es_test_3' => TRUE,
    ]);

    // 18: Sorts.
    $channel_18 = $channel_storage
      ->create([
      'id' => 'channel_18',
      'label' => 'Channel 18',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_sorts' => [
        'promote' => [
          'path' => 'promote',
          'direction' => 'ASC',
          'weight' => -10,
        ],
        'field_es_test_date' => [
          'path' => 'field_es_test_date',
          'direction' => 'DESC',
          'weight' => -9,
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $channel_18
      ->save();
    $this
      ->checkEntitiesOrderOnChannel($channel_18
      ->id(), [
      'es_test_3',
      'es_test_2',
      'es_test_1',
    ]);
  }

  /**
   * Test that a channel provides correct search configuration.
   */
  public function testSearchConfiguration() {

    // Create channels.
    $channel_storage = $this->entityTypeManager
      ->getStorage('channel');
    $es_test_en_channel = $channel_storage
      ->create([
      'id' => 'es_test_en',
      'label' => 'Entity share test en',
      'channel_entity_type' => 'node',
      'channel_bundle' => 'es_test',
      'channel_langcode' => 'en',
      'channel_searches' => [
        'field_es_test_taxonomy_entity_name' => [
          'path' => 'field_es_test_taxonomy.entity.name',
          'label' => 'Tag name',
        ],
      ],
      'authorized_users' => [
        $this->channelUser
          ->uuid(),
      ],
    ]);
    $es_test_en_channel
      ->save();
    $entity_share_entrypoint_url = Url::fromRoute('entity_share_server.resource_list');
    $response = $this
      ->request('GET', $entity_share_entrypoint_url, $this
      ->getAuthenticationRequestOptions($this->channelUser));
    $entity_share_endpoint_response = Json::decode((string) $response
      ->getBody());
    $expected_search_configuration = [
      'label' => [
        'path' => 'title',
        'label' => 'Label',
      ],
      'field_es_test_taxonomy_entity_name' => [
        'path' => 'field_es_test_taxonomy.entity.name',
        'label' => 'Tag name',
      ],
    ];
    $this
      ->assertEquals($entity_share_endpoint_response['data']['channels']['es_test_en']['search_configuration'], $expected_search_configuration, 'The expected search configuration had been found.');
  }

  /**
   * Helper function to check the presence of entities on a specific channel.
   *
   * @param string $channel_id
   *   The channel id on which to check the entities.
   * @param array $entity_uuids
   *   The entity UUIDs to check for. Key is the entity UUID and the value is
   *   the expected status.
   */
  protected function checkEntitiesOnChannel($channel_id, array $entity_uuids) {
    $entity_share_entrypoint_url = Url::fromRoute('entity_share_server.resource_list');
    $response = $this
      ->request('GET', $entity_share_entrypoint_url, $this
      ->getAuthenticationRequestOptions($this->channelUser));
    $entity_share_endpoint_response = Json::decode((string) $response
      ->getBody());

    // Test that the node can be found on the channel URL.
    $response = $this
      ->request('GET', Url::fromUri($entity_share_endpoint_response['data']['channels'][$channel_id]['url']), $this
      ->getAuthenticationRequestOptions($this->channelUser));
    $channel_url_response = Json::decode((string) $response
      ->getBody());
    $channel_url_data = EntityShareUtility::prepareData($channel_url_response['data']);
    foreach ($entity_uuids as $entity_uuid => $expected) {
      $found = FALSE;
      foreach ($channel_url_data as $entity_data) {
        if ($entity_data['id'] == $entity_uuid) {
          $found = TRUE;
        }
      }
      $this
        ->assertEquals($found, $expected, 'Expected state for entity with UUID: ' . $entity_uuid);
    }
  }

  /**
   * Helper function to check the order of entities on a specific channel.
   *
   * @param string $channel_id
   *   The channel id on which to check the entities.
   * @param array $entity_uuids
   *   The entity UUIDs to check for.
   */
  protected function checkEntitiesOrderOnChannel($channel_id, array $entity_uuids) {
    $entity_share_entrypoint_url = Url::fromRoute('entity_share_server.resource_list');
    $response = $this
      ->request('GET', $entity_share_entrypoint_url, $this
      ->getAuthenticationRequestOptions($this->channelUser));
    $entity_share_endpoint_response = Json::decode((string) $response
      ->getBody());

    // Test that the node can be found on the channel URL.
    $response = $this
      ->request('GET', Url::fromUri($entity_share_endpoint_response['data']['channels'][$channel_id]['url']), $this
      ->getAuthenticationRequestOptions($this->channelUser));
    $channel_url_response = Json::decode((string) $response
      ->getBody());
    $channel_url_data = EntityShareUtility::prepareData($channel_url_response['data']);
    foreach ($entity_uuids as $entity_position => $entity_uuid) {
      $found = FALSE;
      if ($channel_url_data[$entity_position]['id'] == $entity_uuid) {
        $found = TRUE;
      }
      $this
        ->assertTrue($found, 'Correct expected position for entity with UUID: ' . $entity_uuid);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
EntityShareServerFunctionalTest::checkEntitiesOnChannel protected function Helper function to check the presence of entities on a specific channel.
EntityShareServerFunctionalTest::checkEntitiesOrderOnChannel protected function Helper function to check the order of entities on a specific channel.
EntityShareServerFunctionalTest::testBasicChannel public function Test that a channel provides correct URLs.
EntityShareServerFunctionalTest::testFilteringAndSortingOnChannel public function Test filters, groups of filters, and sorts.
EntityShareServerFunctionalTest::testSearchConfiguration public function Test that a channel provides correct search configuration.
EntityShareServerFunctionalTestBase::$adminUser protected property A test user with administrative privileges.
EntityShareServerFunctionalTestBase::$channelUser protected property A test user with access to the channel list.
EntityShareServerFunctionalTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
EntityShareServerFunctionalTestBase::$entityTypeManager protected property The entity type manager service.
EntityShareServerFunctionalTestBase::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
EntityShareServerFunctionalTestBase::getAdministratorPermissions protected function Gets the permissions for the admin user.
EntityShareServerFunctionalTestBase::getAuthenticationRequestOptions protected function Returns Guzzle request options for authentication.
EntityShareServerFunctionalTestBase::getChannelUserPermissions protected function Gets the permissions for the channel user.
EntityShareServerFunctionalTestBase::setUp protected function Overrides BrowserTestBase::setUp
EntityShareServerRequestTestTrait::request protected function Performs a HTTP request. Wraps the Guzzle HTTP client.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
JsonApiRequestTestTrait::decorateWithXdebugCookie protected function Adds the Xdebug cookie to the request options.
JsonApiRequestTestTrait::request protected function Performs a HTTP request. Wraps the Guzzle HTTP client. Aliased as: parentRequest
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.