Add a phpunit comparator for models

Author: Oliver Nybroe

src/Illuminate/Foundation/Providers/FoundationServiceProvider.php

@@ -8,6 +8,7 @@
 use Illuminate\Support\Facades\URL;
 use Illuminate\Testing\LoggedExceptionCollection;
 use Illuminate\Testing\ParallelTestingServiceProvider;
+use Illuminate\Testing\TestingServiceProvider;
 use Illuminate\Validation\ValidationException;
 
 class FoundationServiceProvider extends AggregateServiceProvider
@@ -20,6 +21,7 @@ class FoundationServiceProvider extends AggregateServiceProvider
     protected $providers = [
         FormRequestServiceProvider::class,
         ParallelTestingServiceProvider::class,
+        TestingServiceProvider::class,
     ];
 
     /**

src/Illuminate/Testing/Comparators/ModelComparator.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Illuminate\Testing\Comparators;
+
+use Illuminate\Database\Eloquent\Model;
+use SebastianBergmann\Comparator\Comparator;
+use SebastianBergmann\Comparator\ComparisonFailure;
+
+class ModelComparator extends Comparator
+{
+    public function accepts($expected, $actual): bool
+    {
+        return $expected instanceof Model && $actual instanceof Model;
+    }
+
+    /**
+     * @param Model $expected
+     * @param Model $actual
+     */
+    public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false): void
+    {
+        if (! $expected->is($actual)) {
+            throw new ComparisonFailure(
+                $expected,
+                $actual,
+                "{$expected->getMorphClass()}::{$expected->getKey()}",
+                "{$actual->getMorphClass()}::{$actual->getKey()}",
+            );
+        }
+    }
+}

src/Illuminate/Testing/TestingServiceProvider.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Illuminate\Testing;
+
+use Illuminate\Contracts\Support\DeferrableProvider;
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Testing\Comparators\ModelComparator;
+use SebastianBergmann\Comparator\Factory;
+
+class TestingServiceProvider extends ServiceProvider
+{
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $comparatorFactory = Factory::getInstance();
+        $comparatorFactory->register(new ModelComparator());
+    }
+}

tests/Testing/Comparators/ModelComparatorTest.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Illuminate\Tests\Testing\Comparators;
+
+use Illuminate\Database\Eloquent\Model;
+use Orchestra\Testbench\TestCase;
+
+class ModelComparatorTest extends TestCase
+{
+    public function testIsEqual()
+    {
+        $modelA = new TestModel([
+            'id' => 100,
+        ]);
+        $modelB = new TestModel([
+            'id' => 100,
+        ]);
+
+        $this->assertEquals($modelA, $modelB);
+    }
+
+    public function testIgnoresProperties()
+    {
+        $modelA = new TestModel([
+            'id' => 100,
+            'text' => 'good',
+        ]);
+        $modelB = new TestModel([
+            'id' => 100,
+            'text' => 'bad',
+        ]);
+
+        $this->assertEquals($modelA, $modelB);
+    }
+
+    public function testIsNotEqualIfDifferentKey()
+    {
+        $modelA = new TestModel([
+            'id' => 100,
+        ]);
+        $modelB = new TestModel([
+            'id' => 200,
+        ]);
+
+        $this->assertNotEquals($modelA, $modelB);
+    }
+
+    public function testIsNotEqualIfDifferentTable()
+    {
+        $modelA = new TestModel([
+            'id' => 100,
+        ]);
+        $modelA->setTable('table_a');
+        $modelB = new TestModel([
+            'id' => 100,
+        ]);
+        $modelB->setTable('table_b');
+
+        $this->assertNotEquals($modelA, $modelB);
+    }
+
+    public function testIsNotEqualIfDifferentConnection()
+    {
+        $modelA = new TestModel([
+            'id' => 100,
+        ]);
+        $modelA->setConnection('good');
+        $modelB = new TestModel([
+            'id' => 100,
+        ]);
+        $modelA->setConnection('bad');
+
+        $this->assertNotEquals($modelA, $modelB);
+    }
+}
+
+class TestModel extends Model {
+    protected $guarded = [];
+}