Built-in assertion and mock type definitions

.php_cs.dist

@@ -198,7 +198,11 @@ return PhpCsFixer\Config::create()
         ->files()
         ->in(__DIR__ . '/build')
         ->in(__DIR__ . '/src')
-        ->in(__DIR__ . '/tests')
+        ->in(__DIR__ . '/tests/_files')
+        ->in(__DIR__ . '/tests/basic')
+        ->in(__DIR__ . '/tests/end-to-end')
+        ->in(__DIR__ . '/tests/fail')
+        ->in(__DIR__ . '/tests/unit')
         ->notName('*.phpt')
         ->notName('ClassWithAllPossibleReturnTypes.php')
     );

.phpstorm.meta.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace PHPSTORM_META {
+
+    override(
+        \PHPUnit\Framework\TestCase::createMock(0),
+        map([
+            '@&\PHPUnit\Framework\MockObject\MockObject',
+        ])
+    );
+
+    override(
+        \PHPUnit\Framework\TestCase::createConfiguredMock(0),
+        map([
+            '@&\PHPUnit\Framework\MockObject\MockObject',
+        ])
+    );
+
+    override(
+        \PHPUnit\Framework\TestCase::createPartialMock(0),
+        map([
+            '@&\PHPUnit\Framework\MockObject\MockObject',
+        ])
+    );
+
+    override(
+        \PHPUnit\Framework\TestCase::createTestProxy(0),
+        map([
+            '@&\PHPUnit\Framework\MockObject\MockObject',
+        ])
+    );
+
+    override(
+        \PHPUnit\Framework\TestCase::getMockForAbstractClass(0),
+        map([
+            '@&\PHPUnit\Framework\MockObject\MockObject',
+        ])
+    );
+}

.travis.yml

@@ -13,7 +13,7 @@ php:
 
 matrix:
   allow_failures:
-    - php: master
+    - php: nightly
   fast_finish: true
 
 env:
@@ -64,4 +64,5 @@ jobs:
         - phpenv config-rm xdebug.ini
       script:
         - travis_retry ./tools/composer update $DEFAULT_COMPOSER_FLAGS
+        - ./tools/psalm --config=tests/static-analysis/config.xml --no-progress
         - ./tools/psalm --config=.psalm/config.xml --no-progress --shepherd --stats

src/Framework/Assert.php

