✨ switch phan for phpstan (see chillerlan/php-qrcode#277)

codemasher · codemasher · commit 488b11481ba4 · 2024-07-17T02:03:27.000+02:00
(cherry picked from commit ee00916)
diff --git a/.gitattributes b/.gitattributes
@@ -1,17 +1,20 @@
-/.build            export-ignore
-/.github           export-ignore
-/.phan             export-ignore
-/.phpdoc           export-ignore
-/docs              export-ignore
-/examples          export-ignore
-/tests             export-ignore
-/.editorconfig     export-ignore
-/.gitattributes    export-ignore
-/.gitignore        export-ignore
-/.readthedocs.yml  export-ignore
-/phpcs.xml.dist    export-ignore
-/phpdoc.xml.dist   export-ignore
-/phpmd.xml.dist    export-ignore
-/phpunit.xml.dist  export-ignore
+/.build                 export-ignore
+/.github                export-ignore
+/.idea                  export-ignore
+/.phan                  export-ignore
+/.phpdoc                export-ignore
+/docs                   export-ignore
+/examples               export-ignore
+/tests                  export-ignore
+/.editorconfig          export-ignore
+/.gitattributes         export-ignore
+/.gitignore             export-ignore
+/.readthedocs.yml       export-ignore
+/phpcs.xml.dist         export-ignore
+/phpdoc.xml.dist        export-ignore
+/phpmd.xml.dist         export-ignore
+/phpunit.xml.dist       export-ignore
+/phpstan.dist.neon      export-ignore
+/phpstan-baseline.neon  export-ignore
 
 *.php diff=php
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -44,7 +44,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          extensions: ast, ${{ env.PHP_EXTENSIONS }}
+          extensions: ${{ env.PHP_EXTENSIONS }}
           ini-values: ${{ env.PHP_INI_VALUES }}
           coverage: none
 
@@ -54,8 +54,8 @@ jobs:
       - name: "Install dependencies with composer"
         uses: ramsey/composer-install@v3
 
-      - name: "Run phan"
-        run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }}
+      - name: "Run PHPStan"
+        run: php vendor/bin/phpstan
 
 
   tests:
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,5 @@ phpcs.xml
 phpdoc.xml
 phpmd.xml
 phpunit.xml
+phpstan.neon
 *.phpunit.result.cache
