class SearchApiStringTest in Facets 8

Unit test for query type.

@group facets

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\facets\Unit\Plugin\query_type\SearchApiStringTest

File

tests/src/Unit/Plugin/query_type/SearchApiStringTest.php, line 17

Namespace

Drupal\Tests\facets\Unit\Plugin\query_type

class SearchApiStringTest extends UnitTestCase {

  /**
   * Tests string query type without executing the query with an "AND" operator.
   */
  public function testQueryTypeAnd() {
    $query = new SearchApiQuery([], 'search_api_query', []);
    $facet = new Facet([
      'query_operator' => 'and',
    ], 'facets_facet');
    $original_results = [
      [
        'count' => 3,
        'filter' => 'badger',
      ],
      [
        'count' => 5,
        'filter' => 'mushroom',
      ],
      [
        'count' => 7,
        'filter' => 'narwhal',
      ],
      [
        'count' => 9,
        'filter' => 'unicorn',
      ],
    ];
    $query_type = new SearchApiString([
      'facet' => $facet,
      'query' => $query,
      'results' => $original_results,
    ], 'search_api_string', []);
    $built_facet = $query_type
      ->build();
    $this
      ->assertInstanceOf(FacetInterface::class, $built_facet);
    $results = $built_facet
      ->getResults();
    $this
      ->assertSame('array', gettype($results));
    foreach ($original_results as $k => $result) {
      $this
        ->assertInstanceOf(ResultInterface::class, $results[$k]);
      $this
        ->assertEquals($result['count'], $results[$k]
        ->getCount());
      $this
        ->assertEquals($result['filter'], $results[$k]
        ->getDisplayValue());
    }
  }

  /**
   * Tests string query type without executing the query with an "OR" operator.
   */
  public function testQueryTypeOr() {
    $query = new SearchApiQuery([], 'search_api_query', []);
    $facet = new Facet([
      'query_operator' => 'or',
    ], 'facets_facet');
    $facet
      ->setFieldIdentifier('field_animal');
    $original_results = [
      [
        'count' => 3,
        'filter' => 'badger',
      ],
      [
        'count' => 5,
        'filter' => 'mushroom',
      ],
      [
        'count' => 7,
        'filter' => 'narwhal',
      ],
      [
        'count' => 9,
        'filter' => 'unicorn',
      ],
    ];
    $query_type = new SearchApiString([
      'facet' => $facet,
      'query' => $query,
      'results' => $original_results,
    ], 'search_api_string', []);
    $built_facet = $query_type
      ->build();
    $this
      ->assertInstanceOf(FacetInterface::class, $built_facet);
    $results = $built_facet
      ->getResults();
    $this
      ->assertSame('array', gettype($results));
    foreach ($original_results as $k => $result) {
      $this
        ->assertInstanceOf(ResultInterface::class, $results[$k]);
      $this
        ->assertEquals($result['count'], $results[$k]
        ->getCount());
      $this
        ->assertEquals($result['filter'], $results[$k]
        ->getDisplayValue());
    }
  }

  /**
   * Tests string query type without results.
   */
  public function testEmptyResults() {
    $query = new SearchApiQuery([], 'search_api_query', []);
    $facet = new Facet([], 'facets_facet');
    $query_type = new SearchApiString([
      'facet' => $facet,
      'query' => $query,
    ], 'search_api_string', []);
    $built_facet = $query_type
      ->build();
    $this
      ->assertInstanceOf(FacetInterface::class, $built_facet);
    $results = $built_facet
      ->getResults();
    $this
      ->assertSame('array', gettype($results));
    $this
      ->assertEmpty($results);
  }

  /**
   * Tests string query type without results.
   */
  public function testConfiguration() {
    $query = new SearchApiQuery([], 'search_api_query', []);
    $facet = new Facet([], 'facets_facet');
    $default_config = [
      'facet' => $facet,
      'query' => $query,
    ];
    $query_type = new SearchApiString($default_config, 'search_api_string', []);
    $this
      ->assertEquals([], $query_type
      ->defaultConfiguration());
    $this
      ->assertEquals($default_config, $query_type
      ->getConfiguration());
    $query_type
      ->setConfiguration([
      'owl' => 'Long-eared owl',
    ]);
    $this
      ->assertEquals([
      'owl' => 'Long-eared owl',
    ], $query_type
      ->getConfiguration());
  }

  /**
   * Tests trimming in ::build.
   *
   * @dataProvider provideTrimValues
   */
  public function testTrim($expected_value, $input_value) {
    $query = new SearchApiQuery([], 'search_api_query', []);
    $facet = new Facet([], 'facets_facet');
    $original_results = [
      [
        'count' => 1,
        'filter' => $input_value,
      ],
    ];
    $query_type = new SearchApiString([
      'facet' => $facet,
      'query' => $query,
      'results' => $original_results,
    ], 'search_api_string', []);
    $built_facet = $query_type
      ->build();
    $this
      ->assertInstanceOf(FacetInterface::class, $built_facet);
    $results = $built_facet
      ->getResults();
    $this
      ->assertSame('array', gettype($results));
    $this
      ->assertInstanceOf(ResultInterface::class, $results[0]);
    $this
      ->assertEquals(1, $results[0]
      ->getCount());
    $this
      ->assertEquals($expected_value, $results[0]
      ->getDisplayValue());
  }

  /**
   * Data provider for ::provideTrimValues.
   *
   * @return array
   *   An array of expected and input values.
   */
  public function provideTrimValues() {
    return [
      [
        'owl',
        '"owl"',
      ],
      [
        'owl',
        'owl',
      ],
      [
        'owl',
        '"owl',
      ],
      [
        'owl',
        'owl"',
      ],
      [
        '"owl',
        '""owl"',
      ],
      [
        'owl"',
        '"owl""',
      ],
    ];
  }

}

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.
SearchApiStringTest::provideTrimValues	public	function	Data provider for ::provideTrimValues.
SearchApiStringTest::testConfiguration	public	function	Tests string query type without results.
SearchApiStringTest::testEmptyResults	public	function	Tests string query type without results.
SearchApiStringTest::testQueryTypeAnd	public	function	Tests string query type without executing the query with an "AND" operator.
SearchApiStringTest::testQueryTypeOr	public	function	Tests string query type without executing the query with an "OR" operator.
SearchApiStringTest::testTrim	public	function	Tests trimming in ::build.
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.
UnitTestCase::setUp	protected	function		340