test: Complete the test suite

.github/workflows/tests.yml

@@ -35,9 +35,6 @@ jobs:
       - name: Prepare testbench
         run: composer clear && composer prepare && composer build
 
-      - name: Publish required assets
-        run: vendor/bin/testbench vendor:publish --provider="Sprout\\SproutServiceProvider"
-
       - name: Execute tests
         run: composer test
 

composer.json

@@ -63,7 +63,7 @@
       "@clear",
       "@prepare",
       "@build",
-      "@php vendor/bin/phpunit"
+      "@php vendor/bin/phpunit --testsuite=Unit,Feature"
     ]
   },
   "extra"            : {

phpunit.xml

@@ -15,8 +15,14 @@
         testdox="true"
 >
     <testsuites>
-        <testsuite name="Tenanted Laravel Test Suite">
-            <directory>tests</directory>
+        <testsuite name="Original">
+            <directory>tests/_Original</directory>
+        </testsuite>
+        <testsuite name="Feature">
+            <directory>./tests/Feature</directory>
+        </testsuite>
+        <testsuite name="Unit">
+            <directory>./tests/Unit</directory>
         </testsuite>
     </testsuites>
     <source>

src/Concerns/OverridesCookieSettings.php

@@ -39,7 +39,7 @@ public static function setDomain(?string $domain): void
      */
     public static function setPath(?string $path): void
     {
-        self::$settings['path'] = '/' . ltrim($path, '/');
+        self::$settings['path'] = $path ? '/' . ltrim($path, '/') : null;
     }
 
     // @codeCoverageIgnoreStart

src/Http/Middleware/AddTenantHeaderToResponse.php

@@ -5,11 +5,10 @@
 
 use Closure;
 use Illuminate\Http\Request;
-use Illuminate\Http\Response;
 use Sprout\Http\Resolvers\HeaderIdentityResolver;
 use Sprout\Sprout;
 use Sprout\Support\ResolutionHelper;
-use Sprout\Support\ResolutionHook;
+use Symfony\Component\HttpFoundation\Response;
 
 /**
  * Add Tenant Header to Response
@@ -43,9 +42,10 @@
      * @param \Closure                 $next
      * @param string                   ...$options
      *
-     * @return \Illuminate\Http\Response
+     * @return \Symfony\Component\HttpFoundation\Response
      *
-     * @throws \Sprout\Exceptions\NoTenantFound
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
+     * @throws \Sprout\Exceptions\MisconfigurationException
      */
     public function handle(Request $request, Closure $next, string ...$options): Response
     {
@@ -68,7 +68,7 @@
         }
 
         return $response->withHeaders([
-            $resolver->getRequestHeaderName($tenancy) => $tenancy->identifier()
+            $resolver->getRequestHeaderName($tenancy) => $tenancy->identifier(),
         ]);
     }
 }

src/Http/Middleware/TenantRoutes.php

@@ -48,7 +48,7 @@ public function __construct(Sprout $sprout)
      * @param \Closure                 $next
      * @param string                   ...$options
      *
-     * @return \Illuminate\Http\Response
+     * @return \Symfony\Component\HttpFoundation\Response
      *
      * @throws \Sprout\Exceptions\NoTenantFound
      * @throws \Illuminate\Contracts\Container\BindingResolutionException

src/Overrides/AuthOverride.php

@@ -21,7 +21,7 @@
  *
  * @package Overrides
  */
-final class AuthOverride implements ServiceOverride, BootableServiceOverride, DeferrableServiceOverride
+final class AuthOverride implements BootableServiceOverride, DeferrableServiceOverride
 {
     /**
      * @var \Illuminate\Auth\AuthManager

src/Sprout.php

@@ -118,18 +118,6 @@ public function getAllCurrentTenancies(): array
         return $this->tenancies;
     }
 
-    /**
-     * Should Sprout listen for the routing event
-     *
-     * @return bool
-     *
-     * @throws \Illuminate\Contracts\Container\BindingResolutionException
-     */
-    public function shouldListenForRouting(): bool
-    {
-        return (bool)$this->config('listen_for_routing', true);
-    }
-
     /**
      * Get the identity resolver manager
      *
@@ -200,7 +188,7 @@ public function markAsInContext(): self
      *
      * @return static
      */
-    public function maskAsOutsideContext(): self
+    public function markAsOutsideContext(): self
     {
         $this->withinContext = false;
 

src/SproutServiceProvider.php

@@ -31,6 +31,7 @@ public function register(): void
         $this->registerManagers();
         $this->registerMiddleware();
         $this->registerRouteMixin();
+        $this->registerServiceOverrideBooting();
     }
 
     private function registerSprout(): void
@@ -78,13 +79,17 @@ protected function registerRouteMixin(): void
         Router::mixin(new RouterMethods());
     }
 
