Fix error when using seeJson and the response type is not JSON (#16350)

An error is thrown when seeJson is called on a response but the response is not JSON. Instead, seeJson now fails the test with an explanation that the response was not JSON.
laravel · Nov 11, 2016 · 0a9e23a · 0a9e23a
1 parent 6337bf6
commit 0a9e23a
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 8 deletions.
diff --git a/src/Illuminate/Foundation/Testing/Concerns/MakesHttpRequests.php b/src/Illuminate/Foundation/Testing/Concerns/MakesHttpRequests.php
@@ -295,7 +295,7 @@ protected function receiveJson(array $data = null)
     public function seeJsonEquals(array $data)
     {
         $actual = json_encode(Arr::sortRecursive(
-            json_decode($this->response->getContent(), true)
+            (array) $this->decodeResponseJson()
         ));
 
         $this->assertEquals(json_encode(Arr::sortRecursive($data)), $actual);
@@ -321,9 +321,7 @@ public function seeJson(array $data = null, $negate = false)
         }
 
         try {
-            $this->seeJsonEquals($data);
-
-            return $this;
+            return $this->seeJsonEquals($data);
         } catch (PHPUnit_Framework_ExpectationFailedException $e) {
             return $this->seeJsonContains($data, $negate);
         }
@@ -354,7 +352,7 @@ public function seeJsonStructure(array $structure = null, $responseData = null)
         }
 
         if (! $responseData) {
-            $responseData = json_decode($this->response->getContent(), true);
+            $responseData = $this->decodeResponseJson();
         }
 
         foreach ($structure as $key => $value) {

diff --git a/tests/Foundation/FoundationMakesHttpRequestsJsonTest.php b/tests/Foundation/FoundationMakesHttpRequestsJsonTest.php
@@ -51,24 +51,54 @@ public function testSeeJsonStructure()
         $this->response = new Illuminate\Http\Response(new JsonSerializableSingleResourceStub);
         $this->seeJsonStructure(['*' => ['foo', 'bar', 'foobar']]);
     }
+
+    public function testSeeJsonWithNonJson()
+    {
+        $this->response = new Illuminate\Http\Response(new NonJsonSerializableStub);
+
+        try {
+            $this->seeJson(['foo' => 'bad']);
+        } catch (PHPUnit_Framework_AssertionFailedError $e) {
+            $this->assertStringStartsWith('Invalid JSON', $e->getMessage());
+
+            return;
+        }
+
+        $this->fail('invalid JSON should fail seeJson');
+    }
+
+    public function testSeeJsonEqualsWithNonJson()
+    {
+        $this->response = new Illuminate\Http\Response(new NonJsonSerializableStub);
+
+        try {
+            $this->seeJsonEquals(['foo' => 'bad']);
+        } catch (PHPUnit_Framework_AssertionFailedError $e) {
+            $this->assertStringStartsWith('Invalid JSON', $e->getMessage());
+
+            return;
+        }
+
+        $this->fail('Invalid JSON should fail seeJsonEquals');
+    }
 }
 
 class JsonSerializableMixedResourcesStub implements JsonSerializable
 {
     public function jsonSerialize()
     {
         return [
-            'foo' => 'bar',
+            'foo'    => 'bar',
             'foobar' => [
                 'foobar_foo' => 'foo',
                 'foobar_bar' => 'bar',
             ],
-            'bars' => [
+            'bars'   => [
                 ['bar' => 'foo 0', 'foo' => 'bar 0'],
                 ['bar' => 'foo 1', 'foo' => 'bar 1'],
                 ['bar' => 'foo 2', 'foo' => 'bar 2'],
             ],
-            'baz' => [
+            'baz'    => [
                 ['foo' => 'bar 0', 'bar' => ['foo' => 'bar 0', 'bar' => 'foo 0']],
                 ['foo' => 'bar 1', 'bar' => ['foo' => 'bar 1', 'bar' => 'foo 1']],
             ],
@@ -88,3 +118,10 @@ public function jsonSerialize()
         ];
     }
 }
+
+class NonJsonSerializableStub implements JsonSerializable
+{
+    public function jsonSerialize()
+    {
+    }
+}