wip PintPreCommitHook.php

igorsgm · igorsgm · commit 3caec8893628 · 2023-02-21T00:35:01.000-08:00
diff --git a/src/Console/Commands/Hooks/PintPreCommitHook.php b/src/Console/Commands/Hooks/PintPreCommitHook.php
@@ -7,45 +7,44 @@
 use Igorsgm\GitHooks\Exceptions\HookFailException;
 use Igorsgm\GitHooks\Facades\GitHooks;
 use Igorsgm\GitHooks\Git\ChangedFiles;
-use Igorsgm\GitHooks\Traits\ConsoleHelper;
+use Igorsgm\GitHooks\Traits\ProcessHelper;
+use Illuminate\Console\Command;
 use Symfony\Component\Console\Terminal;
 
 class PintPreCommitHook implements PreCommitHook
 {
-    use ConsoleHelper;
+    use ProcessHelper;
 
     /**
-     * @var string
+     * Command instance that is bound automatically by Hooks Pipeline, so it can be used inside the Hook.
+     *
+     * @var Command
      */
-    private $pintExecutable;
+    public $command;
 
     /**
      * @var string
      */
-    private $pintConfig;
+    private $pintExecutable;
 
     /**
      * @var array
      */
-    private $filesBadlyFormatted;
-
-    public function getName(): ?string
-    {
-        return 'Laravel Pint';
-    }
+    private $filesBadlyFormatted = [];
 
     /**
      * Create a new console command instance.
      *
      * @return void
      */
-    public function __construct($argInput = '')
+    public function __construct()
     {
-        $this->initConsole($argInput);
-
         $this->pintExecutable = './'.trim(config('git-hooks.code_analyzers.laravel_pint.path'), '/');
-        $this->pintConfig = './'.trim(config('git-hooks.code_analyzers.laravel_pint.config'), '/');
-        $this->filesBadlyFormatted = [];
+    }
+
+    public function getName(): ?string
+    {
+        return 'Laravel Pint';
     }
 
     public function handle(ChangedFiles $files, Closure $next)
@@ -62,17 +61,22 @@ public function handle(ChangedFiles $files, Closure $next)
 
         foreach ($stagedFilePaths as $stagedFilePath) {
             $isPintProperlyFormatted = $this->runCommands(
-                sprintf('%s --test --config %s %s', $this->pintExecutable, $this->pintConfig, $stagedFilePath),
+                implode(' ', [
+                    $this->pintExecutable,
+                    '--test',
+                    $this->getPintConfigParam(),
+                    $stagedFilePath,
+                ]),
                 [
                     'cwd' => base_path(),
                 ])->isSuccessful();
 
             if (! $isPintProperlyFormatted) {
                 if (empty($this->filesBadlyFormatted)) {
-                    $this->newLine();
+                    $this->command->newLine();
                 }
 
-                $this->output->writeln(
+                $this->command->getOutput()->writeln(
                     sprintf('<fg=red> Pint Failed:</> %s', "$stagedFilePath")
                 );
                 $this->filesBadlyFormatted[] = $stagedFilePath;
@@ -83,15 +87,21 @@ public function handle(ChangedFiles $files, Closure $next)
             return $next($files);
         }
 
-        $this->newLine();
-        $this->output->writeln(
+        $this->command->newLine();
+        $this->command->getOutput()->writeln(
             sprintf('<bg=red;fg=white> COMMIT FAILED </> %s',
                 'Your commit contains files that should pass Pint but do not. Please fix the Pint errors in the files above and try again.')
         );
 
         $this->suggestAutoFixOrExit();
     }
 
+    private function getPintConfigParam(): string
+    {
+        $pintConfigFile = trim(config('git-hooks.code_analyzers.laravel_pint.config'), '/');
+        return empty($pintConfigFile) ? '' : '--config ./'.$pintConfigFile;
+    }
+
     /**
      * @return void
      *
@@ -105,12 +115,12 @@ private function validatePintInstallation()
             return;
         }
 
-        $this->newLine(2);
-        $this->output->writeln(
+        $this->command->newLine(2);
+        $this->command->getOutput()->writeln(
             sprintf('<bg=red;fg=white> ERROR </> %s',
                 'Pint is not installed. Please run <info>composer require laravel/pint --dev</info> to install it.')
         );
-        $this->newLine();
+        $this->command->newLine();
         throw new HookFailException();
     }
 
@@ -122,12 +132,16 @@ private function validatePintInstallation()
     private function suggestAutoFixOrExit()
     {
         if (Terminal::hasSttyAvailable() &&
-            $this->confirm('Would you like to attempt to correct files automagically?', false)
+            $this->command->confirm('Would you like to attempt to correct files automagically?', false)
         ) {
             $errorFilesString = implode(' ', $this->filesBadlyFormatted);
             $this->runCommands(
                 [
-                    sprintf('%s --config %s %s', $this->pintExecutable, $this->pintConfig, $errorFilesString),
+                    implode(' ', [
+                        $this->pintExecutable,
+                        $this->getPintConfigParam(),
+                        $errorFilesString,
+                    ]),
                     'git add '.$errorFilesString,
                 ],
                 ['cwd' => base_path()]
diff --git a/src/Contracts/Hook.php b/src/Contracts/Hook.php
@@ -2,6 +2,9 @@
 
 namespace Igorsgm\GitHooks\Contracts;
 
+/**
+ * @property \Illuminate\Console\Command $command
+ */
 interface Hook
 {
     /**
diff --git a/src/Traits/WithPipeline.php b/src/Traits/WithPipeline.php
@@ -49,6 +49,9 @@ protected function startHookConsoleTask(): Closure
         return function (Hook $hook) {
             $this->hookExecuting = $hook;
 
+            // Binding the Command instance to the Hook, so it can be used inside the Hook
+            $hook->command = $this;
+
             $taskTitle = $this->getHookTaskTitle($hook);
             $loadingText = 'loading...';
             $this->output->write("$taskTitle: <comment>{$loadingText}</comment>");
diff --git a/tests/Datasets/GitLogsDataset.php b/tests/Datasets/GitLogsDataset.php
@@ -23,3 +23,7 @@
 dataset('listOfChangedFiles', [
     'list of changed files' => 'AM src/ChangedFiles.php',
 ]);
+
+dataset('listOfFixableFiles', [
+    'list of fixable files' => 'AM temp/ClassWithFixableIssues.php',
+]);
diff --git a/tests/Features/Commands/Hooks/PintPreCommitHookTest.php b/tests/Features/Commands/Hooks/PintPreCommitHookTest.php
@@ -0,0 +1,106 @@
+<?php
+
+use Igorsgm\GitHooks\Console\Commands\Hooks\PintPreCommitHook;
+use Igorsgm\GitHooks\Facades\GitHooks;
+use Igorsgm\GitHooks\Git\ChangedFiles;
+use Igorsgm\GitHooks\Traits\GitHelper;
+
+uses(GitHelper::class);
+beforeEach(function () {
+    $this->gitInit();
+    $this->initializeTempDirectory(base_path('temp'));
+});
+
+test('Skips Pint check if there are no staged files', function () {
+    $changedFiles = mock(ChangedFiles::class)
+        ->shouldReceive('getStaged')
+        ->andReturn(collect())
+        ->getMock();
+
+    $next = function ($files) {
+        return 'passed';
+    };
+
+    $hook = new PintPreCommitHook();
+    $result = $hook->handle($changedFiles, $next);
+    expect($result)->toBe('passed');
+});
+
+test('Skips Pint check during a Merge process', function ($modifiedFilesList) {
+    $changedFiles = new ChangedFiles($modifiedFilesList);
+    GitHooks::shouldReceive('isMergeInProgress')->andReturn(true);
+
+    $next = function ($files) {
+        return 'passed';
+    };
+
+    $hook = new PintPreCommitHook();
+    $result = $hook->handle($changedFiles, $next);
+    expect($result)->toBe('passed');
+})->with('modifiedFilesList');
+
+test('Throws HookFailException and notifies when Pint is not installed', function ($listOfFixableFiles) {
+    $this->config->set('git-hooks.code_analyzers.laravel_pint', [
+        'path' => 'inexistent/path/to/pint',
+    ]);
+
+    $this->config->set('git-hooks.pre-commit', [
+        PintPreCommitHook::class,
+    ]);
+
+    GitHooks::shouldReceive('isMergeInProgress')->andReturn(false);
+    GitHooks::shouldReceive('getListOfChangedFiles')->andReturn($listOfFixableFiles);
+
+    $this->artisan('git-hooks:pre-commit')
+        ->expectsOutputToContain('Pint is not installed.')
+        ->assertExitCode(1);
+})->with('listOfFixableFiles');
+
+test('Fails commit when Pint is not passing and user does not autofix the files', function ($listOfFixableFiles) {
+    $this->config->set('git-hooks.code_analyzers.laravel_pint', [
+        'path' => '../../../bin/pint',
+    ]);
+    $this->config->set('git-hooks.pre-commit', [
+        PintPreCommitHook::class,
+    ]);
+
+    $this->makeTempFile('ClassWithFixableIssues.php',
+        file_get_contents(__DIR__.'/../../../Fixtures/ClassWithFixableIssues.php')
+    );
+
+    GitHooks::shouldReceive('isMergeInProgress')->andReturn(false);
+    GitHooks::shouldReceive('getListOfChangedFiles')->andReturn($listOfFixableFiles);
+
+    $this->artisan('git-hooks:pre-commit')
+        ->expectsOutputToContain('Pint Failed')
+        ->expectsOutputToContain('COMMIT FAILED')
+        ->expectsConfirmation('Would you like to attempt to correct files automagically?', 'no')
+        ->assertExitCode(1);
+
+})->with('listOfFixableFiles');
+
+test('Commit passes when Pint fixes fix the files', function ($listOfFixableFiles) {
+    $this->config->set('git-hooks.code_analyzers.laravel_pint', [
+        'path' => '../../../bin/pint',
+    ]);
+    $this->config->set('git-hooks.pre-commit', [
+        PintPreCommitHook::class,
+    ]);
+
+    $this->makeTempFile('ClassWithFixableIssues.php',
+        file_get_contents(__DIR__.'/../../../Fixtures/ClassWithFixableIssues.php')
+    );
+
+    GitHooks::shouldReceive('isMergeInProgress')->andReturn(false);
+    GitHooks::shouldReceive('getListOfChangedFiles')->andReturn($listOfFixableFiles);
+
+    $this->artisan('git-hooks:pre-commit')
+        ->expectsOutputToContain('Pint Failed')
+        ->expectsOutputToContain('COMMIT FAILED')
+        ->expectsConfirmation('Would you like to attempt to correct files automagically?', 'yes');
+
+    $this->artisan('git-hooks:pre-commit')
+        ->doesntExpectOutputToContain('Pint Failed')
+        ->assertSuccessful();
+
+})->with('listOfFixableFiles');
diff --git a/tests/Fixtures/ClassWithFixableIssues.php b/tests/Fixtures/ClassWithFixableIssues.php
@@ -0,0 +1,9 @@
+<?php
+
+
+
+namespace Igorsgm\GitHooks\Tests\Fixtures;
+
+class ClassWithFixableIssues
+{
+}
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -40,6 +40,7 @@ public function defineEnvironment($app)
             'post-checkout' => [],
             'post-merge' => [],
             'pre-push' => [],
+            'code_analyzers' => [],
         ]);
 
         $this->config = $app['config'];
@@ -71,13 +72,20 @@ protected function getPackageAliases($app)
         ];
     }
 
+    public function gitInit()
+    {
+        chdir(base_path());
+        shell_exec('git init --quiet');
+
+        return $this;
+    }
+
     /**
      * @return void
      */
     public function initializeGitAsTempDirectory()
     {
-        chdir(base_path());
-        shell_exec('git init --quiet');
-        $this->initializeTempDirectory(base_path('.git'));
+        $this->gitInit()
+            ->initializeTempDirectory(base_path('.git'));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace Igorsgm\GitHooks\Contracts;`
`4`	`4`
	`5`	`+/**`
	`6`	`+ * @property \Illuminate\Console\Command $command`
	`7`	`+ */`
`5`	`8`	`interface Hook`
`6`	`9`	`{`
`7`	`10`	`/**`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,9 @@ @@
 +<?php
++
++
++
 +namespace Igorsgm\GitHooks\Tests\Fixtures;
++
 +class ClassWithFixableIssues
 +{
 +}