Allow regenerating expected formatter outputs

Author: vrana

tests/SqlFormatterTest.php

@@ -18,6 +18,8 @@
 use function defined;
 use function explode;
 use function file_get_contents;
+use function file_put_contents;
+use function getenv;
 use function implode;
 use function pack;
 use function rtrim;
@@ -27,6 +29,21 @@ final class SqlFormatterTest extends TestCase
 {
     private SqlFormatter $formatter;
 
+    public static function setUpBeforeClass(): void
+    {
+        if (! getenv('UPDATE_EXPECTED')) {
+            return;
+        }
+
+        $formatter = new SqlFormatter(new HtmlHighlighter());
+
+        self::updateExpected('format-highlight.html', [$formatter, 'format']);
+        self::updateExpected('format.txt', [new SqlFormatter(new NullHighlighter()), 'format']);
+        self::updateExpected('highlight.html', [$formatter, 'highlight']);
+        self::updateExpected('clihighlight.txt', [new SqlFormatter(new CliHighlighter()), 'format']);
+        self::updateExpected('compress.txt', [$formatter, 'compress']);
+    }
+
     protected function setUp(): void
     {
         // Force SqlFormatter to run in non-CLI mode for tests
@@ -116,7 +133,7 @@ private static function fileDataProvider(string $file): Generator
         assert($contents !== false);
         $formatHighlightData = explode("\n---\n", rtrim($contents, "\n"));
         $sqlData             = self::fileSqlData();
-        if (count($formatHighlightData) !== count($sqlData)) {
+        if (count($formatHighlightData) !== count($sqlData) && ! getenv('UPDATE_EXPECTED')) {
             throw new UnexpectedValueException(sprintf(
                 '"%s" (%d sections) and sql.sql (%d sections) should have the same number of sections',
                 $file,
@@ -175,4 +192,15 @@ public static function highlightData(): Generator
     {
         return self::fileDataProvider('highlight.html');
     }
+
+    private static function updateExpected(string $filename, callable $highlight): void
+    {
+        $data = [];
+
+        foreach (self::fileSqlData() as $sql) {
+            $data[] = rtrim($highlight($sql), "\n");
+        }
+
+        file_put_contents(__DIR__ . '/' . $filename, implode("\n---\n", $data) . "\n");
+    }
 }