SolrIndexTest::testSanitiseClassName() - Code Metrics - Inspection of "FIX Replace Object reference with Injector and use..." - silverstripe/silverstripe-fulltextsearch - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#173)

by Robbie

created 2017-11-20 22:49 UTC

SolrIndexTest::testSanitiseClassName() A

↳ Parent: SolrIndexTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	8
rs	9.4285
c	1
b	0
f	0
cc	1
eloc	5
nc	1
nop	0

<?php

namespace SilverStripe\FullTextSearch\Tests;

use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Core\Kernel;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_AmbiguousRelationIndex;
use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_AmbiguousRelationInheritedIndex;
use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_FakeIndex;
use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_FakeIndex2;
use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_BoostedIndex;
use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_Container;
use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_HasOne;
use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_HasMany;
use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_ManyMany;
use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_OtherContainer;
use SilverStripe\FullTextSearch\Search\Queries\SearchQuery;
use SilverStripe\FullTextSearch\Solr\Services\Solr3Service;

class SolrIndexTest extends SapphireTest
{
    public function testFieldDataHasOne()

    {
        $index = new SolrIndexTest_FakeIndex();
        $data = $index->fieldData('HasOneObject.Field1');

        $data = $data[SearchUpdaterTest_Container::class . '_HasOneObject_Field1'];

        $this->assertEquals(SearchUpdaterTest_Container::class, $data['origin']);
        $this->assertEquals(SearchUpdaterTest_Container::class, $data['base']);
        $this->assertEquals(SearchUpdaterTest_HasOne::class, $data['class']);
    }

    public function testFieldDataHasMany()

    {
        $index = new SolrIndexTest_FakeIndex();
        $data = $index->fieldData('HasManyObjects.Field1');
        $data = $data[SearchUpdaterTest_Container::class . '_HasManyObjects_Field1'];

        $this->assertEquals(SearchUpdaterTest_Container::class, $data['origin']);
        $this->assertEquals(SearchUpdaterTest_Container::class, $data['base']);
        $this->assertEquals(SearchUpdaterTest_HasMany::class, $data['class']);
    }

    public function testFieldDataManyMany()

    {
        $index = new SolrIndexTest_FakeIndex();
        $data = $index->fieldData('ManyManyObjects.Field1');
        $data = $data[SearchUpdaterTest_Container::class . '_ManyManyObjects_Field1'];

        $this->assertEquals(SearchUpdaterTest_Container::class, $data['origin']);
        $this->assertEquals(SearchUpdaterTest_Container::class, $data['base']);
        $this->assertEquals(SearchUpdaterTest_ManyMany::class, $data['class']);
    }

    public function testFieldDataAmbiguousHasMany()

    {
        $index = new SolrIndexTest_AmbiguousRelationIndex();
        $data = $index->fieldData('HasManyObjects.Field1');

        $this->assertArrayHasKey(SearchUpdaterTest_Container::class . '_HasManyObjects_Field1', $data);
        $this->assertArrayHasKey(SearchUpdaterTest_OtherContainer::class . '_HasManyObjects_Field1', $data);

        $dataContainer = $data[SearchUpdaterTest_Container::class . '_HasManyObjects_Field1'];
        $this->assertEquals(SearchUpdaterTest_Container::class, $dataContainer['origin']);
        $this->assertEquals(SearchUpdaterTest_Container::class, $dataContainer['base']);
        $this->assertEquals(SearchUpdaterTest_HasMany::class, $dataContainer['class']);

        $dataOtherContainer = $data[SearchUpdaterTest_OtherContainer::class . '_HasManyObjects_Field1'];
        $this->assertEquals(SearchUpdaterTest_OtherContainer::class, $dataOtherContainer['origin']);
        $this->assertEquals(SearchUpdaterTest_OtherContainer::class, $dataOtherContainer['base']);
        $this->assertEquals(SearchUpdaterTest_HasMany::class, $dataOtherContainer['class']);
    }

    public function testFieldDataAmbiguousManyMany()

