mirror of
https://github.com/archtechx/tenancy.git
synced 2026-02-05 22:04:04 +00:00
Convert test cases
This commit is contained in:
Shift
parent
405b91085e
commit
a8dcd0dfc9
27 changed files with 3059 additions and 3658 deletions
|
|
@ -2,8 +2,6 @@
|
|||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Stancl\Tenancy\Tests;
|
||||
|
||||
use Closure;
|
||||
use Exception;
|
||||
use Illuminate\Support\Str;
|
||||
|
|
@ -32,270 +30,240 @@ use Stancl\Tenancy\Listeners\RevertToCentralContext;
|
|||
use Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
|
||||
|
||||
class QueueTest extends TestCase
|
||||
uses(Stancl\Tenancy\Tests\TestCase::class);
|
||||
|
||||
beforeEach(function () {
|
||||
config([
|
||||
'tenancy.bootstrappers' => [
|
||||
QueueTenancyBootstrapper::class,
|
||||
DatabaseTenancyBootstrapper::class,
|
||||
],
|
||||
'queue.default' => 'redis',
|
||||
]);
|
||||
|
||||
Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
|
||||
Event::listen(TenancyEnded::class, RevertToCentralContext::class);
|
||||
|
||||
createValueStore();
|
||||
});
|
||||
|
||||
afterEach(function () {
|
||||
$this->valuestore->flush();
|
||||
});
|
||||
|
||||
test('tenant id is passed to tenant queues', function () {
|
||||
config(['queue.default' => 'sync']);
|
||||
|
||||
$tenant = Tenant::create();
|
||||
|
||||
tenancy()->initialize($tenant);
|
||||
|
||||
Event::fake([JobProcessing::class, JobProcessed::class]);
|
||||
|
||||
dispatch(new TestJob($this->valuestore));
|
||||
|
||||
Event::assertDispatched(JobProcessing::class, function ($event) {
|
||||
return $event->job->payload()['tenant_id'] === tenant('id');
|
||||
});
|
||||
});
|
||||
|
||||
test('tenant id is not passed to central queues', function () {
|
||||
$tenant = Tenant::create();
|
||||
|
||||
tenancy()->initialize($tenant);
|
||||
|
||||
Event::fake();
|
||||
|
||||
config(['queue.connections.central' => [
|
||||
'driver' => 'sync',
|
||||
'central' => true,
|
||||
]]);
|
||||
|
||||
dispatch(new TestJob($this->valuestore))->onConnection('central');
|
||||
|
||||
Event::assertDispatched(JobProcessing::class, function ($event) {
|
||||
return ! isset($event->job->payload()['tenant_id']);
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
*
|
||||
* @testWith [true]
|
||||
* [false]
|
||||
*/
|
||||
test('tenancy is initialized inside queues', function (bool $shouldEndTenancy) {
|
||||
withTenantDatabases();
|
||||
withFailedJobs();
|
||||
|
||||
$tenant = Tenant::create();
|
||||
|
||||
tenancy()->initialize($tenant);
|
||||
|
||||
withUsers();
|
||||
|
||||
$user = User::create(['name' => 'Foo', 'email' => 'foo@bar.com', 'password' => 'secret']);
|
||||
|
||||
$this->valuestore->put('userName', 'Bar');
|
||||
|
||||
dispatch(new TestJob($this->valuestore, $user));
|
||||
|
||||
$this->assertFalse($this->valuestore->has('tenant_id'));
|
||||
|
||||
if ($shouldEndTenancy) {
|
||||
tenancy()->end();
|
||||
}
|
||||
|
||||
$this->artisan('queue:work --once');
|
||||
|
||||
$this->assertSame(0, DB::connection('central')->table('failed_jobs')->count());
|
||||
|
||||
$this->assertSame('The current tenant id is: ' . $tenant->id, $this->valuestore->get('tenant_id'));
|
||||
|
||||
$tenant->run(function () use ($user) {
|
||||
$this->assertSame('Bar', $user->fresh()->name);
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
*
|
||||
* @testWith [true]
|
||||
* [false]
|
||||
*/
|
||||
test('tenancy is initialized when retrying jobs', function (bool $shouldEndTenancy) {
|
||||
if (! Str::startsWith(app()->version(), '8')) {
|
||||
$this->markTestSkipped('queue:retry tenancy is only supported in Laravel 8');
|
||||
}
|
||||
|
||||
withFailedJobs();
|
||||
withTenantDatabases();
|
||||
|
||||
$tenant = Tenant::create();
|
||||
|
||||
tenancy()->initialize($tenant);
|
||||
|
||||
withUsers();
|
||||
|
||||
$user = User::create(['name' => 'Foo', 'email' => 'foo@bar.com', 'password' => 'secret']);
|
||||
|
||||
$this->valuestore->put('userName', 'Bar');
|
||||
$this->valuestore->put('shouldFail', true);
|
||||
|
||||
dispatch(new TestJob($this->valuestore, $user));
|
||||
|
||||
$this->assertFalse($this->valuestore->has('tenant_id'));
|
||||
|
||||
if ($shouldEndTenancy) {
|
||||
tenancy()->end();
|
||||
}
|
||||
|
||||
$this->artisan('queue:work --once');
|
||||
|
||||
$this->assertSame(1, DB::connection('central')->table('failed_jobs')->count());
|
||||
$this->assertNull($this->valuestore->get('tenant_id')); // job failed
|
||||
|
||||
$this->artisan('queue:retry all');
|
||||
$this->artisan('queue:work --once');
|
||||
|
||||
$this->assertSame(0, DB::connection('central')->table('failed_jobs')->count());
|
||||
|
||||
$this->assertSame('The current tenant id is: ' . $tenant->id, $this->valuestore->get('tenant_id')); // job succeeded
|
||||
|
||||
$tenant->run(function () use ($user) {
|
||||
$this->assertSame('Bar', $user->fresh()->name);
|
||||
});
|
||||
});
|
||||
|
||||
test('the tenant used by the job doesnt change when the current tenant changes', function () {
|
||||
$tenant1 = Tenant::create([
|
||||
'id' => 'acme',
|
||||
]);
|
||||
|
||||
tenancy()->initialize($tenant1);
|
||||
|
||||
dispatch(new TestJob($this->valuestore));
|
||||
|
||||
$tenant2 = Tenant::create([
|
||||
'id' => 'foobar',
|
||||
]);
|
||||
|
||||
tenancy()->initialize($tenant2);
|
||||
|
||||
$this->assertFalse($this->valuestore->has('tenant_id'));
|
||||
$this->artisan('queue:work --once');
|
||||
|
||||
$this->assertSame('The current tenant id is: acme', $this->valuestore->get('tenant_id'));
|
||||
});
|
||||
|
||||
// Helpers
|
||||
function createValueStore(): void
|
||||
{
|
||||
public $mockConsoleOutput = false;
|
||||
$valueStorePath = __DIR__ . '/Etc/tmp/queuetest.json';
|
||||
|
||||
/** @var Valuestore */
|
||||
protected $valuestore;
|
||||
|
||||
public function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
config([
|
||||
'tenancy.bootstrappers' => [
|
||||
QueueTenancyBootstrapper::class,
|
||||
DatabaseTenancyBootstrapper::class,
|
||||
],
|
||||
'queue.default' => 'redis',
|
||||
]);
|
||||
|
||||
Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
|
||||
Event::listen(TenancyEnded::class, RevertToCentralContext::class);
|
||||
|
||||
$this->createValueStore();
|
||||
}
|
||||
|
||||
public function tearDown(): void
|
||||
{
|
||||
$this->valuestore->flush();
|
||||
}
|
||||
|
||||
protected function createValueStore(): void
|
||||
{
|
||||
$valueStorePath = __DIR__ . '/Etc/tmp/queuetest.json';
|
||||
|
||||
if (! file_exists($valueStorePath)) {
|
||||
// The directory sometimes goes missing as well when the file is deleted in git
|
||||
if (! is_dir(__DIR__ . '/Etc/tmp')) {
|
||||
mkdir(__DIR__ . '/Etc/tmp');
|
||||
}
|
||||
|
||||
file_put_contents($valueStorePath, '');
|
||||
if (! file_exists($valueStorePath)) {
|
||||
// The directory sometimes goes missing as well when the file is deleted in git
|
||||
if (! is_dir(__DIR__ . '/Etc/tmp')) {
|
||||
mkdir(__DIR__ . '/Etc/tmp');
|
||||
}
|
||||
|
||||
$this->valuestore = Valuestore::make($valueStorePath)->flush();
|
||||
file_put_contents($valueStorePath, '');
|
||||
}
|
||||
|
||||
protected function withFailedJobs()
|
||||
{
|
||||
Schema::connection('central')->create('failed_jobs', function (Blueprint $table) {
|
||||
$table->increments('id');
|
||||
$table->string('uuid')->unique();
|
||||
$table->text('connection');
|
||||
$table->text('queue');
|
||||
$table->longText('payload');
|
||||
$table->longText('exception');
|
||||
$table->timestamp('failed_at')->useCurrent();
|
||||
});
|
||||
}
|
||||
|
||||
protected function withUsers()
|
||||
{
|
||||
Schema::create('users', function (Blueprint $table) {
|
||||
$table->increments('id');
|
||||
$table->string('name');
|
||||
$table->string('email')->unique();
|
||||
$table->string('password');
|
||||
$table->rememberToken();
|
||||
$table->timestamps();
|
||||
});
|
||||
}
|
||||
|
||||
protected function withTenantDatabases()
|
||||
{
|
||||
Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) {
|
||||
return $event->tenant;
|
||||
})->toListener());
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function tenant_id_is_passed_to_tenant_queues()
|
||||
{
|
||||
config(['queue.default' => 'sync']);
|
||||
|
||||
$tenant = Tenant::create();
|
||||
|
||||
tenancy()->initialize($tenant);
|
||||
|
||||
Event::fake([JobProcessing::class, JobProcessed::class]);
|
||||
|
||||
dispatch(new TestJob($this->valuestore));
|
||||
|
||||
Event::assertDispatched(JobProcessing::class, function ($event) {
|
||||
return $event->job->payload()['tenant_id'] === tenant('id');
|
||||
});
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function tenant_id_is_not_passed_to_central_queues()
|
||||
{
|
||||
$tenant = Tenant::create();
|
||||
|
||||
tenancy()->initialize($tenant);
|
||||
|
||||
Event::fake();
|
||||
|
||||
config(['queue.connections.central' => [
|
||||
'driver' => 'sync',
|
||||
'central' => true,
|
||||
]]);
|
||||
|
||||
dispatch(new TestJob($this->valuestore))->onConnection('central');
|
||||
|
||||
Event::assertDispatched(JobProcessing::class, function ($event) {
|
||||
return ! isset($event->job->payload()['tenant_id']);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*
|
||||
* @testWith [true]
|
||||
* [false]
|
||||
*/
|
||||
public function tenancy_is_initialized_inside_queues(bool $shouldEndTenancy)
|
||||
{
|
||||
$this->withTenantDatabases();
|
||||
$this->withFailedJobs();
|
||||
|
||||
$tenant = Tenant::create();
|
||||
|
||||
tenancy()->initialize($tenant);
|
||||
|
||||
$this->withUsers();
|
||||
|
||||
$user = User::create(['name' => 'Foo', 'email' => 'foo@bar.com', 'password' => 'secret']);
|
||||
|
||||
$this->valuestore->put('userName', 'Bar');
|
||||
|
||||
dispatch(new TestJob($this->valuestore, $user));
|
||||
|
||||
$this->assertFalse($this->valuestore->has('tenant_id'));
|
||||
|
||||
if ($shouldEndTenancy) {
|
||||
tenancy()->end();
|
||||
}
|
||||
|
||||
$this->artisan('queue:work --once');
|
||||
|
||||
$this->assertSame(0, DB::connection('central')->table('failed_jobs')->count());
|
||||
|
||||
$this->assertSame('The current tenant id is: ' . $tenant->id, $this->valuestore->get('tenant_id'));
|
||||
|
||||
$tenant->run(function () use ($user) {
|
||||
$this->assertSame('Bar', $user->fresh()->name);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*
|
||||
* @testWith [true]
|
||||
* [false]
|
||||
*/
|
||||
public function tenancy_is_initialized_when_retrying_jobs(bool $shouldEndTenancy)
|
||||
{
|
||||
if (! Str::startsWith(app()->version(), '8')) {
|
||||
$this->markTestSkipped('queue:retry tenancy is only supported in Laravel 8');
|
||||
}
|
||||
|
||||
$this->withFailedJobs();
|
||||
$this->withTenantDatabases();
|
||||
|
||||
$tenant = Tenant::create();
|
||||
|
||||
tenancy()->initialize($tenant);
|
||||
|
||||
$this->withUsers();
|
||||
|
||||
$user = User::create(['name' => 'Foo', 'email' => 'foo@bar.com', 'password' => 'secret']);
|
||||
|
||||
$this->valuestore->put('userName', 'Bar');
|
||||
$this->valuestore->put('shouldFail', true);
|
||||
|
||||
dispatch(new TestJob($this->valuestore, $user));
|
||||
|
||||
$this->assertFalse($this->valuestore->has('tenant_id'));
|
||||
|
||||
if ($shouldEndTenancy) {
|
||||
tenancy()->end();
|
||||
}
|
||||
|
||||
$this->artisan('queue:work --once');
|
||||
|
||||
$this->assertSame(1, DB::connection('central')->table('failed_jobs')->count());
|
||||
$this->assertNull($this->valuestore->get('tenant_id')); // job failed
|
||||
|
||||
$this->artisan('queue:retry all');
|
||||
$this->artisan('queue:work --once');
|
||||
|
||||
$this->assertSame(0, DB::connection('central')->table('failed_jobs')->count());
|
||||
|
||||
$this->assertSame('The current tenant id is: ' . $tenant->id, $this->valuestore->get('tenant_id')); // job succeeded
|
||||
|
||||
$tenant->run(function () use ($user) {
|
||||
$this->assertSame('Bar', $user->fresh()->name);
|
||||
});
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function the_tenant_used_by_the_job_doesnt_change_when_the_current_tenant_changes()
|
||||
{
|
||||
$tenant1 = Tenant::create([
|
||||
'id' => 'acme',
|
||||
]);
|
||||
|
||||
tenancy()->initialize($tenant1);
|
||||
|
||||
dispatch(new TestJob($this->valuestore));
|
||||
|
||||
$tenant2 = Tenant::create([
|
||||
'id' => 'foobar',
|
||||
]);
|
||||
|
||||
tenancy()->initialize($tenant2);
|
||||
|
||||
$this->assertFalse($this->valuestore->has('tenant_id'));
|
||||
$this->artisan('queue:work --once');
|
||||
|
||||
$this->assertSame('The current tenant id is: acme', $this->valuestore->get('tenant_id'));
|
||||
}
|
||||
test()->valuestore = Valuestore::make($valueStorePath)->flush();
|
||||
}
|
||||
|
||||
class TestJob implements ShouldQueue
|
||||
function withFailedJobs()
|
||||
{
|
||||
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
|
||||
Schema::connection('central')->create('failed_jobs', function (Blueprint $table) {
|
||||
$table->increments('id');
|
||||
$table->string('uuid')->unique();
|
||||
$table->text('connection');
|
||||
$table->text('queue');
|
||||
$table->longText('payload');
|
||||
$table->longText('exception');
|
||||
$table->timestamp('failed_at')->useCurrent();
|
||||
});
|
||||
}
|
||||
|
||||
/** @var Valuestore */
|
||||
protected $valuestore;
|
||||
function withUsers()
|
||||
{
|
||||
Schema::create('users', function (Blueprint $table) {
|
||||
$table->increments('id');
|
||||
$table->string('name');
|
||||
$table->string('email')->unique();
|
||||
$table->string('password');
|
||||
$table->rememberToken();
|
||||
$table->timestamps();
|
||||
});
|
||||
}
|
||||
|
||||
/** @var User|null */
|
||||
protected $user;
|
||||
function withTenantDatabases()
|
||||
{
|
||||
Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) {
|
||||
return $event->tenant;
|
||||
})->toListener());
|
||||
}
|
||||
|
||||
public function __construct(Valuestore $valuestore, User $user = null)
|
||||
{
|
||||
$this->valuestore = $valuestore;
|
||||
$this->user = $user;
|
||||
function __construct(Valuestore $valuestore, User $user = null)
|
||||
{
|
||||
test()->valuestore = $valuestore;
|
||||
test()->user = $user;
|
||||
}
|
||||
|
||||
function handle()
|
||||
{
|
||||
if (test()->valuestore->get('shouldFail')) {
|
||||
test()->valuestore->put('shouldFail', false);
|
||||
|
||||
throw new Exception('failing');
|
||||
}
|
||||
|
||||
public function handle()
|
||||
{
|
||||
if ($this->valuestore->get('shouldFail')) {
|
||||
$this->valuestore->put('shouldFail', false);
|
||||
if (test()->user) {
|
||||
assert(test()->user->getConnectionName() === 'tenant');
|
||||
}
|
||||
|
||||
throw new Exception('failing');
|
||||
}
|
||||
test()->valuestore->put('tenant_id', 'The current tenant id is: ' . tenant('id'));
|
||||
|
||||
if ($this->user) {
|
||||
assert($this->user->getConnectionName() === 'tenant');
|
||||
}
|
||||
|
||||
$this->valuestore->put('tenant_id', 'The current tenant id is: ' . tenant('id'));
|
||||
|
||||
if ($userName = $this->valuestore->get('userName')) {
|
||||
$this->user->update(['name' => $userName]);
|
||||
}
|
||||
if ($userName = test()->valuestore->get('userName')) {
|
||||
test()->user->update(['name' => $userName]);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue