Base::_checkConnection() - Code Metrics - Inspection of "Remove some functional test skip conditions" - ruflin/Elastica - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1936)

by François-Xavier

created 2021-03-19 13:32 UTC

Base::_checkConnection() A

↳ Parent: Base::_waitForAllocation()

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
c	0
b	0
f	0
rs	10
cc	2
nc	2
nop	2

<?php

namespace Elastica\Test;

use Elastica\Client;
use Elastica\Connection;
use Elastica\Index;
use Elasticsearch\Endpoints\Ingest\Pipeline\Put;
use Elasticsearch\Endpoints\Ingest\PutPipeline;
use PHPUnit\Framework\TestCase;
use PHPUnit\Util\Test as TestUtil;
use Psr\Log\LoggerInterface;

/**
 * @internal
 */
class Base extends TestCase
{
    protected function setUp(): void
    {
        parent::setUp();

        $hasGroup = $this->_isUnitGroup() || $this->_isFunctionalGroup() || $this->_isBenchmarkGroup();
        $this->assertTrue($hasGroup, 'Every test must have one of "unit", "functional", "benchmark" group');
        $this->showDeprecated();
    }

    protected function tearDown(): void
    {
        if ($this->_isFunctionalGroup()) {
            $this->_getClient()->getIndex('_all')->delete();
            $this->_getClient()->getIndex('_all')->clearCache();
        }

        parent::tearDown();
    }

    protected static function hideDeprecated(): void
    {
        \error_reporting(\error_reporting() & ~\E_USER_DEPRECATED);
    }

    protected static function showDeprecated(): void
    {
        \error_reporting(\error_reporting() | \E_USER_DEPRECATED);
    }

    /**
     * @param array $params Additional configuration params. Host and Port are already set
     */
    protected function _getClient(array $params = [], ?callable $callback = null, ?LoggerInterface $logger = null): Client
    {
        $config = [
            'host' => $this->_getHost(),
            'port' => $this->_getPort(),
        ];

        $config = \array_merge($config, $params);

        return new Client($config, $callback, $logger);
    }

    /**
     * @return string Host to es for elastica tests
     */
    protected function _getHost()
    {
        return \getenv('ES_HOST') ?: Connection::DEFAULT_HOST;
    }

    /**
     * @return int Port to es for elastica tests
     */
    protected function _getPort()
    {
        return \getenv('ES_PORT') ?: Connection::DEFAULT_PORT;
    }

    protected function _getProxyUrl(): string
    {
        $proxyHost = \getenv('PROXY_HOST') ?: Connection::DEFAULT_HOST;

        return 'http://'.$proxyHost.':8000';
    }

    protected function _getProxyUrl403(): string
    {
        $proxyHost = \getenv('PROXY_HOST') ?: Connection::DEFAULT_HOST;

        return 'http://'.$proxyHost.':8001';
    }

    protected function _createIndex(?string $name = null, bool $delete = true, int $shards = 1): Index
    {
        $name = $name ?: static::buildUniqueId();

        $client = $this->_getClient();
        $index = $client->getIndex($name);

        $index->create(['settings' => ['index' => ['number_of_shards' => $shards, 'number_of_replicas' => 1]]], [
            'recreate' => $delete,
        ]);

        return $index;
    }

    protected static function buildUniqueId(): string
    {
        return \preg_replace('/[^a-z]/i', '', \strtolower(static::class).\uniqid());
    }

    protected function _createRenamePipeline(): void
    {
        $client = $this->_getClient();

        // TODO: Use only PutPipeline when dropping support for elasticsearch/elasticsearch 7.x
        $endpoint = \class_exists(PutPipeline::class) ? new PutPipeline() : new Put();
        $endpoint->setID('renaming');
        $endpoint->setBody([
            'description' => 'Rename field',
            'processors' => [
                [
                    'rename' => [
                        'field' => 'old',
                        'target_field' => 'new',
                    ],
                ],
            ],
        ]);

        $client->requestEndpoint($endpoint);
    }

