BaseIndexTest::testDoSearch() - Code Metrics - Inspection of "Introspection Helper Class" - Firesphere/silverstripe-solr-search - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — sheepy/introspection ( 7d1300...ff3f16 )

by Marco

created 2019-07-12 10:59 UTC

BaseIndexTest::testDoSearch() A

↳ Parent: BaseIndexTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	58
Code Lines	42

Duplication

Lines	0
Ratio	0 %

Importance

Changes	14
Bugs	0	Features	0

Metric	Value
eloc	42
c	14
b	0
f	0
dl	0
loc	58
rs	9.248
cc	1
nc	1
nop	0

How to fix Long Method

<?php


namespace Firesphere\SolrSearch\Tests;

use CircleCITestIndex;
use Firesphere\SolrSearch\Helpers\Synonyms;
use Firesphere\SolrSearch\Indexes\BaseIndex;
use Firesphere\SolrSearch\Queries\BaseQuery;
use Firesphere\SolrSearch\Results\SearchResult;
use Firesphere\SolrSearch\Stores\FileConfigStore;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Control\Director;
use SilverStripe\Control\NullHTTPRequest;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\PaginatedList;
use SilverStripe\Security\DefaultAdminService;
use SilverStripe\View\ArrayData;
use Solarium\Component\Result\Highlighting\Highlighting;
use Solarium\Core\Client\Client;

class BaseIndexTest extends SapphireTest
{
    /**
     * @var BaseIndex
     */
    protected $index;

    public function testConstruct()
    {
        $this->assertInstanceOf(Client::class, $this->index->getClient());
        $this->assertCount(1, $this->index->getClasses());
        $this->assertCount(1, $this->index->getFulltextFields());
        $this->assertContains(SiteTree::class, $this->index->getClasses());
    }

    public function testInit()
    {
        $this->assertNull($this->index->init());
        $this->assertNotEmpty($this->index->getFulltextFields());
        $this->assertNotEmpty($this->index->getFieldsForIndexing());
        $expected = [
            'Title',
            'Content',
            'Created',
            'SubsiteID'
        ];

        $this->assertEquals($expected, array_values($this->index->getFieldsForIndexing()));

        $index = new TestIndexTwo();

        $this->assertCount(3, $index->getFulltextFields());
        $this->assertCount(1, $index->getFacetFields());
        $facets = $index->getFacetFields();
        $this->assertEquals(['Field' => 'SiteTree_TestObjectID', 'Title' => 'TestObject'], $facets[TestObject::class]);
    }

    public function testGetSynonyms()
    {
        $this->assertEquals(Synonyms::getSynonymsAsString(), $this->index->getSynonyms());

        $this->assertEmpty($this->index->getSynonyms(false));
    }

    public function testIndexName()
    {
        $this->assertEquals('TestIndex', $this->index->getIndexName());
    }

    public function testUploadConfig()
    {
        $config = [
            'mode' => 'file',
            'path' => '.solr'
        ];

        /** @var FileConfigStore $configStore */
        $configStore = Injector::inst()->create(FileConfigStore::class, $config);

        $this->index->uploadConfig($configStore);

        $this->assertFileExists(Director::baseFolder() . '/.solr/TestIndex/conf/schema.xml');
        $this->assertFileExists(Director::baseFolder() . '/.solr/TestIndex/conf/synonyms.txt');
        $this->assertFileExists(Director::baseFolder() . '/.solr/TestIndex/conf/stopwords.txt');

        $xml = file_get_contents(Director::baseFolder() . '/.solr/TestIndex/conf/schema.xml');
        $this->assertContains(
            '<field name=\'SiteTree_Title\' type=\'string\' indexed=\'true\' stored=\'true\' multiValued=\'false\'/>',
            $xml
        );

        $original = $configStore->getConfig();
        $configStore->setConfig([]);
        $this->assertEquals([], $configStore->getConfig());
        // Unhappy path, the config is not updated
        $this->assertNotEquals($original, $configStore->getConfig());
    }

