seeInRedis displays difference between expected value to actual value (#14)

* seeInRedis compares expected value to actual value

* Remove boolean flag

* Compare zset as string

because ArrayComparator considers out of order arrays as equal

Author: Naktibalda

composer.json

@@ -17,7 +17,8 @@
 	"require": {
 		"php": "^7.4 || ^8.0",
 		"codeception/codeception": "^4.0",
-		"predis/predis": "^1.0"
+		"predis/predis": "^1.0",
+		"sebastian/comparator": "^4.0"
 	},
 	"autoload": {
 		"classmap": [

src/Codeception/Module/Redis.php

@@ -9,7 +9,10 @@
 use Codeception\Exception\ModuleException;
 use Codeception\TestInterface;
 use Exception;
+use PHPUnit\Framework\ExpectationFailedException;
 use Predis\Client as RedisDriver;
+use SebastianBergmann\Comparator\ComparisonFailure;
+use SebastianBergmann\Comparator\Factory as ComparatorFactory;
 
 /**
  * This module uses the [Predis](https://github.com/nrk/predis) library
@@ -363,10 +366,15 @@ public function haveInRedis(string $type, string $key, $value): void
      */
     public function dontSeeInRedis(string $key, $value = null): void
     {
-        $this->assertFalse(
-            $this->checkKeyExists($key, $value),
-            sprintf('The key "%s" exists', $key) . ($value ? ' and its value matches the one provided' : '')
-        );
+        try {
+            $this->assertFalse(
+                $this->checkKeyExists($key, $value),
+                sprintf('The key "%s" exists', $key) . ($value ? ' and its value matches the one provided' : '')
+            );
+        } catch (ComparisonFailure $failure) {
+            // values are different
+            $this->assertFalse(false);
+        }
     }
 
     /**
@@ -447,10 +455,17 @@ public function dontSeeRedisKeyContains(string $key, $item, $itemValue = null):
      */
     public function seeInRedis(string $key, $value = null): void
     {
-        $this->assertTrue(
-            $this->checkKeyExists($key, $value),
-            sprintf('Cannot find key "%s"', $key) . ($value ? ' with the provided value' : '')
-        );
+        try {
+            $this->assertTrue(
+                $this->checkKeyExists($key, $value),
+                sprintf('Cannot find key "%s"', $key)
+            );
+        } catch (ComparisonFailure $failure) {
+            throw new ExpectationFailedException(
+                sprintf("Value of key \"%s\" does not match expected value", $key),
+                $failure
+            );
+        }
     }
 
     /**
@@ -620,12 +635,16 @@ private function checkKeyContains(string $key, $item, $itemValue = null): bool
      * @param mixed  $value Optional. If specified, also checks the key has this
      * value. Booleans will be converted to 1 and 0 (even inside arrays)
      */
-    private function checkKeyExists(string $key, $value = null): bool
+    private function checkKeyExists(string $key, $value): bool
     {
         $type = $this->driver->type($key);
 
+        if ($type == 'none') {
+            return false;
+        }
+
         if (is_null($value)) {
-            return $type != 'none';
+            return true;
         }
 
         $value = $this->boolToString($value);
@@ -666,7 +685,30 @@ private function checkKeyExists(string $key, $value = null): bool
                 break;
 
             default:
-                $result = false;
+                throw new ModuleException(
+                    $this,
+                    sprintf("Unexpected value type %s", $type)
+                );
+        }
+
+        if (!$result) {
+            $comparatorFactory = new ComparatorFactory();
+            $comparator = $comparatorFactory->getComparatorFor($value, $reply);
+            $comparator->assertEquals($value, $reply);
+
+            if ($type == 'zset') {
+                /**
+                 * ArrayComparator considers out of order assoc arrays as equal
+                 * So we have to compare them as strings
+                 */
+                $replyAsString = var_export($reply, true);
+                $valueAsString = var_export($value, true);
+                $comparator = $comparatorFactory->getComparatorFor($valueAsString, $replyAsString);
+                $comparator->assertEquals($valueAsString, $replyAsString);
+            }
+            // If comparator things that values are equal, then we trust it
+            // This shouldn't happen in practice.
+            return true;
         }
 
         return $result;

tests/unit/Codeception/Module/RedisTest.php

@@ -956,12 +956,15 @@ public function testDontSeeRedisKeyContainsHashWithIncorrectFieldWithValue()
     public function testSeeInRedisNonExistingKeyWithoutValue()
     {
         $this->shouldFail();
+        $this->expectExceptionMessage('Cannot find key "doesnotexist"');
         $this->module->seeInRedis('doesnotexist');
     }
 
     public function testSeeInRedisNonExistingKeyWithValue()
     {
         $this->shouldFail();
+        $this->expectExceptionMessageMatches('/^Cannot find key "doesnotexist"' .
+            "\n" . 'Failed asserting that false is true.$/');
         $this->module->seeInRedis(
             'doesnotexist',
             'some value'
@@ -994,6 +997,7 @@ public function testSeeInRedisExistingStringWithCorrectValue()
     public function testSeeInRedisExistingStringWithIncorrectValue()
     {
         $this->shouldFail();
+        $this->expectExceptionMessage('Value of key "test:string" does not match expected value');
         $this->module->seeInRedis(
             self::$keys['string']['name'],
             'incorrect value'
@@ -1024,6 +1028,7 @@ public function testSeeInRedisExistingListWithCorrectValueDifferentOrder()
     public function testSeeInRedisExistingListWithIncorrectValue()
     {
         $this->shouldFail();
+        $this->expectExceptionMessage('Value of key "test:list" does not match expected value');
         $this->module->seeInRedis(
             self::$keys['list']['name'],
             ['incorrect', 'value']
@@ -1053,6 +1058,7 @@ public function testSeeInRedisExistingSetWithCorrectValueDifferentOrder()
     public function testSeeInRedisExistingSetWithIncorrectValue()
     {
         $this->shouldFail();
+        $this->expectExceptionMessage('Value of key "test:set" does not match expected value');
         $this->module->seeInRedis(
             self::$keys['set']['name'],
             ['incorrect', 'value']
@@ -1092,6 +1098,7 @@ public function testSeeInRedisExistingZSetWithCorrectValueDifferentOrder()
     public function testSeeInRedisExistingZSetWithIncorrectValue()
     {
         $this->shouldFail();
+        $this->expectExceptionMessage('Value of key "test:zset" does not match expected value');
         $this->module->seeInRedis(
             self::$keys['zset']['name'],
             ['incorrect' => 1, 'value' => 2]
@@ -1121,6 +1128,7 @@ public function testSeeInRedisExistingHashWithCorrectValueDifferentOrder()
     public function testSeeInRedisExistingHashWithIncorrectValue()
     {
         $this->shouldFail();
+        $this->expectExceptionMessage('Value of key "test:hash" does not match expected value');
         $this->module->seeInRedis(
             self::$keys['hash']['name'],
             ['incorrect' => 'value']