    protected function _checkPlugin($plugin): void
    {
        $nodes = $this->_getClient()->getCluster()->getNodes();
        if (!$nodes[0]->getInfo()->hasPlugin($plugin)) {
            $this->markTestSkipped($plugin.' plugin not installed.');
        }
    }

    protected function _getVersion()
    {
        $data = $this->_getClient()->request('/')->getData();

        return \substr($data['version']['number'], 0, 1);
    }

    protected function _checkVersion($version): void
    {
        $data = $this->_getClient()->request('/')->getData();
        $installedVersion = $data['version']['number'];

        if (\version_compare($installedVersion, $version) < 0) {
            $this->markTestSkipped('Test require '.$version.'+ version of Elasticsearch');
        }
    }

    protected function _waitForAllocation(Index $index): void
    {
        do {
            $state = $index->getClient()->getCluster()->getState();
            $indexState = $state['routing_table']['indices'][$index->getName()];

            $allocated = true;
            foreach ($indexState['shards'] as $shards) {
                foreach ($shards as $shard) {
                    if ('STARTED' !== $shard['state']) {
                        $allocated = false;
                    }
                }
            }
        } while (!$allocated);
    }

    protected function _isUnitGroup()
    {
        $groups = TestUtil::getGroups(\get_class($this), $this->getName(false));

        return \in_array('unit', $groups, true);
    }

    protected function _isFunctionalGroup()
    {
        $groups = TestUtil::getGroups(\get_class($this), $this->getName(false));

        return \in_array('functional', $groups, true);
    }

    protected function _isBenchmarkGroup()
    {
        $groups = TestUtil::getGroups(\get_class($this), $this->getName(false));

        return \in_array('benchmark', $groups, true);
    }
}


