tests: add full test coverage

Author: calebdw

src/ServiceProvider.php

@@ -19,7 +19,7 @@ class ServiceProvider extends IlluminateServiceProvider implements DeferrablePro
     #[Override]
     public function provides(): array
     {
-        return [EntityManager::class];
+        return [EntityManager::class]; // @codeCoverageIgnore
     }
 
     #[Override]

testbench.yaml

@@ -1,3 +1,4 @@
 ---
 providers:
   - CalebDW\SqlEntities\ServiceProvider
+laravel: ./workbench

tests/Feature/Entities/EntityTest.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+use CalebDW\SqlEntities\Entities\Entity;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Query\Builder;
+
+beforeEach(function () {
+    test()->entity = new FooEntity();
+});
+
+it('converts entity to string', function () {
+    $expected = 'select "id", "name" from "foo"';
+
+    expect((string) test()->entity)
+        ->toBe($expected);
+
+    expect(test()->entity->toString())
+        ->toBe($expected);
+});
+
+class Foo extends Model
+{
+    protected $table = 'foo';
+}
+
+class FooEntity extends Entity
+{
+    public function name(): string
+    {
+        return 'foo_entity';
+    }
+
+    public function definition(): Builder|string
+    {
+        return Foo::query()
+            ->select('id', 'name')
+            ->toBase();
+    }
+}

tests/Feature/EntityManagerTest.php

@@ -0,0 +1,103 @@
+<?php
+
+declare(strict_types=1);
+
+use CalebDW\SqlEntities\Entities\Entity;
+use CalebDW\SqlEntities\Entities\View;
+use CalebDW\SqlEntities\EntityManager;
+use Illuminate\Database\Connection;
+use Illuminate\Database\DatabaseManager;
+use Workbench\Database\Entities\views\FooConnectionUserView;
+use Workbench\Database\Entities\views\UserView;
+
+beforeEach(function () {
+    test()->connection = test()->mock(Connection::class);
+
+    $db = test()->mock(DatabaseManager::class)
+        ->shouldReceive('connection')
+        ->andReturn(test()->connection)
+        ->getMock();
+    app()->instance('db', $db);
+
+    test()->manager = resolve(EntityManager::class);
+});
+
+afterEach(function () {
+    Mockery::close();
+});
+
+it('loads the entities')
+    ->expect(test()->manager->entities)
+    ->not->toBeEmpty();
+
+describe('get', function () {
+    it('returns the entity by name', function () {
+        $entity = test()->manager->get('users_view');
+
+        expect($entity)->toBeInstanceOf(UserView::class);
+    });
+
+    it('returns the entity by name and connection', function () {
+        $entity = test()->manager->get('users_view', 'foo');
+
+        expect($entity)->toBeInstanceOf(FooConnectionUserView::class);
+    });
+
+    it('throws an exception for unknown entity', function () {
+        $entity = test()->manager->get('unknown');
+    })->throws(InvalidArgumentException::class, 'Entity [unknown] not found.');
+});
+
+it('creates an entity', function (string|Entity $entity) {
+    test()->connection
+        ->shouldReceive('getDriverName')->once()->andReturn('sqlite')
+        ->shouldReceive('statement')
+        ->once()
+        ->withArgs(fn ($sql) => str_contains($sql, 'CREATE VIEW'));
+
+    test()->manager->create($entity);
+})->with([
+    'name'   => 'users_view',
+    'entity' => new UserView(),
+]);
+
+it('drops an entity', function (string|Entity $entity) {
+    test()->connection
+        ->shouldReceive('getDriverName')->once()->andReturn('pgsql')
+        ->shouldReceive('statement')
+        ->once()
+        ->withArgs(fn ($sql) => str_contains($sql, 'DROP VIEW'));
+
+    test()->manager->drop($entity);
+})->with([
+    'name'   => 'users_view',
+    'entity' => new UserView(),
+]);
+
+it('creates entities by type and connection', function () {
+    test()->connection
+        ->shouldReceive('getDriverName')->once()->andReturn('sqlite')
+        ->shouldReceive('statement')
+        ->once()
+        ->withArgs(fn ($sql) => str_contains($sql, 'CREATE VIEW'));
+
+    test()->manager->createAll(View::class, 'foo');
+});
+
+it('drops entities by type and connection', function () {
+    test()->connection
+        ->shouldReceive('getDriverName')->once()->andReturn('pgsql')
+        ->shouldReceive('statement')
+        ->once()
+        ->withArgs(fn ($sql) => str_contains($sql, 'DROP VIEW'));
+
+    test()->manager->dropAll(View::class, 'foo');
+});
+
+it('throws exception for unsupported driver', function () {
+    test()->connection
+        ->shouldReceive('getDriverName')
+        ->andReturn('unknown');
+
+    resolve(EntityManager::class)->create(new UserView());
+})->throws(InvalidArgumentException::class, 'Unsupported driver [unknown].');

