PHPStan Coverage for Tests

darsyn · Mar 28, 2024 · e77913a · e77913a
1 parent 762dde4
commit e77913a
Show file tree

Hide file tree

Showing 26 changed files with 814 additions and 98 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,6 +1,6 @@
 parameters:
     level: 'max'
-    paths: [ 'src' ]
+    paths: [ 'src', 'tests' ]
     checkFunctionNameCase: true
     checkGenericClassInNonGenericObjectType: true
     reportUnmatchedIgnoredErrors: true

diff --git a/src/Formatter/ConsistentFormatter.php b/src/Formatter/ConsistentFormatter.php
@@ -73,7 +73,7 @@ private function ntopVersion4($binary)
         // $pack return type is `string|false` below PHP 8 and `string`
         // above PHP 8.
         $pack = \pack('A4', $binary);
-        // @phpstan-ignore-next-line identical.alwaysFalse
+        /** @phpstan-ignore identical.alwaysFalse */
         if (false === $pack || false === $protocol = \inet_ntop($pack)) {
             throw new FormatException($binary);
         }

diff --git a/src/Formatter/NativeFormatter.php b/src/Formatter/NativeFormatter.php
@@ -18,7 +18,7 @@ public function ntop($binary)
                 $pack = \pack(\sprintf('A%d', $length), $binary);
                 // $pack return type is `string|false` below PHP 8 and `string`
                 // above PHP 8.
-                // @phpstan-ignore-next-line identical.alwaysFalse
+                /** @phpstan-ignore identical.alwaysFalse */
                 if (false === $pack || false === $protocol = \inet_ntop($pack)) {
                     throw new FormatException($binary);
                 }

diff --git a/tests/DataProvider/Formatter/ConsistentFormatter.php b/tests/DataProvider/Formatter/ConsistentFormatter.php
@@ -4,6 +4,7 @@
 
 class ConsistentFormatter
 {
+    /** @return list<array{string, string}> */
     public static function getValidBinarySequences()
     {
         return [
@@ -33,6 +34,7 @@ public static function getValidBinarySequences()
         ];
     }
 
+    /** @return list<array{mixed}> */
     public static function getInvalidBinarySequences()
     {
         return [

diff --git a/tests/DataProvider/Formatter/NativeFormatter.php b/tests/DataProvider/Formatter/NativeFormatter.php
@@ -4,6 +4,7 @@
 
 class NativeFormatter
 {
+    /** @return list<array{string, string}> */
     public static function getValidBinarySequences()
     {
         return [
@@ -32,6 +33,7 @@ public static function getValidBinarySequences()
         ];
     }
 
+    /** @return list<array{mixed}> */
     public static function getInvalidBinarySequences()
     {
         return [

diff --git a/tests/DataProvider/IPv4.php b/tests/DataProvider/IPv4.php
@@ -4,6 +4,7 @@
 
 class IPv4 implements IpDataProviderInterface
 {
+    /** @return list<array{string, string, string}> */
     public static function getValidBinarySequences()
     {
         return [
@@ -23,6 +24,7 @@ public static function getValidBinarySequences()
         ];
     }
 
+    /** @return list<array{string, string, string}> */
     public static function getValidProtocolIpAddresses()
     {
         return [
@@ -41,11 +43,13 @@ public static function getValidProtocolIpAddresses()
         ];
     }
 
+    /** @return list<array{string, string, string}> */
     public static function getValidIpAddresses()
     {
         return array_merge(self::getValidBinarySequences(), self::getValidProtocolIpAddresses());
     }
 
+    /** @return list<array{mixed}> */
     public static function getInvalidIpAddresses()
     {
         return [
@@ -67,6 +71,7 @@ public static function getInvalidIpAddresses()
         ];
     }
 
+    /** @return list<array{int, string}> */
     public static function getValidCidrValues()
     {
         return [
@@ -82,6 +87,7 @@ public static function getValidCidrValues()
         ];
     }
 
+    /** @return list<array{mixed}> */
     public static function getInvalidCidrValues()
     {
         return [
@@ -97,6 +103,7 @@ public static function getInvalidCidrValues()
         ];
     }
 
+    /** @return list<array{string, int}> */
     public static function getNetworkIpAddresses()
     {
         return [
@@ -109,6 +116,7 @@ public static function getNetworkIpAddresses()
         ];
     }
 
+    /** @return list<array{string, int}> */
     public static function getBroadcastIpAddresses()
     {
         return [
@@ -121,6 +129,7 @@ public static function getBroadcastIpAddresses()
         ];
     }
 
+    /** @return list<array{string, string, int}> */
     public static function getValidInRangeIpAddresses()
     {
         return [
@@ -131,6 +140,7 @@ public static function getValidInRangeIpAddresses()
         ];
     }
 
+    /** @return list<array{string, string, int}> */
     public static function getCommonCidrValues()
     {
         return [
@@ -153,56 +163,67 @@ public static function getCommonCidrValues()
         ];
     }
 
+    /** @return list<array{string, bool}> */
     public static function getLinkLocalIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::LINK_LOCAL);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getLoopbackIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::LOOPBACK);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getMulticastIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::MULTICAST);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getPrivateUseIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::PRIVATE_USE);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getUnspecifiedIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::UNSPECIFIED);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getBenchmarkingIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::BENCHMARKING);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getDocumentationIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::DOCUMENTATION);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getPublicUseIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::PUBLIC_USE_V4);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getIsBroadcastIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::BROADCAST);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getSharedIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::SHARED);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getFutureReservedIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::FUTURE_RESERVED);

