mirror of
https://github.com/archtechx/tenancy.git
synced 2026-02-05 14:14:03 +00:00
Test if policies get created correctly using action
This commit is contained in:
parent
338d6f1151
commit
562d507482
2 changed files with 87 additions and 4 deletions
71
src/Actions/CreateRLSPoliciesForTables.php
Normal file
71
src/Actions/CreateRLSPoliciesForTables.php
Normal file
|
|
@ -0,0 +1,71 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Stancl\Tenancy\Actions;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Support\Facades\DB;
|
||||||
|
use Illuminate\Support\Facades\Schema;
|
||||||
|
use Stancl\Tenancy\Database\Concerns\BelongsToPrimaryModel;
|
||||||
|
|
||||||
|
class CreateRLSPoliciesForTables
|
||||||
|
{
|
||||||
|
// protected $signature = 'tenants:create-rls-policies';
|
||||||
|
|
||||||
|
public static function handle()
|
||||||
|
{
|
||||||
|
$tenantModels = static::getTenantModels();
|
||||||
|
$tenantKey = config('tenancy.models.tenant_key_column');
|
||||||
|
|
||||||
|
foreach ($tenantModels as $model) {
|
||||||
|
$table = $model->getTable();
|
||||||
|
|
||||||
|
DB::statement("DROP POLICY IF EXISTS {$table}_rls_policy ON {$table}");
|
||||||
|
|
||||||
|
if (! Schema::hasColumn($table, $tenantKey)) {
|
||||||
|
// Table is not directly related to tenant
|
||||||
|
if (in_array(BelongsToPrimaryModel::class, class_uses_recursive($model::class))) {
|
||||||
|
$parentName = $model->getRelationshipToPrimaryModel();
|
||||||
|
$parentKey = $model->$parentName()->getForeignKeyName();
|
||||||
|
$parentModel = $model->$parentName()->make();
|
||||||
|
$parentTable = str($parentModel->getTable())->toString();
|
||||||
|
|
||||||
|
DB::statement("CREATE POLICY {$table}_rls_policy ON {$table} USING (
|
||||||
|
{$parentKey} IN (
|
||||||
|
SELECT id
|
||||||
|
FROM {$parentTable}
|
||||||
|
WHERE ({$tenantKey}::TEXT = (
|
||||||
|
SELECT {$tenantKey}
|
||||||
|
FROM {$parentTable}
|
||||||
|
WHERE id = {$parentKey}
|
||||||
|
))
|
||||||
|
)
|
||||||
|
)");
|
||||||
|
|
||||||
|
DB::statement("ALTER TABLE {$table} FORCE ROW LEVEL SECURITY");
|
||||||
|
|
||||||
|
return Command::SUCCESS;
|
||||||
|
} else {
|
||||||
|
$modelName = $model::class;
|
||||||
|
// $this->components->info("Table '$table' is not related to tenant. Make sure $modelName uses the BelongsToPrimaryModel trait.");
|
||||||
|
|
||||||
|
return Command::FAILURE;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
DB::statement("CREATE POLICY {$table}_rls_policy ON {$table} USING ({$tenantKey}::TEXT = current_user);");
|
||||||
|
|
||||||
|
DB::statement("ALTER TABLE {$table} FORCE ROW LEVEL SECURITY");
|
||||||
|
|
||||||
|
// $this->components->info("Created RLS policy for table '$table'");
|
||||||
|
}
|
||||||
|
|
||||||
|
return Command::SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function getTenantModels(): array
|
||||||
|
{
|
||||||
|
return array_map(fn (string $modelName) => (new $modelName), config('tenancy.models.rls'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -6,6 +6,7 @@ use Illuminate\Support\Facades\DB;
|
||||||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||||
use Stancl\Tenancy\Jobs\DeleteTenantsPostgresUser;
|
use Stancl\Tenancy\Jobs\DeleteTenantsPostgresUser;
|
||||||
use Stancl\Tenancy\Jobs\CreatePostgresUserForTenant;
|
use Stancl\Tenancy\Jobs\CreatePostgresUserForTenant;
|
||||||
|
use Stancl\Tenancy\Actions\CreateRLSPoliciesForTables;
|
||||||
|
|
||||||
beforeEach(function () {
|
beforeEach(function () {
|
||||||
DB::setDefaultConnection('pgsql');
|
DB::setDefaultConnection('pgsql');
|
||||||
|
|
@ -45,7 +46,7 @@ test('postgres user can get deleted using the job', function() {
|
||||||
expect($tenantHasPostgresUser())->toBeFalse();
|
expect($tenantHasPostgresUser())->toBeFalse();
|
||||||
});
|
});
|
||||||
|
|
||||||
test('correct rls policies get created using the command', function() {
|
test('correct rls policies get created using the action or the command', function(bool $action) {
|
||||||
config([
|
config([
|
||||||
'tenancy.models.rls' => [
|
'tenancy.models.rls' => [
|
||||||
Post::class, // Primary model (directly belongs to tenant)
|
Post::class, // Primary model (directly belongs to tenant)
|
||||||
|
|
@ -57,7 +58,13 @@ test('correct rls policies get created using the command', function() {
|
||||||
$getRlsTables = fn() => $getModelTables()->map(fn ($table) => DB::select('select relname, relrowsecurity, relforcerowsecurity from pg_class WHERE oid = ' . "'$table'::regclass"))->collapse();
|
$getRlsTables = fn() => $getModelTables()->map(fn ($table) => DB::select('select relname, relrowsecurity, relforcerowsecurity from pg_class WHERE oid = ' . "'$table'::regclass"))->collapse();
|
||||||
|
|
||||||
expect($getRlsPolicies())->toHaveCount(0);
|
expect($getRlsPolicies())->toHaveCount(0);
|
||||||
|
|
||||||
|
if ($action) {
|
||||||
|
CreateRLSPoliciesForTables::handle();
|
||||||
|
} else {
|
||||||
pest()->artisan('tenants:create-rls-policies');
|
pest()->artisan('tenants:create-rls-policies');
|
||||||
|
}
|
||||||
|
|
||||||
expect($getRlsPolicies())->toHaveCount(count(config('tenancy.models.rls'))); // 1
|
expect($getRlsPolicies())->toHaveCount(count(config('tenancy.models.rls'))); // 1
|
||||||
expect($getRlsTables())->toHaveCount(count(config('tenancy.models.rls'))); // 1
|
expect($getRlsTables())->toHaveCount(count(config('tenancy.models.rls'))); // 1
|
||||||
// Check if tables with policies are RLS protected
|
// Check if tables with policies are RLS protected
|
||||||
|
|
@ -72,7 +79,12 @@ test('correct rls policies get created using the command', function() {
|
||||||
], config('tenancy.models.rls')),
|
], config('tenancy.models.rls')),
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
if ($action) {
|
||||||
|
CreateRLSPoliciesForTables::handle();
|
||||||
|
} else {
|
||||||
pest()->artisan('tenants:create-rls-policies');
|
pest()->artisan('tenants:create-rls-policies');
|
||||||
|
}
|
||||||
|
|
||||||
// Check if tables with policies are RLS protected (even the ones not directly related to the tenant)
|
// Check if tables with policies are RLS protected (even the ones not directly related to the tenant)
|
||||||
// Models related to tenant through some model must use the BelongsToPrimaryModel trait to work properly
|
// Models related to tenant through some model must use the BelongsToPrimaryModel trait to work properly
|
||||||
expect($getRlsPolicies())->toHaveCount(count(config('tenancy.models.rls'))); // 2
|
expect($getRlsPolicies())->toHaveCount(count(config('tenancy.models.rls'))); // 2
|
||||||
|
|
@ -82,4 +94,4 @@ test('correct rls policies get created using the command', function() {
|
||||||
expect($getModelTables())->toContain($table->relname);
|
expect($getModelTables())->toContain($table->relname);
|
||||||
expect($table->relforcerowsecurity)->toBeTrue();
|
expect($table->relforcerowsecurity)->toBeTrue();
|
||||||
}
|
}
|
||||||
});
|
})->with([true, false]);
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue