Added tests for incompatible providers.

Added IncompatibleProviderException.
Moved ForeignResourceException to Porter's namespace.

Author: Bilge

src/Provider/ForeignResourceException.php src/ForeignResourceException.phpsrc/Provider/ForeignResourceException.php renamed to src/ForeignResourceException.php

@@ -1,12 +1,12 @@
 <?php
 declare(strict_types=1);
 
-namespace ScriptFUSION\Porter\Provider;
+namespace ScriptFUSION\Porter;
 
 /**
  * The exception that is thrown when a foreign resource is received.
  */
-class ForeignResourceException extends \RuntimeException
+final class ForeignResourceException extends \LogicException
 {
     // Intentionally empty.
 }

src/ImportException.php

@@ -6,7 +6,7 @@
 /**
  * The exception that is thrown when an import fails.
  */
-class ImportException extends \RuntimeException
+final class ImportException extends \RuntimeException
 {
     // Intentionally empty.
 }

src/IncompatibleProviderException.php

@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+
+namespace ScriptFUSION\Porter;
+
+/**
+ * The exception that is thrown when a provider is incompatible with an import operation because it only supports
+ * sync during an async import or vice-versa.
+ */
+final class IncompatibleProviderException extends \LogicException
+{
+    public function __construct(string $expectedType)
+    {
+        parent::__construct("Provider does not implement $expectedType.");
+    }
+}

src/Porter.php

@@ -18,7 +18,6 @@
 use ScriptFUSION\Porter\Connector\ConnectorOptions;
 use ScriptFUSION\Porter\Connector\ImportConnectorFactory;
 use ScriptFUSION\Porter\Provider\AsyncProvider;
-use ScriptFUSION\Porter\Provider\ForeignResourceException;
 use ScriptFUSION\Porter\Provider\ObjectNotCreatedException;
 use ScriptFUSION\Porter\Provider\Provider;
 use ScriptFUSION\Porter\Provider\ProviderFactory;
@@ -27,6 +26,7 @@
 use ScriptFUSION\Porter\Specification\ImportSpecification;
 use ScriptFUSION\Porter\Transform\AsyncTransformer;
 use ScriptFUSION\Porter\Transform\Transformer;
