qa: apply automated fixes from Psalm and set initial baseline

Signed-off-by: Matthew Weier O'Phinney <[email protected]>

Author: weierophinney

psalm-baseline.xml

@@ -259,13 +259,11 @@ protected function getDetail()
      *
      * If an exception was provided, creates the status code from it;
      * otherwise, code as provided is used.
-     *
-     * @return string
      */
-    protected function getStatus()
+    protected function getStatus(): int
     {
         if ($this->detail instanceof Throwable || $this->detail instanceof Exception) {
-            $this->status = $this->createStatusFromException();
+            $this->status = (int) $this->createStatusFromException();
         }
 
         return $this->status;
@@ -346,7 +344,7 @@ protected function createDetailFromException()
     /**
      * Create HTTP status from an exception.
      *
-     * @return int
+     * @return int|string
      */
     protected function createStatusFromException()
     {

src/ApiProblem.php

@@ -76,6 +76,8 @@ public function attach(EventManagerInterface $events, $priority = 1)
 
     /**
      * Listen to the render event.
+     *
+     * @return void
      */
     public function onRender(MvcEvent $e)
     {
@@ -111,6 +113,8 @@ public function onRender(MvcEvent $e)
      * Handle dispatch.
      *
      * It checks if the controller is in our list
+     *
+     * @return void
      */
     public function onDispatch(MvcEvent $e)
     {
@@ -140,7 +144,7 @@ public function onDispatch(MvcEvent $e)
      * If the event represents an error, and has an exception composed, marshals an ApiProblem
      * based on the exception, stops event propagation, and returns an ApiProblemResponse.
      *
-     * @return ApiProblemResponse
+     * @return ApiProblemResponse|null
      */
     public function onDispatchError(MvcEvent $e)
     {

src/Listener/ApiProblemListener.php

@@ -48,6 +48,8 @@ public function setDisplayExceptions($flag)
      * the PhpRenderer, when we have no templates.
      *
      * As such, report as an unacceptable response.
+     *
+     * @return void
      */
     public function onRenderError(MvcEvent $e)
     {

src/Listener/RenderErrorListener.php

@@ -114,7 +114,7 @@ public function __invoke(SendResponseEvent $event)
     /**
      * Merge headers set on the application response into the API Problem response.
      */
-    protected function mergeHeaders(HttpResponse $applicationResponse, ApiProblemResponse $apiProblemResponse)
+    protected function mergeHeaders(HttpResponse $applicationResponse, ApiProblemResponse $apiProblemResponse): void
     {
         $apiProblemHeaders = $apiProblemResponse->getHeaders();
         foreach ($applicationResponse->getHeaders() as $header) {

src/Listener/SendApiProblemResponseListener.php

@@ -22,6 +22,8 @@ public function getConfig()
      * Listener for bootstrap event.
      *
      * Attaches a render event.
+     *
+     * @return void
      */
     public function onBootstrap(MvcEvent $e)
     {
@@ -44,6 +46,8 @@ public function onBootstrap(MvcEvent $e)
      * Listener for the render event.
      *
      * Attaches a rendering/response strategy to the View.
+     *
+     * @return void
      */
     public function onRender(MvcEvent $e)
     {

src/Module.php

@@ -14,7 +14,7 @@
 
 class ApiProblemResponseTest extends TestCase
 {
-    public function testApiProblemResponseIsAnHttpResponse()
+    public function testApiProblemResponseIsAnHttpResponse(): void
     {
         $response = new ApiProblemResponse(new ApiProblem(400, 'Random error'));
         $this->assertInstanceOf(Response::class, $response);
@@ -23,7 +23,7 @@ public function testApiProblemResponseIsAnHttpResponse()
     /**
      * @depends testApiProblemResponseIsAnHttpResponse
      */
-    public function testApiProblemResponseSetsStatusCodeAndReasonPhrase()
+    public function testApiProblemResponseSetsStatusCodeAndReasonPhrase(): void
     {
         $response = new ApiProblemResponse(new ApiProblem(400, 'Random error'));
         $this->assertEquals(400, $response->getStatusCode());
@@ -32,7 +32,7 @@ public function testApiProblemResponseSetsStatusCodeAndReasonPhrase()
         $this->assertEquals('bad request', strtolower($response->getReasonPhrase()));
     }
 
-    public function testApiProblemResponseBodyIsSerializedApiProblem()
+    public function testApiProblemResponseBodyIsSerializedApiProblem(): void
     {
         $additional = [
             'foo' => fopen('php://memory', 'r'),
@@ -54,7 +54,7 @@ public function testApiProblemResponseBodyIsSerializedApiProblem()
     /**
      * @depends testApiProblemResponseIsAnHttpResponse
      */
-    public function testApiProblemResponseSetsContentTypeHeader()
+    public function testApiProblemResponseSetsContentTypeHeader(): void
     {
         $response = new ApiProblemResponse(new ApiProblem(400, 'Random error'));
         $headers  = $response->getHeaders();
@@ -64,7 +64,7 @@ public function testApiProblemResponseSetsContentTypeHeader()
         $this->assertEquals(ApiProblem::CONTENT_TYPE, $header->getFieldValue());
     }
 
-    public function testComposeApiProblemIsAccessible()
+    public function testComposeApiProblemIsAccessible(): void
     {
         $apiProblem = new ApiProblem(400, 'Random error');
         $response   = new ApiProblemResponse($apiProblem);
@@ -74,7 +74,7 @@ public function testComposeApiProblemIsAccessible()
     /**
      * @group 14
      */
-    public function testOverridesReasonPhraseIfStatusCodeIsUnknown()
+    public function testOverridesReasonPhraseIfStatusCodeIsUnknown(): void
     {
         $response = new ApiProblemResponse(new ApiProblem(7, 'Random error'));
         $this->assertStringContainsString('Internal Server Error', $response->getReasonPhrase());

test/ApiProblemResponseTest.php

@@ -29,7 +29,7 @@ public function statusCodes(): array
     /**
      * @dataProvider statusCodes
      */
-    public function testStatusIsUsedVerbatim(int $status)
+    public function testStatusIsUsedVerbatim(int $status): void
     {
         $apiProblem = new ApiProblem($status, 'foo');
         $payload    = $apiProblem->toArray();
@@ -40,7 +40,7 @@ public function testStatusIsUsedVerbatim(int $status)
     /**
      * @requires PHP 7.0
      */
-    public function testErrorAsDetails()
+    public function testErrorAsDetails(): void
     {
         $error      = new TypeError('error message', 705);
         $apiProblem = new ApiProblem(500, $error);
@@ -54,7 +54,7 @@ public function testErrorAsDetails()
         $this->assertEquals('error message', $payload['detail']);
     }
 
-    public function testExceptionCodeIsUsedForStatus()
+    public function testExceptionCodeIsUsedForStatus(): void
     {
         $exception  = new \Exception('exception message', 401);
         $apiProblem = new ApiProblem('500', $exception);
@@ -63,15 +63,15 @@ public function testExceptionCodeIsUsedForStatus()
         $this->assertEquals($exception->getCode(), $payload['status']);
     }
 
-    public function testDetailStringIsUsedVerbatim()
+    public function testDetailStringIsUsedVerbatim(): void
     {
         $apiProblem = new ApiProblem('500', 'foo');
         $payload    = $apiProblem->toArray();
         $this->assertArrayHasKey('detail', $payload);
         $this->assertEquals('foo', $payload['detail']);
     }
 
-    public function testExceptionMessageIsUsedForDetail()
+    public function testExceptionMessageIsUsedForDetail(): void
     {
         $exception  = new \Exception('exception message');
         $apiProblem = new ApiProblem('500', $exception);
@@ -80,7 +80,7 @@ public function testExceptionMessageIsUsedForDetail()
         $this->assertEquals($exception->getMessage(), $payload['detail']);
     }
 
-    public function testExceptionsCanTriggerInclusionOfStackTraceInDetails()
+    public function testExceptionsCanTriggerInclusionOfStackTraceInDetails(): void
     {
         $exception  = new \Exception('exception message');
         $apiProblem = new ApiProblem('500', $exception);
@@ -91,7 +91,7 @@ public function testExceptionsCanTriggerInclusionOfStackTraceInDetails()
         $this->assertEquals($exception->getTrace(), $payload['trace']);
     }
 
-    public function testExceptionsCanTriggerInclusionOfNestedExceptions()
+    public function testExceptionsCanTriggerInclusionOfNestedExceptions(): void
     {
         $exceptionChild  = new \Exception('child exception');
         $exceptionParent = new \Exception('parent exception', null, $exceptionChild);
@@ -111,7 +111,7 @@ public function testExceptionsCanTriggerInclusionOfNestedExceptions()
         $this->assertEquals($expected, $payload['exception_stack']);
     }
 
-    public function testTypeUrlIsUsedVerbatim()
+    public function testTypeUrlIsUsedVerbatim(): void
     {
         $apiProblem = new ApiProblem('500', 'foo', 'http://status.dev:8080/details.md');
         $payload    = $apiProblem->toArray();
@@ -133,7 +133,7 @@ public function knownStatusCodes(): array
     /**
      * @dataProvider knownStatusCodes
      */
-    public function testKnownStatusResultsInKnownTitle(int $status)
+    public function testKnownStatusResultsInKnownTitle(int $status): void
     {
         $apiProblem = new ApiProblem($status, 'foo');
         $r          = new ReflectionObject($apiProblem);
@@ -146,23 +146,23 @@ public function testKnownStatusResultsInKnownTitle(int $status)
         $this->assertEquals($titles[$status], $payload['title']);
     }
 
-    public function testUnknownStatusResultsInUnknownTitle()
+    public function testUnknownStatusResultsInUnknownTitle(): void
     {
         $apiProblem = new ApiProblem(420, 'foo');
         $payload    = $apiProblem->toArray();
         $this->assertArrayHasKey('title', $payload);
         $this->assertEquals('Unknown', $payload['title']);
     }
 
-    public function testProvidedTitleIsUsedVerbatim()
+    public function testProvidedTitleIsUsedVerbatim(): void
     {
         $apiProblem = new ApiProblem('500', 'foo', 'http://status.dev:8080/details.md', 'some title');
         $payload    = $apiProblem->toArray();
         $this->assertArrayHasKey('title', $payload);
         $this->assertEquals('some title', $payload['title']);
     }
 
-    public function testCanPassArbitraryDetailsToConstructor()
+    public function testCanPassArbitraryDetailsToConstructor(): void
     {
         $problem = new ApiProblem(
             400,
@@ -174,7 +174,7 @@ public function testCanPassArbitraryDetailsToConstructor()
         $this->assertEquals('bar', $problem->foo);
     }
 
-    public function testArraySerializationIncludesArbitraryDetails()
+    public function testArraySerializationIncludesArbitraryDetails(): void
     {
         $problem = new ApiProblem(
             400,
@@ -188,7 +188,7 @@ public function testArraySerializationIncludesArbitraryDetails()
         $this->assertEquals('bar', $array['foo']);
     }
 
-    public function testArbitraryDetailsShouldNotOverwriteRequiredFieldsInArraySerialization()
+    public function testArbitraryDetailsShouldNotOverwriteRequiredFieldsInArraySerialization(): void
     {
         $problem = new ApiProblem(
             400,
@@ -202,7 +202,7 @@ public function testArbitraryDetailsShouldNotOverwriteRequiredFieldsInArraySeria
         $this->assertEquals('Invalid entity', $array['title']);
     }
 
-    public function testUsesTitleFromExceptionWhenProvided()
+    public function testUsesTitleFromExceptionWhenProvided(): void
     {
         $exception = new Exception\DomainException('exception message', 401);
         $exception->setTitle('problem title');
@@ -212,7 +212,7 @@ public function testUsesTitleFromExceptionWhenProvided()
         $this->assertEquals($exception->getTitle(), $payload['title']);
     }
 
-    public function testUsesTypeFromExceptionWhenProvided()
+    public function testUsesTypeFromExceptionWhenProvided(): void
     {
         $exception = new Exception\DomainException('exception message', 401);
         $exception->setType('http://example.com/api/help/401');
@@ -222,7 +222,7 @@ public function testUsesTypeFromExceptionWhenProvided()
         $this->assertEquals($exception->getType(), $payload['type']);
     }
 
-    public function testUsesAdditionalDetailsFromExceptionWhenProvided()
+    public function testUsesAdditionalDetailsFromExceptionWhenProvided(): void
     {
         $exception = new Exception\DomainException('exception message', 401);
         $exception->setAdditionalDetails(['foo' => 'bar']);
@@ -248,7 +248,7 @@ public function invalidStatusCodes(): array
      * @dataProvider invalidStatusCodes
      * @group api-tools-118
      */
-    public function testInvalidHttpStatusCodesAreCastTo500(int $code)
+    public function testInvalidHttpStatusCodesAreCastTo500(int $code): void
     {
         $e       = new \Exception('Testing', $code);
         $problem = new ApiProblem($code, $e);

test/ApiProblemTest.php

@@ -25,15 +25,15 @@ protected function setUp(): void
         $this->listener = new ApiProblemListener();
     }
 
-    public function testOnRenderReturnsEarlyWhenNonHttpRequestDetected()
+    public function testOnRenderReturnsEarlyWhenNonHttpRequestDetected(): void
     {
         $request = $this->prophesize(RequestInterface::class)->reveal();
         $this->event->setRequest($request);
 
         $this->assertNull($this->listener->onRender($this->event));
     }
 
-    public function testOnDispatchErrorReturnsAnApiProblemResponseBasedOnCurrentEventException()
+    public function testOnDispatchErrorReturnsAnApiProblemResponseBasedOnCurrentEventException(): void
     {
         $request = new Request();
         $request->getHeaders()->addHeaderLine('Accept', 'application/json');
@@ -57,7 +57,7 @@ public function testOnDispatchErrorReturnsAnApiProblemResponseBasedOnCurrentEven
     /**
      * @requires PHP 7.0
      */
-    public function testOnDispatchErrorReturnsAnApiProblemResponseBasedOnCurrentEventThrowable()
+    public function testOnDispatchErrorReturnsAnApiProblemResponseBasedOnCurrentEventThrowable(): void
     {
         $request = new Request();
         $request->getHeaders()->addHeaderLine('Accept', 'application/json');

test/Listener/ApiProblemListenerTest.php

@@ -24,7 +24,7 @@ protected function setUp(): void
         $this->listener = new RenderErrorListener();
     }
 
-    public function testOnRenderErrorCreatesAnApiProblemResponse()
+    public function testOnRenderErrorCreatesAnApiProblemResponse(): void
     {
         $response = new Response();
         $request  = new Request();
@@ -55,7 +55,7 @@ public function testOnRenderErrorCreatesAnApiProblemResponse()
         $this->assertStringContainsString('accept', $content['detail']);
     }
 
-    public function testOnRenderErrorCreatesAnApiProblemResponseFromException()
+    public function testOnRenderErrorCreatesAnApiProblemResponseFromException(): void
     {
         $response = new Response();
         $request  = new Request();
@@ -101,7 +101,7 @@ public function testOnRenderErrorCreatesAnApiProblemResponseFromException()
     /**
      * @requires PHP 7.0
      */
-    public function testOnRenderErrorCreatesAnApiProblemResponseFromThrowable()
+    public function testOnRenderErrorCreatesAnApiProblemResponseFromThrowable(): void
     {
         $response = new Response();
         $request  = new Request();