fix: Enhance error handling in ServiceMap for invalid configuration structures and add corresponding test cases. (#27)

Author: terabytesoftw

CHANGELOG.md

@@ -1,9 +1,10 @@
 # Change Log
 
-## 0.2.3 June 05, 2025
+## 0.2.3 June 06, 2025
 
 - Enh #25: Add support for PHPStan Extension Installer (@samuelrajan747)
-- Enh #26: Add PHPStan extension installer instructions and improve `ServiceMap` configuration handling.
+- Enh #26: Add PHPStan extension installer instructions and improve `ServiceMap` configuration handling (@terabytesoftw)
+- Bug #27: Enhance error handling in `ServiceMap` for invalid configuration structures and add corresponding test cases (@terabytesoftw)
 
 ## 0.2.2 June 04, 2025
 

src/ServiceMap.php

@@ -49,7 +49,7 @@ public function testItAllowsContainerWithoutDefinitionsAndSingletons(): void
 
         $ds = DIRECTORY_SEPARATOR;
 
-        new ServiceMap(__DIR__ . "{$ds}fixture{$ds}container-not-definitions.php");
+        new ServiceMap(__DIR__ . "{$ds}fixture{$ds}config-container-empty.php");
     }
 
     /**
@@ -76,7 +76,6 @@ public function testItLoadsServicesAndComponents(): void
             $serviceMap->getServiceClassFromNode(new String_(MyActiveRecord::class)),
             'ServiceMap should resolve \'MyActiveRecord::class\' as a singleton string service.',
         );
-        // Assert: Singleton closure service resolves to SplStack::class.
         $this->assertSame(
             SplStack::class,
             $serviceMap->getServiceClassFromNode(new String_('singleton-closure')),
@@ -123,26 +122,34 @@ public function testItLoadsServicesAndComponents(): void
         );
     }
 
-    /**
-     * @throws ReflectionException if the service definition is invalid or can't be resolved.
-     */
     public function testItAllowsWithoutEmptyConfigPath(): void
     {
         $this->expectNotToPerformAssertions();
 
         new ServiceMap();
     }
 
-    /**
-     * @throws ReflectionException if the service definition is invalid or can't be resolved.
-     */
     public function testItAllowsWithoutEmptyConfigPathStringValue(): void
     {
         $this->expectNotToPerformAssertions();
 
         new ServiceMap('');
     }
 
+    /**
+     * @throws ReflectionException if the service definition is invalid or can't be resolved.
+     */
+    public function testThrowRuntimeExceptionWhenComponentsHasUnsupportedIsNotArrayValue(): void
+    {
+        $ds = DIRECTORY_SEPARATOR;
+        $fixturePath = __DIR__ . "{$ds}fixture{$ds}components-unsupported-is-not-array.php";
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage("Configuration file '{$fixturePath}' must contain a valid 'components' 'array'.");
+
+        new ServiceMap($fixturePath);
+    }
+
     /**
      * @throws ReflectionException if the service definition is invalid or can't be resolved.
      */
@@ -152,44 +159,93 @@ public function testThrowRuntimeExceptionWhenComponentsHasUnsupportedIdNotString
         $fixturePath = __DIR__ . "{$ds}fixture{$ds}components-unsupported-id-not-string.php";
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Component ID must be a string, got \'integer\'.');
+        $this->expectExceptionMessage('\'Component\': ID must be a string, got \'integer\'.');
 
         new ServiceMap($fixturePath);
     }
 
     /**
      * @throws ReflectionException if the service definition is invalid or can't be resolved.
      */
-    public function testThrowRuntimeExceptionWhenComponentsHasUnsupportedTypeIntegerValue(): void
+    public function testThrowRuntimeExceptionWhenComponentsHasUnsupportedTypeArrayInvalidValue(): void
     {
         $ds = DIRECTORY_SEPARATOR;
-        $fixturePath = __DIR__ . "{$ds}fixture{$ds}components-unsupported-type-integer.php";
+        $fixturePath = __DIR__ . "{$ds}fixture{$ds}components-unsupported-type-array-invalid.php";
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Unsupported component definition for \'integer\'.');
+        $this->expectExceptionMessage('Unsupported definition for \'unsupported-array-invalid\'.');
 
         new ServiceMap($fixturePath);
     }
 
     public function testThrowRuntimeExceptionWhenConfigPathFileDoesNotExist(): void
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('Provided config path invalid-path must exist');
+        $this->expectExceptionMessage('Provided config path \'invalid-path\' must be a readable file.');
 
         new ServiceMap('invalid-path');
     }
 
