HelperTest

Complexity

Total Complexity

12

Size/Duplication

Total Lines	236
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	createSphinxQL()	0	3	1
A	createHelper()	0	3	1
A	testCallKeywords()	0	45	1
A	setUp()	0	7	1
A	testDescribe()	0	11	1
A	testSetVariable()	0	12	1
A	testShowTables()	0	5	1
A	testCallSnippets()	0	39	1
A	testCreateFunction()	0	8	1
A	testMiscellaneous()	0	25	1
A	testTruncateRtIndex()	0	30	1
A	testUdfNotInstalled()	0	5	1

<?php

use Foolz\SphinxQL\Drivers\ConnectionInterface;
use Foolz\SphinxQL\Helper;
use Foolz\SphinxQL\SphinxQL;
use Foolz\SphinxQL\Tests\TestUtil;

class HelperTest extends \PHPUnit\Framework\TestCase
{
    /**
     * @var ConnectionInterface
     */
    public $conn;

    protected function setUp(): void
    {
        $conn = TestUtil::getConnectionDriver();
        $conn->setParam('port', 9307);
        $this->conn = $conn;

        $this->createSphinxQL()->query('TRUNCATE RTINDEX rt')->execute();
    }

    /**
     * @return SphinxQL
     */
    protected function createSphinxQL()
    {
        return new SphinxQL($this->conn);
    }

    /**
     * @return Helper
     */
    protected function createHelper()
    {
        return new Helper($this->conn);
    }

    public function testShowTables()
    {
        $this->assertEquals(
            array(array('Index' => 'rt', 'Type' => 'rt')),
            $this->createHelper()->showTables('rt')->execute()->getStored()

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

        );
    }

    public function testDescribe()
    {
        $describe = $this->createHelper()->describe('rt')->execute()->getStored();

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

        array_shift($describe);

It seems like $describe can also be of type integer; however, parameter $array of array_shift() does only seem to accept array, maybe add an additional type check?

        $this->assertSame(
            array(
                array('Field' => 'title', 'Type' => 'field'),
                array('Field' => 'content', 'Type' => 'field'),
                array('Field' => 'gid', 'Type' => 'uint'),
            ),
            $describe
        );
    }

    public function testSetVariable()
    {
        $this->createHelper()->setVariable('AUTOCOMMIT', 0)->execute();
        $vars = Helper::pairsToAssoc($this->createHelper()->showVariables()->execute()->getStored());

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

It seems like $this->createHelper()->showVariables()->execute()->getStored() can also be of type integer; however, parameter $result of Foolz\SphinxQL\Helper::pairsToAssoc() does only seem to accept array, maybe add an additional type check?

        $this->assertEquals(0, $vars['autocommit']);

        $this->createHelper()->setVariable('AUTOCOMMIT', 1)->execute();
        $vars = Helper::pairsToAssoc($this->createHelper()->showVariables()->execute()->getStored());

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

        $this->assertEquals(1, $vars['autocommit']);

        $this->createHelper()->setVariable('@foo', 1, true);
        $this->createHelper()->setVariable('@foo', array(0), true);
    }

    public function testCallSnippets()
    {
        $snippets = $this->createHelper()->callSnippets(

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

            'this is my document text',
            'rt',
            'is'
        )->execute()->getStored();
        $this->assertEquals(
            array(array('snippet' => 'this <b>is</b> my document text')),
            $snippets
        );

        $snippets = $this->createHelper()->callSnippets(

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

            'this is my document text',
            'rt',
            'is',
            array(
                'query_mode'   => 1,
                'before_match' => '<em>',
                'after_match'  => '</em>',
            )
        )->execute()->getStored();
        $this->assertEquals(
            array(array('snippet' => 'this <em>is</em> my document text')),
            $snippets
        );

        $snippets = $this->createHelper()->callSnippets(

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

            array('this is my document text', 'another document'),
            'rt',
            'is',
            array('allow_empty' => 1)
        )->execute()->getStored();
        $this->assertEquals(
            array(
                array('snippet' => 'this <b>is</b> my document text'),
                array('snippet' => ''),
            ),
            $snippets
        );
    }

