[12.x] Fix model pruning when non model files are in the same directory (#56071)

* Allow using the `--path` parameter in `PruneCommandTest`

* Add broken example

* Filter out non Eloquent model classes

* Break example with abstract model

* Expand string assertion

* Exclude abstract models from pruning

Author: rojtjo

src/Illuminate/Database/Console/PruneCommand.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Events\ModelPruningFinished;
 use Illuminate\Database\Events\ModelPruningStarting;
 use Illuminate\Database\Events\ModelsPruned;
@@ -137,8 +138,7 @@ protected function models()
                 );
             })
             ->when(! empty($except), fn ($models) => $models->reject(fn ($model) => in_array($model, $except)))
-            ->filter(fn ($model) => class_exists($model))
-            ->filter(fn ($model) => $model::isPrunable())
+            ->filter(fn ($model) => $this->isPrunable($model))
             ->values();
     }
 
@@ -179,4 +179,18 @@ protected function pretendToPrune($model)
             $this->components->info("{$count} [{$model}] records will be pruned.");
         }
     }
+
+    /**
+     * Determine if the given model is prunable.
+     *
+     * @param  string  $model
+     * @return bool
+     */
+    private function isPrunable(string $model)
+    {
+        return class_exists($model)
+            && is_a($model, Model::class, true)
+            && ! (new \ReflectionClass($model))->isAbstract()
+            && $model::isPrunable();
+    }
 }

tests/Database/PruneCommandTest.php

@@ -6,10 +6,6 @@
 use Illuminate\Contracts\Events\Dispatcher as DispatcherContract;
 use Illuminate\Database\Capsule\Manager as DB;
 use Illuminate\Database\Console\PruneCommand;
-use Illuminate\Database\Eloquent\MassPrunable;
-use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Prunable;
-use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Database\Events\ModelPruningFinished;
 use Illuminate\Database\Events\ModelPruningStarting;
 use Illuminate\Database\Events\ModelsPruned;
@@ -26,7 +22,15 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        Application::setInstance($container = new Application);
+        Application::setInstance($container = new Application(__DIR__.'/Pruning'));
+
+        Closure::bind(
+            fn () => $this->namespace = 'Illuminate\\Tests\\Database\\Pruning\\',
+            $container,
+            Application::class,
+        )();
+
+        $container->useAppPath(__DIR__.'/Pruning');
 
         $container->singleton(DispatcherContract::class, function () {
             return new Dispatcher();
@@ -37,12 +41,12 @@ protected function setUp(): void
 
     public function testPrunableModelWithPrunableRecords()
     {
-        $output = $this->artisan(['--model' => PrunableTestModelWithPrunableRecords::class]);
+        $output = $this->artisan(['--model' => Pruning\Models\PrunableTestModelWithPrunableRecords::class]);
 
         $output = $output->fetch();
 
         $this->assertStringContainsString(
-            'Illuminate\Tests\Database\PrunableTestModelWithPrunableRecords',
+            'Illuminate\Tests\Database\Pruning\Models\PrunableTestModelWithPrunableRecords',
             $output,
         );
 
@@ -52,7 +56,7 @@ public function testPrunableModelWithPrunableRecords()
         );
 
         $this->assertStringContainsString(
-            'Illuminate\Tests\Database\PrunableTestModelWithPrunableRecords',
+            'Illuminate\Tests\Database\Pruning\Models\PrunableTestModelWithPrunableRecords',
             $output,
         );
 
@@ -64,10 +68,10 @@ public function testPrunableModelWithPrunableRecords()
 
     public function testPrunableTestModelWithoutPrunableRecords()
     {
-        $output = $this->artisan(['--model' => PrunableTestModelWithoutPrunableRecords::class]);
+        $output = $this->artisan(['--model' => Pruning\Models\PrunableTestModelWithoutPrunableRecords::class]);
 
         $this->assertStringContainsString(
-            'No prunable [Illuminate\Tests\Database\PrunableTestModelWithoutPrunableRecords] records found.',
+            'No prunable [Illuminate\Tests\Database\Pruning\Models\PrunableTestModelWithoutPrunableRecords] records found.',
             $output->fetch()
         );
     }
@@ -92,12 +96,12 @@ public function testPrunableSoftDeletedModelWithPrunableRecords()
             ['value' => 4, 'deleted_at' => '2021-12-02 00:00:00'],
         ]);
 
