Added failure messages

CHANGELOG.md

@@ -33,3 +33,10 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 ### Removed
 
 - Moved Factory classes into another package : VGirol/JsonApi-Faker
+
+## 1.2.1 - 2019-09-30
+
+### Added
+
+- Added some failure messages
+- Added new methods for testing (VGirol\JsonApiAssert\SetExceptionsTrait::setFailure and VGirol\JsonApiAssert\SetExceptionsTrait::formatAsRegex)

src/Asserts/Content/AssertErrors.php

@@ -2,7 +2,6 @@
 
 namespace VGirol\JsonApiAssert\Asserts\Content;
 
-use DMS\PHPUnitExtensions\ArraySubset\Assert as AssertArray;
 use DMS\PHPUnitExtensions\ArraySubset\Constraint\ArraySubset;
 use PHPUnit\Framework\Assert as PHPUnit;
 use PHPUnit\Framework\ExpectationFailedException;

src/Asserts/Content/AssertLinks.php

@@ -6,6 +6,7 @@
 
 use PHPUnit\Framework\Assert as PHPUnit;
 use VGirol\JsonApiAssert\Constraint\LinkEqualsConstraint;
+use VGirol\JsonApiAssert\Messages;
 
 /**
  * This trait adds the ability to test links objects.
@@ -29,7 +30,14 @@ trait AssertLinks
      */
     public static function assertLinksObjectEquals($expected, $links): void
     {
-        PHPUnit::assertEquals(count($expected), count($links));
+        $countExpected = count($expected);
+        $count = count($links);
+        PHPUnit::assertEquals(
+            $countExpected,
+            $count,
+            sprintf(Messages::LINKS_OBJECT_HAVE_NOT_SAME_LENGTH, $count, $countExpected)
+        );
+
         foreach ($expected as $name => $value) {
             static::assertLinksObjectContains($name, $value, $links);
         }
@@ -64,14 +72,13 @@ public static function assertLinksObjectContains($name, $expected, $links): void
      *
      * @param array|string|null $expected The expected link value
      * @param array|string|null $link     The link to test
-     * @param string            $message  An optional message to explain why the test failed
      *
      * @return void
      * @throws \PHPUnit\Framework\ExpectationFailedException
      */
-    public static function assertLinkObjectEquals($expected, $link, string $message = ''): void
+    public static function assertLinkObjectEquals($expected, $link): void
     {
-        PHPUnit::assertThat($link, self::linkEqualsConstraint($expected), $message);
+        PHPUnit::assertThat($link, self::linkEqualsConstraint($expected));
     }
 
     /**

src/Asserts/Content/AssertPagination.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\Assert as PHPUnit;
 use VGirol\JsonApiAssert\Constraint\PaginationLinksEqualConstraint;
 use VGirol\JsonApiAssert\Members;
+use VGirol\JsonApiAssert\Messages;
 
 /**
  * This trait adds the ability to test pagination (links and meta).
@@ -76,7 +77,11 @@ public static function assertHasNoPaginationLinks($links): void
      */
     public static function assertPaginationLinksEquals($expected, $json): void
     {
-        PHPUnit::assertThat($json, self::paginationLinksEqualConstraint($expected));
+        PHPUnit::assertThat(
+            $json,
+            self::paginationLinksEqualConstraint($expected),
+            Messages::PAGINATION_LINKS_NOT_EQUAL
+        );
     }
 
     /**

src/Asserts/Content/AssertResource.php

@@ -61,10 +61,8 @@ public static function assertResourceCollectionEquals($expected, $json)
             sprintf(Messages::RESOURCE_COLLECTION_HAVE_NOT_SAME_LENGTH, $count, $expectedCount)
         );
 
-        $index = 0;
-        foreach ($expected as $resource) {
+        foreach ($expected as $index => $resource) {
             static::assertResourceObjectEquals($resource, $json[$index]);
-            $index++;
         }
     }
 

src/Asserts/Content/AssertResourceLinkage.php

@@ -5,6 +5,7 @@
 namespace VGirol\JsonApiAssert\Asserts\Content;
 
 use PHPUnit\Framework\Assert as PHPUnit;
+use VGirol\JsonApiAssert\Messages;
 
 /**
  * This trait adds the ability to test resource linkage (single or collection).
@@ -25,7 +26,11 @@ trait AssertResourceLinkage
      */
     public static function assertResourceIdentifierEquals($expected, $json)
     {
-        PHPUnit::assertSame($expected, $json);
+        PHPUnit::assertSame(
+            $expected,
+            $json,
+            sprintf(Messages::RESOURCE_IDENTIFIER_IS_NOT_EQUAL, var_export($json, true), var_export($expected, true))
+        );
     }
 
     /**
@@ -49,7 +54,14 @@ public static function assertResourceIdentifierEquals($expected, $json)
     public static function assertResourceIdentifierCollectionEquals($expected, $json)
     {
         static::assertIsArrayOfObjects($json);
-        PHPUnit::assertEquals(count($expected), count($json));
+
+        $expectedCount = count($expected);
+        $count = count($json);
+        PHPUnit::assertEquals(
+            $expectedCount,
+            $count,
+            sprintf(Messages::RESOURCE_LINKAGE_COLLECTION_HAVE_NOT_SAME_LENGTH, $count, $expectedCount)
+        );
 
         $index = 0;
         foreach ($expected as $resource) {
@@ -89,12 +101,16 @@ public static function assertResourceLinkageEquals($expected, $json, $strict)
         static::assertIsValidResourceLinkage($json, $strict);
 
         if ($expected === null) {
-            PHPUnit::assertNull($json);
+            PHPUnit::assertNull(
+                $json,
+                sprintf(Messages::RESOURCE_LINKAGE_MUST_BE_NULL, var_export($json, true))
+            );
 
             return;
         }
 
-        PHPUnit::assertNotNull($json);
+        PHPUnit::assertNotNull($json, Messages::RESOURCE_LINKAGE_MUST_NOT_BE_NULL);
+
         /** @var array $json */
 
         if (!static::isArrayOfObjects($expected)) {
@@ -105,7 +121,7 @@ public static function assertResourceLinkageEquals($expected, $json, $strict)
         }
 
         if (count($expected) == 0) {
-            PHPUnit::assertEmpty($json);
+            PHPUnit::assertEmpty($json, Messages::RESOURCE_LINKAGE_COLLECTION_MUST_BE_EMPTY);
 
             return;
         }

src/Constraint/PaginationLinksEqualConstraint.php

@@ -6,7 +6,6 @@
 
 use PHPUnit\Framework\Constraint\Constraint;
 use VGirol\JsonApiAssert\Constraint\LinkEqualsConstraint;
-use VGirol\JsonApiAssert\Members;
 
 /**
  * A constraint class to assert that a link object equals an expected value.

src/Messages.php

@@ -119,4 +119,18 @@ abstract class Messages
     'Failed asserting that the resource collection length (%u) is equal to %u.';
     const RESOURCE_IS_NOT_EQUAL =
     'Failed asserting that the resource %s is equal to %s.';
+    const PAGINATION_LINKS_NOT_EQUAL =
+    'Failed asserting that pagination links equal expected values.';
+    const RESOURCE_LINKAGE_COLLECTION_MUST_BE_EMPTY =
+    'Failed asserting that the resource linkage collection is empty.';
+    const RESOURCE_LINKAGE_COLLECTION_HAVE_NOT_SAME_LENGTH =
+    'Failed asserting that the resource linkage collection length (%u) is equal to %u.';
+    const RESOURCE_IDENTIFIER_IS_NOT_EQUAL =
+    'Failed asserting that the resource identifier %s is equal to %s.';
+    const RESOURCE_LINKAGE_MUST_BE_NULL =
+    'Failed asserting that the resource linkage %s is null.';
+    const RESOURCE_LINKAGE_MUST_NOT_BE_NULL =
+    'Failed asserting that the resource linkage is not null.';
+    const LINKS_OBJECT_HAVE_NOT_SAME_LENGTH =
+    'Failed asserting that the links collection length (%u) is equal to %u.';
 }