+    /**
+     * @throws ReflectionException if the service definition is invalid or can't be resolved.
+     */
     public function testThrowRuntimeExceptionWhenConfigHasUnsupportedIsNotArrayValue(): void
     {
         $ds = DIRECTORY_SEPARATOR;
-        $fixturePath = __DIR__ . "{$ds}fixture{$ds}config-unsupported-integer.php";
+        $fixturePath = __DIR__ . "{$ds}fixture{$ds}config-unsupported-is-not-array.php";
 
         $this->expectException(RuntimeException::class);
         $this->expectExceptionMessage("Configuration file '{$fixturePath}' must return an array.");
 
         new ServiceMap($fixturePath);
     }
 
+    /**
+     * @throws ReflectionException if the service definition is invalid or can't be resolved.
+     */
+    public function testThrowRuntimeExceptionWhenConfigContainerDefinitionsHasUnsupportedIsNotArrayValue(): void
+    {
+        $ds = DIRECTORY_SEPARATOR;
+        $fixturePath = __DIR__ . "{$ds}fixture{$ds}definitions-unsupported-is-not-array.php";
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage(
+            "Configuration file '{$fixturePath}' must contain a valid 'container.definitions' 'array'.",
+        );
+
+        new ServiceMap($fixturePath);
+    }
+
+    /**
+     * @throws ReflectionException if the service definition is invalid or can't be resolved.
+     */
+    public function testThrowRuntimeExceptionWhenConfigContainerHasUnsupportedIsNotArrayValue(): void
+    {
+        $ds = DIRECTORY_SEPARATOR;
+        $fixturePath = __DIR__ . "{$ds}fixture{$ds}config-container-unsupported-type-array-invalid.php";
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage("Configuration file '{$fixturePath}' must contain a valid 'container' 'array'.");
+
+        new ServiceMap($fixturePath);
+    }
+
+    /**
+     * @throws ReflectionException if the service definition is invalid or can't be resolved.
+     */
+    public function testThrowRuntimeExceptionWhenConfigContainerSingletonsHasUnsupportedIsNotArrayValue(): void
+    {
+        $ds = DIRECTORY_SEPARATOR;
+        $fixturePath = __DIR__ . "{$ds}fixture{$ds}singletons-unsupported-is-not-array.php";
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage(
+            "Configuration file '{$fixturePath}' must contain a valid 'container.singletons' 'array'.",
+        );
+
+        new ServiceMap($fixturePath);
+    }
+
     /**
      * @throws ReflectionException if the service definition is invalid or can't be resolved.
      */
@@ -213,7 +269,7 @@ public function testThrowRuntimeExceptionWhenContainerDefinitionsHasUnsupportedI
         $fixturePath = __DIR__ . "{$ds}fixture{$ds}definitions-unsupported-id-not-string.php";
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Service ID must be a string, got \'integer\'.');
+        $this->expectExceptionMessage('\'Definition\': ID must be a string, got \'integer\'.');
 
         new ServiceMap($fixturePath);
     }
@@ -224,10 +280,10 @@ public function testThrowRuntimeExceptionWhenContainerDefinitionsHasUnsupportedI
     public function testThrowRuntimeExceptionWhenContainerDefinitionsHasUnsupportedIsNotArrayValue(): void
     {
         $ds = DIRECTORY_SEPARATOR;
-        $fixturePath = __DIR__ . "{$ds}fixture{$ds}definitions-unsupported-integer.php";
+        $fixturePath = __DIR__ . "{$ds}fixture{$ds}definitions-unsupported-type-integer.php";
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Unsupported service definition for \'integer\'.');
+        $this->expectExceptionMessage('Unsupported definition for \'unsupported-type-integer\'.');
 
         new ServiceMap($fixturePath);
     }
@@ -241,9 +297,7 @@ public function testThrowRuntimeExceptionWhenContainerDefinitionsHasUnsupportedT
         $fixturePath = __DIR__ . "{$ds}fixture{$ds}definitions-unsupported-type-array-invalid.php";
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage(
-            'Service definition must be an \'array\', \'integer\', \'object\', or \'string\', got \'resource\'.',
-        );
+        $this->expectExceptionMessage('Unsupported definition for \'unsupported-array-invalid\'.');
 
         new ServiceMap($fixturePath);
     }
