HelpTopicDiscoveryTest.php in Drupal 8

Namespace

Drupal\Tests\help_topics\Unit

File

core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php

<?php

namespace Drupal\Tests\help_topics\Unit;

use Drupal\Component\Discovery\DiscoveryException;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\help_topics\HelpTopicDiscovery;
use Drupal\help_topics\HelpTopicTwig;
use Drupal\Tests\UnitTestCase;
use org\bovigo\vfs\vfsStream;

/**
 * @coversDefaultClass \Drupal\help_topics\HelpTopicDiscovery
 * @group help_topics
 */
class HelpTopicDiscoveryTest extends UnitTestCase {

  /**
   * @covers ::findAll
   */
  public function testDiscoveryExceptionProviderMismatch() {
    vfsStream::setup('root');
    vfsStream::create([
      'modules' => [
        'foo' => [
          'help_topics' => [
            // The content of the help topic does not matter.
            'test.topic.html.twig' => '',
          ],
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'foo' => vfsStream::url('root/modules/foo/help_topics'),
    ]);
    $this
      ->expectException(DiscoveryException::class);
    $this
      ->expectExceptionMessage("vfs://root/modules/foo/help_topics/test.topic.html.twig file name should begin with 'foo'");
    $discovery
      ->getDefinitions();
  }

  /**
   * @covers ::findAll
   */
  public function testDiscoveryExceptionMissingLabel() {
    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() {
    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() {
    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() {
    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() {
    vfsStream::setup('root');
    $topic_content = <<<EOF
---
label: Test
---
<h2>Test</h2>
EOF;
    vfsStream::create([
      'modules' => [
        'help_topics' => [
          'help_topics' => [
            'core.topic.html.twig' => $topic_content,
          ],
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'help_topics' => vfsStream::url('root/modules/help_topics/help_topics'),
    ]);
    $this
      ->assertArrayHasKey('core.topic', $discovery
      ->getDefinitions());
  }

  /**
   * @covers ::findAll
   */
  public function testHelpTopicsInCore() {
    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() {
    vfsStream::setup('root');
    $topic_content = <<<EOF
---
foo : [bar}
---
<h2>Test</h2>
EOF;
    vfsStream::create([
      'modules' => [
        'help_topics' => [
          'help_topics' => [
            'core.topic.html.twig' => $topic_content,
          ],
        ],
      ],
    ]);
    $discovery = new HelpTopicDiscovery([
      'help_topics' => vfsStream::url('root/modules/help_topics/help_topics'),
    ]);
    $this
      ->expectException(DiscoveryException::class);
    $this
      ->expectExceptionMessage("Malformed YAML in help topic \"vfs://root/modules/help_topics/help_topics/core.topic.html.twig\":");
    $discovery
      ->getDefinitions();
  }

  /**
   * @covers ::findAll
   */
  public function testHelpTopicsDefinition() {
    $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
      ->assertSame(TRUE, $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']);
  }

}

Classes

Name	Description
HelpTopicDiscoveryTest	@coversDefaultClass \Drupal\help_topics\HelpTopicDiscovery @group help_topics