    {
        $index = new SolrIndexTest_AmbiguousRelationIndex();
        $data = $index->fieldData('ManyManyObjects.Field1');

        $this->assertArrayHasKey(SearchUpdaterTest_Container::class . '_ManyManyObjects_Field1', $data);
        $this->assertArrayHasKey(SearchUpdaterTest_OtherContainer::class . '_ManyManyObjects_Field1', $data);

        $dataContainer = $data[SearchUpdaterTest_Container::class . '_ManyManyObjects_Field1'];
        $this->assertEquals(SearchUpdaterTest_Container::class, $dataContainer['origin']);
        $this->assertEquals(SearchUpdaterTest_Container::class, $dataContainer['base']);
        $this->assertEquals(SearchUpdaterTest_ManyMany::class, $dataContainer['class']);

        $dataOtherContainer = $data[SearchUpdaterTest_OtherContainer::class . '_ManyManyObjects_Field1'];
        $this->assertEquals(SearchUpdaterTest_OtherContainer::class, $dataOtherContainer['origin']);
        $this->assertEquals(SearchUpdaterTest_OtherContainer::class, $dataOtherContainer['base']);
        $this->assertEquals(SearchUpdaterTest_ManyMany::class, $dataOtherContainer['class']);
    }

    public function testFieldDataAmbiguousManyManyInherited()

    {
        $index = new SolrIndexTest_AmbiguousRelationInheritedIndex();
        $data = $index->fieldData('ManyManyObjects.Field1');

        $this->assertArrayHasKey(SearchUpdaterTest_Container::class . '_ManyManyObjects_Field1', $data);
        $this->assertArrayHasKey(SearchUpdaterTest_OtherContainer::class . '_ManyManyObjects_Field1', $data);
        $this->assertArrayNotHasKey(SearchUpdaterTest_ExtendedContainer::class . '_ManyManyObjects_Field1', $data);

        $dataContainer = $data[SearchUpdaterTest_Container::class . '_ManyManyObjects_Field1'];
        $this->assertEquals(SearchUpdaterTest_Container::class, $dataContainer['origin']);
        $this->assertEquals(SearchUpdaterTest_Container::class, $dataContainer['base']);
        $this->assertEquals(SearchUpdaterTest_ManyMany::class, $dataContainer['class']);

        $dataOtherContainer = $data[SearchUpdaterTest_OtherContainer::class . '_ManyManyObjects_Field1'];
        $this->assertEquals(SearchUpdaterTest_OtherContainer::class, $dataOtherContainer['origin']);
        $this->assertEquals(SearchUpdaterTest_OtherContainer::class, $dataOtherContainer['base']);
        $this->assertEquals(SearchUpdaterTest_ManyMany::class, $dataOtherContainer['class']);
    }

    /**
     * Test boosting on SearchQuery
     */
    public function testBoostedQuery()
    {
        /** @var Solr3Service|PHPUnit_Framework_MockObject_MockObject $serviceMock */
        $serviceMock = $this->getMockBuilder(Solr3Service::class)
            ->setMethods(['search'])
            ->getMock();

        $serviceMock->expects($this->once())
            ->method('search')
            ->with(
                $this->equalTo('+(Field1:term^1.5 OR HasOneObject_Field1:term^3)'),
                $this->anything(),
                $this->anything(),
                $this->anything(),
                $this->anything()
            )->willReturn($this->getFakeRawSolrResponse());

        $index = new SolrIndexTest_FakeIndex();
        $index->setService($serviceMock);

        $query = new SearchQuery();
        $query->search(
            'term',
            null,
            array('Field1' => 1.5, 'HasOneObject_Field1' => 3)
        );
        $index->search($query);
    }

    /**
     * Test boosting on field schema (via queried fields parameter)
     */
    public function testBoostedField()
    {
        /** @var Solr3Service|PHPUnit_Framework_MockObject_MockObject $serviceMock */
        $serviceMock = $this->getMockBuilder(Solr3Service::class)
            ->setMethods(['search'])
            ->getMock();

        $serviceMock->expects($this->once())
            ->method('search')
            ->with(
                $this->equalTo('+term'),
                $this->anything(),
                $this->anything(),
                $this->equalTo(['qf' => SearchUpdaterTest_Container::class . '_Field1^1.5 ' . SearchUpdaterTest_Container::class . '_Field2^2.1 _text',
                    'fq' => '+(_versionedstage:"" (*:* -_versionedstage:[* TO *]))']),
                $this->anything()
            )->willReturn($this->getFakeRawSolrResponse());

        $index = new SolrIndexTest_BoostedIndex();
        $index->setService($serviceMock);

        $query = new SearchQuery();
        $query->search('term');
        $index->search($query);
    }