    public function testCallKeywords()
    {
        $keywords = $this->createHelper()->callKeywords(

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

            'test case',
            'rt'
        )->execute()->getStored();
        $this->assertEquals(
            array(
                array(
                    'qpos'       => '1',
                    'tokenized'  => 'test',
                    'normalized' => 'test',
                ),
                array(
                    'qpos'       => '2',
                    'tokenized'  => 'case',
                    'normalized' => 'case',
                ),
            ),
            $keywords
        );

        $keywords = $this->createHelper()->callKeywords(

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

            'test case',
            'rt',
            1
        )->execute()->getStored();
        $this->assertEquals(
            array(
                array(
                    'qpos'       => '1',
                    'tokenized'  => 'test',
                    'normalized' => 'test',
                    'docs'       => '0',
                    'hits'       => '0',
                ),
                array(
                    'qpos'       => '2',
                    'tokenized'  => 'case',
                    'normalized' => 'case',
                    'docs'       => '0',
                    'hits'       => '0',
                ),
            ),
            $keywords
        );
    }

    public function testUdfNotInstalled()
    {
        $this->expectException(Foolz\SphinxQL\Exception\DatabaseException::class);
        $this->expectExceptionMessage('Sphinx expr: syntax error');
        $this->conn->query('SELECT MY_UDF()');
    }

    public function testCreateFunction()
    {
        $this->createHelper()->createFunction('my_udf', 'INT', 'test_udf.so')->execute();
        $this->assertSame(
            array(array('MY_UDF()' => '42')),
            $this->conn->query('SELECT MY_UDF()')->getStored()

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

        );
        $this->createHelper()->dropFunction('my_udf')->execute();
    }

    /**
     * @covers \Foolz\SphinxQL\Helper::truncateRtIndex
     */
    public function testTruncateRtIndex()
    {
        $this->createSphinxQL()
            ->insert()
            ->into('rt')
            ->set(array(
                'id' => 1,
                'title' => 'this is a title',
                'content' => 'this is the content',
                'gid' => 100
            ))
            ->execute();

        $result = $this->createSphinxQL()

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

            ->select()
            ->from('rt')
            ->execute()
            ->getStored();

        $this->assertCount(1, $result);

It seems like $result can also be of type integer; however, parameter $haystack of PHPUnit\Framework\Assert::assertCount() does only seem to accept Countable|iterable, maybe add an additional type check?

        $this->createHelper()->truncateRtIndex('rt')->execute();

        $result = $this->createSphinxQL()

The function Foolz\SphinxQL\Drivers\ResultSetInterface::getStored() has been deprecated: Commodity method for simple transition to version 1.0.0

            ->select()
            ->from('rt')
            ->execute()
            ->getStored();

        $this->assertCount(0, $result);
    }

    // actually executing these queries may not be useful nor easy to test
    public function testMiscellaneous()
    {
        $query = $this->createHelper()->showMeta();
        $this->assertEquals('SHOW META', $query->compile()->getCompiled());

        $query = $this->createHelper()->showWarnings();
        $this->assertEquals('SHOW WARNINGS', $query->compile()->getCompiled());

        $query = $this->createHelper()->showStatus();
        $this->assertEquals('SHOW STATUS', $query->compile()->getCompiled());

        $query = $this->createHelper()->attachIndex('disk', 'rt');
        $this->assertEquals('ATTACH INDEX disk TO RTINDEX rt', $query->compile()->getCompiled());

        $query = $this->createHelper()->flushRtIndex('rt');
        $this->assertEquals('FLUSH RTINDEX rt', $query->compile()->getCompiled());

        $query = $this->createHelper()->optimizeIndex('rt');
        $this->assertEquals('OPTIMIZE INDEX rt', $query->compile()->getCompiled());

        $query = $this->createHelper()->showIndexStatus('rt');
        $this->assertEquals('SHOW INDEX rt STATUS', $query->compile()->getCompiled());

        $query = $this->createHelper()->flushRamchunk('rt');
        $this->assertEquals('FLUSH RAMCHUNK rt', $query->compile()->getCompiled());
    }
}