class HelpTopicTwigLoaderTest in Drupal 9

Unit test for the HelpTopicTwigLoader class.

@coversDefaultClass \Drupal\help_topics\HelpTopicTwigLoader @group help_topics

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitCompatibilityTrait, PhpUnitWarnings
  • class \Drupal\Tests\help_topics\Unit\HelpTopicTwigLoaderTest

File

core/modules/help_topics/tests/src/Unit/HelpTopicTwigLoaderTest.php, line 16

Namespace

Drupal\Tests\help_topics\Unit

class HelpTopicTwigLoaderTest extends UnitTestCase {

  /**
   * The help topic loader instance to test.
   *
   * @var \Drupal\help_topics\HelpTopicTwigLoader
   */
  protected $helpLoader;

  /**
   * The virtual directories to use in testing.
   *
   * @var array
   */
  protected $directories;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    $this
      ->setUpVfs();
    $this->helpLoader = new HelpTopicTwigLoader('\\fake\\root\\path', $this
      ->getHandlerMock('module'), $this
      ->getHandlerMock('theme'));
  }

  /**
   * @covers ::__construct
   */
  public function testConstructor() {

    // Verify that the module/theme directories were added in the constructor,
    // and non-existent directories were omitted.
    $paths = $this->helpLoader
      ->getPaths(HelpTopicTwigLoader::MAIN_NAMESPACE);
    $this
      ->assertCount(2, $paths);
    $this
      ->assertContains($this->directories['module']['test'] . '/help_topics', $paths);
    $this
      ->assertContains($this->directories['theme']['test'] . '/help_topics', $paths);
  }

  /**
   * @covers ::getSourceContext
   */
  public function testGetSourceContext() {
    $source = $this->helpLoader
      ->getSourceContext('@' . HelpTopicTwigLoader::MAIN_NAMESPACE . '/test.topic.html.twig');
    $this
      ->assertEquals('{% line 4 %}<h2>Test</h2>', $source
      ->getCode());
  }

  /**
   * @covers ::getSourceContext
   */
  public function testGetSourceContextException() {
    $this
      ->expectException(LoaderError::class);
    $this
      ->expectExceptionMessage("Malformed YAML in help topic \"vfs://root/modules/test/help_topics/test.invalid_yaml.html.twig\":");
    $this->helpLoader
      ->getSourceContext('@' . HelpTopicTwigLoader::MAIN_NAMESPACE . '/test.invalid_yaml.html.twig');
  }

  /**
   * Creates a mock module or theme handler class for the test.
   *
   * @param string $type
   *   Type of handler to return: 'module' or 'theme'.
   *
   * @return \PHPUnit\Framework\MockObject\MockObject
   *   The mock of module or theme handler.
   */
  protected function getHandlerMock($type) {
    if ($type == 'module') {
      $class = 'Drupal\\Core\\Extension\\ModuleHandlerInterface';
      $method = 'getModuleDirectories';
    }
    else {
      $class = 'Drupal\\Core\\Extension\\ThemeHandlerInterface';
      $method = 'getThemeDirectories';
    }
    $handler = $this
      ->getMockBuilder($class)
      ->disableOriginalConstructor()
      ->getMock();
    $handler
      ->method($method)
      ->willReturn($this->directories[$type]);
    return $handler;
  }

  /**
   * Sets up the virtual file system.
   */
  protected function setUpVfs() {
    $content = <<<EOF
---
label: Test
---
<h2>Test</h2>
EOF;
    $invalid_content = <<<EOF
---
foo : [bar}
---
<h2>Test</h2>
EOF;
    $help_topics_dir = [
      'help_topics' => [
        'test.topic.html.twig' => $content,
        'test.invalid_yaml.html.twig' => $invalid_content,
      ],
    ];
    vfsStream::setup('root');
    vfsStream::create([
      'modules' => [
        'test' => $help_topics_dir,
      ],
      'themes' => [
        'test' => $help_topics_dir,
      ],
    ]);
    $this->directories = [
      'root' => vfsStream::url('root'),
      'module' => [
        'test' => vfsStream::url('root/modules/test'),
        'not_a_dir' => vfsStream::url('root/modules/not_a_dir'),
      ],
      'theme' => [
        'test' => vfsStream::url('root/themes/test'),
        'not_a_dir' => vfsStream::url('root/themes/not_a_dir'),
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
HelpTopicTwigLoaderTest::$directories	protected	property	The virtual directories to use in testing.
HelpTopicTwigLoaderTest::$helpLoader	protected	property	The help topic loader instance to test.
HelpTopicTwigLoaderTest::getHandlerMock	protected	function	Creates a mock module or theme handler class for the test.
HelpTopicTwigLoaderTest::setUp	protected	function	Overrides UnitTestCase::setUp
HelpTopicTwigLoaderTest::setUpVfs	protected	function	Sets up the virtual file system.
HelpTopicTwigLoaderTest::testConstructor	public	function	@covers ::__construct
HelpTopicTwigLoaderTest::testGetSourceContext	public	function	@covers ::getSourceContext
HelpTopicTwigLoaderTest::testGetSourceContextException	public	function	@covers ::getSourceContext
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals Deprecated	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass	public static	function