    public function testHighlightQueryOnBoost()
    {
        /** @var SilverStripe\FullTextSearch\Solr\Services\Solr3Service|ObjectProphecy $serviceMock */
        $serviceMock = $this->getMockBuilder(Solr3Service::class)
            ->setMethods(['search'])
            ->getMock();

        $serviceMock->expects($this->exactly(2))
            ->method('search')
            ->withConsecutive(
                [
                    $this->equalTo('+(Field1:term^1.5 OR HasOneObject_Field1:term^3)'),
                    $this->anything(),
                    $this->anything(),
                    $this->logicalNot(
                        $this->arrayHasKey('hl.q')
                    ),
                    $this->anything()
                ],
                [
                    $this->equalTo('+(Field1:term^1.5 OR HasOneObject_Field1:term^3)'),
                    $this->anything(),
                    $this->anything(),
                    $this->arrayHasKey('hl.q'),
                    $this->anything()
                ]
            )->willReturn($this->getFakeRawSolrResponse());

        $index = new SolrIndexTest_FakeIndex();
        $index->setService($serviceMock);

        // Search without highlighting
        $query = new SearchQuery();
        $query->search(
            'term',
            null,
            array('Field1' => 1.5, 'HasOneObject_Field1' => 3)
        );
        $index->search($query);

        // Search with highlighting
        $query = new SearchQuery();
        $query->search(
            'term',
            null,
            array('Field1' => 1.5, 'HasOneObject_Field1' => 3)
        );
        $index->search($query, -1, -1, array('hl' => true));
    }

    public function testIndexExcludesNullValues()
    {
        /** @var Solr3Service|ObjectProphecy $serviceMock */
        $serviceMock = $this->createMock(Solr3Service::class);
        $index = new SolrIndexTest_FakeIndex();
        $index->setService($serviceMock);
        $obj = new SearchUpdaterTest_Container();

        $obj->Field1 = 'Field1 val';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $obj->Field2 = null;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $obj->MyDate = null;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $docs = $index->add($obj);
        $value = $docs[0]->getField(SearchUpdaterTest_Container::class . '_Field1');
        $this->assertEquals('Field1 val', $value['value'], 'Writes non-NULL string fields');
        $value = $docs[0]->getField(SearchUpdaterTest_Container::class . '_Field2');
        $this->assertFalse($value, 'Ignores string fields if they are NULL');
        $value = $docs[0]->getField(SearchUpdaterTest_Container::class . '_MyDate');
        $this->assertFalse($value, 'Ignores date fields if they are NULL');

        $obj->MyDate = '2010-12-30';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $docs = $index->add($obj);
        $value = $docs[0]->getField(SearchUpdaterTest_Container::class . '_MyDate');
        $this->assertEquals('2010-12-30T00:00:00Z', $value['value'], 'Writes non-NULL dates');
    }

    public function testAddFieldExtraOptions()
    {
        Injector::inst()->get(Kernel::class)->setEnvironment('live');

        $index = new SolrIndexTest_FakeIndex();

        $defs = simplexml_load_string('<fields>' . $index->getFieldDefinitions() . '</fields>');
        $defField1 = $defs->xpath('field[@name="' . SearchUpdaterTest_Container::class . '_Field1"]');
        $this->assertEquals((string)$defField1[0]['stored'], 'false');

        $index->addFilterField('Field1', null, array('stored' => 'true'));
        $defs = simplexml_load_string('<fields>' . $index->getFieldDefinitions() . '</fields>');
        $defField1 = $defs->xpath('field[@name="' . SearchUpdaterTest_Container::class . '_Field1"]');
        $this->assertEquals((string)$defField1[0]['stored'], 'true');
    }

    public function testAddAnalyzer()
    {
        $index = new SolrIndexTest_FakeIndex();

        $defs = simplexml_load_string('<fields>' . $index->getFieldDefinitions() . '</fields>');
        $defField1 = $defs->xpath('field[@name="' . SearchUpdaterTest_Container::class . '_Field1"]');
        $analyzers = $defField1[0]->analyzer;
        $this->assertFalse((bool)$analyzers);

        $index->addAnalyzer('Field1', 'charFilter', array('class' => 'solr.HTMLStripCharFilterFactory'));
        $defs = simplexml_load_string('<fields>' . $index->getFieldDefinitions() . '</fields>');
        $defField1 = $defs->xpath('field[@name="' . SearchUpdaterTest_Container::class . '_Field1"]');
        $analyzers = $defField1[0]->analyzer;
        $this->assertTrue((bool)$analyzers);
        $this->assertEquals('solr.HTMLStripCharFilterFactory', $analyzers[0]->charFilter[0]['class']);
    }

