Get rid of baseline, add types to tests

composer · Feb 3, 2022 · 43f8029 · 43f8029
1 parent 66c6445
commit 43f8029
Show file tree

Hide file tree

Showing 10 changed files with 135 additions and 882 deletions.
diff --git a/composer.json b/composer.json
@@ -54,6 +54,6 @@
     },
     "scripts": {
         "test": "SYMFONY_PHPUNIT_REMOVE_RETURN_TYPEHINT=1 vendor/bin/simple-phpunit",
-        "phpstan": "phpstan analyse"
+        "phpstan": "@php vendor/bin/phpstan analyse"
     }
 }
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,8 +1,10 @@
-includes:
-    - tests/baseline.neon
-
 parameters:
     level: 8
     paths:
         - src
         - tests
+
+    ignoreErrors:
+        # Ignore some irrelevant errors in test files
+        - '~Method Composer\\Semver\\[^:]+::(setUp(BeforeClass)?|tearDown(AfterClass)?|test[^(]+)\(\) has no return type specified.~'
+        - '~Method Composer\\Semver\\[^:]+::(data\w+|provide\w+|\w+?Provider)\(\) has no return type specified.~'
diff --git a/tests/ComparatorTest.php b/tests/ComparatorTest.php
@@ -126,7 +126,7 @@ public function testCompare($version1, $operator, $version2, $expected)
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function greaterThanProvider()
     {
@@ -141,7 +141,7 @@ public function greaterThanProvider()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function greaterThanOrEqualToProvider()
     {
@@ -153,7 +153,7 @@ public function greaterThanOrEqualToProvider()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function lessThanProvider()
     {
@@ -169,7 +169,7 @@ public function lessThanProvider()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function lessThanOrEqualToProvider()
     {
@@ -181,7 +181,7 @@ public function lessThanOrEqualToProvider()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function equalToProvider()
     {
@@ -196,7 +196,7 @@ public function equalToProvider()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function notEqualToProvider()
     {
@@ -208,7 +208,7 @@ public function notEqualToProvider()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function compareProvider()
     {

diff --git a/tests/Constraint/ConstraintTest.php b/tests/Constraint/ConstraintTest.php
@@ -53,6 +53,9 @@ public function testGetPrettyString()
         $this->assertSame($expectedVersion, $result);
     }
 
+    /**
+     * @return array<mixed>
+     */
     public static function successfulVersionMatches()
     {
         return array(
@@ -161,6 +164,10 @@ public static function successfulVersionMatches()
 
     /**
      * @dataProvider successfulVersionMatches
+     * @param Constraint::STR_OP_* $requireOperator
+     * @param string $requireVersion
+     * @param Constraint::STR_OP_* $provideOperator
+     * @param string $provideVersion
      */
     public function testVersionMatchSucceeds($requireOperator, $requireVersion, $provideOperator, $provideVersion)
     {
@@ -178,6 +185,9 @@ public function testVersionMatchSucceeds($requireOperator, $requireVersion, $pro
         $this->assertTrue(Intervals::compactConstraint($versionProvide)->matches(Intervals::compactConstraint($versionRequire)));
     }
 
+    /**
+     * @return array<mixed>
+     */
     public static function failingVersionMatches()
     {
         return array(
@@ -331,6 +341,10 @@ public static function failingVersionMatches()
 
     /**
      * @dataProvider failingVersionMatches
+     * @param Constraint::STR_OP_* $requireOperator
+     * @param string $requireVersion
+     * @param Constraint::STR_OP_* $provideOperator
+     * @param string $provideVersion
      */
     public function testVersionMatchFails($requireOperator, $requireVersion, $provideOperator, $provideVersion)
     {
@@ -411,19 +425,18 @@ public function testComparableBranches()
      * @dataProvider invalidOperators
      *
      * @param string $version
-     * @param string $operator
-     * @param string $expected
+     * @param Constraint::STR_OP_* $operator
+     * @param class-string $expected
      */
     public function testInvalidOperators($version, $operator, $expected)
     {
         $this->doExpectException($expected);
 
-        /** @phpstan-ignore-next-line */
         new Constraint($operator, $version);
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function invalidOperators()
     {
@@ -437,12 +450,10 @@ public function invalidOperators()
     /**
      * @dataProvider bounds
      *
-     * @param string $operator
+     * @param Constraint::STR_OP_* $operator
      * @param string $normalizedVersion
      * @param Bound  $expectedLower
      * @param Bound  $expectedUpper
-     *
-     * @phpstan-param Constraint::STR_OP_* $operator
      */
     public function testBounds($operator, $normalizedVersion, Bound $expectedLower, Bound $expectedUpper)
     {
@@ -453,7 +464,7 @@ public function testBounds($operator, $normalizedVersion, Bound $expectedLower,
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function bounds()
     {
@@ -496,6 +507,10 @@ public function bounds()
 
     /**
      * @dataProvider matrix
+     * @param Constraint::STR_OP_* $requireOperator
+     * @param string $requireVersion
+     * @param Constraint::STR_OP_* $provideOperator
+     * @param string $provideVersion
      */
     public function testCompile($requireOperator, $requireVersion, $provideOperator, $provideVersion)
     {
@@ -517,6 +532,9 @@ public function testCompile($requireOperator, $requireVersion, $provideOperator,
         $this->assertSame($m, Intervals::haveIntersections($require, $provide));
     }
 
+    /**
+     * @return array<mixed>
+     */
     public function matrix()
     {
         $versions = array('1.0', '2.0', 'dev-master', 'dev-foo', '3.0-b2', '3.0-beta2');
@@ -536,6 +554,11 @@ public function matrix()
         return $matrix;
     }
 
+    /**
+     * @param Constraint::STR_OP_* $operator
+     * @param string $version
+     * @return bool
+     */
     private function matchCompiled(ConstraintInterface $constraint, $operator, $version)
     {
         $map = array(
@@ -556,6 +579,10 @@ private function matchCompiled(ConstraintInterface $constraint, $operator, $vers
         return eval("return $code;");
     }
 
+    /**
+     * @param  class-string $class
+     * @return void
+     */
     private function doExpectException($class)
     {
         if (method_exists($this, 'expectException')) {

diff --git a/tests/Constraint/MultiConstraintTest.php b/tests/Constraint/MultiConstraintTest.php
@@ -54,7 +54,7 @@ public function testMultiVersionMatchSucceeds()
 
         $this->assertTrue($multiRequire->matches($versionProvide));
         $this->assertTrue($versionProvide->matches($multiRequire));
-        $this->assertTrue($this->matchCompiled($multiRequire, '==', 1.1));
+        $this->assertTrue($this->matchCompiled($multiRequire, '==', '1.1'));
         $this->assertTrue(Intervals::haveIntersections($multiRequire, $versionProvide));
         $this->assertTrue(Intervals::compactConstraint($multiRequire)->matches(Intervals::compactConstraint($versionProvide)));
         $this->assertTrue(Intervals::compactConstraint($versionProvide)->matches(Intervals::compactConstraint($multiRequire)));
@@ -113,7 +113,7 @@ public function testMultiVersionMatchFails()
 
         $this->assertFalse($multiRequire->matches($versionProvide));
         $this->assertFalse($versionProvide->matches($multiRequire));
-        $this->assertFalse($this->matchCompiled($multiRequire, '==', 1.2));
+        $this->assertFalse($this->matchCompiled($multiRequire, '==', '1.2'));
         $this->assertFalse(Intervals::haveIntersections($multiRequire, $versionProvide));
         $this->assertFalse(Intervals::compactConstraint($multiRequire)->matches(Intervals::compactConstraint($versionProvide)));
         $this->assertFalse(Intervals::compactConstraint($versionProvide)->matches(Intervals::compactConstraint($multiRequire)));
@@ -138,7 +138,7 @@ public function testGetPrettyString()
     /**
      * @dataProvider bounds
      *
-     * @param array $constraints
+     * @param array<ConstraintInterface> $constraints
      * @param bool  $conjunctive
      * @param Bound $expectedLower
      * @param Bound $expectedUpper
@@ -152,7 +152,7 @@ public function testBounds(array $constraints, $conjunctive, Bound $expectedLowe
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function bounds()
     {
@@ -224,7 +224,7 @@ public function testBoundsIntegrationWithVersionParser($constraints, Bound $expe
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function boundsIntegration()
     {
@@ -304,6 +304,9 @@ public function testMultiConstraintOptimizations($constraints, ConstraintInterfa
         $this->assertSame((string) $expectedConstraint, (string) $parser->parseConstraints($constraints));
     }
 
+    /**
+     * @return array<mixed>
+     */
     public function multiConstraintOptimizations()
     {
         return array(
@@ -516,7 +519,7 @@ public function testMultiConstraintNotconjunctiveFillWithFalse()
 
         $this->assertFalse($multiRequire->matches($versionProvide));
         $this->assertFalse($versionProvide->matches($multiRequire));
-        $this->assertFalse($this->matchCompiled($multiRequire, '==', 1.1));
+        $this->assertFalse($this->matchCompiled($multiRequire, '==', '1.1'));
         $this->assertFalse(Intervals::haveIntersections($multiRequire, $versionProvide));
     }
 
@@ -530,10 +533,15 @@ public function testMultiConstraintConjunctiveFillWithTrue()
 
         $this->assertTrue($multiRequire->matches($versionProvide));
         $this->assertTrue($versionProvide->matches($multiRequire));
-        $this->assertTrue($this->matchCompiled($multiRequire, '!=', 1.1));
+        $this->assertTrue($this->matchCompiled($multiRequire, '!=', '1.1'));
         $this->assertTrue(Intervals::haveIntersections($multiRequire, $versionProvide));
     }
 
+    /**
+     * @param Constraint::STR_OP_* $operator
+     * @param string $version
+     * @return bool
+     */
     private function matchCompiled(ConstraintInterface $constraint, $operator, $version)
     {
         $map = array(

diff --git a/tests/IntervalsTest.php b/tests/IntervalsTest.php
@@ -28,6 +28,9 @@ class IntervalsTest extends TestCase
 
     /**
      * @dataProvider compactProvider
+     * @param string $expected
+     * @param array<string> $toCompact
+     * @param bool $conjunctive
      */
     public function testCompactConstraint($expected, $toCompact, $conjunctive)
     {
@@ -191,6 +194,8 @@ public function compactProvider()
 
     /**
      * @dataProvider intervalsProvider
+     * @param array<mixed>|self::INTERVAL_* $expected
+     * @param string $constraint
      */
     public function testGetIntervals($expected, $constraint)
     {

diff --git a/tests/SemverTest.php b/tests/SemverTest.php
@@ -36,8 +36,8 @@ public function testSatisfies($expected, $version, $constraint)
      * @dataProvider satisfiedByProvider
      *
      * @param string $constraint
-     * @param array  $versions
-     * @param array  $expected
+     * @param array<string> $versions
+     * @param array<string> $expected
      */
     public function testSatisfiedBy($constraint, $versions, $expected)
     {
@@ -50,9 +50,9 @@ public function testSatisfiedBy($constraint, $versions, $expected)
      * @covers ::usort
      * @dataProvider sortProvider
      *
-     * @param array $versions
-     * @param array $sorted
-     * @param array $rsorted
+     * @param array<string> $versions
+     * @param array<string> $sorted
+     * @param array<string> $rsorted
      */
     public function testSort(array $versions, array $sorted, array $rsorted)
     {
@@ -77,7 +77,7 @@ public function testUsortShouldInitialVersionParserClass()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function sortProvider()
     {
@@ -96,7 +96,7 @@ public function sortProvider()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function satisfiesProvider()
     {
@@ -116,7 +116,7 @@ public function satisfiesProvider()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function satisfiesProviderPositive()
     {
@@ -198,7 +198,7 @@ public function satisfiesProviderPositive()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function satisfiesProviderNegative()
     {
@@ -252,7 +252,7 @@ public function satisfiesProviderNegative()
     }
 
     /**
-     * @return array
+     * @return array<mixed>
      */
     public function satisfiedByProvider()
     {