qa: ensure test setup mimics proper application

Ensures the test asset `Application` class implements the MVC `ApplicationInterface`, allowing us to test the `Module` class properly.

Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>

Author: weierophinney

psalm.xml

@@ -28,7 +28,14 @@
                 <referencedMethod name="PHPUnit\Framework\MockObject\Builder\InvocationMocker::with"/>
             </errorLevel>
         </InternalMethod>
+
+        <InvalidReturnType>
+            <errorLevel type="suppress">
+                <file name="./test/TestAsset/Application.php"/>
+            </errorLevel>
+        </InvalidReturnType>
     </issueHandlers>
+
     <plugins>
         <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
     </plugins>

src/Module.php

@@ -8,7 +8,7 @@
 use Laminas\ApiTools\Versioning\ContentTypeListener;
 use Laminas\ApiTools\Versioning\VersionListener;
 use Laminas\ModuleManager\ModuleManager;
-use Laminas\Mvc\Application;
+use Laminas\Mvc\ApplicationInterface;
 use Laminas\Mvc\MvcEvent;
 
 use function assert;
@@ -56,7 +56,7 @@ public function init($moduleManager)
     public function onBootstrap($e)
     {
         $app = $e->getTarget();
-        assert($app instanceof Application);
+        assert($app instanceof ApplicationInterface);
         $events   = $app->getEventManager();
         $services = $app->getServiceManager();
         $services->get(AcceptListener::class)->attach($events);

test/TestAsset/Application.php

@@ -5,14 +5,18 @@
 namespace LaminasTest\ApiTools\Versioning\TestAsset;
 
 use Laminas\EventManager\EventManagerInterface;
+use Laminas\Mvc\ApplicationInterface;
 use Laminas\ServiceManager\ServiceLocatorInterface;
+use Laminas\Stdlib\RequestInterface;
+use Laminas\Stdlib\ResponseInterface;
 
-class Application
+/** @psalm-suppress MissingConstructor */
+class Application implements ApplicationInterface
 {
-    /** @var EventManagerInterface|null */
+    /** @var EventManagerInterface */
     protected $events;
 
-    /** @var ServiceLocatorInterface|null */
+    /** @var ServiceLocatorInterface */
     protected $services;
 
     public function setServiceManager(ServiceLocatorInterface $services): void
@@ -25,15 +29,47 @@ public function setEventManager(EventManagerInterface $events): void
         $this->events = $events;
     }
 
-    /** @return ServiceLocatorInterface|null */
+    /** @return ServiceLocatorInterface */
     public function getServiceManager()
     {
         return $this->services;
     }
 
-    /** @return EventManagerInterface|null */
+    /** @return EventManagerInterface */
     public function getEventManager()
     {
         return $this->events;
     }
+
+    // Unimplemented methods
+    // phpcs:disable Squiz.Commenting.FunctionComment.InvalidNoReturn
+
+    /**
+     * Get the request object
+     *
+     * @return RequestInterface
+     */
+    public function getRequest()
+    {
+    }
+
+    /**
+     * Get the response object
+     *
+     * @return ResponseInterface
+     */
+    public function getResponse()
+    {
+    }
+
+    /**
+     * Run the application
+     *
+     * @return self
+     */
+    public function run()
+    {
+    }
+
+    // phpcs:enable Squiz Commenting.FunctionComment.InvalidNoReturn
 }