-        $output = $this->artisan(['--model' => PrunableTestSoftDeletedModelWithPrunableRecords::class]);
+        $output = $this->artisan(['--model' => Pruning\Models\PrunableTestSoftDeletedModelWithPrunableRecords::class]);
 
         $output = $output->fetch();
 
         $this->assertStringContainsString(
-            'Illuminate\Tests\Database\PrunableTestSoftDeletedModelWithPrunableRecords',
+            'Illuminate\Tests\Database\Pruning\Models\PrunableTestSoftDeletedModelWithPrunableRecords',
             $output,
         );
 
@@ -106,29 +110,51 @@ public function testPrunableSoftDeletedModelWithPrunableRecords()
             $output,
         );
 
-        $this->assertEquals(2, PrunableTestSoftDeletedModelWithPrunableRecords::withTrashed()->count());
+        $this->assertEquals(2, Pruning\Models\PrunableTestSoftDeletedModelWithPrunableRecords::withTrashed()->count());
     }
 
     public function testNonPrunableTest()
     {
-        $output = $this->artisan(['--model' => NonPrunableTestModel::class]);
+        $output = $this->artisan(['--model' => Pruning\Models\NonPrunableTestModel::class]);
 
         $this->assertStringContainsString(
-            'No prunable [Illuminate\Tests\Database\NonPrunableTestModel] records found.',
+            'No prunable [Illuminate\Tests\Database\Pruning\Models\NonPrunableTestModel] records found.',
             $output->fetch(),
         );
     }
 
     public function testNonPrunableTestWithATrait()
     {
-        $output = $this->artisan(['--model' => NonPrunableTrait::class]);
+        $output = $this->artisan(['--model' => Pruning\Models\NonPrunableTrait::class]);
 
         $this->assertStringContainsString(
             'No prunable models found.',
             $output->fetch(),
         );
     }
 
+    public function testNonModelFilesAreIgnoredTest()
+    {
+        $output = $this->artisan(['--path' => 'Models']);
+
+        $output = $output->fetch();
+
+        $this->assertStringNotContainsString(
+            'No prunable [Illuminate\Tests\Database\Pruning\Models\AbstractPrunableModel] records found.',
+            $output,
+        );
+
+        $this->assertStringNotContainsString(
+            'No prunable [Illuminate\Tests\Database\Pruning\Models\SomeClass] records found.',
+            $output,
+        );
+
+        $this->assertStringNotContainsString(
+            'No prunable [Illuminate\Tests\Database\Pruning\Models\SomeEnum] records found.',
+            $output,
+        );
+    }
+
     public function testTheCommandMayBePretended()
     {
         $db = new DB;
@@ -151,16 +177,16 @@ public function testTheCommandMayBePretended()
         ]);
 
         $output = $this->artisan([
-            '--model' => PrunableTestModelWithPrunableRecords::class,
+            '--model' => Pruning\Models\PrunableTestModelWithPrunableRecords::class,
             '--pretend' => true,
         ]);
 
         $this->assertStringContainsString(
-            '3 [Illuminate\Tests\Database\PrunableTestModelWithPrunableRecords] records will be pruned.',
+            '3 [Illuminate\Tests\Database\Pruning\Models\PrunableTestModelWithPrunableRecords] records will be pruned.',
             $output->fetch(),
         );
 
-        $this->assertEquals(5, PrunableTestModelWithPrunableRecords::count());
+        $this->assertEquals(5, Pruning\Models\PrunableTestModelWithPrunableRecords::count());
     }
 
     public function testTheCommandMayBePretendedOnSoftDeletedModel()
@@ -184,16 +210,16 @@ public function testTheCommandMayBePretendedOnSoftDeletedModel()
         ]);
 
         $output = $this->artisan([
-            '--model' => PrunableTestSoftDeletedModelWithPrunableRecords::class,
+            '--model' => Pruning\Models\PrunableTestSoftDeletedModelWithPrunableRecords::class,
             '--pretend' => true,
         ]);
 
         $this->assertStringContainsString(
-            '2 [Illuminate\Tests\Database\PrunableTestSoftDeletedModelWithPrunableRecords] records will be pruned.',
+            '2 [Illuminate\Tests\Database\Pruning\Models\PrunableTestSoftDeletedModelWithPrunableRecords] records will be pruned.',
             $output->fetch(),
         );
 
