add model assertion that two models are related

Author: aidan-casey

src/Laravel/ModelAssertions.php

@@ -3,6 +3,8 @@
 namespace Astrotomic\PhpunitAssertions\Laravel;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Testing\Constraints\HasInDatabase;
 use PHPUnit\Framework\Assert as PHPUnit;
@@ -33,4 +35,14 @@ public static function assertSame(Model $expected, $actual): void
         PHPUnit::assertSame($expected->exists, $actual->exists);
         PHPUnit::assertTrue($expected->is($actual));
     }
+
+    public static function assertRelated(Model $model, $actual, string $relation)
+    {
+        PHPUnit::assertInstanceOf(Model::class, $actual);
+        PHPUnit::assertTrue(method_exists($model, $relation));
+        PHPUnit::assertInstanceOf(Relation::class, $model->$relation());
+
+        $related = $model->$relation()->whereKey($actual->getKey())->first();
+        self::assertSame($actual, $related);
+    }
 }

tests/Laravel/ModelAssertionsTest.php

@@ -3,7 +3,10 @@
 namespace Astrotomic\PhpunitAssertions\Tests\Laravel;
 
 use Astrotomic\PhpunitAssertions\Laravel\ModelAssertions;
+use Astrotomic\PhpunitAssertions\Tests\Laravel\Models\Comment;
+use Astrotomic\PhpunitAssertions\Tests\Laravel\Models\Post;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
@@ -13,11 +16,8 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        Schema::create('posts', static function (Blueprint $table): void {
-            $table->increments('id');
-            $table->string('title');
-            $table->timestamps();
-        });
+        Post::migrate();
+        Comment::migrate();
     }
 
     /**
@@ -26,15 +26,11 @@ protected function setUp(): void
      */
     public function it_can_validate_exists(): void
     {
-        $model = new class extends Model {
-            protected $table = 'posts';
-            protected $guarded = [];
-        };
+        $post = Post::create([
+            'title' => self::randomString(),
+        ]);
 
-        $model->title = self::randomString();
-        $model->save();
-
-        ModelAssertions::assertExists($model);
+        ModelAssertions::assertExists($post);
     }
 
     /**
@@ -43,14 +39,29 @@ public function it_can_validate_exists(): void
      */
     public function it_can_validate_same(): void
     {
-        $model = new class extends Model {
-            protected $table = 'posts';
-            protected $guarded = [];
-        };
+        $post = Post::create([
+            'title' => self::randomString(),
+        ]);
+
+        ModelAssertions::assertSame($post, Post::first());
+    }
+
+    /**
+     * @test
+     * @dataProvider hundredTimes
+     */
+    public function it_can_validate_related(): void
+    {
+        $post = Post::create([
+            'title' => self::randomString(),
+        ]);
 
-        $model->title = self::randomString();
-        $model->save();
+        $comment = Comment::create([
+            'message' => self::randomString(),
+            'post_id' => $post->getKey(),
+        ]);
 
-        ModelAssertions::assertSame($model, $model->query()->first());
+        ModelAssertions::assertRelated($post, $comment, 'comments');
+        ModelAssertions::assertRelated($comment, $post, 'post');
     }
 }

tests/Laravel/Models/Comment.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Astrotomic\PhpunitAssertions\Tests\Laravel\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class Comment extends Model
+{
+    protected $table = 'comments';
+    protected $guarded = [];
+
+    public static function migrate(): void
+    {
+        Schema::create((new self)->table, static function (Blueprint $table): void {
+            $table->increments('id');
+            $table->text('message');
+            $table->foreignId('post_id')->constrained('posts');
+            $table->timestamps();
+        });
+    }
+
+    public function post(): BelongsTo
+    {
+        return $this->belongsTo(Post::class);
+    }
+}

tests/Laravel/Models/Post.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Astrotomic\PhpunitAssertions\Tests\Laravel\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class Post extends Model
+{
+    protected $table = 'posts';
+    protected $guarded = [];
+
+    public static function migrate(): void
+    {
+        Schema::create((new self)->table, static function (Blueprint $table): void {
+            $table->increments('id');
+            $table->string('title');
+            $table->timestamps();
+        });
+    }
+
+    public function comments(): HasMany
+    {
+        return $this->hasMany(Comment::class);
+    }
+}