class HelpTopicDiscoveryTest

Same name and namespace in other branches
  1. 9 core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php \Drupal\Tests\help_topics\Unit\HelpTopicDiscoveryTest
  2. 8.9.x core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php \Drupal\Tests\help_topics\Unit\HelpTopicDiscoveryTest
  3. 11.x core/modules/help/tests/src/Unit/HelpTopicDiscoveryTest.php \Drupal\Tests\help\Unit\HelpTopicDiscoveryTest

@coversDefaultClass \Drupal\help\HelpTopicDiscovery
@group help

Hierarchy

Expanded class hierarchy of HelpTopicDiscoveryTest

File

core/modules/help/tests/src/Unit/HelpTopicDiscoveryTest.php, line 19

Namespace

Drupal\Tests\help\Unit
View source
class HelpTopicDiscoveryTest extends UnitTestCase {
  
  /**
   * @covers ::findAll
   */
  public function testDiscoveryExceptionMissingLabel() : void {
    vfsStream::setup('root');
    vfsStream::create([
      'modules' => [
        'test' => [
          'help_topics' => [
            // The content of the help topic does not matter.
'test.topic.html.twig' => '',
          ],
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'test' => vfsStream::url('root/modules/test/help_topics'),
    ]);
    $this->expectException(DiscoveryException::class);
    $this->expectExceptionMessage("vfs://root/modules/test/help_topics/test.topic.html.twig does not contain the required key with name='label'");
    $discovery->getDefinitions();
  }
  
  /**
   * @covers ::findAll
   */
  public function testDiscoveryExceptionInvalidYamlKey() : void {
    vfsStream::setup('root');
    $topic_content = <<<EOF
---
label: 'A label'
foo: bar
---
EOF;
    vfsStream::create([
      'modules' => [
        'test' => [
          'help_topics' => [
            'test.topic.html.twig' => $topic_content,
          ],
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'test' => vfsStream::url('root/modules/test/help_topics'),
    ]);
    $this->expectException(DiscoveryException::class);
    $this->expectExceptionMessage("vfs://root/modules/test/help_topics/test.topic.html.twig contains invalid key='foo'");
    $discovery->getDefinitions();
  }
  
  /**
   * @covers ::findAll
   */
  public function testDiscoveryExceptionInvalidTopLevel() : void {
    vfsStream::setup('root');
    $topic_content = <<<EOF
---
label: 'A label'
top_level: bar
---
EOF;
    vfsStream::create([
      'modules' => [
        'test' => [
          'help_topics' => [
            'test.topic.html.twig' => $topic_content,
          ],
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'test' => vfsStream::url('root/modules/test/help_topics'),
    ]);
    $this->expectException(DiscoveryException::class);
    $this->expectExceptionMessage("vfs://root/modules/test/help_topics/test.topic.html.twig contains invalid value for 'top_level' key, the value must be a Boolean");
    $discovery->getDefinitions();
  }
  
  /**
   * @covers ::findAll
   */
  public function testDiscoveryExceptionInvalidRelated() : void {
    vfsStream::setup('root');
    $topic_content = <<<EOF
---
label: 'A label'
related: "one, two"
---
EOF;
    vfsStream::create([
      'modules' => [
        'test' => [
          'help_topics' => [
            'test.topic.html.twig' => $topic_content,
          ],
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'test' => vfsStream::url('root/modules/test/help_topics'),
    ]);
    $this->expectException(DiscoveryException::class);
    $this->expectExceptionMessage("vfs://root/modules/test/help_topics/test.topic.html.twig contains invalid value for 'related' key, the value must be an array of strings");
    $discovery->getDefinitions();
  }
  
  /**
   * @covers ::findAll
   */
  public function testHelpTopicsExtensionProviderSpecialCase() : void {
    vfsStream::setup('root');
    $topic_content = <<<EOF
---
label: Test
---
<h2>Test</h2>
EOF;
    vfsStream::create([
      'modules' => [
        'help' => [
          'help_topics' => [
            'core.topic.html.twig' => $topic_content,
          ],
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'help' => vfsStream::url('root/modules/help/help_topics'),
    ]);
    $this->assertArrayHasKey('core.topic', $discovery->getDefinitions());
  }
  
  /**
   * @covers ::findAll
   */
  public function testHelpTopicsInCore() : void {
    vfsStream::setup('root');
    $topic_content = <<<EOF
---
label: Test
---
<h2>Test</h2>
EOF;
    vfsStream::create([
      'core' => [
        'help_topics' => [
          'core.topic.html.twig' => $topic_content,
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'core' => vfsStream::url('root/core/help_topics'),
    ]);
    $this->assertArrayHasKey('core.topic', $discovery->getDefinitions());
  }
  
  /**
   * @covers ::findAll
   */
  public function testHelpTopicsBrokenYaml() : void {
    vfsStream::setup('root');
    $topic_content = <<<EOF
---
foo : [bar}
---
<h2>Test</h2>
EOF;
    vfsStream::create([
      'modules' => [
        'help' => [
          'help_topics' => [
            'core.topic.html.twig' => $topic_content,
          ],
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'help' => vfsStream::url('root/modules/help/help_topics'),
    ]);
    $this->expectException(DiscoveryException::class);
    $this->expectExceptionMessage("Malformed YAML in help topic \"vfs://root/modules/help/help_topics/core.topic.html.twig\":");
    $discovery->getDefinitions();
  }
  
  /**
   * @covers ::findAll
   */
  public function testHelpTopicsDefinition() : void {
    $container = new ContainerBuilder();
    $container->set('string_translation', $this->getStringTranslationStub());
    \Drupal::setContainer($container);
    vfsStream::setup('root');
    $topic_content = <<<EOF
---
label: 'Test'
top_level: true
related:
  - one
  - two
  - three
---
<h2>Test</h2>
EOF;
    vfsStream::create([
      'modules' => [
        'foo' => [
          'help_topics' => [
            'foo.topic.html.twig' => $topic_content,
          ],
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'foo' => vfsStream::url('root/modules/foo/help_topics'),
    ]);
    $definition = $discovery->getDefinitions()['foo.topic'];
    $this->assertEquals('Test', $definition['label']);
    $this->assertInstanceOf(TranslatableMarkup::class, $definition['label']);
    $this->assertTrue($definition['top_level']);
    // Each related plugin ID should be trimmed.
    $this->assertSame([
      'one',
      'two',
      'three',
    ], $definition['related']);
    $this->assertSame('foo', $definition['provider']);
    $this->assertSame(HelpTopicTwig::class, $definition['class']);
    $this->assertSame(vfsStream::url('root/modules/foo/help_topics/foo.topic.html.twig'), $definition['_discovered_file_path']);
    $this->assertSame('foo.topic', $definition['id']);
  }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overrides
HelpTopicDiscoveryTest::testDiscoveryExceptionInvalidRelated public function @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testDiscoveryExceptionInvalidTopLevel public function @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testDiscoveryExceptionInvalidYamlKey public function @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testDiscoveryExceptionMissingLabel public function @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsBrokenYaml public function @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsDefinition public function @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsExtensionProviderSpecialCase public function @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsInCore public function @covers ::findAll[[api-linebreak]]
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.
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.
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 Deprecated public function Callback for random string validation.
UnitTestCase::$root protected property The app root. 1
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::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUp protected function 358
UnitTestCase::setUpBeforeClass public static function
UnitTestCase::__get public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.