-        $this->assertEquals(4, PrunableTestSoftDeletedModelWithPrunableRecords::withTrashed()->count());
+        $this->assertEquals(4, Pruning\Models\PrunableTestSoftDeletedModelWithPrunableRecords::withTrashed()->count());
     }
 
     public function testTheCommandDispatchesEvents()
@@ -202,19 +228,19 @@ public function testTheCommandDispatchesEvents()
 
         $dispatcher->shouldReceive('dispatch')->once()->withArgs(function ($event) {
             return get_class($event) === ModelPruningStarting::class &&
-                $event->models === [PrunableTestModelWithPrunableRecords::class];
+                $event->models === [Pruning\Models\PrunableTestModelWithPrunableRecords::class];
         });
         $dispatcher->shouldReceive('listen')->once()->with(ModelsPruned::class, m::type(Closure::class));
         $dispatcher->shouldReceive('dispatch')->twice()->with(m::type(ModelsPruned::class));
         $dispatcher->shouldReceive('dispatch')->once()->withArgs(function ($event) {
             return get_class($event) === ModelPruningFinished::class &&
-                $event->models === [PrunableTestModelWithPrunableRecords::class];
+                $event->models === [Pruning\Models\PrunableTestModelWithPrunableRecords::class];
         });
         $dispatcher->shouldReceive('forget')->once()->with(ModelsPruned::class);
 
         Application::getInstance()->instance(DispatcherContract::class, $dispatcher);
 
-        $this->artisan(['--model' => PrunableTestModelWithPrunableRecords::class]);
+        $this->artisan(['--model' => Pruning\Models\PrunableTestModelWithPrunableRecords::class]);
     }
 
     protected function artisan($arguments)
@@ -238,57 +264,3 @@ protected function tearDown(): void
         m::close();
     }
 }
-
-class PrunableTestModelWithPrunableRecords extends Model
-{
-    use MassPrunable;
-
-    protected $table = 'prunables';
-    protected $connection = 'default';
-
-    public function pruneAll()
-    {
-        event(new ModelsPruned(static::class, 10));
-        event(new ModelsPruned(static::class, 20));
-
-        return 20;
-    }
-
-    public function prunable()
-    {
-        return static::where('value', '>=', 3);
-    }
-}
-
-class PrunableTestSoftDeletedModelWithPrunableRecords extends Model
-{
-    use MassPrunable, SoftDeletes;
-
-    protected $table = 'prunables';
-    protected $connection = 'default';
-
-    public function prunable()
-    {
-        return static::where('value', '>=', 3);
-    }
-}
-
-class PrunableTestModelWithoutPrunableRecords extends Model
-{
-    use Prunable;
-
-    public function pruneAll()
-    {
-        return 0;
-    }
-}
-
-class NonPrunableTestModel extends Model
-{
-    // ..
-}
-
-trait NonPrunableTrait
-{
-    use Prunable;
-}

tests/Database/Pruning/Models/AbstractPrunableModel.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Illuminate\Tests\Database\Pruning\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Prunable;
+
+abstract class AbstractPrunableModel extends Model
+{
+    use Prunable;
+}

tests/Database/Pruning/Models/NonPrunableTestModel.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Illuminate\Tests\Database\Pruning\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class NonPrunableTestModel extends Model
+{
+    // ..
+}

tests/Database/Pruning/Models/NonPrunableTrait.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Illuminate\Tests\Database\Pruning\Models;
+
+use Illuminate\Database\Eloquent\Prunable;
+
+trait NonPrunableTrait
+{
+    use Prunable;
+}

tests/Database/Pruning/Models/PrunableTestModelWithPrunableRecords.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Illuminate\Tests\Database\Pruning\Models;
+
+use Illuminate\Database\Eloquent\MassPrunable;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Events\ModelsPruned;
+
+class PrunableTestModelWithPrunableRecords extends Model
+{
+    use MassPrunable;
+
+    protected $table = 'prunables';
+    protected $connection = 'default';
+
+    public function pruneAll()
+    {
+        event(new ModelsPruned(static::class, 10));
+        event(new ModelsPruned(static::class, 20));
+
+        return 20;
+    }
+
+    public function prunable()
+    {
+        return static::where('value', '>=', 3);
+    }
+}

tests/Database/Pruning/Models/PrunableTestModelWithoutPrunableRecords.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Illuminate\Tests\Database\Pruning\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Prunable;
+
+class PrunableTestModelWithoutPrunableRecords extends Model
+{
+    use Prunable;
+
+    public function pruneAll()
+    {
+        return 0;
+    }
+}