Better testing. Not relying on output of Collision

Author: robiningelbrecht

composer.json

@@ -30,6 +30,7 @@
     }
   },
   "require-dev": {
+    "dg/bypass-finals": "^1.4",
     "friendsofphp/php-cs-fixer": "^3.15",
     "phpstan/phpstan": "^1.10",
     "spatie/phpunit-snapshot-assertions": "^5.0"

composer.lock

@@ -5,7 +5,9 @@
          beStrictAboutOutputDuringTests="true"
          colors="true"
          defaultTestSuite="unit"
-         cacheDirectory=".phpunit.cache">
+         cacheDirectory=".phpunit.cache"
+         displayDetailsOnTestsThatTriggerWarnings="true"
+         bootstrap="tests/bootstrap.php">
   <extensions>
     <bootstrap class="RobinIngelbrecht\PHPUnitPrettyPrint\PhpUnitExtension">
 
@@ -14,6 +16,7 @@
   <testsuites>
     <testsuite name="unit">
       <file>tests/OutputTest.php</file>
+      <directory>tests/Unit</directory>
     </testsuite>
   </testsuites>
   <source>

phpunit.xml.dist

@@ -18,7 +18,7 @@ public function testPrintWithoutConfig(): void
         ];
 
         exec(implode(' ', $command), $out);
-        $this->assertMatchesSnapshot(implode(PHP_EOL, $out), new SnapshotTextDriver());
+        $this->assertStringContainsString('Tests:    3 failed, 1 risky, 1 incomplete, 1 skipped, 3 passed (7 assertions)', implode(PHP_EOL, $out));
     }
 
     public function testWithProfiling(): void
@@ -29,7 +29,9 @@ public function testWithProfiling(): void
         ];
 
         exec(implode(' ', $command), $out);
-        $this->assertMatchesSnapshot(implode(PHP_EOL, $out), new SnapshotTextDriver());
+        $output = implode(PHP_EOL, $out);
+        $this->assertStringContainsString('Tests:    2 passed (4 assertions)', $output);
+        $this->assertStringContainsString('Top 10 slowest tests', $output);
     }
 
     public function testWithProfilingAtRunTime(): void
@@ -41,7 +43,9 @@ public function testWithProfilingAtRunTime(): void
             '-d --profiling',
         ];
         exec(implode(' ', $command), $out);
-        $this->assertMatchesSnapshot(implode(PHP_EOL, $out), new SnapshotTextDriver());
+        $output = implode(PHP_EOL, $out);
+        $this->assertStringContainsString('Tests:    2 passed (4 assertions)', $output);
+        $this->assertStringContainsString('Top 10 slowest tests', $output);
     }
 
     public function testPrintCompactMode(): void
@@ -52,7 +56,9 @@ public function testPrintCompactMode(): void
         ];
 
         exec(implode(' ', $command), $out);
-        $this->assertMatchesSnapshot(implode(PHP_EOL, $out), new SnapshotTextDriver());
+        $output = implode(PHP_EOL, $out);
+        $this->assertStringContainsString('.⨯⨯⨯!si..', $output);
+        $this->assertStringContainsString('Tests:    3 failed, 1 risky, 1 incomplete, 1 skipped, 3 passed (7 assertions)', $output);
     }
 
     public function testPrintCompactModeAtRunTime(): void
@@ -63,7 +69,9 @@ public function testPrintCompactModeAtRunTime(): void
             '-d --compact',
         ];
         exec(implode(' ', $command), $out);
-        $this->assertMatchesSnapshot(implode(PHP_EOL, $out), new SnapshotTextDriver());
+        $output = implode(PHP_EOL, $out);
+        $this->assertStringContainsString('.⨯⨯⨯!si..', $output);
+        $this->assertStringContainsString('Tests:    3 failed, 1 risky, 1 incomplete, 1 skipped, 3 passed (7 assertions)', $output);
     }
 
     public function testPrintWithQuote(): void

tests/OutputTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Tests;
+
+use Symfony\Component\Console\Output\NullOutput;
+
+class SpyOutput extends NullOutput implements \Stringable
+{
+    private array $messages = [];
+
+    public function writeln(string|iterable $messages, int $options = self::OUTPUT_NORMAL): void
+    {
+        if (!is_iterable($messages)) {
+            $messages = [$messages];
+        }
+        $this->messages = [...$this->messages, ...$messages];
+    }
+
+    public function write(string|iterable $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL): void
+    {
+        if (!is_iterable($messages)) {
+            $messages = [$messages];
+        }
+        $this->messages = [...$this->messages, ...$messages];
+    }
+
+    public function __toString(): string
+    {
+        return implode(PHP_EOL, $this->messages);
+    }
+}

tests/SnapshotTextDriver.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Tests\Unit;
+
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Runner\Extension\ParameterCollection;
+use RobinIngelbrecht\PHPUnitPrettyPrint\Configuration;
+
+class ConfigurationTest extends TestCase
+{
+    private array $originalServer = [];
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->originalServer = $_SERVER;
+    }
+
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        $_SERVER = $this->originalServer;
+    }
+
+    public function testFromParameterCollection(): void
+    {
+        $configuration = Configuration::fromParameterCollection(ParameterCollection::fromArray([
+            'displayProfiling' => 'true',
+            'useCompactMode' => 'true',
+            'displayQuote' => 'true',
+        ]));
+
+        $this->assertTrue($configuration->displayProfiling());
+        $this->assertTrue($configuration->useCompactMode());
+        $this->assertTrue($configuration->displayQuote());
+
+        $configuration = Configuration::fromParameterCollection(ParameterCollection::fromArray([]));
+
+        $this->assertFalse($configuration->displayProfiling());
+        $this->assertFalse($configuration->useCompactMode());
+        $this->assertFalse($configuration->displayQuote());
+    }
+
+    public function testFromParameterCollectionWithServerArguments(): void
+    {
+        $_SERVER['argv'][] = '--profiling';
+        $_SERVER['argv'][] = '--compact';
+        $_SERVER['argv'][] = '--display-quote';
+        $configuration = Configuration::fromParameterCollection(ParameterCollection::fromArray([]));
+
+        $this->assertTrue($configuration->displayProfiling());
+        $this->assertTrue($configuration->useCompactMode());
+        $this->assertTrue($configuration->displayQuote());
+    }
+}