    public function testEscapeTerms()
    {
        $term = '"test me" help';

        $helper = $this->index->getClient()->createSelect()->getHelper();

        $escaped = $this->index->escapeSearch($term, $helper);
        $this->assertEquals('"\"test me\"" help', $escaped);

        $term = 'help me';

        $this->assertEquals('help me', $this->index->escapeSearch($term, $helper));
    }

    public function testGetFieldsForIndexing()
    {
        $expected = [
            'Title',
            'Content',
            'Created',
            'SubsiteID'
        ];
        $this->assertEquals($expected, array_values($this->index->getFieldsForIndexing()));
    }

    public function testGetSetClient()
    {
        $client = $this->index->getClient();
        // set client to something stupid
        $this->index->setClient('test');
        $this->assertEquals('test', $this->index->getClient());
        $this->index->setClient($client);
        $this->assertInstanceOf(Client::class, $this->index->getClient());
    }

    public function testDoSearch()
    {
        $index = new CircleCITestIndex();

        $query = new BaseQuery();
        $query->addTerm('Home');

        $result = $index->doSearch($query);
        $this->assertInstanceOf(SearchResult::class, $result);
        $this->assertEquals(1, $result->getTotalItems());

        $admin = singleton(DefaultAdminService::class)->findOrCreateDefaultAdmin();
        $this->loginAs($admin);
        // Result should be the same for now
        $result2 = $index->doSearch($query);
        $this->assertEquals($result, $result2);

        $query->addClass(SiteTree::class);

        $result3 = $index->doSearch($query);
        $request = new NullHTTPRequest();
        $this->assertInstanceOf(PaginatedList::class, $result3->getPaginatedMatches($request));
        $this->assertEquals($result3->getTotalItems(), $result3->getPaginatedMatches($request)->getTotalItems());
        $this->assertInstanceOf(ArrayData::class, $result3->getFacets());
        $this->assertInstanceOf(ArrayList::class, $result3->getSpellcheck());
        $this->assertInstanceOf(Highlighting::class, $result3->getHighlight());

        $index = new CircleCITestIndex();
        $query = new BaseQuery();
        $query->addTerm('Home', ['SiteTree_Title'], 5);
        $result4 = $index->doSearch($query);

        $this->assertEquals(['SiteTree_Title:Home^5.0'], $index->getBoostTerms());
        $this->assertEquals(['Home'], $index->getQueryTerms());
        $this->assertEquals(1, $result4->getTotalItems());

        $index = new CircleCITestIndex();
        $query = new BaseQuery();
        $query->addTerm('Home', ['SiteTree.Title'], 3);
        $result4 = $index->doSearch($query);

        $this->assertEquals(['SiteTree_Title:Home^3.0'], $index->getBoostTerms());
        $this->assertEquals(['Home'], $index->getQueryTerms());
        $this->assertEquals(1, $result4->getTotalItems());

        $index = new CircleCITestIndex();
        $query = new BaseQuery();
        $query->addTerm('Home', [], 0, true);
        $index->doSearch($query);

        $this->assertContains('Home~', $index->getQueryTerms());

        $index = new CircleCITestIndex();
        $query = new BaseQuery();
        $query->addTerm('Home', [], 0, 2);
        $index->doSearch($query);

        $this->assertContains('Home~2', $index->getQueryTerms());
    }

    public function testGetFieldsForSubsites()
    {
        $this->assertContains('SubsiteID', $this->index->getFilterFields());
    }

    protected function setUp()
    {
        $this->index = Injector::inst()->get(TestIndex::class);

        return parent::setUp();
    }
}


