class LocalTasksTest in Search API 8

Tests whether Search API's local tasks work correctly.

@group search_api

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\Menu\LocalTaskIntegrationTestBase
    • class \Drupal\Tests\search_api\Unit\LocalTasksTest

File

tests/src/Unit/LocalTasksTest.php, line 12

Namespace

Drupal\Tests\search_api\Unit

class LocalTasksTest extends LocalTaskIntegrationTestBase {

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();

    // Set the path of the module dynamically.
    $module_path = str_replace(\Drupal::root(), '', __DIR__);
    $module_path = str_replace('tests/src/Unit', '', $module_path);
    $module_path = trim($module_path, '/');
    $this->directoryList = [
      'search_api' => $module_path,
    ];
  }

  /**
   * Tests whether the server's local tasks are present at the given route.
   *
   * @param string $route
   *   The route to test.
   *
   * @dataProvider getPageRoutesServer
   */
  public function testLocalTasksServer($route) {
    $tasks = [
      0 => [
        'entity.search_api_server.canonical',
        'entity.search_api_server.edit_form',
      ],
    ];
    $this
      ->assertLocalTasks($route, $tasks);
  }

  /**
   * Provides a list of routes to test.
   *
   * @return array[]
   *   An array containing arrays with the arguments for a
   *   testLocalTasksServer() call.
   */
  public function getPageRoutesServer() {
    return [
      [
        'entity.search_api_server.canonical',
      ],
      [
        'entity.search_api_server.edit_form',
      ],
    ];
  }

  /**
   * Tests whether the index's local tasks are present at the given route.
   *
   * @param string $route
   *   The route to test.
   *
   * @dataProvider getPageRoutesIndex
   */
  public function testLocalTasksIndex($route) {
    $tasks = [
      0 => [
        'entity.search_api_index.canonical',
        'entity.search_api_index.edit_form',
        'entity.search_api_index.fields',
        'entity.search_api_index.processors',
      ],
    ];
    $this
      ->assertLocalTasks($route, $tasks);
  }

  /**
   * Provides a list of routes to test.
   *
   * @return array[]
   *   An array containing arrays with the arguments for a
   *   testLocalTasksIndex() call.
   */
  public function getPageRoutesIndex() {
    return [
      [
        'entity.search_api_index.canonical',
      ],
      [
        'entity.search_api_index.edit_form',
      ],
      [
        'entity.search_api_index.fields',
      ],
      [
        'entity.search_api_index.processors',
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LocalTaskIntegrationTestBase::$container	protected	property	The container.
LocalTaskIntegrationTestBase::$directoryList	protected	property	A list of module directories used for YAML searching.
LocalTaskIntegrationTestBase::$moduleHandler	protected	property	The module handler.
LocalTaskIntegrationTestBase::assertLocalTasks	protected	function	Tests integration for local tasks.
LocalTaskIntegrationTestBase::getLocalTaskManager	protected	function	Sets up the local task manager for the test.
LocalTasksTest::getPageRoutesIndex	public	function	Provides a list of routes to test.
LocalTasksTest::getPageRoutesServer	public	function	Provides a list of routes to test.
LocalTasksTest::setUp	public	function	Overrides LocalTaskIntegrationTestBase::setUp
LocalTasksTest::testLocalTasksIndex	public	function	Tests whether the index's local tasks are present at the given route.
LocalTasksTest::testLocalTasksServer	public	function	Tests whether the server's local tasks are present at the given route.
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.