@@ -819,6 +819,8 @@ public static function assertAttributeNotEquals($expected, string $actualAttribu
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert empty $actual
      */
     public static function assertEmpty($actual, string $message = ''): void
     {
@@ -853,6 +855,8 @@ public static function assertAttributeEmpty(string $haystackAttributeName, $hays
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !empty $actual
      */
     public static function assertNotEmpty($actual, string $message = ''): void
     {
@@ -1305,6 +1309,8 @@ public static function assertFileNotIsWritable(string $file, string $message = '
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert true $condition
      */
     public static function assertTrue($condition, string $message = ''): void
     {
@@ -1316,6 +1322,8 @@ public static function assertTrue($condition, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !true $condition
      */
     public static function assertNotTrue($condition, string $message = ''): void
     {
@@ -1327,6 +1335,8 @@ public static function assertNotTrue($condition, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert false $condition
      */
     public static function assertFalse($condition, string $message = ''): void
     {
@@ -1338,6 +1348,8 @@ public static function assertFalse($condition, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !false $condition
      */
     public static function assertNotFalse($condition, string $message = ''): void
     {
@@ -1349,6 +1361,8 @@ public static function assertNotFalse($condition, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert null $actual
      */
     public static function assertNull($actual, string $message = ''): void
     {
@@ -1360,6 +1374,8 @@ public static function assertNull($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !null $actual
      */
     public static function assertNotNull($actual, string $message = ''): void
     {
@@ -1556,6 +1572,10 @@ public static function assertObjectNotHasAttribute(string $attributeName, $objec
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-template ExpectedType
+     * @psalm-param ExpectedType $expected
+     * @psalm-assert =ExpectedType $actual
      */
     public static function assertSame($expected, $actual, string $message = ''): void
     {
@@ -1643,6 +1663,10 @@ public static function assertAttributeNotSame($expected, string $actualAttribute
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
      * @throws Exception
+     *
+     * @psalm-template ExpectedType of object
+     * @psalm-param class-string<ExpectedType> $expected
+     * @psalm-assert ExpectedType $actual
      */
     public static function assertInstanceOf(string $expected, $actual, string $message = ''): void
     {
@@ -1668,6 +1692,8 @@ public static function assertInstanceOf(string $expected, $actual, string $messa
      *
      * @deprecated https://github.com/sebastianbergmann/phpunit/issues/3338
      * @codeCoverageIgnore
+     *
+     * @psalm-param class-string $expected
      */
     public static function assertAttributeInstanceOf(string $expected, string $attributeName, $classOrObject, string $message = ''): void
     {
@@ -1686,6 +1712,10 @@ public static function assertAttributeInstanceOf(string $expected, string $attri
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
      * @throws Exception
+     *
+     * @psalm-template ExpectedType of object
+     * @psalm-param class-string<ExpectedType> $expected
+     * @psalm-assert !ExpectedType $actual
      */
     public static function assertNotInstanceOf(string $expected, $actual, string $message = ''): void
     {
@@ -1713,6 +1743,8 @@ public static function assertNotInstanceOf(string $expected, $actual, string $me
      *
      * @deprecated https://github.com/sebastianbergmann/phpunit/issues/3338
      * @codeCoverageIgnore
+     *
+     * @psalm-param class-string $expected
      */
     public static function assertAttributeNotInstanceOf(string $expected, string $attributeName, $classOrObject, string $message = ''): void
     {
@@ -1773,6 +1805,8 @@ public static function assertAttributeInternalType(string $expected, string $att
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert array $actual
      */
     public static function assertIsArray($actual, string $message = ''): void
     {
@@ -1788,6 +1822,8 @@ public static function assertIsArray($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert bool $actual
      */
     public static function assertIsBool($actual, string $message = ''): void
     {
@@ -1803,6 +1839,8 @@ public static function assertIsBool($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert float $actual
      */
     public static function assertIsFloat($actual, string $message = ''): void
     {
@@ -1818,6 +1856,8 @@ public static function assertIsFloat($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert int $actual
      */
     public static function assertIsInt($actual, string $message = ''): void
     {
@@ -1833,6 +1873,8 @@ public static function assertIsInt($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert numeric $actual
      */
     public static function assertIsNumeric($actual, string $message = ''): void
     {
@@ -1848,6 +1890,8 @@ public static function assertIsNumeric($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert object $actual
      */
     public static function assertIsObject($actual, string $message = ''): void
     {
@@ -1863,6 +1907,8 @@ public static function assertIsObject($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert resource $actual
      */
     public static function assertIsResource($actual, string $message = ''): void
     {
@@ -1878,6 +1924,8 @@ public static function assertIsResource($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert string $actual
      */
     public static function assertIsString($actual, string $message = ''): void
     {
@@ -1893,6 +1941,8 @@ public static function assertIsString($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert scalar $actual
      */
     public static function assertIsScalar($actual, string $message = ''): void
     {
@@ -1908,6 +1958,8 @@ public static function assertIsScalar($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert callable $actual
      */
     public static function assertIsCallable($actual, string $message = ''): void
     {
@@ -1923,6 +1975,8 @@ public static function assertIsCallable($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert iterable $actual
      */
     public static function assertIsIterable($actual, string $message = ''): void
     {
@@ -1960,6 +2014,8 @@ public static function assertNotInternalType(string $expected, $actual, string $
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !array $actual
      */
     public static function assertIsNotArray($actual, string $message = ''): void
     {
@@ -1975,6 +2031,8 @@ public static function assertIsNotArray($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !bool $actual
      */
     public static function assertIsNotBool($actual, string $message = ''): void
     {
@@ -1990,6 +2048,8 @@ public static function assertIsNotBool($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !float $actual
      */
     public static function assertIsNotFloat($actual, string $message = ''): void
     {
@@ -2005,6 +2065,8 @@ public static function assertIsNotFloat($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !int $actual
      */
     public static function assertIsNotInt($actual, string $message = ''): void
     {
@@ -2020,6 +2082,8 @@ public static function assertIsNotInt($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !numeric $actual
      */
     public static function assertIsNotNumeric($actual, string $message = ''): void
     {
@@ -2035,6 +2099,8 @@ public static function assertIsNotNumeric($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !object $actual
      */
     public static function assertIsNotObject($actual, string $message = ''): void
     {
@@ -2050,6 +2116,8 @@ public static function assertIsNotObject($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !resource $actual
      */
     public static function assertIsNotResource($actual, string $message = ''): void
     {
@@ -2065,6 +2133,8 @@ public static function assertIsNotResource($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !string $actual
      */
     public static function assertIsNotString($actual, string $message = ''): void
     {
@@ -2080,6 +2150,8 @@ public static function assertIsNotString($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !scalar $actual
      */
     public static function assertIsNotScalar($actual, string $message = ''): void
     {
@@ -2095,6 +2167,8 @@ public static function assertIsNotScalar($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !callable $actual
      */
     public static function assertIsNotCallable($actual, string $message = ''): void
     {
@@ -2110,6 +2184,8 @@ public static function assertIsNotCallable($actual, string $message = ''): void
      *
      * @throws ExpectationFailedException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     *
+     * @psalm-assert !iterable $actual
      */
     public static function assertIsNotIterable($actual, string $message = ''): void
     {
@@ -2986,6 +3062,8 @@ public static function countOf(int $count): Count
      * Fails a test with the given message.
      *
      * @throws AssertionFailedError
+     *
+     * @psalm-return never-return
      */
     public static function fail(string $message = ''): void
     {