@@ -257,7 +311,7 @@ public function testThrowRuntimeExceptionWhenContainerDefinitionsHasUnsupportedT
         $fixturePath = __DIR__ . "{$ds}fixture{$ds}definitions-unsupported-empty-array.php";
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Cannot guess service definition for \'unsupported-empty-array\'.');
+        $this->expectExceptionMessage('Unsupported definition for \'unsupported-empty-array\'.');
 
         new ServiceMap($fixturePath);
     }
@@ -271,7 +325,7 @@ public function testThrowRuntimeExceptionWhenContainerDefinitionsHasUnsupportedT
         $fixturePath = __DIR__ . "{$ds}fixture{$ds}definitions-unsupported-type-integer.php";
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Unsupported service definition for \'unsupported-type-integer\'.');
+        $this->expectExceptionMessage('Unsupported definition for \'unsupported-type-integer\'.');
 
         new ServiceMap($fixturePath);
     }
@@ -299,21 +353,21 @@ public function testThrowRuntimeExceptionWhenContainerSingletonsHasUnsupportedId
         $fixturePath = __DIR__ . "{$ds}fixture{$ds}singletons-unsupported-id-not-string.php";
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Singleton ID must be a string, got \'integer\'.');
+        $this->expectExceptionMessage('\'Singleton\': ID must be a string, got \'integer\'.');
 
         new ServiceMap($fixturePath);
     }
 
     /**
      * @throws ReflectionException if the service definition is invalid or can't be resolved.
      */
-    public function testThrowRuntimeExceptionWhenContainerSingletonsHasUnsupportedIsNotArrayValue(): void
+    public function testThrowRuntimeExceptionWhenContainerSingletonsHasUnsupportedTypeArrayInvalidValue(): void
     {
         $ds = DIRECTORY_SEPARATOR;
-        $fixturePath = __DIR__ . "{$ds}fixture{$ds}singletons-unsupported-is-not-array.php";
+        $fixturePath = __DIR__ . "{$ds}fixture{$ds}singletons-unsupported-type-array-invalid.php";
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Unsupported singletons definition for \'integer\'.');
+        $this->expectExceptionMessage('Unsupported definition for \'unsupported-array-invalid\'.');
 
         new ServiceMap($fixturePath);
     }
@@ -327,21 +381,7 @@ public function testThrowRuntimeExceptionWhenContainerSingletonsHasUnsupportedTy
         $fixturePath = __DIR__ . "{$ds}fixture{$ds}singletons-unsupported-empty-array.php";
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Cannot guess service definition for \'unsupported-empty-array\'.');
-
-        new ServiceMap($fixturePath);
-    }
-
-    /**
-     * @throws ReflectionException if the service definition is invalid or can't be resolved.
-     */
-    public function testThrowRuntimeExceptionWhenContainerSingletonsHasUnsupportedTypeIntegerValue(): void
-    {
-        $ds = DIRECTORY_SEPARATOR;
-        $fixturePath = __DIR__ . "{$ds}fixture{$ds}singletons-unsupported-type-integer.php";
-
-        $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Singleton service definition must be an array, got \'integer\'.');
+        $this->expectExceptionMessage('Unsupported definition for \'unsupported-empty-array\'.');
 
         new ServiceMap($fixturePath);
     }

tests/ServiceMapTest.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'components' => 1,
+];

tests/fixture/components-unsupported-is-not-array.php

@@ -4,6 +4,6 @@
 
 return [
     'components' => [
-        'unsupported-type-integer' => 5,
+        'unsupported-array-invalid' => 1,
     ],
 ];

tests/fixture/components-unsupported-type-integer.php renamed to tests/fixture/components-unsupported-type-array-invalid.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'container' => 1,
+];

tests/fixture/container-not-definitions.php renamed to tests/fixture/config-container-empty.php

@@ -5,7 +5,7 @@
 return [
     'container' => [
         'definitions' => [
-            'unsupported-type-resource' => \fopen('php://memory', 'rb'),
+            'unsupported-array-invalid' => 1,
         ],
     ],
 ];