diff --git a/.phan/config.php b/.phan/config.php
diff --git a/composer.json b/composer.json
@@ -32,17 +32,18 @@
 	"prefer-stable": true,
 	"require": {
 		"php": "^7.4 || ^8.0",
-		"chillerlan/php-settings-container": "^2.1.5 || ^3.2",
+		"chillerlan/php-settings-container": "^2.1.6 || ^3.2.1",
 		"paragonie/constant_time_encoding": "^2.6"
 	},
 	"require-dev": {
 		"ext-curl": "*",
 		"ext-json": "*",
 		"ext-sodium": "*",
-		"phan/phan": "^5.4",
 		"phpmd/phpmd": "^2.15",
+		"phpstan/phpstan": "^1.11",
+		"phpstan/phpstan-deprecation-rules": "^1.2",
 		"phpunit/phpunit": "^9.6",
-		"squizlabs/php_codesniffer": "^3.9"
+		"squizlabs/php_codesniffer": "^3.10"
 	},
 	"suggest": {
 		"chillerlan/php-qrcode": "Create QR Codes for use with an authenticator app."
@@ -58,9 +59,9 @@
 		}
 	},
 	"scripts": {
-		"phan": "@php vendor/bin/phan --allow-polyfill-parser",
 		"phpcs": "@php vendor/bin/phpcs",
-		"phpunit": "@php vendor/bin/phpunit"
+		"phpunit": "@php vendor/bin/phpunit",
+		"phpstan": "@php vendor/bin/phpstan"
 	},
 	"config": {
 		"lock": false,
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -0,0 +1,31 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Cannot access offset 'server_time' on mixed\\.$#"
+			count: 1
+			path: src/Authenticators/SteamGuard.php
+
+		-
+			message: "#^Cannot cast mixed to int\\.$#"
+			count: 1
+			path: src/Authenticators/SteamGuard.php
+
+		-   # $response is always string here because CURLOPT_RETURNTRANSFER is set to true
+			message: "#^Parameter \\#1 \\$json of function json_decode expects string, string\\|true given\\.$#"
+			count: 1
+			path: src/Authenticators/SteamGuard.php
+
+		-   # the value given to getHMAC() is always int - this is most likely a false positive
+			message: "#^Parameter \\#1 \\$counter of method chillerlan\\\\Authenticator\\\\Authenticators\\\\HOTP\\:\\:getHMAC\\(\\) expects int, float\\|int given\\.$#"
+			count: 1
+			path: src/Authenticators/TOTP.php
+
+		-   # 32-bit system check
+			message: "#^Call to function is_int\\(\\) with 59\\|1111111109\\|1111111111\\|1234567890\\|2000000000\\|20000000000 will always evaluate to true\\.$#"
+			count: 1
+			path: tests/Authenticators/SteamGuardTest.php
+
+		-   # 32-bit system check
+			message: "#^Call to function is_int\\(\\) with 59\\|1111111109\\|1111111111\\|1234567890\\|2000000000\\|20000000000 will always evaluate to true\\.$#"
+			count: 1
+			path: tests/Authenticators/TOTPTest.php
diff --git a/phpstan.dist.neon b/phpstan.dist.neon
@@ -0,0 +1,17 @@
+# https://phpstan.org/config-reference
+
+parameters:
+	level: 9
+	tmpDir: .build/phpstan-cache
+	paths:
+		- examples
+		- src
+		- tests
+
+	treatPhpDocTypesAsCertain: false
+
+includes:
+	- phpstan-baseline.neon
+	- vendor/phpstan/phpstan/conf/bleedingEdge.neon
+	- vendor/phpstan/phpstan-deprecation-rules/rules.neon
+	- vendor/chillerlan/php-settings-container/rules-magic-access.neon
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -8,12 +8,12 @@
 >
 	<testsuites>
 		<testsuite name="php-authenticator test suite">
-			<directory suffix=".php">./tests</directory>
+			<directory>tests</directory>
 		</testsuite>
 	</testsuites>
 	<coverage processUncoveredFiles="true">
 		<include>
-			<directory suffix=".php">./src</directory>
+			<directory suffix=".php">src</directory>
 		</include>
 		<report>
 			<clover outputFile=".build/coverage/clover.xml"/>
diff --git a/src/AuthenticatorOptionsTrait.php b/src/AuthenticatorOptionsTrait.php
@@ -17,6 +17,17 @@
 use function strtolower;
 use function strtoupper;
 
+/**
+ * @property int    $digits
+ * @property int    $period
+ * @property int    $secret_length
+ * @property string $algorithm
+ * @property string $mode
+ * @property int    $adjacent
+ * @property int    $time_offset
+ * @property bool   $useLocalTime
+ * @property bool   $forceTimeRefresh
+ */
 trait AuthenticatorOptionsTrait{
 
 	/**
diff --git a/src/Authenticators/HOTP.php b/src/Authenticators/HOTP.php
@@ -54,7 +54,12 @@ public function getHMAC(int $counter):string{
 	 */
 	public function getCode(string $hmac):int{
 		$data = unpack('C*', $hmac);
-		$b    = ($data[strlen($hmac)] & 0xF);
+
+		if($data === false){
+			throw new RuntimeException('error while unpacking HMAC'); // @codeCoverageIgnore
+		}
+
+		$b = ($data[strlen($hmac)] & 0xF);
 		// phpcs:ignore
 		return (($data[$b + 1] & 0x7F) << 24) | ($data[$b + 2] << 16) | ($data[$b + 3] << 8) | $data[$b + 4];
 	}
diff --git a/src/Authenticators/SteamGuard.php b/src/Authenticators/SteamGuard.php
@@ -22,6 +22,7 @@
 use function curl_setopt_array;
 use function floor;
 use function intdiv;
+use function is_array;
 use function json_decode;
 use function sprintf;
 use function time;
@@ -128,21 +129,26 @@ public function getServerTime():int{
 
 		$ch = curl_init($this::steamTimeURL);
 
+		// it's almost impossible to run into this, but hey, phpstan happy
+		if($ch === false){
+			throw new RuntimeException('curl_init error'); // @codeCoverageIgnore
+		}
+
 		curl_setopt_array($ch, $options);
 
 		$response = curl_exec($ch);
 		$info     = curl_getinfo($ch);
 
 		curl_close($ch);
 
-		if($info['http_code'] !== 200){
+		if($info['http_code'] !== 200 || $response === false){
 			// I'm not going to investigate the error further as this shouldn't happen usually
 			throw new RuntimeException(sprintf('Steam API request error: HTTP/%s', $info['http_code'])); // @codeCoverageIgnore
 		}
 
 		$json = json_decode($response, true);
 
-		if(empty($json) || !isset($json['response']['server_time'])){
+		if(!is_array($json) || !isset($json['response']['server_time'])){
 			throw new RuntimeException('Unable to decode Steam API response'); // @codeCoverageIgnore
 		}
 
diff --git a/tests/AuthenticatorTest.php b/tests/AuthenticatorTest.php
@@ -84,7 +84,7 @@ public function testGetUri():void{
 		);
 	}
 
-	public function testGetUriEmptyLabelException(){
+	public function testGetUriEmptyLabelException():void{
 		$this->expectException(InvalidArgumentException::class);
 		$this->expectExceptionMessage('$label and $issuer cannot be empty');
 
diff --git a/tests/Common/Base32Test.php b/tests/Common/Base32Test.php
@@ -17,6 +17,9 @@
 
 class Base32Test extends TestCase{
 
+	/**
+	 * @phpstan-return array<int, array<int, string>>
+	 */
 	public static function base32DataProvider():array{
 		return [
 			['a'                   , 'ME'                              ],
diff --git a/tests/Common/Base64Test.php b/tests/Common/Base64Test.php
@@ -22,6 +22,9 @@
  */
 class Base64Test extends TestCase{
 
+	/**
+	 * @phpstan-return array<int, array<int, string>>
+	 */
 	public static function base64DataProvider():array{
 		return [
 			['a'                   , 'YQ=='                        ],
diff --git a/tests/Common/HexTest.php b/tests/Common/HexTest.php
@@ -22,6 +22,9 @@
  */
 class HexTest extends TestCase{
 
+	/**
+	 * @phpstan-return array<int, array<int, string>>
+	 */
 	public static function hexDataProvider():array{
 		return [
 			['a'                   , '61'                                      ],