1			<?php
2
3
4			namespace Firesphere\SolrSearch\Tests;
5
6			use CircleCITestIndex;
7			use Firesphere\SolrSearch\Helpers\Synonyms;
8			use Firesphere\SolrSearch\Indexes\BaseIndex;
9			use Firesphere\SolrSearch\Queries\BaseQuery;
10			use Firesphere\SolrSearch\Results\SearchResult;
11			use Firesphere\SolrSearch\Stores\FileConfigStore;
12			use SilverStripe\CMS\Model\SiteTree;
13			use SilverStripe\Control\Director;
14			use SilverStripe\Control\NullHTTPRequest;
15			use SilverStripe\Core\Injector\Injector;
16			use SilverStripe\Dev\SapphireTest;
17			use SilverStripe\ORM\ArrayList;
18			use SilverStripe\ORM\PaginatedList;
19			use SilverStripe\Security\DefaultAdminService;
20			use SilverStripe\View\ArrayData;
21			use Solarium\Component\Result\Highlighting\Highlighting;
22			use Solarium\Core\Client\Client;
23
24			class BaseIndexTest extends SapphireTest
25			{
26			/**
27			* @var BaseIndex
28			*/
29			protected $index;
30
31			public function testConstruct()
32			{
33			$this->assertInstanceOf(Client::class, $this->index->getClient());
34			$this->assertCount(1, $this->index->getClasses());
35			$this->assertCount(1, $this->index->getFulltextFields());
36			$this->assertContains(SiteTree::class, $this->index->getClasses());
37			}
38
39			public function testInit()
40			{
41			$this->assertNull($this->index->init());
42			$this->assertNotEmpty($this->index->getFulltextFields());
43			$this->assertNotEmpty($this->index->getFieldsForIndexing());
44			$expected = [
45			'Title',
46			'Content',
47			'Created',
48			'SubsiteID'
49			];
50
51			$this->assertEquals($expected, array_values($this->index->getFieldsForIndexing()));
52
53			$index = new TestIndexTwo();
54
55			$this->assertCount(3, $index->getFulltextFields());
56			$this->assertCount(1, $index->getFacetFields());
57			$facets = $index->getFacetFields();
58			$this->assertEquals(['Field' => 'SiteTree_TestObjectID', 'Title' => 'TestObject'], $facets[TestObject::class]);
59			}
60
61			public function testGetSynonyms()
62			{
63			$this->assertEquals(Synonyms::getSynonymsAsString(), $this->index->getSynonyms());
64
65			$this->assertEmpty($this->index->getSynonyms(false));
66			}
67
68			public function testIndexName()
69			{
70			$this->assertEquals('TestIndex', $this->index->getIndexName());
71			}
72
73			public function testUploadConfig()
74			{
75			$config = [
76			'mode' => 'file',
77			'path' => '.solr'
78			];
79
80			/** @var FileConfigStore $configStore */
81			$configStore = Injector::inst()->create(FileConfigStore::class, $config);
82
83			$this->index->uploadConfig($configStore);
84
85			$this->assertFileExists(Director::baseFolder() . '/.solr/TestIndex/conf/schema.xml');
86			$this->assertFileExists(Director::baseFolder() . '/.solr/TestIndex/conf/synonyms.txt');
87			$this->assertFileExists(Director::baseFolder() . '/.solr/TestIndex/conf/stopwords.txt');
88
89			$xml = file_get_contents(Director::baseFolder() . '/.solr/TestIndex/conf/schema.xml');
90			$this->assertContains(
91			'<field name=\'SiteTree_Title\' type=\'string\' indexed=\'true\' stored=\'true\' multiValued=\'false\'/>',
92			$xml
93			);
94
95			$original = $configStore->getConfig();
96			$configStore->setConfig([]);
97			$this->assertEquals([], $configStore->getConfig());
98			// Unhappy path, the config is not updated
99			$this->assertNotEquals($original, $configStore->getConfig());
100			}
101
102			public function testEscapeTerms()
103			{
104			$term = '"test me" help';
105
106			$helper = $this->index->getClient()->createSelect()->getHelper();
107
108			$escaped = $this->index->escapeSearch($term, $helper);
109			$this->assertEquals('"\"test me\"" help', $escaped);
110
111			$term = 'help me';
112
113			$this->assertEquals('help me', $this->index->escapeSearch($term, $helper));
114			}
115
116			public function testGetFieldsForIndexing()
117			{
118			$expected = [
119			'Title',
120			'Content',
121			'Created',
122			'SubsiteID'
123			];
124			$this->assertEquals($expected, array_values($this->index->getFieldsForIndexing()));
125			}
126
127			public function testGetSetClient()
128			{
129			$client = $this->index->getClient();
130			// set client to something stupid
131			$this->index->setClient('test');
132			$this->assertEquals('test', $this->index->getClient());
133			$this->index->setClient($client);
134			$this->assertInstanceOf(Client::class, $this->index->getClient());
135			}
136
137			public function testDoSearch()
138			{
139			$index = new CircleCITestIndex();
140
141			$query = new BaseQuery();
142			$query->addTerm('Home');
143
144			$result = $index->doSearch($query);
145			$this->assertInstanceOf(SearchResult::class, $result);
146			$this->assertEquals(1, $result->getTotalItems());
147
148			$admin = singleton(DefaultAdminService::class)->findOrCreateDefaultAdmin();
149			$this->loginAs($admin);
150			// Result should be the same for now
151			$result2 = $index->doSearch($query);
152			$this->assertEquals($result, $result2);
153
154			$query->addClass(SiteTree::class);
155
156			$result3 = $index->doSearch($query);
157			$request = new NullHTTPRequest();
158			$this->assertInstanceOf(PaginatedList::class, $result3->getPaginatedMatches($request));
159			$this->assertEquals($result3->getTotalItems(), $result3->getPaginatedMatches($request)->getTotalItems());
160			$this->assertInstanceOf(ArrayData::class, $result3->getFacets());
161			$this->assertInstanceOf(ArrayList::class, $result3->getSpellcheck());
162			$this->assertInstanceOf(Highlighting::class, $result3->getHighlight());
163
164			$index = new CircleCITestIndex();
165			$query = new BaseQuery();
166			$query->addTerm('Home', ['SiteTree_Title'], 5);
167			$result4 = $index->doSearch($query);
168
169			$this->assertEquals(['SiteTree_Title:Home^5.0'], $index->getBoostTerms());
170			$this->assertEquals(['Home'], $index->getQueryTerms());
171			$this->assertEquals(1, $result4->getTotalItems());
172
173			$index = new CircleCITestIndex();
174			$query = new BaseQuery();
175			$query->addTerm('Home', ['SiteTree.Title'], 3);
176			$result4 = $index->doSearch($query);
177
178			$this->assertEquals(['SiteTree_Title:Home^3.0'], $index->getBoostTerms());
179			$this->assertEquals(['Home'], $index->getQueryTerms());
180			$this->assertEquals(1, $result4->getTotalItems());
181
182			$index = new CircleCITestIndex();
183			$query = new BaseQuery();
184			$query->addTerm('Home', [], 0, true);
185			$index->doSearch($query);
186
187			$this->assertContains('Home~', $index->getQueryTerms());
188
189			$index = new CircleCITestIndex();
190			$query = new BaseQuery();
191			$query->addTerm('Home', [], 0, 2);
192			$index->doSearch($query);
193
194			$this->assertContains('Home~2', $index->getQueryTerms());
195			}
196
197			public function testGetFieldsForSubsites()
198			{
199			$this->assertContains('SubsiteID', $this->index->getFilterFields());
200			}
201
202			protected function setUp()
203			{
204			$this->index = Injector::inst()->get(TestIndex::class);
205
206			return parent::setUp();
207			}
208			}
209

Firesphere / silverstripe-solr-search

Push — sheepy/introspection ( 7d1300...ff3f16 )

BaseIndexTest::testDoSearch() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like