Adds new stdin-input option

Author: raphaelstolt

README.md

@@ -179,6 +179,13 @@ Would expect the following .gitattributes file content:
 The `--report-stale-export-ignores` option extends the validation to look for export-ignore statements referencing non-existent
 repository artifacts. In combination with the `--diff` option these will be shown in the output.
 
+The `--stdin-input` option allows the validate command to read from `STDIN` so that the following can be used for validation.
+It currently only does a strict comparison.
+
+```bash
+cat .gitattributes | lean-package-validator validate --stdin-input
+```
+
 ### Additional commands
 
 #### Init command

bin/lean-package-validator

@@ -30,6 +30,7 @@ use Stolt\LeanPackage\Commands\ValidateCommand;
 use Stolt\LeanPackage\Analyser;
 use Stolt\LeanPackage\Archive;
 use Stolt\LeanPackage\Archive\Validator;
+use Stolt\LeanPackage\Helpers\PhpInputReader;
 use Stolt\LeanPackage\Presets\Finder;
 use Stolt\LeanPackage\Presets\PhpPreset;
 use Stolt\LeanPackage\Tree;
@@ -44,7 +45,8 @@ $initCommand = new InitCommand(
 );
 $validateCommand = new ValidateCommand(
     $analyser,
-    new Validator($archive)
+    new Validator($archive),
+    new PhpInputReader()
 );
 $treeCommand = new TreeCommand(new Tree(new Archive(WORKING_DIRECTORY,'tree-temp')));
 

src/Analyser.php

@@ -853,15 +853,18 @@ public function getPresentNonExportIgnoresContent(): string
      * the .gitattributes file.
      *
      * @param bool $applyGlob
+     * @param string $gitattributesContent
      * @return array
      */
-    public function getPresentExportIgnores(bool $applyGlob = true): array
+    public function getPresentExportIgnores(bool $applyGlob = true, string $gitattributesContent = ''): array
     {
-        if ($this->hasGitattributesFile() === false) {
+        if ($this->hasGitattributesFile() === false && $gitattributesContent === '') {
             return [];
         }
 
-        $gitattributesContent = (string) \file_get_contents($this->gitattributesFile);
+        if ($gitattributesContent === '') {
+            $gitattributesContent = (string) \file_get_contents($this->gitattributesFile);
+        }
 
         $gitattributesLines = \preg_split(
             '/\\r\\n|\\r|\\n/',
@@ -936,6 +939,14 @@ private function getByDirectoriesToFilesExportIgnoreArtifacts(array $artifacts):
         return \array_merge($directories, $files);
     }
 
+    public function hasCompleteExportIgnoresFromString(string $gitattributesContent): bool
+    {
+        $expectedExportIgnores = $this->collectExpectedExportIgnores();
+        $presentExportIgnores = $this->getPresentExportIgnores(true, $gitattributesContent);
+
+        return \array_values($expectedExportIgnores) === \array_values($presentExportIgnores);
+    }
+
     /**
      * Is existing .gitattributes file having all export-ignore(s).
      *

src/Commands/ValidateCommand.php

@@ -4,6 +4,7 @@
 
 namespace Stolt\LeanPackage\Commands;
 
+use function PHPUnit\Framework\stringContains;
 use SebastianBergmann\Diff\Differ;
 use SebastianBergmann\Diff\Output\UnifiedDiffOutputBuilder;
 use SplFileInfo;
@@ -17,6 +18,7 @@
 use Stolt\LeanPackage\Exceptions\InvalidGlobPatternFile;
 use Stolt\LeanPackage\Exceptions\NoLicenseFilePresent;
 use Stolt\LeanPackage\Exceptions\NonExistentGlobPatternFile;
+use Stolt\LeanPackage\Helpers\InputReader;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -47,13 +49,22 @@ final class ValidateCommand extends Command
     protected Validator $archiveValidator;
 
     /**
-     * @param Analyser  $analyser
+     * Input reader.
+     *
+     * @var InputReader
+     */
+    protected InputReader $inputReader;
+
+    /**
+     * @param Analyser $analyser
      * @param Validator $archiveValidator
+     * @param InputReader $inputReader
      */
-    public function __construct(Analyser $analyser, Validator $archiveValidator)
+    public function __construct(Analyser $analyser, Validator $archiveValidator, InputReader $inputReader)
     {
         $this->analyser = $analyser;
         $this->archiveValidator = $archiveValidator;
+        $this->inputReader = $inputReader;
 
         parent::__construct();
     }
@@ -105,7 +116,9 @@ protected function configure(): void
         $sortDescription = 'Sort from directories to files';
 
         $alignExportIgnoresDescription = 'Align export-ignores on create or overwrite';
+        $stdinInputDescription = "Read .gitattributes content from standard input";
 
+        $this->addOption('stdin-input', null, InputOption::VALUE_NONE, $stdinInputDescription);
         $this->addOption('create', 'c', InputOption::VALUE_NONE, $createDescription);
         $this->addOption(
             'enforce-strict-order',
@@ -220,6 +233,35 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         }
 
+        $stdinInput = $input->getOption('stdin-input');
+
+        if ($stdinInput !== false) {
+            $stdinInputContents = $this->inputReader->get();
+
+            if (!\strpos($stdinInputContents, 'export-ignore')) {
+                $warning = "Warning: The provided input stream seems to be no .gitattributes content.";
+                $outputContent = '<error>' . $warning . '</error>';
+                $output->writeln($outputContent);
+
+                return Command::FAILURE;
+            }
+
+            $verboseOutput = '+ Validating .gitattributes content from STDIN.';
+            $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);
+
+            if ($this->analyser->hasCompleteExportIgnoresFromString($stdinInputContents)) {
+                $info = 'The provided .gitattributes content is considered <info>valid</info>.';
+                $output->writeln($info);
+
+                return Command::SUCCESS;
+            }
+
+            $outputContent = 'The provided .gitattributes file is considered <error>invalid</error>.';
+            $output->writeln($outputContent);
+
+            return Command::FAILURE;
+        }
+
         $verboseOutput = '+ Scanning directory ' . $directory . '.';
         $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);
 