+    protected function registerServiceOverrideBooting(): void
+    {
+        $this->app->booted($this->sprout->bootOverrides(...));
+    }
+
     public function boot(): void
     {
         $this->publishConfig();
         $this->registerServiceOverrides();
         $this->registerEventListeners();
         $this->registerTenancyBootstrappers();
-        $this->bootServiceOverrides();
     }
 
     private function publishConfig(): void
@@ -128,9 +133,4 @@ private function registerTenancyBootstrappers(): void
             $events->listen(CurrentTenantChanged::class, $bootstrapper);
         }
     }
-
-    private function bootServiceOverrides(): void
-    {
-        $this->sprout->bootOverrides();
-    }
 }

src/Support/DefaultTenancy.php

@@ -257,6 +257,11 @@ public function setTenant(?Tenant $tenant): static
             event(new CurrentTenantChanged($this, $previousTenant, $tenant));
         }
 
+        if ($tenant === null) {
+            $this->resolver = null;
+            $this->hook     = null;
+        }
+
         return $this;
     }
 

src/Support/GenericTenant.php

@@ -13,6 +13,8 @@
  * as the tenant entity.
  *
  * @pacakge Core
+ *
+ * @codeCoverageIgnore
  */
 class GenericTenant implements Tenant
 {

tests/Unit/Attributes/CurrentTenantTest.php

@@ -0,0 +1,82 @@
+<?php
+declare(strict_types=1);
+
+namespace Sprout\Tests\Unit\Attributes;
+
+use Illuminate\Config\Repository;
+use Orchestra\Testbench\Attributes\DefineEnvironment;
+use PHPUnit\Framework\Attributes\Test;
+use Sprout\Attributes\CurrentTenant;
+use Sprout\Support\GenericTenant;
+use Sprout\Tests\Unit\UnitTestCase;
+use Workbench\App\Models\TenantModel;
+use function Sprout\sprout;
+use function Sprout\tenancy;
+
+class CurrentTenantTest extends UnitTestCase
+{
+    protected function setsUpTenancy($app)
+    {
+        tap($app['config'], function ($config) {
+            $config->set('multitenancy.providers.tenants.model', TenantModel::class);
+        });
+    }
+
+    protected function setupSecondTenancy($app): void
+    {
+        tap($app['config'], static function (Repository $config) {
+            $config->set('multitenancy.providers.backup', [
+                'driver' => 'database',
+                'table'  => 'tenants',
+            ]);
+
+            $config->set('multitenancy.tenancies.backup', [
+                'provider' => 'backup',
+            ]);
+        });
+    }
+
+    #[Test]
+    public function resolvesCurrentTenant(): void
+    {
+        /** @var \Sprout\Contracts\Tenancy $tenancy */
+        $tenancy = tenancy('tenants');
+
+        sprout()->setCurrentTenancy($tenancy);
+
+        $tenant = TenantModel::factory()->createOne();
+
+        $tenancy->setTenant($tenant);
+
+        $callback = static function (#[CurrentTenant] TenantModel $tenant) {
+            return $tenant;
+        };
+
+        $currentTenant = $this->app->call($callback);
+
+        $this->assertSame($tenant, $currentTenant);
+        $this->assertSame($tenancy->tenant(), $currentTenant);
+    }
+
+    #[Test, DefineEnvironment('setupSecondTenancy')]
+    public function resolvesCurrentTenantForSpecificTenancy(): void
+    {
+        /** @var \Sprout\Contracts\Tenancy $tenancy */
+        $tenancy = tenancy('backup');
+
+        sprout()->setCurrentTenancy($tenancy);
+
+        $tenant = new GenericTenant(TenantModel::factory()->createOne()->toArray());
+
+        $tenancy->setTenant($tenant);
+
+        $callback = static function (#[CurrentTenant('backup')] GenericTenant $tenant) {
+            return $tenant;
+        };
+
+        $currentTenant = $this->app->call($callback);
+
+        $this->assertSame($tenant, $currentTenant);
+        $this->assertSame($tenancy->tenant(), $currentTenant);
+    }
+}

tests/Unit/Providers/DatabaseProviderTest.php

@@ -0,0 +1,120 @@
+<?php
+declare(strict_types=1);
+
+namespace Sprout\Tests\Unit\Providers;
+
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\DB;
+use Orchestra\Testbench\Attributes\DefineEnvironment;
+use PHPUnit\Framework\Attributes\Test;
+use Sprout\Providers\DatabaseTenantProvider;
+use Sprout\Support\GenericTenant;
+use Sprout\Tests\Unit\UnitTestCase;
+use Workbench\App\CustomTenantEntity;
+use function Sprout\provider;
+use function Sprout\sprout;
+
+class DatabaseProviderTest extends UnitTestCase
+{
+    use RefreshDatabase;
+
+    protected function defineEnvironment($app): void
+    {
+        tap($app['config'], static function ($config) {
+            $config->set('multitenancy.providers.tenants.driver', 'database');
+            $config->set('multitenancy.providers.tenants.table', 'tenants');
+        });
+    }
+
+    protected function withCustomTenantEntity($app): void
+    {
+        tap($app['config'], static function ($config) {
+            $config->set('multitenancy.providers.tenants.entity', CustomTenantEntity::class);
+        });
+    }
+
+    #[Test]
+    public function hasARegisteredName(): void
+    {
+        $provider = provider('tenants');
+
+        $this->assertInstanceOf(DatabaseTenantProvider::class, $provider);
+        $this->assertSame('tenants', $provider->getName());
+    }
+
+    #[Test]
+    public function hasATable(): void
+    {
+        $provider = provider('tenants');
+
+        $this->assertInstanceOf(DatabaseTenantProvider::class, $provider);
+        $this->assertSame('tenants', $provider->getTable());
+    }
+
+    #[Test]
+    public function hasATenantEntity(): void
+    {
+        $provider = provider('tenants');
+
+        $this->assertInstanceOf(DatabaseTenantProvider::class, $provider);
+        $this->assertSame(GenericTenant::class, $provider->getEntityClass());
+    }
+
+    #[Test]
+    public function retrievesTenantsByTheirIdentifier(): void
+    {
+        $provider = provider('tenants');
+
+        $tenantData = [
+            'name'       => 'Test Tenant',
+            'identifier' => 'tenant-test',
+            'active'     => true,
+        ];
+
+        $tenantData['id'] = DB::table('tenants')->insertGetId($tenantData);
+
+        $found = $provider->retrieveByIdentifier($tenantData['identifier']);
+
+        $this->assertNotNull($found);
+        $this->assertInstanceOf(GenericTenant::class, $found);
+        $this->assertSame($tenantData['identifier'], $found->getTenantIdentifier());
+        $this->assertSame($tenantData['id'], $found->getTenantKey());
+
+        $this->assertNull($provider->retrieveByIdentifier('fake-identifier'));
+    }
+
+    #[Test]
+    public function retrievesTenantsByTheirKey(): void
+    {
+        $provider = provider('tenants');
+
+        $tenantData = [
+            'name'       => 'Test Tenant',
+            'identifier' => 'tenant-test',
+            'active'     => true,
+        ];
+
+        $tenantData['id'] = DB::table('tenants')->insertGetId($tenantData);
+
+        $found = $provider->retrieveByKey($tenantData['id']);
+
+        $this->assertNotNull($found);
+        $this->assertInstanceOf(GenericTenant::class, $found);
+        $this->assertSame($tenantData['identifier'], $found->getTenantIdentifier());
+        $this->assertSame($tenantData['id'], $found->getTenantKey());
+
+        $this->assertNull($provider->retrieveByKey(-999));
+    }
+
+    #[Test, DefineEnvironment('withCustomTenantEntity')]
+    public function canHaveCustomTenantEntity(): void
+    {
+        // This is necessary as the provider has already been resolved
+        sprout()->providers()->flushResolved();
+
+        $provider = provider('tenants');
+
+        $this->assertInstanceOf(DatabaseTenantProvider::class, $provider);
+        $this->assertSame(CustomTenantEntity::class, $provider->getEntityClass());
+    }
+}