Merge pull request #88 from UseMuffin/endpoint-default-conn-name

Improve error message for missing connection.

Author: ADmad

src/Model/EndpointLocator.php

@@ -5,7 +5,9 @@
 
 use Cake\Core\App;
 use Cake\Datasource\ConnectionManager;
+use Cake\Datasource\Exception\MissingDatasourceConfigException;
 use Cake\Utility\Inflector;
+use Muffin\Webservice\Datasource\Connection;
 use RuntimeException;
 
 /**
@@ -99,9 +101,9 @@ public function get(string $alias, array $options = []): Endpoint
                 $connectionName = Inflector::underscore(end($pluginParts));
             }
 
-            $options['connection'] = ConnectionManager::get($connectionName);
+            $options['connection'] = $this->getConnection($connectionName);
         } elseif (is_string($options['connection'])) {
-            $options['connection'] = ConnectionManager::get($options['connection']);
+            $options['connection'] = $this->getConnection($options['connection']);
         }
 
         $options['registryAlias'] = $alias;
@@ -111,6 +113,26 @@ public function get(string $alias, array $options = []): Endpoint
         return $this->_instances[$alias];
     }
 
+    /**
+     * Get connection instance.
+     *
+     * @param string $connectionName Connection name.
+     * @return \Muffin\Webservice\Datasource\Connection
+     */
+    protected function getConnection(string $connectionName): Connection
+    {
+        try {
+            /** @var \Muffin\Webservice\Datasource\Connection */
+            return ConnectionManager::get($connectionName);
+        } catch (MissingDatasourceConfigException $e) {
+            $message = $e->getMessage()
+                . ' You can override Endpoint::defaultConnectionName() to return the connection name you want.';
+
+            /** @psalm-suppress PossiblyInvalidArgument */
+            throw new MissingDatasourceConfigException($message, $e->getCode(), $e->getPrevious());
+        }
+    }
+
     /**
      * Check to see if an instance exists in the locator.
      *

tests/TestCase/Model/EndpointLocatorTest.php

@@ -3,8 +3,10 @@
 
 namespace Muffin\Webservice\Model;
 
+use Cake\Datasource\Exception\MissingDatasourceConfigException;
 use Cake\TestSuite\TestCase;
 use RuntimeException;
+use TestApp\Model\Endpoint\TestEndpoint;
 
 class EndpointLocatorTest extends TestCase
 {
@@ -115,6 +117,18 @@ public function testGet()
         $this->assertSame($first, $result);
     }
 
+    public function testGetException()
+    {
+        $this->expectException(MissingDatasourceConfigException::class);
+        $this->expectExceptionMessage(
+            'The datasource configuration "non-existent" was not found.'
+            . ' You can override Endpoint::defaultConnectionName() to return the connection name you want.'
+        );
+
+        $locator = new EndpointLocator();
+        $locator->get('Foo', ['className' => TestEndpoint::class, 'connection' => 'non-existent']);
+    }
+
     public function testGetWithExistingObject()
     {
         $this->expectException(RuntimeException::class);