Merge pull request #76 from Gummibeer/ft-html-driver

sebastiandedeyne · web-flow · commit 7da647e383d5 · 2019-10-23T17:00:34.000+02:00
html driver
diff --git a/README.md b/README.md
@@ -83,6 +83,7 @@ To make snapshot assertions, use the `Spatie\Snapshots\MatchesSnapshots` trait i
 - `assertMatchesSnapshot($actual)`
 - `assertMatchesJsonSnapshot($actual)`
 - `assertMatchesXmlSnapshot($actual)`
+- `assertMatchesHtmlSnapshot($actual)`
 - `assertMatchesFileSnapshot($filePath)`
 - `assertMatchesFileHashSnapshot($filePath)`
 
diff --git a/composer.json b/composer.json
@@ -21,6 +21,7 @@
     ],
     "require": {
         "php": "^7.2",
+        "ext-dom": "*",
         "phpunit/phpunit": "^8.0",
         "symfony/yaml": "^4.0"
     },
diff --git a/src/Drivers/HtmlDriver.php b/src/Drivers/HtmlDriver.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace Spatie\Snapshots\Drivers;
+
+use DOMDocument;
+use PHPUnit\Framework\Assert;
+use Spatie\Snapshots\Driver;
+use Spatie\Snapshots\Exceptions\CantBeSerialized;
+
+class HtmlDriver implements Driver
+{
+    public function serialize($data): string
+    {
+        if (! is_string($data)) {
+            throw new CantBeSerialized('Only strings can be serialized to html');
+        }
+
+        $domDocument = new DOMDocument('1.0');
+        $domDocument->preserveWhiteSpace = false;
+        $domDocument->formatOutput = true;
+
+        @$domDocument->loadHTML($data); // to ignore HTML5 errors
+
+        return $domDocument->saveHTML();
+    }
+
+    public function extension(): string
+    {
+        return 'html';
+    }
+
+    public function match($expected, $actual)
+    {
+        Assert::assertEquals($expected, $this->serialize($actual));
+    }
+}
diff --git a/src/MatchesSnapshots.php b/src/MatchesSnapshots.php
@@ -5,6 +5,7 @@
 use PHPUnit\Framework\ExpectationFailedException;
 use ReflectionClass;
 use ReflectionObject;
+use Spatie\Snapshots\Drivers\HtmlDriver;
 use Spatie\Snapshots\Drivers\JsonDriver;
 use Spatie\Snapshots\Drivers\VarDriver;
 use Spatie\Snapshots\Drivers\XmlDriver;
@@ -55,6 +56,11 @@ public function assertMatchesSnapshot($actual, Driver $driver = null)
         $this->doSnapshotAssertion($actual, $driver ?? new VarDriver());
     }
 
+    public function assertMatchesHtmlSnapshot($actual)
+    {
+        $this->assertMatchesSnapshot($actual, new HtmlDriver());
+    }
+
     public function assertMatchesXmlSnapshot($actual)
     {
         $this->assertMatchesSnapshot($actual, new XmlDriver());
diff --git a/tests/Integration/AssertionTest.php b/tests/Integration/AssertionTest.php
@@ -25,6 +25,14 @@ public function can_match_a_string_snapshot()
         $this->assertMatchesSnapshot($data);
     }
 
+    /** @test */
+    public function can_match_an_html_snapshot()
+    {
+        $data = '<!doctype html><html lang="en"><head></head><body><h1>Hello, world!</h1></body></html>';
+
+        $this->assertMatchesHtmlSnapshot($data);
+    }
+
     /** @test */
     public function can_match_an_xml_snapshot()
     {
diff --git a/tests/Integration/MatchesSnapshotTest.php b/tests/Integration/MatchesSnapshotTest.php
@@ -54,6 +54,21 @@ public function it_can_create_a_snapshot_from_an_array()
         );
     }
 
+    /** @test */
+    public function it_can_create_a_snapshot_from_html()
+    {
+        $mockTrait = $this->getMatchesSnapshotMock();
+
+        $this->expectIncompleteMatchesSnapshotTest($mockTrait, function ($mockTrait) {
+            $mockTrait->assertMatchesHtmlSnapshot('<!doctype html><html lang="en"><head></head><body><h1>Hello, world!</h1></body></html>');
+        });
+
+        $this->assertSnapshotMatchesExample(
+            'MatchesSnapshotTest__it_can_create_a_snapshot_from_html__1.html',
+            'snapshot.html'
+        );
+    }
+
     /** @test */
     public function it_can_create_a_snapshot_from_xml()
     {
@@ -107,6 +122,14 @@ public function it_can_match_an_existing_string_snapshot()
         $mockTrait->assertMatchesSnapshot('Foo');
     }
 
+    /** @test */
+    public function it_can_match_an_existing_html_snapshot()
+    {
+        $mockTrait = $this->getMatchesSnapshotMock();
+
+        $mockTrait->assertMatchesHtmlSnapshot('<!doctype html><html lang="en"><head></head><body><h1>Hello, world!</h1></body></html>');
+    }
+
     /** @test */
     public function it_can_match_an_existing_xml_snapshot()
     {
@@ -141,6 +164,16 @@ public function it_can_mismatch_a_string_snapshot()
         $mockTrait->assertMatchesSnapshot('Bar');
     }
 
+    /** @test */
+    public function it_can_mismatch_a_html_snapshot()
+    {
+        $mockTrait = $this->getMatchesSnapshotMock();
+
+        $this->expectFailedMatchesSnapshotTest();
+
+        $mockTrait->assertMatchesHtmlSnapshot('<!doctype html><html lang="en"><head></head><body><h1>Hallo welt!</h1></body></html>');
+    }
+
     /** @test */
     public function it_can_mismatch_a_xml_snapshot()
     {
@@ -257,6 +290,23 @@ public function it_can_update_a_string_snapshot()
         );
     }
 