@@ -302,7 +344,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         }
 
-
         $alignExportIgnores = $input->getOption('align-export-ignores');
 
         if ($alignExportIgnores) {

src/Helpers/InputReader.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stolt\LeanPackage\Helpers;
+
+interface InputReader
+{
+    public function get(): string|false;
+}

src/Helpers/PhpInputReader.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stolt\LeanPackage\Helpers;
+
+use Stolt\LeanPackage\Helpers\InputReader;
+
+class PhpInputReader implements InputReader
+{
+    public function get(): string|false
+    {
+        return \file_get_contents('php://stdin');
+    }
+}

tests/Commands/ValidateCommandTest.php

@@ -10,6 +10,7 @@
 use phpmock\MockBuilder;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
+use PHPUnit\Framework\Attributes\RunInSeparateProcess;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\Attributes\Ticket;
 use Stolt\LeanPackage\Analyser;
@@ -21,6 +22,7 @@
 use Stolt\LeanPackage\Presets\Finder;
 use Stolt\LeanPackage\Presets\PhpPreset;
 use Stolt\LeanPackage\Tests\CommandTester;
+use Stolt\LeanPackage\Tests\Helpers\FakeInputReader;
 use Stolt\LeanPackage\Tests\TestCase;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Command\Command;
@@ -43,7 +45,8 @@ protected function setUp(): void
 
         $analyserCommand = new ValidateCommand(
             new Analyser(new Finder(new PhpPreset())),
-            new Validator(new Archive($this->temporaryDirectory))
+            new Validator(new Archive($this->temporaryDirectory)),
+            new FakeInputReader()
         );
 
         $this->application = $this->getApplication($analyserCommand);
@@ -2196,6 +2199,35 @@ public function gitignoredFilesAreExcludedFromValidation(): void
         $commandTester->assertCommandIsSuccessful();
     }
 
+
+    #[Test]
+    #[RunInSeparateProcess]
+    public function detectsNonGitattributeContentInStdinInput(): void
+    {
+        $application = new Application();
+        $fakeInputReader = new FakeInputReader();
+        $fakeInputReader->set('Some non .gitattributes content.');
+
+        $analyserCommand = new ValidateCommand(
+            new Analyser(new Finder(new PhpPreset())),
+            new Validator(new Archive(\getcwd())),
+            $fakeInputReader
+        );
+
+        $application->add($analyserCommand);
+        $command = $application->find('validate');
+
+        $expectedDisplay = <<<CONTENT
+Warning: The provided input stream seems to be no .gitattributes content.
+CONTENT;
+
+        TestCommand::for($command)
+            ->addOption('stdin-input')
+            ->execute()
+            ->assertOutputContains($expectedDisplay)
+            ->assertFaulty();
+    }
+
     /**
      * @return array
      */
@@ -2221,7 +2253,8 @@ protected function getApplicationWithMockedAnalyser(MockInterface $mockedAnalyse
 
         $analyserCommand = new ValidateCommand(
             $mockedAnalyser,
-            new Validator($archive)
+            new Validator($archive),
+            new FakeInputReader()
         );
 
         $application->add($analyserCommand);
@@ -2239,7 +2272,8 @@ protected function getApplicationWithMockedArchiveValidator(MockInterface $mocke
 
         $analyserCommand = new ValidateCommand(
             new Analyser(new Finder(new PhpPreset())),
-            $mockedArchiveValidator
+            $mockedArchiveValidator,
+            new FakeInputReader()
         );
 
         $application->add($analyserCommand);

tests/Helpers/FakeInputReader.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stolt\LeanPackage\Tests\Helpers;
+
+use Stolt\LeanPackage\Helpers\InputReader;
+
+class FakeInputReader implements InputReader
+{
+    private string $input = '';
+
+    public function set(string $input): void
+    {
+        $this->input = $input;
+    }
+    public function get(): string|false
+    {
+        return $this->input;
+    }
+}