[TEST] add PHPStan to build (#628)

* PHPUnit 5.7.21 + update config + fix risky tests

* PHPUnit 6.3.0

* use $this->expectException instead of annotation

* [TEST] fixes of issues detected by phpstan

* phpstan setup

Author: mhujer

.travis.yml

@@ -52,6 +52,7 @@ before_script:
   - php util/EnsureClusterAlive.php
 
 script:
+  - composer run-script phpstan
   - vendor/bin/phpunit $PHPUNIT_FLAGS
   - vendor/bin/phpunit -c phpunit-integration.xml --group sync $PHPUNIT_FLAGS
 

composer.json

@@ -21,7 +21,8 @@
     "symfony/yaml": "^2.8",
     "symfony/finder": "^2.8",
     "cpliakas/git-wrapper": "~1.0",
-    "doctrine/inflector": "^1.1"
+    "doctrine/inflector": "^1.1",
+    "phpstan/phpstan-shim": "0.8.3"
   },
   "suggest": {
     "ext-curl": "*",
@@ -36,5 +37,10 @@
     "psr-4": {
       "Elasticsearch\\Tests\\":      "tests/Elasticsearch/Tests/"
     }
+  },
+  "scripts": {
+    "phpstan": [
+      "@php vendor/phpstan/phpstan-shim/phpstan.phar analyse -c phpstan.neon tests --level 7 --no-progress"
+    ]
   }
 }

phpstan.neon

@@ -0,0 +1,9 @@
+parameters:
+    ignoreErrors:
+        - '#Mockery\\MockInterface::shouldReceive\(\)#'
+        - '#Mockery\\MockInterface given#'
+        - '#Mockery\\MockInterface\[\] given#'
+
+        # because of \Elasticsearch\Tests\RegisteredNamespaceTest
+        - '#Call to an undefined method Elasticsearch\\Client::foo\(\)#'
+        - '#Call to an undefined method Elasticsearch\\Client::bar\(\)#'

tests/Elasticsearch/Tests/ClientIntegrationTests.php

@@ -2,6 +2,10 @@
 
 declare(strict_types = 1);
 
+namespace Elasticsearch\Tests;
+
+use Elasticsearch;
+
 /**
  * Class ClientTest
  *

tests/Elasticsearch/Tests/ConnectionPool/StaticConnectionPoolIntegrationTest.php

@@ -2,6 +2,10 @@
 
 declare(strict_types = 1);
 
+namespace Elasticsearch\Tests\ConnectionPool;
+
+use Elasticsearch;
+
 /**
  * Class StaticConnectionPoolIntegrationTest
  *

tests/Elasticsearch/Tests/ConnectionPool/StaticConnectionPoolTest.php

@@ -48,8 +48,10 @@ public function testAddOneHostThenGetConnection()
 
         $connectionFactory = m::mock(ConnectionFactory::class);
 
-        $randomizeHosts = false;
-        $connectionPool = new StaticConnectionPool($connections, $selector, $connectionFactory, $randomizeHosts);
+        $connectionPoolParams = [
+            'randomizeHosts' => false,
+        ];
+        $connectionPool = new StaticConnectionPool($connections, $selector, $connectionFactory, $connectionPoolParams);
 
         $retConnection = $connectionPool->nextConnection();
 
@@ -80,8 +82,10 @@ public function testAddMultipleHostsThenGetFirst()
 
         $connectionFactory = m::mock(ConnectionFactory::class);
 
-        $randomizeHosts = false;
-        $connectionPool = new StaticConnectionPool($connections, $selector, $connectionFactory, $randomizeHosts);
+        $connectionPoolParams = [
+            'randomizeHosts' => false,
+        ];
+        $connectionPool = new StaticConnectionPool($connections, $selector, $connectionFactory, $connectionPoolParams);
 
         $retConnection = $connectionPool->nextConnection();
 
@@ -114,8 +118,13 @@ public function testAllHostsFailPing()
 
         $connectionFactory = m::mock(ConnectionFactory::class);
 
-        $randomizeHosts = false;
-        $connectionPool = new StaticConnectionPool($connections, $selector, $connectionFactory, $randomizeHosts);
+        $connectionPoolParams = [
+            'randomizeHosts' => false,
+        ];
+        $connectionPool = new StaticConnectionPool($connections, $selector, $connectionFactory, $connectionPoolParams);
+
+        $this->expectException(\Elasticsearch\Common\Exceptions\NoNodesAvailableException::class);
+        $this->expectExceptionMessage('No alive nodes found in your cluster');
 
         $this->expectException(\Elasticsearch\Common\Exceptions\NoNodesAvailableException::class);
         $this->expectExceptionMessage('No alive nodes found in your cluster');
@@ -162,8 +171,10 @@ public function testAllExceptLastHostFailPingRevivesInSkip()
 
         $connectionFactory = m::mock(ConnectionFactory::class);
 
-        $randomizeHosts = false;
-        $connectionPool = new StaticConnectionPool($connections, $selector, $connectionFactory, $randomizeHosts);
+        $connectionPoolParams = [
+            'randomizeHosts' => false,
+        ];
+        $connectionPool = new StaticConnectionPool($connections, $selector, $connectionFactory, $connectionPoolParams);
 
         $ret = $connectionPool->nextConnection();
         $this->assertSame($goodConnection, $ret);
@@ -208,8 +219,10 @@ public function testAllExceptLastHostFailPingRevivesPreSkip()
 
         $connectionFactory = m::mock(ConnectionFactory::class);
 
-        $randomizeHosts = false;
-        $connectionPool = new StaticConnectionPool($connections, $selector, $connectionFactory, $randomizeHosts);
+        $connectionPoolParams = [
+            'randomizeHosts' => false,
+        ];
+        $connectionPool = new StaticConnectionPool($connections, $selector, $connectionFactory, $connectionPoolParams);
 
         $ret = $connectionPool->nextConnection();
         $this->assertSame($goodConnection, $ret);

tests/Elasticsearch/Tests/YamlRunnerTest.php

@@ -169,7 +169,7 @@ public function testAsyncIntegration($testProcedure, $skip, $setupProcedure, $fi
         }
 
         if (null !== $setupProcedure) {
-            $this->processProcedure(current($setupProcedure), 'setup');
+            $this->processProcedure(current($setupProcedure), 'setup', $fileName);
             $this->waitForYellow();
         }
 
@@ -326,6 +326,9 @@ public function operationDo($operation, $lastOperationResult, &$context, $testNa
             $endpointParams->client['headers'] = $headers;
         }
 
+        if (!is_string($method)) {
+            throw new \Exception('$method must be string');
+        }
         list($method, $namespace) = $this->mapEndpoint($method, $namespace);
 
         if (null !== $namespace) {
@@ -404,7 +407,7 @@ public function executeRequest($caller, $method, $endpointParams, $expectedError
      *
      * @throws \Exception
      *
-     * @return bool
+     * @return bool|mixed[]
      */
     public function executeAsyncExistRequest($caller, $method, $endpointParams, $expectedError, $expectedWarnings, $testName)
     {