tenancy/tests/TenantManagerTest.php

<?php

namespace Stancl\Tenancy\Tests;

use Tenancy;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Storage;
use Stancl\Tenancy\Exceptions\CannotChangeUuidOrDomainException;

class TenantManagerTest extends TestCase
{
    public $autoCreateTenant = false;
    public $autoInitTenancy = false;

    /** @test */
    public function current_tenant_is_stored_in_the_tenant_property()
    {
        $tenant = tenant()->create('localhost');

        tenancy()->init('localhost');

        $this->assertSame($tenant, tenancy()->tenant);
    }

    /** @test */
    public function invoke_works()
    {
        $this->assertSame(tenant('uuid'), tenant()('uuid'));
    }

    /** @test */
    public function initById_works()
    {
        $tenant = tenant()->create('foo.localhost');

        $this->assertNotSame($tenant, tenancy()->tenant);

        tenancy()->initById($tenant['uuid']);

        $this->assertSame($tenant, tenancy()->tenant);
    }

    /** @test */
    public function findByDomain_works()
    {
        $tenant = tenant()->create('foo.localhost');

        $this->assertSame($tenant, tenant()->findByDomain('foo.localhost'));
    }

    /** @test */
    public function getIdByDomain_works()
    {
        $tenant = tenant()->create('foo.localhost');
        $this->assertSame(tenant()->getTenantIdByDomain('foo.localhost'), tenant()->getIdByDomain('foo.localhost'));
    }

    /** @test */
    public function find_works()
    {
        tenant()->create('dev.localhost');
        tenancy()->init('dev.localhost');

        $this->assertSame(tenant()->tenant, tenant()->find(tenant('uuid')));
    }

    /** @test */
    public function getTenantById_works()
    {
        $tenant = tenant()->create('foo.localhost');

        $this->assertSame($tenant, tenancy()->getTenantById($tenant['uuid']));
    }

    /** @test */
    public function init_returns_the_tenant()
    {
        $tenant = tenant()->create('foo.localhost');

        $this->assertSame($tenant, tenancy()->init('foo.localhost'));
    }

    /** @test */
    public function initById_returns_the_tenant()
    {
        $tenant = tenant()->create('foo.localhost');
        $uuid = $tenant['uuid'];

        $this->assertSame($tenant, tenancy()->initById($uuid));
    }

    /** @test */
    public function create_returns_the_supplied_domain()
    {
        $domain = 'foo.localhost';

        $this->assertSame($domain, tenant()->create($domain)['domain']);
    }

    /** @test */
    public function findByDomain_throws_an_exception_when_an_unused_domain_is_supplied()
    {
        $this->expectException(\Exception::class);
        tenancy()->findByDomain('nonexistent.domain');
    }

    /** @test */
    public function tenancy_can_be_ended()
    {
        $originals = [
            'databaseName' => DB::connection()->getDatabaseName(),
            'storage_path' => storage_path(),
            'storage_root' => Storage::disk('local')->getAdapter()->getPathPrefix(),
            'cache' => app('cache'),
        ];

        // Verify that these assertions are the right way for testing this
        $this->assertSame($originals['databaseName'], DB::connection()->getDatabaseName());
        $this->assertSame($originals['storage_path'], storage_path());
        $this->assertSame($originals['storage_root'], Storage::disk('local')->getAdapter()->getPathPrefix());
        $this->assertSame($originals['cache'], app('cache'));

        tenant()->create('foo.localhost');
        tenancy()->init('foo.localhost');

        $this->assertNotSame($originals['databaseName'], DB::connection()->getDatabaseName());
        $this->assertNotSame($originals['storage_path'], storage_path());
        $this->assertNotSame($originals['storage_root'], Storage::disk('local')->getAdapter()->getPathPrefix());
        $this->assertNotSame($originals['cache'], app('cache'));

        tenancy()->end();

        $this->assertSame($originals['databaseName'], DB::connection()->getDatabaseName());
        $this->assertSame($originals['storage_path'], storage_path());
        $this->assertSame($originals['storage_root'], Storage::disk('local')->getAdapter()->getPathPrefix());
        $this->assertSame($originals['cache'], app('cache'));
    }

    /** @test */
    public function tenancy_can_be_ended_after_reidentification()
    {
        $originals = [
            'databaseName' => DB::connection()->getDatabaseName(),
            'storage_path' => storage_path(),
            'storage_root' => Storage::disk('local')->getAdapter()->getPathPrefix(),
            'cache' => app('cache'),
        ];

        tenant()->create('foo.localhost');
        tenancy()->init('foo.localhost');

        $this->assertNotSame($originals['databaseName'], DB::connection()->getDatabaseName());
        $this->assertNotSame($originals['storage_path'], storage_path());
        $this->assertNotSame($originals['storage_root'], Storage::disk('local')->getAdapter()->getPathPrefix());
        $this->assertNotSame($originals['cache'], app('cache'));

        tenancy()->end();

        $this->assertSame($originals['databaseName'], DB::connection()->getDatabaseName());
        $this->assertSame($originals['storage_path'], storage_path());
        $this->assertSame($originals['storage_root'], Storage::disk('local')->getAdapter()->getPathPrefix());
        $this->assertSame($originals['cache'], app('cache'));

        // Reidentify tenant
        tenant()->create('bar.localhost');
        tenancy()->init('bar.localhost');

        $this->assertNotSame($originals['databaseName'], DB::connection()->getDatabaseName());
        $this->assertNotSame($originals['storage_path'], storage_path());
        $this->assertNotSame($originals['storage_root'], Storage::disk('local')->getAdapter()->getPathPrefix());
        $this->assertNotSame($originals['cache'], app('cache'));

        tenancy()->end();

        $this->assertSame($originals['databaseName'], DB::connection()->getDatabaseName());
        $this->assertSame($originals['storage_path'], storage_path());
        $this->assertSame($originals['storage_root'], Storage::disk('local')->getAdapter()->getPathPrefix());
        $this->assertSame($originals['cache'], app('cache'));
    }

