Mutation testing + more UT

MacFJA · MacFJA · commit 18413697e5d8 · 2021-03-16T20:32:23.000+01:00
diff --git a/.gitattributes b/.gitattributes
@@ -22,6 +22,7 @@ Makefile  text
 /.unused.php      export-ignore
 /CHANGELOG.md     export-ignore
 /CONTRIBUTING.md  export-ignore
+/infection.json   export-ignore
 /Makefile         export-ignore
 /phpmd.xml        export-ignore
 /phpstan.neon     export-ignore
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@
 /.php_cs.cache
 /.phpunit.cache/
 /.phpunit.result.cache
+/infection.log
diff --git a/.php_cs b/.php_cs
@@ -256,8 +256,6 @@ return PhpCsFixer\Config::create()
         'no_php4_constructor' => true,
         // Adds or removes `?` before type declarations for parameters with a default `null` value.
         'nullable_type_declaration_for_default_null_value' => true,
-        // A return statement wishing to return `void` should not return `null`.
-        'simplified_null_return' => true,
         // Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.
         'phpdoc_line_span' => ['const'=>'multi','property'=>'single'],
         // Function `implode` must be called with 2 arguments in the documented order.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,7 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add **Deprecated** section in `CHANGELOG.md`
 - Add Redis pipeline support
 - Prefix properties name with `@` in Aggregation's SortBy (keep BC)
-- Add more unit tests (Aggregation options, Field creation)
+- Add more unit tests (Aggregation options, Field creation, DataHelper, RedisHelper)
+- (dev) Add mutation testing
 
 ### Changed
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -34,12 +34,20 @@ The application use PSR-12 code conventions, strong typing.
 
 The source code must be, at least, compatible with **PHP 7.2**.
 
-Check your code by running the command:
+Check your code by running the commands:
 ```sh
 make analyze
+make test
 ```
 The command will output any information worth knowing. No error should be left.
 
+If Xdebug is installed, you can also run the commands:
+```sh
+make coverage
+make mutation-test
+```
+Ideally, coverage should only increase, and **Covered Code MSI** shouldn't be below 95%
+
 ----
 
 Thanks!
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: analyze fix-code test coverage
+.PHONY: analyze fix-code test coverage mutation-test clean
 
 analyze: | vendor
 	$(COMPOSER) exec -v parallel-lint -- src
@@ -24,6 +24,14 @@ coverage: | vendor
 	@if [ -z "`php -v | grep -i 'xdebug'`" ]; then echo "You need to install Xdebug in order to do this action"; exit 1; fi
 	$(COMPOSER) exec -v phpunit -- --coverage-text --color
 
+mutation-test: | vendor
+	@if [ -z "`php -v | grep -i 'xdebug'`" ]; then echo "You need to install Xdebug in order to do this action"; exit 1; fi
+	$(COMPOSER) exec -v infection -- --only-covered --min-covered-msi=95
+
+clean:
+	rm -rf .phpunit.cache vendor
+	rm -f .php_cs.cache .phpunit.result.cache composer.phar composer.lock infection.log
+
 vendor: composer.json
 	$(COMPOSER) install --optimize-autoloader --no-suggest --prefer-dist
 	touch vendor
diff --git a/composer.json b/composer.json
@@ -24,6 +24,7 @@
         "enlightn/security-checker": "^1.5",
         "ergebnis/composer-normalize": "^2.13",
         "friendsofphp/php-cs-fixer": "^2.16",
+        "infection/infection": "^0.18.2",
         "insolita/unused-scanner": "^2.2",
         "phan/phan": "^3.2",
         "php-parallel-lint/php-parallel-lint": "^1.2",
