Merge branch 'hotfix/dispatch-abstract-services' into develop

Close #38

Author: mwillbanks

CHANGELOG.md

@@ -85,6 +85,11 @@ All notable changes to this project will be documented in this file, in reverse
     `Zend\ModuleManager\Listener\ServiceListener` instance before retrieving and
     bootstrapping the `Application` instance; this ensure it is fully
     configured at that time.
+- [#38](https://github.com/zendframework/zend-mvc/pull/38) Ensure middleware
+  tests against abstract factories
+  - zend-servicemanager v3 modified the behavior of has() to not search abstract
+    factories by default. You can force it to do so by passing an optional
+    second argument, a boolean flag, with a value of boolean true.
 
 ## 2.6.1 - TBD
 

src/MiddlewareListener.php

@@ -48,7 +48,7 @@ public function onDispatch(MvcEvent $event)
         $serviceManager = $application->getServiceManager();
         $middlewareName = is_string($middleware) ? $middleware : get_class($middleware);
 
-        if (is_string($middleware) && $serviceManager->has($middleware)) {
+        if (is_string($middleware) && $serviceManager->has($middleware, true)) {
             $middleware = $serviceManager->get($middleware);
         }
         if (! is_callable($middleware)) {

test/DispatchListenerTest.php

@@ -43,7 +43,7 @@ public function createMvcEvent($controllerMatched)
         return $event;
     }
 
-    public function testControllerLoaderComposedOfAbstractFactory()
+    public function testControllerManagerUsingAbstractFactory()
     {
         $controllerManager = new ControllerManager(new ServiceManager(), ['abstract_factories' => [
             Controller\TestAsset\ControllerLoaderAbstractFactory::class,
@@ -64,7 +64,7 @@ public function testControllerLoaderComposedOfAbstractFactory()
         $this->assertSame(200, $return->getStatusCode());
     }
 
-    public function testUnlocatableControllerLoaderComposedOfAbstractFactory()
+    public function testUnlocatableControllerViaAbstractFactory()
     {
         $controllerManager = new ControllerManager(new ServiceManager(), ['abstract_factories' => [
             Controller\TestAsset\UnlocatableControllerLoaderAbstractFactory::class,

test/MiddlewareListenerTest.php

@@ -20,6 +20,7 @@
 use Zend\Mvc\MiddlewareListener;
 use Zend\Mvc\MvcEvent;
 use Zend\Mvc\Router\RouteMatch;
+use Zend\ServiceManager\ServiceManager;
 
 class MiddlewareListenerTest extends TestCase
 {
@@ -39,7 +40,7 @@ public function createMvcEvent($middlewareMatched, $middleware = null)
         $eventManager = new EventManager();
 
         $serviceManager = $this->prophesize(ContainerInterface::class);
-        $serviceManager->has($middlewareMatched)->willReturn(true);
+        $serviceManager->has($middlewareMatched, true)->willReturn(true);
         $serviceManager->get($middlewareMatched)->willReturn($middleware);
 
         $application = $this->prophesize(Application::class);
@@ -115,4 +116,49 @@ public function testTriggersErrorForExceptionRaisedInMiddleware()
         $return   = $listener->onDispatch($event);
         $this->assertEquals('FAILED', $return);
     }
+
+    /**
+     * Ensure that the listener tests for services in abstract factories.
+     *
+     * has() omits abstract factories by default; you must pass an optional
+     * second parameter, a boolean flag, to indicate it should also search
+     * those.
+     *
+     * This test ensures that.
+     */
+    public function testCanLoadFromAbstractFactory()
+    {
+        $response   = new Response();
+        $routeMatch = $this->prophesize(RouteMatch::class);
+        $routeMatch->getParam('middleware', false)->willReturn('test');
+
+        $eventManager = new EventManager();
+
+        $serviceManager = new ServiceManager(['abstract_factories' => [
+            TestAsset\MiddlewareAbstractFactory::class,
+        ]]);
+
+        $application = $this->prophesize(Application::class);
+        $application->getEventManager()->willReturn($eventManager);
+        $application->getServiceManager()->willReturn($serviceManager);
+        $application->getResponse()->willReturn($response);
+
+        $event = new MvcEvent();
+        $event->setRequest(new Request());
+        $event->setResponse($response);
+        $event->setApplication($application->reveal());
+        $event->setRouteMatch($routeMatch->reveal());
+
+        $eventManager->attach(MvcEvent::EVENT_DISPATCH_ERROR, function ($e) {
+            $this->fail(sprintf('dispatch.error triggered when it should not be: %s', var_export($e->getError(), 1)));
+        });
+
+        $listener = new MiddlewareListener();
+        $return   = $listener->onDispatch($event);
+        $this->assertInstanceOf(Response::class, $return);
+
+        $this->assertInstanceOf('Zend\Http\Response', $return);
+        $this->assertSame(200, $return->getStatusCode());
+        $this->assertEquals(TestAsset\Middleware::class, $return->getBody());
+    }
 }

test/TestAsset/Middleware.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendTest\Mvc\TestAsset;
+
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+class Middleware
+{
+    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next = null)
+    {
+        $response->getBody()->write(__CLASS__);
+        return $response;
+    }
+}

test/TestAsset/MiddlewareAbstractFactory.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendTest\Mvc\TestAsset;
+
+use Interop\Container\ContainerInterface;
+use Zend\ServiceManager\Factory\AbstractFactoryInterface;
+
+class MiddlewareAbstractFactory implements AbstractFactoryInterface
+{
+    public $classmap = array(
+        'test' => 'ZendTest\Mvc\TestAsset\Middleware',
+    );
+
+    public function canCreateServiceWithName(ContainerInterface $container, $name)
+    {
+        if (! isset($this->classmap[$name])) {
+            return false;
+        }
+
+        $classname = $this->classmap[$name];
+        return class_exists($classname);
+    }
+
+    public function __invoke(ContainerInterface $container, $name, array $options = null)
+    {
+        $classname = $this->classmap[$name];
+        return new $classname;
+    }
+}