diff --git a/tests/DataProvider/IPv6.php b/tests/DataProvider/IPv6.php
@@ -4,6 +4,7 @@
 
 class IPv6 implements IpDataProviderInterface
 {
+    /** @return list<array{string, string, string, string}> */
     public static function getValidBinarySequences()
     {
         return [
@@ -23,6 +24,7 @@ public static function getValidBinarySequences()
         ];
     }
 
+    /** @return list<array{string, string, string, string}> */
     public static function getValidProtocolIpAddresses()
     {
         return [
@@ -40,11 +42,13 @@ public static function getValidProtocolIpAddresses()
         ];
     }
 
+    /** @return list<array{string, string, string, string}> */
     public static function getValidIpAddresses()
     {
         return array_merge(self::getValidBinarySequences(), self::getValidProtocolIpAddresses());
     }
 
+    /** @return list<array{mixed}> */
     public static function getInvalidIpAddresses()
     {
         return [
@@ -67,6 +71,7 @@ public static function getInvalidIpAddresses()
         ];
     }
 
+    /** @return list<array{int, string}> */
     public static function getValidCidrValues()
     {
         return [
@@ -81,6 +86,7 @@ public static function getValidCidrValues()
         ];
     }
 
+    /** @return list<array{mixed}> */
     public static function getInvalidCidrValues()
     {
         return [
@@ -96,6 +102,7 @@ public static function getInvalidCidrValues()
         ];
     }
 
+    /** @return list<array{string, int}> */
     public static function getNetworkIpAddresses()
     {
         return [
@@ -107,6 +114,7 @@ public static function getNetworkIpAddresses()
         ];
     }
 
+    /** @return list<array{string, int}> */
     public static function getBroadcastIpAddresses()
     {
         return [
@@ -118,6 +126,7 @@ public static function getBroadcastIpAddresses()
         ];
     }
 
+    /** @return list<array{string, string, int}> */
     public static function getValidInRangeIpAddresses()
     {
         return [
@@ -130,6 +139,7 @@ public static function getValidInRangeIpAddresses()
         ];
     }
 
+    /** @return list<array{string, string, int}> */
     public static function getCommonCidrValues()
     {
         return [
@@ -152,61 +162,73 @@ public static function getCommonCidrValues()
         ];
     }
 
+    /** @return list<array{string, bool}> */
     public static function getMappedIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::MAPPED);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getDerivedIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::DERIVED);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getCompatibleIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::COMPATIBLE);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getLinkLocalIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::LINK_LOCAL);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getLoopbackIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::LOOPBACK);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getMulticastIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::MULTICAST);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getPrivateUseIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::PRIVATE_USE);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getUnspecifiedIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::UNSPECIFIED);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getBenchmarkingIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::BENCHMARKING);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getDocumentationIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::DOCUMENTATION);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getPublicUseIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::PUBLIC_USE_V6);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getPublicUseIpAddressesExcludingMapped()
     {
         // Exclude IPv4-embedded addresses embedded using the Mapped strategy,
@@ -215,31 +237,37 @@ public static function getPublicUseIpAddressesExcludingMapped()
         return self::getCategoryOfIpAddresses(self::PUBLIC_USE_V6, self::MAPPED);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getUniqueLocalIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::UNIQUE_LOCAL);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getUniqueLocalIpAddressesExcludingMapped()
     {
         return self::getCategoryOfIpAddresses(self::UNIQUE_LOCAL, self::MAPPED);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getUnicastIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::UNICAST);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getUnicastIpAddressesExcludingMapped()
     {
         return self::getCategoryOfIpAddresses(self::UNICAST, self::MAPPED);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getUnicastGlobalIpAddresses()
     {
         return self::getCategoryOfIpAddresses(self::UNICAST_GLOBAL);
     }
 
+    /** @return list<array{string, bool}> */
     public static function getUnicastGlobalIpAddressesExcludingMapped()
     {
         return self::getCategoryOfIpAddresses(self::UNICAST_GLOBAL, self::MAPPED);