diff --git a/infection.json b/infection.json
@@ -0,0 +1,29 @@
+{
+    "source": {
+        "directories": [
+            "src"
+        ]
+    },
+    "logs": {
+        "text": "infection.log"
+    },
+    "mutators": {
+        "@default": true,
+        "global-ignoreSourceCodeByRegex": [
+            "throw new RuntimeException\\(sprintf\\('The assertion of %s::%s at line %d failed\\.'.+",
+            "for \\(.+\\) \\{"
+        ],
+        "DecrementInteger": {
+            "ignore": [
+                "MacFJA\\RediSearch\\Aggregate\\Exception\\UnknownSortDirectionException",
+                "MacFJA\\RediSearch\\Search\\Exception\\UnknownUnitException"
+            ]
+        },
+        "OneZeroInteger": {
+            "ignore": [
+                "MacFJA\\RediSearch\\Aggregate\\Exception\\UnknownSortDirectionException",
+                "MacFJA\\RediSearch\\Search\\Exception\\UnknownUnitException"
+            ]
+        }
+    }
+}
diff --git a/src/Aggregate/Exception/UnknownSortDirectionException.php b/src/Aggregate/Exception/UnknownSortDirectionException.php
@@ -33,7 +33,7 @@ class UnknownSortDirectionException extends UnexpectedValueException
      */
     public function __construct(array $directions, int $code = 0, ?Throwable $previous = null)
     {
-        $message = sprintf('Sort By direction can only be "ASC" or "DESC". Provided: %s', implode(', ', $directions));
+        $message = sprintf('Sort By direction can only be "ASC" or "DESC". Provided: %s.', implode(', ', $directions));
         parent::__construct($message, $code, $previous);
     }
 }
diff --git a/src/Aggregate/SortBy.php b/src/Aggregate/SortBy.php
@@ -39,6 +39,8 @@ class SortBy implements \MacFJA\RediSearch\PartialQuery
 
     public const SORT_DESC = 'DESC';
 
+    private const SORT_ACCEPTABLE_VALUES = [self::SORT_ASC, self::SORT_DESC];
+
     /**
      * @psalm-var array<string,"ASC"|"DESC">
      * @phpstan-var array<string,"ASC"|"DESC">
@@ -61,10 +63,10 @@ class SortBy implements \MacFJA\RediSearch\PartialQuery
     public function __construct(array $properties, ?int $max = null)
     {
         DataHelper::assertArrayOf(array_keys($properties), 'string');
-        $allValues = array_unique(array_merge($properties, ['ASC', 'DESC']));
+        $allValues = array_unique(array_merge($properties, self::SORT_ACCEPTABLE_VALUES));
         DataHelper::assert(
             2 === count($allValues),
-            new UnknownSortDirectionException(array_diff($allValues, ['ASC', 'DESC']))
+            new UnknownSortDirectionException(array_diff($allValues, self::SORT_ACCEPTABLE_VALUES))
 
         );
         DataHelper::assert(null === $max || $max >= 0, new OutOfRangeException('MAX such by greater or equals to 0'));
diff --git a/src/Helper/RedisHelper.php b/src/Helper/RedisHelper.php
@@ -27,6 +27,7 @@
 use function array_filter;
 use function array_keys;
 use function array_merge;
+use function array_pop;
 use function array_shift;
 use function assert;
 use function count;
@@ -125,6 +126,9 @@ public static function buildQueryPartial(array $query, array $partials): array
      */
     public static function getPairs(array $notKeyedArray): array
     {
+        if (count($notKeyedArray) % 2 > 0) {
+            array_pop($notKeyedArray);
+        }
         $entries = array_chunk($notKeyedArray, 2);
         $keyed = array_combine(array_column($entries, 0), array_column($entries, 1));
         assert(is_array($keyed));
@@ -133,14 +137,16 @@ public static function getPairs(array $notKeyedArray): array
     }
 
     /**
-     * @param array<float|int|string> $notKeyedArray
+     * @param array<bool|float|int|string> $notKeyedArray
+     *
+     * @return null|bool|float|int|string
      */