    public function testAddCopyField()
    {
        $index = new SolrIndexTest_FakeIndex();
        $index->addCopyField('sourceField', 'destField');

        $defs = simplexml_load_string('<fields>' . $index->getCopyFieldDefinitions() . '</fields>');
        $copyField = $defs->xpath('copyField');

        $this->assertEquals('sourceField', $copyField[0]['source']);
        $this->assertEquals('destField', $copyField[0]['dest']);
    }

    /**
     * Tests the setting of the 'stored' flag
     */
    public function testStoredFields()
    {
        // Test two fields
        $index = new SolrIndexTest_FakeIndex2();
        $index->addStoredField('Field1');
        $index->addFulltextField('Field2');
        $schema = $index->getFieldDefinitions();
        $this->assertContains(
            "<field name='" . SearchUpdaterTest_Container::class . "_Field1' type='text' indexed='true' stored='true'",
            $schema
        );
        $this->assertContains(
            "<field name='" . SearchUpdaterTest_Container::class . "_Field2' type='text' indexed='true' stored='false'",
            $schema
        );

        // Test with addAllFulltextFields
        $index2 = new SolrIndexTest_FakeIndex2();
        $index2->addAllFulltextFields();
        $index2->addStoredField('Field2');
        $schema2 = $index2->getFieldDefinitions();
        $this->assertContains(
            "<field name='" . SearchUpdaterTest_Container::class . "_Field1' type='text' indexed='true' stored='false'",
            $schema2
        );
        $this->assertContains(
            "<field name='" . SearchUpdaterTest_Container::class . "_Field2' type='text' indexed='true' stored='true'",
            $schema2
        );
    }

    public function testSanitiseClassName()
    {
        $index = new SolrIndexTest_FakeIndex2;
        $this->assertSame(
            'SilverStripe\\\\FullTextSearch\\\\Tests\\\\SolrIndexTest',
            $index->sanitiseClassName(static::class)
        );
    }

    protected function getFakeRawSolrResponse()
    {
        return new \Apache_Solr_Response(
            new \Apache_Solr_HttpTransport_Response(
                null,
                null,
                '{}'
            )
        );
    }
}


1		<?php
2
3		namespace SilverStripe\FullTextSearch\Tests;
4
5		use SilverStripe\Core\Config\Config;
6		use SilverStripe\Core\Injector\Injector;
7		use SilverStripe\Core\Kernel;
8		use SilverStripe\Dev\SapphireTest;
9		use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_AmbiguousRelationIndex;
10		use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_AmbiguousRelationInheritedIndex;
11		use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_FakeIndex;
12		use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_FakeIndex2;
13		use SilverStripe\FullTextSearch\Tests\SolrIndexTest\SolrIndexTest_BoostedIndex;
14		use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_Container;
15		use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_HasOne;
16		use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_HasMany;
17		use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_ManyMany;
18		use SilverStripe\FullTextSearch\Tests\SearchUpdaterTest\SearchUpdaterTest_OtherContainer;
19		use SilverStripe\FullTextSearch\Search\Queries\SearchQuery;
20		use SilverStripe\FullTextSearch\Solr\Services\Solr3Service;
21
22		class SolrIndexTest extends SapphireTest
23		{
24	View Code Duplication	public function testFieldDataHasOne()
		0 ignored issues – show Duplication introduced 2017-11-15 03:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
25		{
26		$index = new SolrIndexTest_FakeIndex();
27		$data = $index->fieldData('HasOneObject.Field1');
28
29		$data = $data[SearchUpdaterTest_Container::class . '_HasOneObject_Field1'];
30
31		$this->assertEquals(SearchUpdaterTest_Container::class, $data['origin']);
32		$this->assertEquals(SearchUpdaterTest_Container::class, $data['base']);
33		$this->assertEquals(SearchUpdaterTest_HasOne::class, $data['class']);
34		}
35
36	View Code Duplication	public function testFieldDataHasMany()
		0 ignored issues – show Duplication introduced 2017-11-15 03:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
37		{
38		$index = new SolrIndexTest_FakeIndex();

silverstripe / silverstripe-fulltextsearch

Pull Request — master (#173)

SolrIndexTest::testSanitiseClassName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like