1			<?php
2
3			namespace Elastica\Test;
4
5			use Elastica\Client;
6			use Elastica\Connection;
7			use Elastica\Index;
8			use Elasticsearch\Endpoints\Ingest\Pipeline\Put;
9			use Elasticsearch\Endpoints\Ingest\PutPipeline;
10			use PHPUnit\Framework\TestCase;
11			use PHPUnit\Util\Test as TestUtil;
12			use Psr\Log\LoggerInterface;
13
14			/**
15			* @internal
16			*/
17			class Base extends TestCase
18			{
19			protected function setUp(): void
20			{
21			parent::setUp();
22
23			$hasGroup = $this->_isUnitGroup() \|\| $this->_isFunctionalGroup() \|\| $this->_isBenchmarkGroup();
24			$this->assertTrue($hasGroup, 'Every test must have one of "unit", "functional", "benchmark" group');
25			$this->showDeprecated();
26			}
27
28			protected function tearDown(): void
29			{
30			if ($this->_isFunctionalGroup()) {
31			$this->_getClient()->getIndex('_all')->delete();
32			$this->_getClient()->getIndex('_all')->clearCache();
33			}
34
35			parent::tearDown();
36			}
37
38			protected static function hideDeprecated(): void
39			{
40			\error_reporting(\error_reporting() & ~\E_USER_DEPRECATED);
41			}
42
43			protected static function showDeprecated(): void
44			{
45			\error_reporting(\error_reporting() \| \E_USER_DEPRECATED);
46			}
47
48			/**
49			* @param array $params Additional configuration params. Host and Port are already set
50			*/
51			protected function _getClient(array $params = [], ?callable $callback = null, ?LoggerInterface $logger = null): Client
52			{
53			$config = [
54			'host' => $this->_getHost(),
55			'port' => $this->_getPort(),
56			];
57
58			$config = \array_merge($config, $params);
59
60			return new Client($config, $callback, $logger);
61			}
62
63			/**
64			* @return string Host to es for elastica tests
65			*/
66			protected function _getHost()
67			{
68			return \getenv('ES_HOST') ?: Connection::DEFAULT_HOST;
69			}
70
71			/**
72			* @return int Port to es for elastica tests
73			*/
74			protected function _getPort()
75			{
76			return \getenv('ES_PORT') ?: Connection::DEFAULT_PORT;
77			}
78
79			protected function _getProxyUrl(): string
80			{
81			$proxyHost = \getenv('PROXY_HOST') ?: Connection::DEFAULT_HOST;
82
83			return 'http://'.$proxyHost.':8000';
84			}
85
86			protected function _getProxyUrl403(): string
87			{
88			$proxyHost = \getenv('PROXY_HOST') ?: Connection::DEFAULT_HOST;
89
90			return 'http://'.$proxyHost.':8001';
91			}
92
93			protected function _createIndex(?string $name = null, bool $delete = true, int $shards = 1): Index
94			{
95			$name = $name ?: static::buildUniqueId();
96
97			$client = $this->_getClient();
98			$index = $client->getIndex($name);
99
100			$index->create(['settings' => ['index' => ['number_of_shards' => $shards, 'number_of_replicas' => 1]]], [
101			'recreate' => $delete,
102			]);
103
104			return $index;
105			}
106
107			protected static function buildUniqueId(): string
108			{
109			return \preg_replace('/[^a-z]/i', '', \strtolower(static::class).\uniqid());
110			}
111
112			protected function _createRenamePipeline(): void
113			{
114			$client = $this->_getClient();
115
116			// TODO: Use only PutPipeline when dropping support for elasticsearch/elasticsearch 7.x
117			$endpoint = \class_exists(PutPipeline::class) ? new PutPipeline() : new Put();
118			$endpoint->setID('renaming');
119			$endpoint->setBody([
120			'description' => 'Rename field',
121			'processors' => [
122			[
123			'rename' => [
124			'field' => 'old',
125			'target_field' => 'new',
126			],
127			],
128			],
129			]);
130
131			$client->requestEndpoint($endpoint);
132			}
133
134			protected function _checkPlugin($plugin): void
135			{
136			$nodes = $this->_getClient()->getCluster()->getNodes();
137			if (!$nodes[0]->getInfo()->hasPlugin($plugin)) {
138			$this->markTestSkipped($plugin.' plugin not installed.');
139			}
140			}
141
142			protected function _getVersion()
143			{
144			$data = $this->_getClient()->request('/')->getData();
145
146			return \substr($data['version']['number'], 0, 1);
147			}
148
149			protected function _checkVersion($version): void
150			{
151			$data = $this->_getClient()->request('/')->getData();
152			$installedVersion = $data['version']['number'];
153
154			if (\version_compare($installedVersion, $version) < 0) {
155			$this->markTestSkipped('Test require '.$version.'+ version of Elasticsearch');
156			}
157			}
158
159			protected function _waitForAllocation(Index $index): void
160			{
161			do {
162			$state = $index->getClient()->getCluster()->getState();
163			$indexState = $state['routing_table']['indices'][$index->getName()];
164
165			$allocated = true;
166			foreach ($indexState['shards'] as $shards) {
167			foreach ($shards as $shard) {
168			if ('STARTED' !== $shard['state']) {
169			$allocated = false;
170			}
171			}
172			}
173			} while (!$allocated);
174			}
175
176			protected function _isUnitGroup()
177			{
178			$groups = TestUtil::getGroups(\get_class($this), $this->getName(false));
179
180			return \in_array('unit', $groups, true);
181			}
182
183			protected function _isFunctionalGroup()
184			{
185			$groups = TestUtil::getGroups(\get_class($this), $this->getName(false));
186
187			return \in_array('functional', $groups, true);
188			}
189
190			protected function _isBenchmarkGroup()
191			{
192			$groups = TestUtil::getGroups(\get_class($this), $this->getName(false));
193
194			return \in_array('benchmark', $groups, true);
195			}
196			}
197

ruflin / Elastica

Pull Request — master (#1936)

Base::_checkConnection() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like