-    public static function getValue(array $notKeyedArray, string $key): ?string
+    public static function getValue(array $notKeyedArray, string $key)
     {
-        while (count($notKeyedArray) > 0) {
+        while (count($notKeyedArray) >= 2) {
             $shifted = array_shift($notKeyedArray);
-            if ($shifted === $key && count($notKeyedArray) > 0) {
-                return (string) array_shift($notKeyedArray);
+            if ($shifted === $key) {
+                return array_shift($notKeyedArray);
             }
         }
 
diff --git a/src/Index/InfoResult.php b/src/Index/InfoResult.php
@@ -171,7 +171,8 @@ public function getFieldsAsObject(): array
                 case 'TAG':
                     return new TagField(
                         $name,
-                        RedisHelper::getValue($field, 'SEPARATOR'),
+                        /** @phan-suppress-next-line PhanPartialTypeMismatchArgument */
+                        DataHelper::nullOrCast(RedisHelper::getValue($field, 'SEPARATOR'), 'string'),
                         in_array('SORTABLE', $field, true),
                         in_array('NOINDEX', $field, true)
                     );
@@ -181,7 +182,8 @@ public function getFieldsAsObject(): array
                         in_array('NOSTEM', $field, true),
                         /** @phan-suppress-next-line PhanPartialTypeMismatchArgument */
                         DataHelper::nullOrCast(RedisHelper::getValue($field, 'WEIGHT'), 'float'),
-                        RedisHelper::getValue($field, 'PHONETIC'),
+                        /** @phan-suppress-next-line PhanPartialTypeMismatchArgument */
+                        DataHelper::nullOrCast(RedisHelper::getValue($field, 'PHONETIC'), 'string'),
                         in_array('SORTABLE', $field, true),
                         in_array('NOINDEX', $field, true)
                     );
diff --git a/tests/Aggregate/GroupByTest.php b/tests/Aggregate/GroupByTest.php
@@ -24,6 +24,7 @@
 use MacFJA\RediSearch\Aggregate\GroupBy;
 use MacFJA\RediSearch\Aggregate\Reducer;
 use PHPUnit\Framework\TestCase;
+use RuntimeException;
 use Tests\MacFJA\RediSearch\support\Assertion;
 
 /**
@@ -76,4 +77,16 @@ public function testNoReducer(): void
             new GroupBy(['name', 'age'], [])
         );
     }
+
+    public function testInvalidPropertiesDataType(): void
+    {
+        $this->expectException(RuntimeException::class);
+        new GroupBy([1, false], []);
+    }
+
+    public function testInvalidReducerDataType(): void
+    {
+        $this->expectException(RuntimeException::class);
+        new GroupBy([], ['foo', 1, false]);
+    }
 }
diff --git a/tests/Aggregate/ReducerTest.php b/tests/Aggregate/ReducerTest.php
@@ -23,6 +23,8 @@
 
 use MacFJA\RediSearch\Aggregate\Reducer;
 use PHPUnit\Framework\TestCase;
+use RuntimeException;
+use stdClass;
 use Tests\MacFJA\RediSearch\support\Assertion;
 
 /**
@@ -38,6 +40,12 @@ class ReducerTest extends TestCase
 {
     use Assertion;
 
+    public function testInvalidArgumentsDataType(): void
+    {
+        $this->expectException(RuntimeException::class);
+        new Reducer('foo', [new stdClass()]);
+    }
+
     /**
      * @covers ::count
      */
diff --git a/tests/Aggregate/SortByTest.php b/tests/Aggregate/SortByTest.php
@@ -25,6 +25,7 @@
 use MacFJA\RediSearch\Aggregate\SortBy;
 use OutOfRangeException;
 use PHPUnit\Framework\TestCase;
+use RuntimeException;
 use Tests\MacFJA\RediSearch\support\Assertion;
 
 /**
@@ -48,6 +49,10 @@ public function testNominal(): void
             'SORTBY 4 @name ASC @age DESC MAX 20',
             new SortBy(['name' => SortBy::SORT_ASC, 'age' => SortBy::SORT_DESC], 20)
         );
+        self::assertSameQuery(
+            'SORTBY 4 @name ASC @age DESC MAX 20',
+            new SortBy(['name' => SortBy::SORT_ASC, '@age' => SortBy::SORT_DESC], 20)
+        );
         self::assertSameQuery(
             'SORTBY 2 @name ASC', new SortBy(['name' => SortBy::SORT_ASC]));
     }
@@ -69,7 +74,13 @@ public function testInvalidMax(): void
     public function testInvalidSort(): void
     {
         $this->expectException(UnknownSortDirectionException::class);
-        $this->expectExceptionMessage('Sort By direction can only be "ASC" or "DESC". Provided: UP, DOWN');
+        $this->expectExceptionMessage('Sort By direction can only be "ASC" or "DESC". Provided: UP, DOWN.');
         new SortBy(['foo' => 'UP', 'bar' => 'DOWN']);
     }
+
+    public function testInvalidSortProperties(): void
+    {
+        $this->expectException(RuntimeException::class);
+        new SortBy([1 => 'ASC', false => 'DESC']);
+    }
 }
diff --git a/tests/Helper/DataHelperTest.php b/tests/Helper/DataHelperTest.php
@@ -0,0 +1,112 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright MacFJA
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+namespace Tests\MacFJA\RediSearch\Helper;
+
+use InvalidArgumentException;
+use MacFJA\RediSearch\Helper\DataHelper;
+use PHPUnit\Framework\TestCase;
+use RuntimeException;
+use stdClass;
+
+/**
+ * @coversDefaultClass \MacFJA\RediSearch\Helper\DataHelper
+ */
+class DataHelperTest extends TestCase
+{
+    /**
+     * @covers ::assert
+     */
+    public function testAssertTrue(): void
+    {
+        DataHelper::assert(true);
+        $this->expectNotToPerformAssertions();
+    }
+
+    /**
+     * @covers ::assert
+     */
+    public function testAssertFalse(): void
+    {
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('The assertion of Tests\MacFJA\RediSearch\Helper\DataHelperTest::testAssertFalse at line ');
+
+        DataHelper::assert(false);
+    }
+
+    /**
+     * @covers ::assert
+     */
+    public function testAssertFalseCustomException1(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        DataHelper::assert(false, InvalidArgumentException::class);
+    }
+
+    /**
+     * @covers ::assert
+     */
+    public function testAssertFalseCustomException2(): void
+    {
+        $exception = new InvalidArgumentException('not valid');
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('not valid');
+
+        DataHelper::assert(false, $exception);
+    }
+
+    /**
+     * @covers ::assert
+     */
+    public function testAssertFalseWrongCustomException(): void
+    {
+        $this->expectException(RuntimeException::class);
+
+        DataHelper::assert(false, stdClass::class);
+    }
+
+    /**
+     * @covers ::assert
+     */
+    public function testAssertEmbed1(): void
+    {
+        $runner = function () {
+            $this->expectException(RuntimeException::class);
+            $this->expectExceptionMessage('The assertion of Tests\MacFJA\RediSearch\Helper\DataHelperTest::Tests\MacFJA\RediSearch\Helper\{closure} at line ');
+            DataHelper::assert(false);
+        };
+        $runner();
+    }
+
+    /**
+     * @covers ::assert
+     */
+    public function testAssertEmbed2(): void
+    {
+        $runner = function () {
+            $this->expectException(RuntimeException::class);
+            $this->expectExceptionMessage('The assertion of Tests\MacFJA\RediSearch\Helper\DataHelperTest::testAssertEmbed2 at line ');
+            DataHelper::assert(false, null, 2);
+        };
+        $runner();
+    }
+}
diff --git a/tests/Helper/RedisHelperTest.php b/tests/Helper/RedisHelperTest.php
diff --git a/tests/Search/QueryBuilder/GeoFacetTest.php b/tests/Search/QueryBuilder/GeoFacetTest.php
diff --git a/tests/Search/QueryBuilder/NumericFacetTest.php b/tests/Search/QueryBuilder/NumericFacetTest.php

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ class UnknownSortDirectionException extends UnexpectedValueException`
`33`	`33`	`*/`
`34`	`34`	`public function __construct(array $directions, int $code = 0, ?Throwable $previous = null)`
`35`	`35`	`{`
`36`		`- $message = sprintf('Sort By direction can only be "ASC" or "DESC". Provided: %s', implode(', ', $directions));`
	`36`	`+ $message = sprintf('Sort By direction can only be "ASC" or "DESC". Provided: %s.', implode(', ', $directions));`
`37`	`37`	`parent::__construct($message, $code, $previous);`
`38`	`38`	`}`
`39`	`39`	`}`