Merge pull request #517 from OndraM/feature/phpstan

OndraM · web-flow · commit 139980fb59bb · 2017-12-12T15:17:08.000+01:00
Use PHPStan for static analysis, lint PHP
diff --git a/.travis.yml b/.travis.yml
@@ -70,7 +70,10 @@ matrix:
     - php: 7.1
       env: CHECK_CODESTYLE=1
       before_script: ~
-      script: composer codestyle:check
+      script:
+        - composer require phpstan/phpstan-shim # Not part of require-dev, because it won't install on PHP 5.6
+        - composer analyze
+        - composer codestyle:check
       after_script: ~
       after_success: ~
 
diff --git a/composer.json b/composer.json
@@ -24,7 +24,8 @@
     "squizlabs/php_codesniffer": "^2.6",
     "php-mock/php-mock-phpunit": "^1.1",
     "php-coveralls/php-coveralls": "^2.0",
-    "symfony/var-dumper": "^3.3 || ^4.0"
+    "symfony/var-dumper": "^3.3 || ^4.0",
+    "jakub-onderka/php-parallel-lint": "^0.9.2"
   },
   "autoload": {
     "psr-4": {
@@ -45,6 +46,10 @@
     "codestyle:fix": [
       "vendor/bin/php-cs-fixer fix --diff || exit 0",
       "vendor/bin/phpcbf --standard=PSR2 ./lib/ ./tests/"
+    ],
+    "analyze": [
+      "vendor/bin/parallel-lint -j 10 ./lib ./tests",
+      "vendor/bin/phpstan.phar analyze ./lib ./tests --level 2 -c phpstan.neon --ansi"
     ]
   },
   "extra": {
diff --git a/lib/Firefox/FirefoxProfile.php b/lib/Firefox/FirefoxProfile.php
@@ -110,7 +110,7 @@ public function setPreference($key, $value)
     }
 
     /**
-     * @param $key
+     * @param mixed $key
      * @return mixed
      */
     public function getPreference($key)
diff --git a/lib/Support/Events/EventFiringWebDriver.php b/lib/Support/Events/EventFiringWebDriver.php
@@ -133,7 +133,7 @@ public function findElement(WebDriverBy $by)
     }
 
     /**
-     * @param       $script
+     * @param string $script
      * @param array $arguments
      * @throws WebDriverException
      * @return mixed
@@ -161,7 +161,7 @@ public function executeScript($script, array $arguments = [])
     }
 
     /**
-     * @param       $script
+     * @param string $script
      * @param array $arguments
      * @throws WebDriverException
      * @return mixed
@@ -396,7 +396,7 @@ protected function newElement(WebDriverElement $element)
 
     /**
      * @param mixed $method
-     * @param mixed $arguments,...
+     * @param mixed ...$arguments
      */
     protected function dispatch($method, ...$arguments)
     {
diff --git a/lib/Support/Events/EventFiringWebDriverNavigation.php b/lib/Support/Events/EventFiringWebDriverNavigation.php
@@ -149,7 +149,7 @@ public function to($url)
 
     /**
      * @param mixed $method
-     * @param mixed $arguments,...
+     * @param mixed ...$arguments
      */
     protected function dispatch($method, ...$arguments)
     {
diff --git a/lib/Support/Events/EventFiringWebElement.php b/lib/Support/Events/EventFiringWebElement.php
@@ -392,7 +392,7 @@ protected function dispatchOnException(WebDriverException $exception)
 
     /**
      * @param mixed $method
-     * @param mixed $arguments,...
+     * @param mixed ...$arguments
      */
     protected function dispatch($method, ...$arguments)
     {
diff --git a/lib/WebDriverExpectedCondition.php b/lib/WebDriverExpectedCondition.php
@@ -213,7 +213,7 @@ function (WebDriver $driver) use ($by) {
                         if ($element->isDisplayed()) {
                             $visibleElements[] = $element;
                         }
-                    } catch (StateElementReferenceException $e) {
+                    } catch (StaleElementReferenceException $e) {
                     }
                 }
 
@@ -399,7 +399,7 @@ function (WebDriver $driver) use ($by) {
     /**
      * An expectation for checking that an element with text is either invisible or not present on the DOM.
      *
-     * @param WebdriverBy $by The locator used to find the element.
+     * @param WebDriverBy $by The locator used to find the element.
      * @param string $text The text of the element.
      * @return WebDriverExpectedCondition<bool> Condition returns whether the text is found in the element located.
      */
diff --git a/lib/WebDriverHasInputDevices.php b/lib/WebDriverHasInputDevices.php
@@ -21,7 +21,7 @@
 interface WebDriverHasInputDevices
 {
     /**
-     * @return WebDriverKeyBoard
+     * @return WebDriverKeyboard
      */
     public function getKeyboard();
 
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,10 @@
+parameters:
+	ignoreErrors:
+		- '#Class Symfony\\Component\\Process\\ProcessBuilder not found.#'
+		- '#Instantiated class Symfony\\Component\\Process\\ProcessBuilder not found.#'
+		- '#Call to method setPrefix\(\) on an unknown class Symfony\\Component\\Process\\ProcessBuilder#'
+        # To be fixed:
+		- '#Call to an undefined method RecursiveIteratorIterator::getSubPathName\(\)#'
+		- '#Call to an undefined method Facebook\\WebDriver\\WebDriver::getTouch\(\)#'
+		- '#Call to an undefined method Facebook\\WebDriver\\WebDriverElement::getCoordinates\(\)#'
+		- '#Call to an undefined method Facebook\\WebDriver\\WebDriverElement::equals\(\)#'
diff --git a/tests/functional/Chrome/ChromeDriverServiceTest.php b/tests/functional/Chrome/ChromeDriverServiceTest.php
@@ -19,8 +19,8 @@
 
 /**
  * @group exclude-saucelabs
- * @covers Facebook\WebDriver\Chrome\ChromeDriverService
- * @covers Facebook\WebDriver\Remote\Service\DriverService
+ * @covers \Facebook\WebDriver\Chrome\ChromeDriverService
+ * @covers \Facebook\WebDriver\Remote\Service\DriverService
  */
 class ChromeDriverServiceTest extends TestCase
 {
diff --git a/tests/functional/Chrome/ChromeDriverTest.php b/tests/functional/Chrome/ChromeDriverTest.php
@@ -21,7 +21,7 @@
 
 /**
  * @group exclude-saucelabs
- * @covers Facebook\WebDriver\Chrome\ChromeDriver
+ * @covers \Facebook\WebDriver\Chrome\ChromeDriver
  */
 class ChromeDriverTest extends TestCase
 {
diff --git a/tests/functional/FileUploadTest.php b/tests/functional/FileUploadTest.php
@@ -18,8 +18,8 @@
 use Facebook\WebDriver\Remote\LocalFileDetector;
 
 /**
- * @covers Facebook\WebDriver\Remote\LocalFileDetector
- * @covers Facebook\WebDriver\Remote\RemoteWebElement
+ * @covers \Facebook\WebDriver\Remote\LocalFileDetector
+ * @covers \Facebook\WebDriver\Remote\RemoteWebElement
  */
 class FileUploadTest extends WebDriverTestCase
 {
diff --git a/tests/functional/RemoteWebDriverCreateTest.php b/tests/functional/RemoteWebDriverCreateTest.php
@@ -20,8 +20,8 @@
 use Facebook\WebDriver\Remote\RemoteWebDriver;
 
 /**
- * @covers Facebook\WebDriver\Remote\RemoteWebDriver
- * @covers Facebook\WebDriver\Remote\HttpCommandExecutor
+ * @covers \Facebook\WebDriver\Remote\RemoteWebDriver
+ * @covers \Facebook\WebDriver\Remote\HttpCommandExecutor
  */
 class RemoteWebDriverCreateTest extends WebDriverTestCase
 {
diff --git a/tests/functional/RemoteWebDriverFindElementTest.php b/tests/functional/RemoteWebDriverFindElementTest.php
@@ -20,7 +20,7 @@
 
 /**
  * Tests for findElement() and findElements() method of RemoteWebDriver.
- * @covers Facebook\WebDriver\Remote\RemoteWebDriver
+ * @covers \Facebook\WebDriver\Remote\RemoteWebDriver
  */
 class RemoteWebDriverFindElementTest extends WebDriverTestCase
 {
diff --git a/tests/functional/RemoteWebDriverTest.php b/tests/functional/RemoteWebDriverTest.php
@@ -20,7 +20,7 @@
 use Facebook\WebDriver\Remote\WebDriverBrowserType;
 
 /**
- * @coversDefaultClass Facebook\WebDriver\Remote\RemoteWebDriver
+ * @coversDefaultClass \Facebook\WebDriver\Remote\RemoteWebDriver
  */
 class RemoteWebDriverTest extends WebDriverTestCase
 {
@@ -170,7 +170,7 @@ function(){document.getElementById("id_test").innerHTML = "Text changed by scrip
 
     /**
      * @covers ::executeAsyncScript
-     * @covers Facebook\WebDriver\WebDriverTimeouts::setScriptTimeout
+     * @covers \Facebook\WebDriver\WebDriverTimeouts::setScriptTimeout
      */
     public function testShouldExecuteAsyncScriptAndWaitUntilItIsFinished()
     {
diff --git a/tests/functional/RemoteWebElementTest.php b/tests/functional/RemoteWebElementTest.php
@@ -19,7 +19,7 @@
 use Facebook\WebDriver\Remote\RemoteWebElement;
 
 /**
- * @coversDefaultClass Facebook\WebDriver\Remote\RemoteWebElement
+ * @coversDefaultClass \Facebook\WebDriver\Remote\RemoteWebElement
  */
 class RemoteWebElementTest extends WebDriverTestCase
 {
diff --git a/tests/functional/WebDriverActionsTest.php b/tests/functional/WebDriverActionsTest.php
@@ -18,7 +18,7 @@
 use Facebook\WebDriver\Remote\WebDriverBrowserType;
 
 /**
- * @coversDefaultClass Facebook\WebDriver\Interactions\WebDriverActions
+ * @coversDefaultClass \Facebook\WebDriver\Interactions\WebDriverActions
  */
 class WebDriverActionsTest extends WebDriverTestCase
 {
diff --git a/tests/functional/WebDriverAlertTest.php b/tests/functional/WebDriverAlertTest.php
@@ -19,7 +19,7 @@
 use Facebook\WebDriver\Remote\WebDriverBrowserType;
 
 /**
- * @covers Facebook\WebDriver\WebDriverAlert
+ * @covers \Facebook\WebDriver\WebDriverAlert
  */
 class WebDriverAlertTest extends WebDriverTestCase
 {
diff --git a/tests/functional/WebDriverByTest.php b/tests/functional/WebDriverByTest.php
@@ -19,14 +19,14 @@
 
 /**
  * Tests for locator strategies provided by WebDriverBy.
- * @covers Facebook\WebDriver\WebDriverBy
+ * @covers \Facebook\WebDriver\WebDriverBy
  */
 class WebDriverByTest extends WebDriverTestCase
 {
     /**
      * @dataProvider textElementsProvider
-     * @param $webDriverByLocatorMethod
-     * @param $webDriverByLocatorValue
+     * @param string $webDriverByLocatorMethod
+     * @param string $webDriverByLocatorValue
      * @param string $expectedText
      * @param string $expectedAttributeValue
      */
diff --git a/tests/functional/WebDriverNavigationTest.php b/tests/functional/WebDriverNavigationTest.php
@@ -16,7 +16,7 @@
 namespace Facebook\WebDriver;
 
 /**
- * @coversDefaultClass Facebook\WebDriver\WebDriverNavigation
+ * @coversDefaultClass \Facebook\WebDriver\WebDriverNavigation
  */
 class WebDriverNavigationTest extends WebDriverTestCase
 {
diff --git a/tests/functional/WebDriverSelectTest.php b/tests/functional/WebDriverSelectTest.php
@@ -20,8 +20,8 @@
 use Facebook\WebDriver\Exception\UnsupportedOperationException;
 
 /**
- * @covers Facebook\WebDriver\WebDriverSelect
- * @covers Facebook\WebDriver\Exception\UnexpectedTagNameException
+ * @covers \Facebook\WebDriver\WebDriverSelect
+ * @covers \Facebook\WebDriver\Exception\UnexpectedTagNameException
  */
 class WebDriverSelectTest extends WebDriverTestCase
 {
diff --git a/tests/functional/WebDriverTimeoutsTest.php b/tests/functional/WebDriverTimeoutsTest.php
@@ -22,7 +22,7 @@
 use Facebook\WebDriver\Remote\WebDriverBrowserType;
 
 /**
- * @coversDefaultClass Facebook\WebDriver\WebDriverTimeouts
+ * @coversDefaultClass \Facebook\WebDriver\WebDriverTimeouts
  */
 class WebDriverTimeoutsTest extends WebDriverTestCase
 {
diff --git a/tests/unit/CookieTest.php b/tests/unit/CookieTest.php
@@ -18,7 +18,7 @@
 use PHPUnit\Framework\TestCase;
 
 /**
- * @covers Facebook\WebDriver\Cookie
+ * @covers \Facebook\WebDriver\Cookie
  */
 class CookieTest extends TestCase
 {
diff --git a/tests/unit/Remote/RemoteWebDriverTest.php b/tests/unit/Remote/RemoteWebDriverTest.php
@@ -24,7 +24,7 @@
 /**
  * Unit part of RemoteWebDriver tests. Ie. tests for behavior which do not interact with the real remote server.
  *
- * @coversDefaultClass Facebook\WebDriver\Remote\RemoteWebDriver
+ * @coversDefaultClass \Facebook\WebDriver\Remote\RemoteWebDriver
  */
 class RemoteWebDriverTest extends TestCase
 {
diff --git a/tests/unit/Remote/RemoteWebElementTest.php b/tests/unit/Remote/RemoteWebElementTest.php
@@ -20,7 +20,7 @@
 /**
  * Unit part of RemoteWebDriver tests. Ie. tests for behavior which do not interact with the real remote server.
  *
- * @coversDefaultClass Facebook\WebDriver\Remote\RemoteWebElement
+ * @coversDefaultClass \Facebook\WebDriver\Remote\RemoteWebElement
  */
 class RemoteWebElementTest extends TestCase
 {
diff --git a/tests/unit/WebDriverExpectedConditionTest.php b/tests/unit/WebDriverExpectedConditionTest.php
diff --git a/tests/unit/WebDriverKeysTest.php b/tests/unit/WebDriverKeysTest.php
diff --git a/tests/unit/WebDriverOptionsTest.php b/tests/unit/WebDriverOptionsTest.php

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ public function setPreference($key, $value)`
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`/**`
`113`		`- * @param $key`
	`113`	`+ * @param mixed $key`
`114`	`114`	`* @return mixed`
`115`	`115`	`*/`
`116`	`116`	`public function getPreference($key)`
Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ public function to($url)`
`149`	`149`
`150`	`150`	`/**`
`151`	`151`	`* @param mixed $method`
`152`		`- * @param mixed $arguments,...`
	`152`	`+ * @param mixed ...$arguments`
`153`	`153`	`*/`
`154`	`154`	`protected function dispatch($method, ...$arguments)`
`155`	`155`	`{`
Original file line number	Diff line number	Diff line change
`@@ -392,7 +392,7 @@ protected function dispatchOnException(WebDriverException $exception)`
`392`	`392`
`393`	`393`	`/**`
`394`	`394`	`* @param mixed $method`
`395`		`- * @param mixed $arguments,...`
	`395`	`+ * @param mixed ...$arguments`
`396`	`396`	`*/`
`397`	`397`	`protected function dispatch($method, ...$arguments)`
`398`	`398`	`{`
Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,7 @@ function (WebDriver $driver) use ($by) {`
`213`	`213`	`if ($element->isDisplayed()) {`
`214`	`214`	`$visibleElements[] = $element;`
`215`	`215`	`}`
`216`		`- } catch (StateElementReferenceException $e) {`
	`216`	`+ } catch (StaleElementReferenceException $e) {`
`217`	`217`	`}`
`218`	`218`	`}`
`219`	`219`
`@@ -399,7 +399,7 @@ function (WebDriver $driver) use ($by) {`
`399`	`399`	`/**`
`400`	`400`	`* An expectation for checking that an element with text is either invisible or not present on the DOM.`
`401`	`401`	`*`
`402`		`- * @param WebdriverBy $by The locator used to find the element.`
	`402`	`+ * @param WebDriverBy $by The locator used to find the element.`
`403`	`403`	`* @param string $text The text of the element.`
`404`	`404`	`* @return WebDriverExpectedCondition<bool> Condition returns whether the text is found in the element located.`
`405`	`405`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`interface WebDriverHasInputDevices`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`		`- * @return WebDriverKeyBoard`
	`24`	`+ * @return WebDriverKeyboard`
`25`	`25`	`*/`
`26`	`26`	`public function getKeyboard();`
`27`	`27`