    /** @test */
    public function tenant_can_be_deleted()
    {
        $tenant = tenant()->create('foo.localhost');
        tenant()->delete($tenant['uuid']);
        $this->assertSame([], tenancy()->all()->toArray());

        $tenant = tenant()->create('foo.localhost');
        $this->assertSame([$tenant], tenancy()->all()->toArray());
    }

    /** @test */
    public function all_returns_a_list_of_all_tenants()
    {
        $tenant1 = tenant()->create('foo.localhost');
        $tenant2 = tenant()->create('bar.localhost');
        $this->assertEqualsCanonicalizing([$tenant1, $tenant2], tenant()->all()->toArray());
    }

    /** @test */
    public function properites_can_be_passed_in_the_create_method()
    {
        $data = ['plan' => 'free', 'subscribed_until' => '2020-01-01'];
        $tenant = tenant()->create('foo.localhost', $data);

        $tenant_data = $tenant;
        unset($tenant_data['uuid']);
        unset($tenant_data['domain']);

        $this->assertSame($data, $tenant_data);
    }

    /** @test */
    public function database_name_can_be_passed_in_the_create_method()
    {
        $database = 'abc';
        config(['tenancy.database_name_key' => '_stancl_tenancy_database_name']);

        $tenant = tenant()->create('foo.localhost', [
            '_stancl_tenancy_database_name' => $database,
        ]);

        $this->assertSame($database, tenant()->getDatabaseName($tenant));
    }

    /** @test */
    public function uuid_and_domain_cannot_be_changed()
    {
        $tenant = tenant()->create('foo.localhost');

        $this->expectException(CannotChangeUuidOrDomainException::class);
        tenant()->put('uuid', 'foo', $tenant['uuid']);

        $this->expectException(CannotChangeUuidOrDomainException::class);
        tenant()->put(['uuid' => 'foo'], null, $tenant['uuid']);

        tenancy()->init('foo.localhost');

        $this->expectException(CannotChangeUuidOrDomainException::class);
        tenant()->put('uuid', 'foo');

        $this->expectException(CannotChangeUuidOrDomainException::class);
        tenant()->put(['uuid' => 'foo']);
    }

    /** @test */
    public function bootstrapping_event_works()
    {
        $uuid = tenant()->create('foo.localhost')['uuid'];

        Tenancy::bootstrapping(function ($tenantManager) use ($uuid) {
            if ($tenantManager->tenant['uuid'] === $uuid) {
                config(['tenancy.foo' => 'bar']);
            }
        });

        $this->assertSame(null, config('tenancy.foo'));
        tenancy()->init('foo.localhost');
        $this->assertSame('bar', config('tenancy.foo'));
    }

    /** @test */
    public function bootstrapped_event_works()
    {
        $uuid = tenant()->create('foo.localhost')['uuid'];

        Tenancy::bootstrapped(function ($tenantManager) use ($uuid) {
            if ($tenantManager->tenant['uuid'] === $uuid) {
                config(['tenancy.foo' => 'bar']);
            }
        });

        $this->assertSame(null, config('tenancy.foo'));
        tenancy()->init('foo.localhost');
        $this->assertSame('bar', config('tenancy.foo'));
    }

    /** @test */
    public function ending_event_works()
    {
        $uuid = tenant()->create('foo.localhost')['uuid'];

        Tenancy::ending(function ($tenantManager) use ($uuid) {
            if ($tenantManager->tenant['uuid'] === $uuid) {
                config(['tenancy.foo' => 'bar']);
            }
        });

        $this->assertSame(null, config('tenancy.foo'));
        tenancy()->init('foo.localhost');
        $this->assertSame(null, config('tenancy.foo'));
        tenancy()->end();
        $this->assertSame('bar', config('tenancy.foo'));
    }

    /** @test */
    public function ended_event_works()
    {
        $uuid = tenant()->create('foo.localhost')['uuid'];

        Tenancy::ended(function ($tenantManager) use ($uuid) {
            if ($tenantManager->tenant['uuid'] === $uuid) {
                config(['tenancy.foo' => 'bar']);
            }
        });

        $this->assertSame(null, config('tenancy.foo'));
        tenancy()->init('foo.localhost');
        $this->assertSame(null, config('tenancy.foo'));
        tenancy()->end();
        $this->assertSame('bar', config('tenancy.foo'));
    }
}