Fix UploadedFile unit tests, add phpdoc

Author: IngeniozIT

tests/MessageTest.php

@@ -36,6 +36,7 @@ protected function getMessage()
     /**
      * Get a \Psr\Http\Message\StreamInterface mock.
      *
+      * @suppress PhanTypeMismatchReturn
      * @return StreamInterface
      */
     protected function getMockStream(): StreamInterface

tests/RequestTest.php

@@ -34,6 +34,8 @@ public function getRequest(): RequestInterface
      * @param array $methods (optional) Methods to mock.
      *
      * @return UriInterface
+     * @suppress PhanAccessMethodInternal
+     * @suppress PhanTypeMismatchReturn
      */
     protected function getMockUri($methods = []): UriInterface
     {

tests/StreamTest.php

@@ -66,7 +66,7 @@ protected function getStream()
     /**
      * Get a generic StreamInterface object with a specific stream.
      *
-     * @param  resource $handle {@see \fopen}.
+     * @param  resource|mixed $handle {@see \fopen}.
      * @return StreamInterface
      */
     protected function getStreamWithHandle($handle)

tests/UploadedFileTest.php

@@ -22,9 +22,9 @@ class UploadedFileTest extends TestCase
     public static $is_resource = null;
 
     /**
-     * Before each test, reset functions overrides.
+     * After each test, reset functions overrides.
      */
-    protected function setUp(): void
+    protected function tearDown(): void
     {
         self::$rename = null;
         self::$is_uploaded_file = null;
@@ -58,13 +58,16 @@ protected function getTempFilePath(): string
         return tempnam(sys_get_temp_dir(), 'UploadedFileTest');
     }
 
+    /**
+     * @suppress PhanAccessMethodInternal
+     * @suppress PhanTypeMismatchReturn
+     */
     protected function getStreamMock(?string $path = null, $methods = []): StreamInterface
     {
         if ($path === null) {
             $path = $this->getTempFilePath();
         }
 
-        /** @var StreamInterface */
         $streamMock = $this->createMock(StreamInterface::class);
 
         foreach ($methods as $name => $returnValue) {
@@ -89,21 +92,22 @@ protected function getStreamMock(?string $path = null, $methods = []): StreamInt
      */
     protected function getUploadedFile(?string $path = null, ?int $size = null, ?int $error = null, ?string $clientFilename = null, ?string $clientMediaType = null)
     {
-        $mockStream = $this->getStreamMock($path);
-        $mockStream
-            ->method('getContents')
-            ->willReturn('foo bar baz !');
+        $mockStream = $this->getStreamMock($path, [
+            'getContents' => 'foo bar baz !',
+        ]);
+
+        $errorToUse = $error ?? \UPLOAD_ERR_OK;
 
         if ($clientMediaType !== null) {
-            return new \IngeniozIT\Http\Message\UploadedFile($mockStream, $size, $error, $clientFilename, $clientMediaType);
+            return new \IngeniozIT\Http\Message\UploadedFile($mockStream, $size, $errorToUse, $clientFilename, $clientMediaType);
         }
 
         if ($clientFilename !== null) {
-            return new \IngeniozIT\Http\Message\UploadedFile($mockStream, $size, $error, $clientFilename);
+            return new \IngeniozIT\Http\Message\UploadedFile($mockStream, $size, $errorToUse, $clientFilename);
         }
 
         if ($error !== null) {
-            return new \IngeniozIT\Http\Message\UploadedFile($mockStream, $size, $error);
+            return new \IngeniozIT\Http\Message\UploadedFile($mockStream, $size, $errorToUse);
         }
 
         if ($size !== null) {
@@ -225,39 +229,58 @@ public function testMoveToExistingTargetPath()
      * throws \RuntimeException on any error during the move operation.
      * @dataProvider providerFsErrorCases
      */
-    public function testMoveToThrowsExceptionOnFilesystemError(bool $isCli, bool $streamWithUri)
+    public function testMoveToThrowsExceptionOnFilesystemError(bool $isCli, bool $streamWithUri, bool $overrideFopen)
     {
         $uploadedFile = $this->getUploadedFile();
         $path = $this->getEmptyPath();
         $mockStream = $this->getStreamMock($path, [
             'getContents' => 'foo bar baz !',
-            'getMetadata' => 'test_uri',
+            'getMetadata' => $streamWithUri ? 'test_uri' : null,
         ]);
-
         $uploadedFile = new \IngeniozIT\Http\Message\UploadedFile($mockStream);
         $path = $this->getEmptyPath();
+
         self::$rename = false;
         self::$move_uploaded_file = false;
         self::$file_put_contents = false;
         self::$fopen = false;
         self::$php_sapi_name = $isCli ? 'cli' : 'not_cli';
+        if ($overrideFopen) {
+            self::$fopen = false;
+        }
 
         $this->expectException(\RuntimeException::class);
         $uploadedFile->moveTo($path);
     }
 
+    /**
+     * Provider. Gives filesystem error cases based on
+     * - cli / not cli environment
+     * - StreamInterface object with / without uri, metadata, fopen fail
+     * @return array
+     */
+    public function providerFsErrorCases(): array
+    {
+        return [
+            'cli + uri' => [true, true, false],
+            'cli + no uri' => [true, false, false],
+            'not cli + uri' => [false, true, false],
+            'not cli + no uri' => [false, false, false],
+            'cli + no uri + fopen fail' => [false, false, true],
+        ];
+    }
+
     /**
      * Move the uploaded file to a new location.
-     * throws \RuntimeException on any error during the move operation.
-     * @dataProvider providerFsErrorCases
+     * @dataProvider providerFsWorkingCases
      */
     public function testMoveToWorksWithAllEnvs(bool $isCli, bool $streamWithUri)
     {
         $uploadedFile = $this->getUploadedFile();
         $path = $this->getEmptyPath();
         $mockStream = $this->getStreamMock($path, [
             'getContents' => 'foo bar baz !',
-            'getMetadata' => 'test_uri',
+            'getMetadata' => $streamWithUri ? 'test_uri' : null,
         ]);
         $uploadedFile = new \IngeniozIT\Http\Message\UploadedFile($mockStream);
         $path = $this->getEmptyPath();
@@ -278,13 +301,14 @@ public function testMoveToWorksWithAllEnvs(bool $isCli, bool $streamWithUri)
      * - StreamInterface object with / without uri metadata
      * @return array
      */
-    public function providerFsErrorCases(): array
+    public function providerFsWorkingCases(): array
     {
         return [
             'cli + uri' => [true, true],
             'cli + no uri' => [true, false],
             'not cli + uri' => [false, true],
             'not cli + no uri' => [false, false],
+            'cli + no uri + fopen fail' => [false, false],
         ];
     }
 

tests/UriTest.php

@@ -1029,7 +1029,8 @@ public function providerFullComponents()
      * Return the string representation as a URI reference.
      *
      * @dataProvider providerStringUri
-     * @param        string $str Expected uri.
+     * @param string $str Expected uri.
+     * @suppress PhanTypeSuspiciousStringExpression
      */
     public function testReturnsExpectedStringWhenPassingUriInConstructor(string $str)
     {
@@ -1058,7 +1059,8 @@ public function providerStringUri()
      * Return the string representation as a URI reference.
      *
      * @dataProvider providerInvalidStringUri
-     * @param        string $str Invalid uri.
+     * @param string $str Invalid uri.
+     * @suppress PhanNoopNew
      */
     public function testThrowsInvalidargumentExceptionOnInvalidString(string $str)
     {