Fixing missing model import in generated tests for show-only controllers (#37)

Author: dmason30

.gitattributes

@@ -12,3 +12,5 @@
 /.php.cs            export-ignore
 /.github            export-ignore
 
+# Declare files that will always have LF line endings on checkout.
+/tests/__snapshots__/*.php text eol=lf

.styleci.yml

@@ -2,4 +2,5 @@ preset: laravel
 
 finder:
   exclude:
+    - "tests/__snapshots__"
     - "tests/fixtures"

composer.json

@@ -25,11 +25,12 @@
         "laravel-shift/blueprint": "^2.3"
     },
     "require-dev": {
-        "mockery/mockery": "^1.4.4",
-        "orchestra/testbench": "^7.0",
-        "pestphp/pest": "^1.21.1",
-        "phpunit/phpunit": "^9.3",
-        "vimeo/psalm": "^4.0"
+        "mockery/mockery": "^1.5.1",
+        "orchestra/testbench": "^7.22",
+        "pestphp/pest": "^1.22.4",
+        "phpunit/phpunit": "^9.6.3",
+        "spatie/pest-plugin-snapshots": "^1.1",
+        "vimeo/psalm": "^4.30"
     },
     "autoload": {
         "psr-4": {

src/Builders/Statements/InitialStatementBuilder.php

@@ -5,10 +5,13 @@
 use Blueprint\Models\Controller;
 use Blueprint\Models\Statements\SessionStatement;
 use Blueprint\Tree;
+use Fidum\BlueprintPestAddon\Builders\Concerns\DeterminesModels;
 use Fidum\BlueprintPestAddon\Builders\PendingOutput;
 
 class InitialStatementBuilder extends StatementBuilder
 {
+    use DeterminesModels;
+
     public function __construct(
         protected Controller $controller,
         protected string $methodName,
@@ -23,7 +26,9 @@ public function execute(): PendingOutput
         if (in_array($this->methodName, ['edit', 'update', 'show', 'destroy'])) {
             $model = $this->controller->prefix();
 
-            $this->output->addFactory($this->variable, $model);
+            $this->output
+                ->addFactory($this->variable, $model)
+                ->addImport($this->fullyQualifiedModelClassName($model));
         }
 
         return $this->output;

tests/Datasets/Pest.php

@@ -15,4 +15,5 @@
     'custom queries defined on controller routes' => ['query.yml', false, 2],
     'controller test created in specified subfolder' => ['subfolder.yml', false, 2, 0, [], false, false, 'Api'],
     'controller test created in specified subfolder with nested models' => ['subfolder_nested.yml', false, 2, 0, ['models_namespace' => 'Models'], false, false, 'Screening'],
+    'controller with single action' => ['single_action_controller.yml', true, 1, 1],
 ]);

tests/Feature/FeatureTestCase.php

@@ -61,12 +61,24 @@ protected function getExampleTestsOutput(bool $featureExists, bool $unitExists):
         $output = [];
 
         if ($featureExists) {
-            $this->files->expects('put')->with($this->exampleFeatureFile, $this->fixture($this->exampleFeatureFile));
+            $this->files->expects('put')->withArgs(function ($file, $content) {
+                $this->assertSame($this->exampleFeatureFile, $file);
+                $this->assertMatchesPHPSnapshot($content);
+
+                return true;
+            });
+
             $output['updated'][] = $this->exampleFeatureFile;
         }
 
         if ($unitExists) {
-            $this->files->expects('put')->with($this->exampleUnitFile, $this->fixture($this->exampleUnitFile));
+            $this->files->expects('put')->withArgs(function ($file, $content) {
+                $this->assertSame($this->exampleUnitFile, $file);
+                $this->assertMatchesPHPSnapshot($content);
+
+                return true;
+            });
+
             $output['updated'][] = $this->exampleUnitFile;
         }
 
@@ -100,7 +112,7 @@ protected function getHttpTestsOutput(Tree $tree, string $controllerPath): array
             $this->files->expects('put')
                 ->withArgs(function ($pathArg, $output) use ($controllerPath) {
                     $this->assertSame($controllerPath, $pathArg);
-                    $this->assertSame($this->fixture($controllerPath), $output);
+                    $this->assertMatchesPHPSnapshot($output);
 
                     return true;
                 });
@@ -114,7 +126,12 @@ protected function getHttpTestsOutput(Tree $tree, string $controllerPath): array
     protected function getPestGlobalFileOutput(bool $updated): array
     {
         $this->files->expects('exists')->with($this->pestGlobalFile)->andReturn($updated);
-        $this->files->expects('put')->with($this->pestGlobalFile, $this->fixture($this->pestGlobalFile));
+        $this->files->expects('put')->withArgs(function ($file, $output) {
+            $this->assertSame($this->pestGlobalFile, $file);
+            $this->assertMatchesPHPSnapshot($output);
+
+            return true;
+        });
 
         $key = $updated ? 'updated' : 'created';
 

tests/Feature/PestGeneratorTest.php

@@ -35,16 +35,16 @@
     $tokens = $this->blueprint->parse($this->definition($definition));
     $tree = $this->blueprint->analyze($tokens);
 
-    $exampleFileOutput = $this->getExampleTestsOutput($exampleFeature, $exampleUnit);
     $pestGlobalFileOutput = $this->getPestGlobalFileOutput($pestGlobalFileExists);
+    $exampleFileOutput = $this->getExampleTestsOutput($exampleFeature, $exampleUnit);
     $httpTestsOutput = $this->getHttpTestsOutput(
         $tree,
         'tests/Feature/Http/Controllers'.($folder ? '/'.$folder : ''),
     );
 
     $expectedOutput = array_merge_recursive($pestGlobalFileOutput, $exampleFileOutput, $httpTestsOutput);
 
-    expect($expectedOutput['created'] ?? [])->toHaveCount($createdCount);
-    expect($expectedOutput['updated'] ?? [])->toHaveCount($updatedCount);
-    expect($this->subject->output($tree))->toBe($expectedOutput);
+    expect($expectedOutput['created'] ?? [])->toHaveCount($createdCount)
+        ->and($expectedOutput['updated'] ?? [])->toHaveCount($updatedCount)
+        ->and($this->subject->output($tree))->toBe($expectedOutput);
 })->with('pest');

tests/PHPDriver.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Fidum\BlueprintPestAddon\Tests;
+
+use Spatie\Snapshots\Drivers\TextDriver;
+
+class PHPDriver extends TextDriver
+{
+    public function extension(): string
+    {
+        return 'php';
+    }
+}

tests/TestCase.php

@@ -5,9 +5,15 @@
 use Blueprint\BlueprintServiceProvider;
 use Fidum\BlueprintPestAddon\BlueprintPestAddonServiceProvider;
 use Orchestra\Testbench\TestCase as BaseTestCase;
+use function Spatie\Snapshots\assertMatchesSnapshot;
 
 class TestCase extends BaseTestCase
 {
+    public function assertMatchesPHPSnapshot(string $content)
+    {
+        assertMatchesSnapshot(str_replace("\r", '', $content), new PHPDriver());
+    }
+
     protected function getEnvironmentSetUp($app): void
     {
         // blueprint config