+use function Amp\call;
 
 /**
  * Imports data from a provider defined in the providers container or internal factory.
@@ -106,6 +106,10 @@ private function fetch(ImportSpecification $specification): \Iterator
         $resource = $specification->getResource();
         $provider = $this->getProvider($specification->getProviderName() ?? $resource->getProviderClassName());
 
+        if (!$provider instanceof Provider) {
+            throw new IncompatibleProviderException('Provider');
+        }
+
         if ($resource->getProviderClassName() !== \get_class($provider)) {
             throw new ForeignResourceException(sprintf(
                 'Cannot fetch data from foreign resource: "%s".',
@@ -143,7 +147,11 @@ public function importAsync(AsyncImportSpecification $specification): AsyncRecor
             $records = new AsyncProviderRecords($records, $specification->getAsyncResource());
         }
 
-        $records = $this->transformAsync($records, $specification->getTransformers(), $specification->getContext());
+        $records = $this->transformRecordsAsync(
+            $records,
+            $specification->getTransformers(),
+            $specification->getContext()
+        );
 
         return $this->createAsyncPorterRecords($records, $specification);
     }
@@ -157,7 +165,7 @@ public function importAsync(AsyncImportSpecification $specification): AsyncRecor
      */
     public function importOneAsync(AsyncImportSpecification $specification): Promise
     {
-        return \Amp\call(function () use ($specification) {
+        return call(function () use ($specification) {
             $results = $this->importAsync($specification);
 
             yield $results->advance();
@@ -178,8 +186,7 @@ private function fetchAsync(AsyncImportSpecification $specification): Iterator
         $provider = $this->getProvider($specification->getProviderName() ?? $resource->getProviderClassName());
 
         if (!$provider instanceof AsyncProvider) {
-            // TODO: Specific exception type.
-            throw new \RuntimeException('Provider does not implement AsyncProvider.');
+            throw new IncompatibleProviderException('AsyncProvider');
         }
 
         if ($resource->getProviderClassName() !== \get_class($provider)) {
@@ -206,8 +213,6 @@ private function fetchAsync(AsyncImportSpecification $specification): Iterator
      * @param RecordCollection $records
      * @param Transformer[] $transformers
      * @param mixed $context
-     *
-     * @return RecordCollection
      */
     private function transformRecords(RecordCollection $records, array $transformers, $context): RecordCollection
     {
@@ -226,10 +231,8 @@ private function transformRecords(RecordCollection $records, array $transformers
      * @param AsyncRecordCollection $records
      * @param AsyncTransformer[] $transformers
      * @param mixed $context
-     *
-     * @return AsyncRecordCollection
      */
-    private function transformAsync(
+    private function transformRecordsAsync(
         AsyncRecordCollection $records,
         array $transformers,
         $context

src/ProviderNotFoundException.php

@@ -3,6 +3,9 @@
 
 namespace ScriptFUSION\Porter;
 
+/**
+ * The exception that is thrown when the specified provider name is not found.
+ */
 final class ProviderNotFoundException extends \RuntimeException
 {
     public function __construct(string $message, \Exception $previous = null)

test/Integration/Porter/PorterAsyncTest.php

@@ -7,7 +7,10 @@
 use Amp\Loop;
 use Amp\Producer;
 use ScriptFUSION\Porter\ImportException;
+use ScriptFUSION\Porter\IncompatibleProviderException;
 use ScriptFUSION\Porter\Porter;
+use ScriptFUSION\Porter\Provider\AsyncProvider;
+use ScriptFUSION\Porter\Provider\Provider;
 use ScriptFUSION\Porter\Specification\AsyncImportSpecification;
 use ScriptFUSION\Porter\Transform\FilterTransformer;
 
@@ -53,6 +56,17 @@ public function testImportOneOfManyAsync(): \Generator
         yield $this->porter->importOneAsync($this->specification);
     }
 
+    /**
+     * Tests that when importing from a provider that does not implement AsyncProvider, an exception is thrown.
+     */
+    public function testImportIncompatibleProvider(): \Generator
+    {
+        $this->registerProvider(\Mockery::mock(Provider::class), $providerName = 'foo');
+
+        $this->expectException(IncompatibleProviderException::class);
+        yield $this->porter->importAsync($this->specification->setProviderName($providerName));
+    }
+
     /**
      * Tests that a stack of async filter transformers are applied correctly.
      * The order is deterministic because filters yield immediately.

test/Integration/Porter/PorterSyncTest.php

@@ -14,8 +14,11 @@
 use ScriptFUSION\Porter\Connector\Recoverable\RecoverableExceptionHandler;
 use ScriptFUSION\Porter\Connector\Recoverable\StatelessRecoverableExceptionHandler;
 use ScriptFUSION\Porter\ImportException;
+use ScriptFUSION\Porter\IncompatibleProviderException;
 use ScriptFUSION\Porter\PorterAware;
-use ScriptFUSION\Porter\Provider\ForeignResourceException;
+use ScriptFUSION\Porter\ForeignResourceException;
+use ScriptFUSION\Porter\Provider\AsyncProvider;
+use ScriptFUSION\Porter\Provider\Provider;
 use ScriptFUSION\Porter\ProviderNotFoundException;
 use ScriptFUSION\Porter\Specification\ImportSpecification;
 use ScriptFUSION\Porter\Specification\StaticDataImportSpecification;
@@ -146,6 +149,17 @@ public function testImportUnregisteredProvider(): void
         $this->porter->import($this->specification->setProviderName('foo'));
     }
 
+    /**
+     * Tests that when importing from a provider that does not implement Provider, an exception is thrown.
+     */
+    public function testImportIncompatibleProvider(): void
+    {
+        $this->registerProvider(\Mockery::mock(AsyncProvider::class), $providerName = 'foo');
+
+        $this->expectException(IncompatibleProviderException::class);
+        $this->porter->import($this->specification->setProviderName($providerName));
+    }
+
     /**
      * Tests that when a resource's provider class name does not match the provider an exception is thrown.
      */

test/Integration/Porter/PorterTest.php

@@ -64,7 +64,11 @@ protected function setUp(): void
         $this->specification = new ImportSpecification($this->resource);
     }
 
-    protected function registerProvider(Provider $provider, string $name = null): void
+    /**
+     * @param Provider|AsyncProvider $provider
+     * @param string|null $name
+     */
+    protected function registerProvider($provider, string $name = null): void
     {
         $name = $name ?? \get_class($provider);