+    /** @test */
+    public function it_can_update_a_html_snapshot()
+    {
+        $_SERVER['argv'][] = '--update-snapshots';
+
+        $mockTrait = $this->getMatchesSnapshotMock();
+
+        $this->expectIncompleteMatchesSnapshotTest($mockTrait, function ($mockTrait) {
+            $mockTrait->assertMatchesHtmlSnapshot('<!doctype html><html lang="en"><head></head><body><h1>Hello, world!</h1></body></html>');
+        });
+
+        $this->assertSnapshotMatchesExample(
+            'MatchesSnapshotTest__it_can_update_a_html_snapshot__1.html',
+            'snapshot.html'
+        );
+    }
+
     /** @test */
     public function it_can_update_a_xml_snapshot()
     {
@@ -355,7 +405,7 @@ private function expectFailedMatchesSnapshotTest()
     }
 
     /**
-     * @return \PHPUnit\Framework\MockObject\MockObject
+     * @return \PHPUnit\Framework\MockObject\MockObject|\Spatie\Snapshots\MatchesSnapshots
      */
     private function getMatchesSnapshotMock(): MockObject
     {
diff --git a/tests/Integration/stubs/__snapshots__/AssertionTest__can_match_an_array_snapshot__1.json b/tests/Integration/stubs/__snapshots__/AssertionTest__can_match_an_array_snapshot__1.json
@@ -0,0 +1,5 @@
+{
+    "foo": "foo",
+    "bar": "bar",
+    "baz": "baz"
+}
diff --git a/tests/Integration/stubs/__snapshots__/AssertionTest__can_match_an_html_snapshot__1.html b/tests/Integration/stubs/__snapshots__/AssertionTest__can_match_an_html_snapshot__1.html
@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<html lang="en">
+<head></head>
+<body><h1>Hello, world!</h1></body>
+</html>
diff --git a/tests/Integration/stubs/__snapshots__/MatchesSnapshotTest__it_can_match_an_existing_html_snapshot__1.html b/tests/Integration/stubs/__snapshots__/MatchesSnapshotTest__it_can_match_an_existing_html_snapshot__1.html
@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<html lang="en">
+<head></head>
+<body><h1>Hello, world!</h1></body>
+</html>
diff --git a/tests/Integration/stubs/__snapshots__/MatchesSnapshotTest__it_can_mismatch_a_html_snapshot__1.html b/tests/Integration/stubs/__snapshots__/MatchesSnapshotTest__it_can_mismatch_a_html_snapshot__1.html
@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<html lang="en">
+<head></head>
+<body><h1>Hello, world!</h1></body>
+</html>
diff --git a/tests/Integration/stubs/__snapshots__/MatchesSnapshotTest__it_can_update_a_html_snapshot__1.html b/tests/Integration/stubs/__snapshots__/MatchesSnapshotTest__it_can_update_a_html_snapshot__1.html
@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<html lang="en">
+<head></head>
+<body><h1>Hallo welt!</h1></body>
+</html>
diff --git a/tests/Integration/stubs/example_snapshots/snapshot.html b/tests/Integration/stubs/example_snapshots/snapshot.html
@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<html lang="en">
+<head></head>
+<body><h1>Hello, world!</h1></body>
+</html>
diff --git a/tests/Unit/Drivers/HtmlDriverTest.php b/tests/Unit/Drivers/HtmlDriverTest.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace Spatie\Snapshots\Test\Unit\Drivers;
+
+use PHPUnit\Framework\TestCase;
+use Spatie\Snapshots\Drivers\HtmlDriver;
+use Spatie\Snapshots\Exceptions\CantBeSerialized;
+
+class HtmlDriverTest extends TestCase
+{
+    /** @test */
+    public function it_can_serialize_a_html_string_to_pretty_html()
+    {
+        $driver = new HtmlDriver();
+
+        $expected = implode(PHP_EOL, [
+            '<!DOCTYPE html>',
+            '<html lang="en">',
+            '<head></head>',
+            '<body><h1>Hello, world!</h1></body>',
+            '</html>',
+            '',
+        ]);
+
+        $this->assertEquals($expected, $driver->serialize('<!doctype html><html lang="en"><head></head><body><h1>Hello, world!</h1></body></html>'));
+    }
+
+    /** @test */
+    public function it_can_only_serialize_strings()
+    {
+        $driver = new HtmlDriver();
+
+        $this->expectException(CantBeSerialized::class);
+
+        $driver->serialize(['foo' => 'bar']);
+    }
+}
diff --git a/tests/Unit/Drivers/XmlDriverTest.php b/tests/Unit/Drivers/XmlDriverTest.php
@@ -9,7 +9,7 @@
 class XmlDriverTest extends TestCase
 {
     /** @test */
-    public function it_can_serialize_a_json_string_to_pretty_json()
+    public function it_can_serialize_a_xml_string_to_pretty_xml()
     {
         $driver = new XmlDriver();
 

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,14 @@ public function can_match_a_string_snapshot()`
`25`	`25`	`$this->assertMatchesSnapshot($data);`
`26`	`26`	`}`
`27`	`27`
	`28`	`+ /** @test */`
	`29`	`+ public function can_match_an_html_snapshot()`
	`30`	`+ {`
	`31`	`+ $data = '<!doctype html><html lang="en"><head></head><body><h1>Hello, world!</h1></body></html>';`
	`32`	`+`
	`33`	`+ $this->assertMatchesHtmlSnapshot($data);`
	`34`	`+ }`
	`35`	`+`
`28`	`36`	`/** @test */`
`29`	`37`	`public function can_match_an_xml_snapshot()`
`30`	`38`	`{`