Add feature tests, controller, and make all tests pass

Author: wardtd

.gitignore

@@ -2,3 +2,4 @@
 /.phive/
 /tools/
 
+.idea

composer.json

@@ -6,13 +6,14 @@
     "require": {
         "php": ">=7.3",
       	"ext-json": "*",
-        "aws/aws-php-sns-message-validator": "^1.6",
-        "orchestra/testbench": "^6.0"
+        "aws/aws-php-sns-message-validator": "^1.6"
+
     },
     "require-dev" : {
         "phpunit/phpunit": "^9.5",
         "roave/security-advisories": "dev-latest",
-        "guzzlehttp/guzzle": "^7.2"
+        "guzzlehttp/guzzle": "^7.2",
+        "orchestra/testbench": "^6.0"
     },
     "autoload-dev": {
         "psr-4": {

config/sns-handler.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'sns-class-map' => []
+];

routes/api.php

@@ -0,0 +1,5 @@
+<?php
+use Illuminate\Support\Facades\Route;
+use MiamiOH\SnsHandler\Controllers\SnsMessageController;
+
+Route::post('/sns/message', [SnsMessageController::class, 'handle']);

src/Controllers/SnsMessageController.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace MiamiOH\SnsHandler\Controllers;
+
+use Illuminate\Http\Request;
+use Illuminate\Routing\Controller;
+use MiamiOH\SnsHandler\SnsBroker;
+use MiamiOH\SnsHandler\SnsConfirmSubscriptionException;
+use MiamiOH\SnsHandler\SnsException;
+use MiamiOH\SnsHandler\SnsHttpRequest;
+use MiamiOH\SnsHandler\SnsUnknownTopicArnException;
+
+
+class SnsMessageController extends Controller
+{
+    /**
+     * @var SnsBroker
+     */
+    private $snsBroker;
+
+    public function __construct(SnsBroker $snsBroker)
+    {
+        $this->snsBroker = $snsBroker;
+    }
+
+    public function handle(SnsHttpRequest $request)
+    {
+        try {
+            $this->snsBroker->handleRequest($request);
+        } catch (SnsUnknownTopicArnException $e) {
+            return response(null, 404);
+        } catch (SnsConfirmSubscriptionException $e) {
+            return response(null, 502);
+        } catch (SnsException $e) {
+            return response(null, 500);
+        }
+
+        return response()->json();
+    }
+}

src/ServiceProvider.php

@@ -0,0 +1,35 @@
+<?php
+
+
+namespace MiamiOH\SnsHandler;
+
+
+use Illuminate\Support\ServiceProvider as BaseServiceProvider;
+use MiamiOH\SnsHandler\Controllers\SnsMessageController;
+
+class ServiceProvider extends BaseServiceProvider
+{
+    private $configPath = __DIR__ . '/../config/sns-handler.php';
+
+    public function boot()
+    {
+        $this->loadRoutesFrom(__DIR__ . '/../routes/api.php');
+        $this->publishes([
+            $this->configPath => config_path('sns-handler.php'),
+        ]);
+    }
+
+    /**
+     * Register the application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->make(SnsMessageController::class);
+        $this->mergeConfigFrom($this->configPath, 'sns-handler');
+        $this->app->bind(SnsTopicMapper::class, function () {
+            return new SnsTopicMapper(config('sns-handler.sns-class-map', []));
+        });
+    }
+}

src/SnsHttpRequest.php

@@ -1,9 +1,35 @@
 <?php
 
-
 namespace MiamiOH\SnsHandler;
 
-interface SnsHttpRequest
+use Illuminate\Foundation\Http\FormRequest;
+
+class SnsHttpRequest extends FormRequest
 {
-    public function jsonContent(): string;
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            //
+        ];
+    }
+
+    public function jsonContent(): string
+    {
+        return $this->content;
+    }
 }

tests/Feature/SnsHandlerTest.php

@@ -0,0 +1,117 @@
+<?php
+
+
+namespace Tests\MiamiOH\SnsHandler\Feature;
+
+use Aws\Sns\MessageValidator;
+use Illuminate\Http\Client\Request;
+use Illuminate\Support\Facades\Http;
+use MiamiOH\SnsHandler\NullMessageValidator;
+use MiamiOH\SnsHandler\ServiceProvider;
+use MiamiOH\SnsHandler\SnsMessage;
+use Tests\MiamiOH\SnsHandler\MakesSnsTests;
+use Tests\MiamiOH\SnsHandler\Unit\SnsMessageHandlerStub;
+
+
+class SnsHandlerTest extends \Tests\MiamiOH\SnsHandler\TestCase
+{
+    use MakesSnsTests;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->app->bind(MessageValidator::class, NullMessageValidator::class);
+    }
+
+    protected function getEnvironmentSetUp($app)
+    {
+        $app['config']->set('sns-handler.sns-class-map', [
+            'arn:aws:sns:us-west-2:123456789012:MyTopic' => SnsMessageHandlerStub::class,
+        ]);
+    }
+
+    protected function getPackageProviders($app)
+    {
+        return [ServiceProvider::class];
+    }
+
+    public function testReturnsNotFoundForUnknownTopicArn(): void
+    {
+
+
+        $data = $this->makeSnsMessageData([
+            'Type' => SnsMessage::NOTIFICATION_TYPE,
+            'TopicArn' => 'arn:aws:sns:us-west-2:123456789012:Unknown',
+        ]);
+        $response = $this->postJson('/sns/message', $data);
+
+        $this->assertEquals(404, $response->status());
+    }
+
+    public function testConfirmsSubscriptionForKnownTopicArn(): void
+    {
+        Http::fake();
+
+        $data = $this->makeSnsMessageData([
+            'Type' => SnsMessage::SUBSCRIBE_TYPE,
+            'Message' => json_encode(['id' => 123, 'color' => 'red'], true),
+            'SubscribeURL' => 'https://aws.amazon.com/sns/register/abc123'
+        ]);
+
+        $this->postJson('/sns/message', $data);
+
+        Http::assertSent(function (Request $request) {
+            return $request->url() === 'https://aws.amazon.com/sns/register/abc123';
+        });
+    }
+
+    public function testRespondsWithOkAfterConfirmsSubscription(): void
+    {
+        Http::fake();
+
+        $data = $this->makeSnsMessageData([
+            'Type' => SnsMessage::SUBSCRIBE_TYPE,
+            'Message' => json_encode(['id' => 123, 'color' => 'red'], true),
+            'SubscribeURL' => 'https://aws.amazon.com/sns/register/abc123'
+        ]);
+
+        $response = $this->postJson('/sns/message', $data);
+        print_r($response->getContent());
+
+        $this->assertEquals(200, $response->status());
+    }
+
+    public function testReturnsBadGatewayResponseIfConfirmationFails(): void
+    {
+        Http::fake([
+            '*' => Http::response(null, 404),
+        ]);
+
+        $data = $this->makeSnsMessageData([
+            'Type' => SnsMessage::SUBSCRIBE_TYPE,
+            'Message' => json_encode(['id' => 123, 'color' => 'red'], true),
+            'SubscribeURL' => 'https://aws.amazon.com/sns/register/abc123'
+        ]);
+
+        $response = $this->postJson('/sns/message', $data);
+
+        $this->assertEquals(502, $response->status());
+    }
+
+    public function testSendsMessageToRegisteredHandler(): void
+    {
+        $data = $this->makeSnsMessageData([
+            'Type' => SnsMessage::NOTIFICATION_TYPE,
+            'TopicArn' => 'arn:aws:sns:us-west-2:123456789012:MyTopic',
+            'Message' => 'Test message',
+        ]);
+
+        SnsMessageHandlerStub::handleCallback(function (SnsMessage $message) {
+            $this->assertEquals('Test message', $message->message());
+        });
+
+        $response = $this->postJson('/sns/message', $data);
+
+        $this->assertEquals(200, $response->status());
+    }
+}

tests/Unit/SnsBrokerTest.php

@@ -102,7 +102,7 @@ public function testThrowsExceptionIfConfirmSubscriptionFails(): void
                 'Type' => SnsMessage::SUBSCRIBE_TYPE,
                 'SubscribeURL' => 'https://aws.amazon.com/subscribe/123',
             ]));
-        
+
         Http::fake([
             'https://aws.amazon.com/subscribe/123' => Http::response([], 404, [])
         ]);