Improve RLS policies test, move setup things to beforeEach, scaffold test for scoping queries

tests/PostgresTest.php

@@ -3,22 +3,62 @@
 declare(strict_types=1);
 
 use Illuminate\Support\Facades\DB;
+use Stancl\Tenancy\Tests\Etc\Post;
 use Stancl\Tenancy\Tests\Etc\Tenant;
 use Illuminate\Support\Facades\Schema;
 use Illuminate\Database\Schema\Blueprint;
 use Stancl\Tenancy\Jobs\DeleteTenantsPostgresUser;
 use Stancl\Tenancy\Jobs\CreatePostgresUserForTenant;
-use Stancl\Tenancy\Actions\CreateRLSPoliciesForTables;
+use Stancl\Tenancy\Tests\Etc\ScopedComment;
 
 beforeEach(function () {
     DB::setDefaultConnection('pgsql');
 
-    config(['tenancy.models.tenant' => Tenant::class]);
+    config(['tenancy.models.tenant_key_column' => 'tenant_id']);
+    config(['tenancy.models.tenant' => $tenantClass = Tenant::class]);
+    config(['tenancy.models.rls' => [
+        $primaryModelClass = Post::class, // Primary model (directly belongs to tenant)
+        $secondaryModelClass = ScopedComment::class, // Secondary model (belongs to tenant through a primary model)
+    ]]);
+
+    $tenantModel = new $tenantClass;
+    $primaryModel = new $primaryModelClass;
+    $secondaryModel = new $secondaryModelClass;
+
+    $tenantTable = $tenantModel->getTable();
 
     // Drop all existing policies
     foreach (DB::select('select * from pg_policies') as $policy) {
         DB::statement("DROP POLICY IF EXISTS {$policy->policyname} ON {$policy->tablename};");
     }
+
+    Schema::dropIfExists($secondaryModel->getTable());
+    Schema::dropIfExists($primaryModel->getTable());
+
+    if(! Schema::hasTable($tenantTable)) {
+        Schema::create($tenantTable, function (Blueprint $table) {
+            $table->string('id')->primary();
+
+            $table->timestamps();
+            $table->json('data')->nullable();
+        });
+    }
+
+    Schema::create($primaryModel->getTable(), function (Blueprint $table) use ($tenantTable) {
+        $table->increments('id');
+        $table->string('text');
+        $table->string($tenantKey = config('tenancy.models.tenant_key_column'));
+
+        $table->foreign($tenantKey)->references('id')->on($tenantTable)->onUpdate('cascade')->onDelete('cascade');
+    });
+
+    Schema::create($secondaryModel->getTable(), function (Blueprint $table) use ($primaryModel) {
+        $table->increments('id');
+        $table->string('text');
+        $table->unsignedInteger($primaryModel->getForeignKey());
+
+        $table->foreign($primaryModel->getForeignKey())->references('id')->on($primaryModel->getTable())->onUpdate('cascade')->onDelete('cascade');
+    });
 });
 
 test('postgres user can get created using the job', function() {
@@ -50,68 +90,10 @@ test('postgres user can get deleted using the job', function() {
 });
 
 test('correct rls policies get created', function () {
-    config([
+    $rlsModels = config('tenancy.models.rls');
-        'tenancy.models.rls' => [
+    $modelTables = collect($rlsModels)->map(fn (string $model) => (new $model)->getTable());
-            Post::class, // Primary model (directly belongs to tenant)
-        ],
-    ]);
-
-    // Schema::dropIfExists('tenants');
-    Schema::dropIfExists('comments');
-    Schema::dropIfExists('posts');
-
-    if(! Schema::hasTable('tenants')) {
-        Schema::create('tenants', function (Blueprint $table) {
-            $table->string('id')->primary();
-
-            $table->timestamps();
-            $table->json('data')->nullable();
-        });
-    }
-
-    Schema::create('posts', function (Blueprint $table) {
-        $table->increments('id');
-        $table->string('text');
-
-        $table->string('tenant_id');
-
-        $table->foreign('tenant_id')->references('id')->on('tenants')->onUpdate('cascade')->onDelete('cascade');
-    });
-
-    Schema::create('comments', function (Blueprint $table) {
-        $table->increments('id');
-        $table->string('text');
-
-        $table->unsignedInteger('post_id');
-
-        $table->foreign('post_id')->references('id')->on('posts')->onUpdate('cascade')->onDelete('cascade');
-    });
-
     $getRlsPolicies = fn () => DB::select('select * from pg_policies');
-    $getRlsModels = fn () => config('tenancy.models.rls');
+    $getRlsTables = fn() => $modelTables->map(fn ($table) => DB::select('select relname, relrowsecurity, relforcerowsecurity from pg_class WHERE oid = ' . "'$table'::regclass"))->collapse();
-    $getModelTables = fn () => collect($getRlsModels())->map(fn (string $model) => (new $model)->getTable());
-    $getRlsTables = fn() => $getModelTables()->map(fn ($table) => DB::select('select relname, relrowsecurity, relforcerowsecurity from pg_class WHERE oid = ' . "'$table'::regclass"))->collapse();
-
-    expect($getRlsPolicies())->toHaveCount(0);
-
-    pest()->artisan('tenants:create-rls-policies');
-
-    expect($getRlsPolicies())->toHaveCount(count($getRlsModels())); // 1
-    expect($getRlsTables())->toHaveCount(count($getRlsModels())); // 1
-
-    // Check if RLS is forced on tables with the policies
-    foreach ($getRlsTables() as $table) {
-        expect($getModelTables())->toContain($table->relname);
-        expect($table->relforcerowsecurity)->toBeTrue();
-    }
-
-    config([
-        'tenancy.models.rls' => array_merge([
-            ScopedComment::class, // Add secondary model to RLS protected models (belongs to tenant through Post)
-        ], $getRlsModels()),
-    ]);
-
-    expect(count($getRlsModels()))->toBe(2); // Post::class + ScopedComment::class
 
     // Drop all existing policies to check if the command creates policies for multiple tables
     foreach ($getRlsPolicies() as $policy) {
@@ -125,11 +107,20 @@ test('correct rls policies get created', function () {
     // Check if all 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
     // For the command to create the policy correctly for the model's table
-    expect($getRlsPolicies())->toHaveCount(count($getRlsModels())); // 2
+    expect($getRlsPolicies())->toHaveCount(count($rlsModels)); // 2
-    expect($getRlsTables())->toHaveCount(count($getRlsModels())); // 2
+    expect($getRlsTables())->toHaveCount(count($rlsModels)); // 2
 
     foreach ($getRlsTables() as $table) {
-        expect($getModelTables())->toContain($table->relname);
+        expect($modelTables)->toContain($table->relname);
         expect($table->relforcerowsecurity)->toBeTrue();
     }
 });
+
+test('queries are correctly scoped using RLS', function() {
+    // todo1
+    // 1) create rls policies for tables
+    // 2) create two tenants with postgres users
+    // 3) create posts and comments for both tenants
+    // 4) ensure RLS scopes the queries – disable the global scopes that the single-db tenancy traits add to the models
+    // 5) expect that tenants cannot access the records (posts and comments) of other tenants
+})->skip();