class SortTest in Drupal 8

@coversDefaultClass \Drupal\jsonapi\Query\Sort @group jsonapi

@internal

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\jsonapi\Unit\Query\SortTest

File

core/modules/jsonapi/tests/src/Unit/Query/SortTest.php, line 18

Namespace

Drupal\Tests\jsonapi\Unit\Query

class SortTest extends UnitTestCase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $container = new Container();
    $cache_context_manager = $this
      ->prophesize(CacheContextsManager::class);
    $cache_context_manager
      ->assertValidTokens(Argument::any())
      ->willReturn(TRUE);
    $container
      ->set('cache_contexts_manager', $cache_context_manager
      ->reveal());
    \Drupal::setContainer($container);
  }

  /**
   * @covers ::createFromQueryParameter
   * @dataProvider parameterProvider
   */
  public function testCreateFromQueryParameter($input, $expected) {
    $sort = Sort::createFromQueryParameter($input);
    foreach ($sort
      ->fields() as $index => $sort_field) {
      $this
        ->assertEquals($expected[$index]['path'], $sort_field['path']);
      $this
        ->assertEquals($expected[$index]['direction'], $sort_field['direction']);
      $this
        ->assertEquals($expected[$index]['langcode'], $sort_field['langcode']);
    }
  }

  /**
   * Provides a suite of shortcut sort paramaters and their expected expansions.
   */
  public function parameterProvider() {
    return [
      [
        'lorem',
        [
          [
            'path' => 'lorem',
            'direction' => 'ASC',
            'langcode' => NULL,
          ],
        ],
      ],
      [
        '-lorem',
        [
          [
            'path' => 'lorem',
            'direction' => 'DESC',
            'langcode' => NULL,
          ],
        ],
      ],
      [
        '-lorem,ipsum',
        [
          [
            'path' => 'lorem',
            'direction' => 'DESC',
            'langcode' => NULL,
          ],
          [
            'path' => 'ipsum',
            'direction' => 'ASC',
            'langcode' => NULL,
          ],
        ],
      ],
      [
        '-lorem,-ipsum',
        [
          [
            'path' => 'lorem',
            'direction' => 'DESC',
            'langcode' => NULL,
          ],
          [
            'path' => 'ipsum',
            'direction' => 'DESC',
            'langcode' => NULL,
          ],
        ],
      ],
      [
        [
          [
            'path' => 'lorem',
            'langcode' => NULL,
          ],
          [
            'path' => 'ipsum',
            'langcode' => 'ca',
          ],
          [
            'path' => 'dolor',
            'direction' => 'ASC',
            'langcode' => 'ca',
          ],
          [
            'path' => 'sit',
            'direction' => 'DESC',
            'langcode' => 'ca',
          ],
        ],
        [
          [
            'path' => 'lorem',
            'direction' => 'ASC',
            'langcode' => NULL,
          ],
          [
            'path' => 'ipsum',
            'direction' => 'ASC',
            'langcode' => 'ca',
          ],
          [
            'path' => 'dolor',
            'direction' => 'ASC',
            'langcode' => 'ca',
          ],
          [
            'path' => 'sit',
            'direction' => 'DESC',
            'langcode' => 'ca',
          ],
        ],
      ],
    ];
  }

  /**
   * @covers ::createFromQueryParameter
   * @dataProvider badParameterProvider
   */
  public function testCreateFromQueryParameterFail($input) {
    $this
      ->expectException(BadRequestHttpException::class);
    Sort::createFromQueryParameter($input);
  }

  /**
   * Data provider for testCreateFromQueryParameterFail.
   */
  public function badParameterProvider() {
    return [
      [
        [
          [
            'lorem',
          ],
        ],
      ],
      [
        '',
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
SortTest::badParameterProvider	public	function	Data provider for testCreateFromQueryParameterFail.
SortTest::parameterProvider	public	function	Provides a suite of shortcut sort paramaters and their expected expansions.
SortTest::setUp	protected	function	Overrides UnitTestCase::setUp
SortTest::testCreateFromQueryParameter	public	function	@covers ::createFromQueryParameter @dataProvider parameterProvider
SortTest::testCreateFromQueryParameterFail	public	function	@covers ::createFromQueryParameter @dataProvider badParameterProvider
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.