og-8.x-1.x-dev/tests/src/Kernel/Entity/ReferenceStringIdTest.php

<?php

declare(strict_types=1);

namespace Drupal\Tests\og\Kernel\Entity;

use Drupal\Core\Entity\EntityInterface;
use Drupal\KernelTests\KernelTestBase;
use Drupal\entity_test\Entity\EntityTestStringId;
use Drupal\og\Og;
use Drupal\og\OgGroupAudienceHelperInterface;

/**
 * Checks that groups with string IDs can be referenced.
 *
 * @group og
 */
class ReferenceStringIdTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'user',
    'entity_test',
    'field',
    'og',
    'options',
    'system',
  ];

  /**
   * Array of test bundles. The first is a group, the second group content.
   *
   * @var \Drupal\Core\Entity\EntityInterface[]
   */
  protected array $bundles;

  /**
   * The name of the group audience field used for the group content type.
   */
  protected string $fieldName;

  /**
   * The group entity type.
   */
  protected EntityInterface $group;

  /**
   * {@inheritdoc}
   */
  protected function setUp(): void {
    parent::setUp();

    // Add membership and config schema.
    $this->installConfig(['og']);
    $this->installEntitySchema('entity_test_string_id');
    $this->installEntitySchema('og_membership');
    $this->installEntitySchema('user');
    $this->installSchema('system', 'sequences');

    // Create two bundles; one to serve as a group, the other as group content.
    for ($i = 0; $i < 2; $i++) {
      $bundle = EntityTestStringId::create([
        'type' => mb_strtolower($this->randomMachineName()),
        'name' => $this->randomString(),
        'id' => $this->randomMachineName(),
      ]);
      $bundle->save();
      $this->bundles[] = $bundle->id();
    }

    // Create a group with a string as an ID.
    $group = EntityTestStringId::create([
      'type' => $this->bundles[0],
      'id' => $this->randomMachineName(),
    ]);
    $group->save();
    $this->group = $group;

    // Let OG mark the group entity type as a group.
    Og::groupTypeManager()->addGroup('entity_test_string_id', $this->bundles[0]);

    // Add a group audience field to the second bundle, this will turn it into a
    // group content type.
    $this->fieldName = strtolower($this->randomMachineName());
    Og::CreateField(OgGroupAudienceHelperInterface::DEFAULT_FIELD, 'entity_test_string_id', $this->bundles[1], [
      'field_name' => $this->fieldName,
    ]);
  }

  /**
   * Test if a group that uses a string as ID can be referenced.
   */
  public function testReferencingStringIds(): void {
    // Create a group content entity that references the group.
    $entity = EntityTestStringId::create([
      'type' => $this->bundles[1],
      'name' => $this->randomString(),
      'id' => $this->randomMachineName(),
      $this->fieldName => [['target_id' => $this->group->id()]],
    ]);
    $entity->save();

    // Check that the group content entity is referenced.
    $references = $this->container->get('entity_type.manager')->getStorage('entity_test_string_id')
      ->getQuery()
      ->accessCheck()
      ->condition($this->fieldName, $this->group->id())
      ->execute();
    $this->assertEquals([$entity->id()], array_keys($references), 'The correct group is referenced.');
  }

}