Adds tests covering ServerRequestErrorResponseGenerator behavior

Corrects an issue in the default message when a stack trace is produced
as well.

Author: weierophinney

src/Response/ErrorResponseGeneratorTrait.php

@@ -65,7 +65,7 @@ private function prepareDefaultResponse(Throwable $e, ResponseInterface $respons
         $message = 'An unexpected error occurred';
 
         if ($this->debug) {
-            $message .= "; strack trace:\n\n" . $this->prepareStackTrace($e);
+            $message .= "; stack trace:\n\n" . $this->prepareStackTrace($e);
         }
 
         $response->getBody()->write($message);

src/Response/ServerRequestErrorResponseGenerator.php

@@ -45,10 +45,10 @@ public function __construct(
         $this->template  = $template;
     }
 
-    public function __invoke(Throwable $e)
+    public function __invoke(Throwable $e) : ResponseInterface
     {
-        $response = ($this->responseFactory)()
-            ->withStatus(Utils::getStatusCode($e, $response));
+        $response = ($this->responseFactory)();
+        $response = $response->withStatus(Utils::getStatusCode($e, $response));
 
         if ($this->renderer) {
             return $this->prepareTemplatedResponse($e, $response, [

test/Response/ServerRequestErrorResponseGeneratorTest.php

@@ -0,0 +1,120 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-expressive for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-expressive/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace ZendTest\Expressive\Response;
+
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\Prophecy\ObjectProphecy;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\StreamInterface;
+use Throwable;
+use RuntimeException;
+use Zend\Expressive\Response\ServerRequestErrorResponseGenerator;
+use Zend\Expressive\Template\TemplateRendererInterface;
+use Zend\Stratigility\Utils;
+
+class ServerRequestErrorResponseGeneratorTest extends TestCase
+{
+    /** @var TemplateRendererInterface|ObjectProphecy */
+    private $renderer;
+
+    /** @var ResponseInterface|ObjectProphecy */
+    private $response;
+
+    /** @var callable */
+    private $responseFactory;
+
+    public function setUp()
+    {
+        $this->response = $this->prophesize(ResponseInterface::class);
+        $this->responseFactory = function () {
+            return $this->response->reveal();
+        };
+
+        $this->renderer = $this->prophesize(TemplateRendererInterface::class);
+    }
+
+    public function testPreparesTemplatedResponseWhenRendererPresent()
+    {
+        $stream = $this->prophesize(StreamInterface::class);
+        $stream->write('data from template')->shouldBeCalled();
+
+        $this->response->withStatus(422)->will([$this->response, 'reveal']);
+        $this->response->getBody()->will([$stream, 'reveal']);
+        $this->response->getStatusCode()->willReturn(422);
+        $this->response->getReasonPhrase()->willReturn('Unexpected entity');
+
+        $template = 'some::template';
+        $e = new RuntimeException('This is the exception message', 422);
+        $this->renderer
+            ->render($template, [
+                'response' => $this->response->reveal(),
+                'status'   => 422,
+                'reason'   => 'Unexpected entity',
+                'error'    => $e,
+            ])
+            ->willReturn('data from template');
+
+        $generator = new ServerRequestErrorResponseGenerator(
+            $this->responseFactory,
+            true,
+            $this->renderer->reveal(),
+            $template
+        );
+
+        $this->assertSame($this->response->reveal(), $generator($e));
+    }
+
+    public function testPreparesResponseWithDefaultMessageOnlyWhenNoRendererPresentAndNotInDebugMode()
+    {
+        $stream = $this->prophesize(StreamInterface::class);
+        $stream->write('An unexpected error occurred')->shouldBeCalled();
+
+        $this->response->withStatus(422)->will([$this->response, 'reveal']);
+        $this->response->getBody()->will([$stream, 'reveal']);
+        $this->response->getStatusCode()->shouldNotBeCalled();
+        $this->response->getReasonPhrase()->shouldNotBeCalled();
+
+        $e = new RuntimeException('This is the exception message', 422);
+
+        $generator = new ServerRequestErrorResponseGenerator($this->responseFactory);
+
+        $this->assertSame($this->response->reveal(), $generator($e));
+    }
+
+    public function testPreparesResponseWithDefaultMessageAndStackTraceWhenNoRendererPresentAndInDebugMode()
+    {
+        $stream = $this->prophesize(StreamInterface::class);
+        $stream
+            ->write(Argument::that(function ($message) {
+                if (! preg_match('/^An unexpected error occurred; stack trace:/', $message)) {
+                    echo "Failed first assertion: $message\n";
+                    return false;
+                }
+                if (false === strpos($message, 'Stack Trace:')) {
+                    echo "Failed second assertion: $message\n";
+                    return false;
+                }
+                return $message;
+            }))
+            ->shouldBeCalled();
+
+        $this->response->withStatus(422)->will([$this->response, 'reveal']);
+        $this->response->getBody()->will([$stream, 'reveal']);
+        $this->response->getStatusCode()->shouldNotBeCalled();
+        $this->response->getReasonPhrase()->shouldNotBeCalled();
+
+        $e = new RuntimeException('This is the exception message', 422);
+
+        $generator = new ServerRequestErrorResponseGenerator($this->responseFactory, true);
+
+        $this->assertSame($this->response->reveal(), $generator($e));
+    }
+}