AttributeClassDiscoveryCachedTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\Component\Plugin\Attribute;

use Composer\Autoload\ClassLoader;
use Drupal\Component\Plugin\Discovery\AttributeClassDiscovery;
use Drupal\Component\FileCache\FileCacheFactory;
use PHPUnit\Framework\TestCase;

/**
 * @coversDefaultClass \Drupal\Component\Plugin\Discovery\AttributeClassDiscovery
 * @covers \Drupal\Component\Discovery\MissingClassDetectionClassLoader
 * @group Attribute
 * @runTestsInSeparateProcesses
 */
class AttributeClassDiscoveryCachedTest extends TestCase {
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    // Ensure FileCacheFactory::DISABLE_CACHE is *not* set, since we're testing
    // integration with the file cache.
    FileCacheFactory::setConfiguration([]);
    // Ensure that FileCacheFactory has a prefix.
    FileCacheFactory::setPrefix('prefix');
    // Normally the attribute classes would be autoloaded.
    include_once __DIR__ . '/../../../../../fixtures/plugins/CustomPlugin.php';
    $additionalClassLoader = new ClassLoader();
    $additionalClassLoader->addPsr4("com\\example\\PluginNamespace\\", __DIR__ . "/../../../../../fixtures/plugins/Plugin/PluginNamespace");
    $additionalClassLoader->register(TRUE);
  }
  
  /**
   * Tests that getDefinitions() retrieves the file cache correctly.
   *
   * @covers ::getDefinitions
   */
  public function testGetDefinitions() : void {
    // Path to the classes which we'll discover and parse annotation.
    $discovery_path = __DIR__ . "/../../../../../fixtures/plugins/Plugin";
    // File path that should be discovered within that directory.
    $file_path = $discovery_path . '/PluginNamespace/AttributeDiscoveryTest1.php';
    // Define file paths within the directory that should not be discovered.
    $non_discoverable_file_paths = [
      $discovery_path . '/PluginNamespace/AttributeDiscoveryTest2.php',
      $discovery_path . '/PluginNamespace/AttributeDiscoveryTestMissingInterface.php',
      $discovery_path . '/PluginNamespace/AttributeDiscoveryTestMissingTrait.php',
    ];
    $discovery = new AttributeClassDiscovery([
      'com\\example' => [
        $discovery_path,
      ],
    ]);
    $this->assertEquals([
      'discovery_test_1' => [
        'id' => 'discovery_test_1',
        'class' => 'com\\example\\PluginNamespace\\AttributeDiscoveryTest1',
      ],
    ], $discovery->getDefinitions());
    // Gain access to the file cache.
    $ref_file_cache = new \ReflectionProperty($discovery, 'fileCache');
    $ref_file_cache->setAccessible(TRUE);
    /** @var \Drupal\Component\FileCache\FileCacheInterface $file_cache */
    $file_cache = $ref_file_cache->getValue($discovery);
    // The valid plugin definition should be cached.
    $this->assertEquals([
      'id' => 'discovery_test_1',
      'class' => 'com\\example\\PluginNamespace\\AttributeDiscoveryTest1',
    ], unserialize($file_cache->get($file_path)['content']));
    // The plugins that extend a missing class, implement a missing interface,
    // and use a missing trait should not be cached.
    foreach ($non_discoverable_file_paths as $non_discoverable_file_path) {
      $this->assertTrue(file_exists($non_discoverable_file_path));
      $this->assertNull($file_cache->get($non_discoverable_file_path));
    }
    // Change the file cache entry.
    // The file cache is keyed by the file path, and we'll add some known
    // content to test against.
    $file_cache->set($file_path, [
      'id' => 'wrong_id',
      'content' => serialize([
        'an' => 'array',
      ]),
    ]);
    // Now perform the same query and check for the cached results.
    $this->assertEquals([
      'wrong_id' => [
        'an' => 'array',
      ],
    ], $discovery->getDefinitions());
  }
  
  /**
   * Tests discovery with missing traits.
   *
   * @covers ::getDefinitions
   */
  public function testGetDefinitionsMissingTrait() : void {
    // Path to the classes which we'll discover and parse annotation.
    $discovery_path = __DIR__ . "/../../../../../fixtures/plugins/Plugin";
    // Define file paths within the directory that should not be discovered.
    $non_discoverable_file_paths = [
      $discovery_path . '/PluginNamespace/AttributeDiscoveryTest2.php',
      $discovery_path . '/PluginNamespace/AttributeDiscoveryTestMissingInterface.php',
      $discovery_path . '/PluginNamespace/AttributeDiscoveryTestMissingTrait.php',
    ];
    $discovery = new AttributeClassDiscovery([
      'com\\example' => [
        $discovery_path,
      ],
    ]);
    $this->assertEquals([
      'discovery_test_1' => [
        'id' => 'discovery_test_1',
        'class' => 'com\\example\\PluginNamespace\\AttributeDiscoveryTest1',
      ],
    ], $discovery->getDefinitions());
    // Gain access to the file cache.
    $ref_file_cache = new \ReflectionProperty($discovery, 'fileCache');
    $ref_file_cache->setAccessible(TRUE);
    /** @var \Drupal\Component\FileCache\FileCacheInterface $file_cache */
    $file_cache = $ref_file_cache->getValue($discovery);
    // The plugins that extend a missing class, implement a missing interface,
    // and use a missing trait should not be cached.
    foreach ($non_discoverable_file_paths as $non_discoverable_file_path) {
      $this->assertTrue(file_exists($non_discoverable_file_path));
      $this->assertNull($file_cache->get($non_discoverable_file_path));
    }
    $discovery = new AttributeClassDiscovery([
      'com\\example' => [
        $discovery_path,
      ],
      'Drupal\\a_module_that_does_not_exist' => [
        $discovery_path,
      ],
    ]);
    $this->assertEquals([
      'discovery_test_1' => [
        'id' => 'discovery_test_1',
        'class' => 'com\\example\\PluginNamespace\\AttributeDiscoveryTest1',
      ],
      'discovery_test_missing_trait' => [
        'id' => 'discovery_test_missing_trait',
        'class' => 'com\\example\\PluginNamespace\\AttributeDiscoveryTestMissingTrait',
        'title' => 'Discovery test plugin missing trait',
      ],
    ], $discovery->getDefinitions());
    // The plugins that extend a missing class, implement a missing interface,
    // and use a missing trait should not be cached. This is the case even for
    // the plugin that was just discovered.
    foreach ($non_discoverable_file_paths as $non_discoverable_file_path) {
      $this->assertTrue(file_exists($non_discoverable_file_path));
      $this->assertNull($file_cache->get($non_discoverable_file_path));
    }
  }

}