silverstripe-fulltextsearch/tests/SearchVariantSubsitesTest.php

<?php

namespace SilverStripe\FullTextSearch\Tests;

use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\FullTextSearch\Search\FullTextSearch;
use SilverStripe\FullTextSearch\Search\Processors\SearchUpdateProcessor;
use SilverStripe\FullTextSearch\Search\Queries\SearchQuery;
use SilverStripe\FullTextSearch\Search\Updaters\SearchUpdater;
use SilverStripe\FullTextSearch\Search\Variants\SearchVariantSubsites;
use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_Container;
use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_FakeIndex;
use SilverStripe\Subsites\Model\Subsite;

class SearchVariantSubsiteTest extends SapphireTest
{
    private static $index = null;

    protected function setUp(): void
    {
        parent::setUp();

        // Check versioned available
        if (!class_exists(Subsite::class)) {
            $this->markTestSkipped('The subsites module is not installed');
        }

        if (self::$index === null) {
            self::$index = singleton(static::class);
        }

        Config::inst()->merge(Injector::class, SearchUpdateProcessor::class, [
            'class' => SearchUpdateImmediateProcessor::class
        ]);

        FullTextSearch::force_index_list(self::$index);
        SearchUpdater::clear_dirty_indexes();
    }

    public function testQueryIsAlteredWhenSubsiteNotSet()
    {
        $index = new SolrIndexTest_FakeIndex();
        $query = new SearchQuery();

        //typical behaviour: nobody is explicitly filtering on subsite, so the search variant adds a filter to the query
        $this->assertArrayNotHasKey('_subsite', $query->require);
        $variant = new SearchVariantSubsites();
        $variant->alterDefinition(SearchUpdaterTest_Container::class, $index);
        $variant->alterQuery($query, $index);

        //check that the "default" query has been put in place: it's not empty, and we're searching on Subsite ID:0 and
        // an object of SearchQuery::missing
        $this->assertNotEmpty($query->require['_subsite']);
        $this->assertEmpty($query->require['_subsite'][0]);

        //check that SearchQuery::missing is set (by default, it is an object of stdClass)
        $this->assertInstanceOf('stdClass', $query->require['_subsite'][1]);
    }


    public function testQueryIsAlteredWhenSubsiteIsSet()
    {
        //now we want to test if somebody has already applied the _subsite filter to the query
        $index = new SolrIndexTest_FakeIndex();
        $query = new SearchQuery();

        //check that _subsite is not applied yet
        //this key should not be exist until the SearchVariant applies it later
        $this->assertArrayNotHasKey('_subsite', $query->require);

        //apply the subsite filter on the query (for example, if it's passed into a controller and set before searching)
        //we've chosen an arbirary value of 2 here, to check if it is changed later
        $query->addFilter('_subsite', 2);
        $this->assertNotEmpty($query->require['_subsite']);

        //apply the search variant's definition and query
        $variant = new SearchVariantSubsites();
        $variant->alterDefinition(SearchUpdaterTest_Container::class, $index);

        //the protected function isFieldFiltered is implicitly tested here
        $variant->alterQuery($query, $index);

        //confirm that the query has been altered, but NOT with default values
        //first check that _subsite filter is not empty
        $this->assertNotEmpty($query->require['_subsite']);
        //subsite filter first value is not 0
        $this->assertNotEquals(0, $query->require['_subsite'][0]);

        //subsite filter SearchQuery::missing should not be set so its expected location is empty
        $this->assertArrayNotHasKey(1, $query->require['_subsite']);

        //subsite filter has been modified with our arbitrary test value. The second value is not set
        //this proves that the query has not been altered by the variant
        $this->assertEquals(2, $query->require['_subsite'][0]);
    }
}