You are here

Home » API reference » Allow a content type only once (Only One) 8 » OnlyOneModuleHandlerTest.php

class OnlyOneModuleHandlerTest in Allow a content type only once (Only One) 8

Tests the OnlyOneModuleHandler class methods.

@group onlyone @coversDefaultClass \Drupal\onlyone\OnlyOneModuleHandler

Hierarchy

Expanded class hierarchy of OnlyOneModuleHandlerTest

File

tests/src/Unit/OnlyOneModuleHandlerTest.php, line 15

Namespace

Drupal\Tests\onlyone\Unit
View source 
class OnlyOneModuleHandlerTest extends UnitTestCase {

  /**
   * A module handler instance.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $moduleHandler;

  /**
   * A renderer instance.
   *
   * @var \Drupal\Core\Render\RendererInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $renderer;

  /**
   * A module extension list instance.
   *
   * @var \Drupal\Core\Extension\ModuleExtensionList|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $moduleExtensionList;

  /**
   * The OnlyOneModuleHandler Object.
   *
   * @var \Drupal\onlyone\OnlyOneModuleHandler
   */
  protected $onlyOneModuleHandler;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    if (!defined('DRUPAL_MINIMUM_PHP')) {
      define('DRUPAL_MINIMUM_PHP', '5.5.9');
    }

    // Module Handler mock.
    $this->moduleHandler = $this
      ->createMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');

    // Renderer mock.
    $this->renderer = $this
      ->createMock('Drupal\\Core\\Render\\RendererInterface');

    // ModuleExtensionList mock.
    $this->moduleExtensionList = $this
      ->createMock('Drupal\\Core\\Extension\\ModuleExtensionList');

    // Creating the object.
    $this->onlyOneModuleHandler = new OnlyOneModuleHandler($this->moduleHandler, $this->renderer, $this->moduleExtensionList);
  }

  /**
   * Tests the returned link from OnlyOneModuleHandler::getModuleHelpPageLink().
   *
   * @param string $expected
   *   The expected result from calling the function.
   * @param string $module_machine_name
   *   The module machine name.
   * @param string $module_name_alternate
   *   Alternate module name to use if the module is not present in the site.
   * @param string|false $emphasize
   *   Use this parameter to wrap with <em> tags the module name if the module
   *   is not installed or not present in the site.
   *
   * @covers ::getModuleHelpPageLink
   * @dataProvider providerGetModuleHelpPageLink
   */
  public function testGetModuleHelpPageLink($expected, $module_machine_name, $module_name_alternate, $emphasize = FALSE) {

    // All the installed modules.
    $modules = [];
    $modules['admin_toolbar']['name'] = 'Admin Toolbar';
    $modules['modules_weight']['name'] = 'Modules Weight';
    $modules['no_autocomplete']['name'] = 'No Autocomplete';
    $modules['node']['name'] = 'Node';
    $modules['views']['name'] = 'Views';
    $modules['workflows']['name'] = 'Workflows';

    // Mocking getAllInstalledInfo method.
    $this->moduleExtensionList
      ->expects($this
      ->any())
      ->method('getAllInstalledInfo')
      ->willReturn($modules);

    // Modules installed and implementing the hook_help.
    $modules_with_hook_help = [
      'admin_toolbar',
      'modules_weight',
      'no_autocomplete',
    ];

    // Mocking getImplementations method.
    $this->moduleHandler
      ->expects($this
      ->any())
      ->method('getImplementations')
      ->with('help')
      ->willReturn($modules_with_hook_help);

    // Here $module_name_alternate made the works as $module_name.
    $build = [
      '#type' => 'link',
      '#title' => $module_name_alternate,
      '#url' => Url::fromRoute('help.page', [
        'name' => $module_machine_name,
      ]),
      '#cache' => [
        'tags' => [
          'config:core.extension',
        ],
      ],
    ];

    // Mocking render method.
    $this->renderer
      ->expects($this
      ->any())
      ->method('render')
      ->with($build)
      ->willReturn($expected);

    // Testing the function.
    $this
      ->assertEquals($expected, $this->onlyOneModuleHandler
      ->getModuleHelpPageLink($module_machine_name, $module_name_alternate, $emphasize));
  }

  /**
   * Data provider for testGetModuleHelpPageLink().
   *
   * @return array
   *   An array of arrays, each containing:
   *   - 'expected' - Expected return from existsNodesContentType().
   *   - 'module_machine_name' - The module machine name.
   *   - 'module_name_alternate' - Alternate module name.
   *   - 'emphasize' - Boolean for wrap with <em> tags the module name.
   *
   * @see testExistsNodesContentType()
   */
  public function providerGetModuleHelpPageLink() {
    $tests = [
      // No existing modules.
      [
        '<em>Action</em>',
        'action',
        'Action',
        TRUE,
      ],
      [
        'Asana Module',
        'asana',
        'Asana Module',
        FALSE,
      ],
      [
        'Webform',
        'webform',
        'Webform',
      ],
      // Existing installed modules.
      [
        'Admin Toolbar',
        'admin_toolbar',
        'Admin Toolbar',
        TRUE,
      ],
      [
        'Modules Weight',
        'modules_weight',
        'Modules Weight',
      ],
      [
        'No Autocomplete',
        'no_autocomplete',
        'No Autocomplete',
        FALSE,
      ],
      // Existing not installed modules.
      [
        '<em>Node</em>',
        'node',
        'Node Module',
        TRUE,
      ],
      [
        'Views',
        'views',
        'Views Module',
        FALSE,
      ],
      [
        'Workflows',
        'workflows',
        'Workflows Module',
      ],
    ];
    return $tests;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
OnlyOneModuleHandlerTest::$moduleExtensionList protected property A module extension list instance.
OnlyOneModuleHandlerTest::$moduleHandler protected property A module handler instance.
OnlyOneModuleHandlerTest::$onlyOneModuleHandler protected property The OnlyOneModuleHandler Object.
OnlyOneModuleHandlerTest::$renderer protected property A renderer instance.
OnlyOneModuleHandlerTest::providerGetModuleHelpPageLink public function Data provider for testGetModuleHelpPageLink().
OnlyOneModuleHandlerTest::setUp public function Overrides UnitTestCase::setUp
OnlyOneModuleHandlerTest::testGetModuleHelpPageLink public function Tests the returned link from OnlyOneModuleHandler::getModuleHelpPageLink().
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated protected function Mocks a block with a block plugin. 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::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.