tests/Unit/Grammars/GrammarTest.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+use CalebDW\SqlEntities\Entities\Entity;
+use CalebDW\SqlEntities\Entities\View;
+use CalebDW\SqlEntities\Grammars\Grammar;
+use Illuminate\Database\Connection;
+use Illuminate\Database\Query\Builder;
+
+beforeEach(function () {
+    $connection = Mockery::mock(Connection::class);
+
+    test()->grammar = new TestGrammar($connection);
+});
+
+it('throws exception when creating unknown entity', function () {
+    $entity = new UnknownEntity();
+
+    test()->grammar->compileCreate($entity);
+})->throws(InvalidArgumentException::class, 'Unsupported entity [UnknownEntity].');
+
+it('throws exception when dropping unknown entity', function () {
+    $entity = new UnknownEntity();
+
+    test()->grammar->compileDrop($entity);
+})->throws(InvalidArgumentException::class, 'Unsupported entity [UnknownEntity].');
+
+class TestGrammar extends Grammar
+{
+    public function compileViewCreate(View $view): string
+    {
+        return '';
+    }
+
+    public function compileViewDrop(View $view): string
+    {
+        return '';
+    }
+}
+
+class UnknownEntity extends Entity
+{
+    public function name(): string
+    {
+        return 'unknown_entity';
+    }
+
+    public function definition(): Builder|string
+    {
+        return '';
+    }
+}

tests/Unit/Grammars/PostgresGrammarTest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+use CalebDW\SqlEntities\Grammars\PostgresGrammar;
+use Illuminate\Database\Connection;
+use Workbench\Database\Entities\views\UserView;
+
+beforeEach(function () {
+    $connection = Mockery::mock(Connection::class);
+
+    test()->grammar = new PostgresGrammar($connection);
+});
+
+it('compiles view create', function () {
+    $sql = test()->grammar->compileCreate(new UserView());
+
+    expect($sql)->toBe(<<<'SQL'
+        CREATE OR REPLACE VIEW users_view AS
+        SELECT id, name FROM users
+        SQL);
+});
+
+it('compiles view drop', function () {
+    $sql = test()->grammar->compileDrop(new UserView());
+
+    expect($sql)->toBe(<<<'SQL'
+        DROP VIEW IF EXISTS users_view CASCADE
+        SQL);
+});

tests/Unit/Grammars/SQLiteGrammarTest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+use CalebDW\SqlEntities\Grammars\SQLiteGrammar;
+use Illuminate\Database\Connection;
+use Workbench\Database\Entities\views\UserView;
+
+beforeEach(function () {
+    $connection = Mockery::mock(Connection::class);
+
+    test()->grammar = new SQLiteGrammar($connection);
+});
+
+it('compiles view drop', function () {
+    $sql = test()->grammar->compileCreate(new UserView());
+
+    expect($sql)->toBe(<<<'SQL'
+        CREATE VIEW users_view AS
+        SELECT id, name FROM users
+        SQL);
+});
+
+it('compiles view create', function () {
+    $sql = test()->grammar->compileDrop(new UserView());
+
+    expect($sql)->toBe(<<<'SQL'
+        DROP VIEW IF EXISTS users_view
+        SQL);
+});

workbench/bootstrap/cache/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

workbench/composer.json

@@ -0,0 +1,24 @@
+{
+  "name": "laravel/laravel",
+  "description": "The Laravel Framework.",
+  "keywords": [
+    "framework",
+    "laravel"
+  ],
+  "license": "MIT",
+  "type": "project",
+  "autoload": {
+    "psr-4": {
+      "App\\": "app/",
+      "Workbench\\Database\\Entities\\": "database/entities/",
+      "Database\\Factories\\": "database/factories/",
+      "Database\\Seeders\\": "database/seeders/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Tests\\": "tests/"
+    }
+  },
+  "minimum-stability": "dev"
+}

workbench/database/entities/views/FooConnectionUserView.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workbench\Database\Entities\views;
+
+use CalebDW\SqlEntities\Entities\View;
+use Override;
+
+class FooConnectionUserView extends View
+{
+    #[Override]
+    public function name(): string
+    {
+        return 'users_view';
+    }
+
+    #[Override]
+    public function definition(): string
+    {
+        return 'SELECT id, name FROM users';
+    }
+
+    #[Override]
+    public function connectionName(): string
+    {
+        return 'foo';
+    }
+}