PHPLIB-1093: Assert $expectedType array is non-empty for InvalidArgumentException (#1049)

* PHPLIB-1093: Assert $expectedType array is non-empty for InvalidArgumentException

This also factors out the logic for converting an $expectedType array to a string.

Co-authored-by: Andreas Braun <[email protected]>

Author: jmikola

phpunit.evergreen.xml

@@ -11,8 +11,10 @@
 >
 
     <php>
+        <ini name="assert.exception" value="1"/>
         <ini name="error_reporting" value="-1"/>
         <ini name="memory_limit" value="-1"/>
+        <ini name="zend.assertions" value="1"/>
         <env name="MONGODB_URI" value="mongodb://127.0.0.1:27017/?serverSelectionTimeoutMS=100"/>
         <env name="MONGODB_DATABASE" value="phplib_test"/>
     </php>

phpunit.xml.dist

@@ -11,7 +11,9 @@
 >
 
     <php>
+        <ini name="assert.exception" value="1"/>
         <ini name="error_reporting" value="-1"/>
+        <ini name="zend.assertions" value="1"/>
         <env name="MONGODB_URI" value="mongodb://127.0.0.1:27017/?serverSelectionTimeoutMS=100"/>
         <env name="MONGODB_DATABASE" value="phplib_test"/>
     </php>

src/Exception/InvalidArgumentException.php

@@ -20,6 +20,7 @@
 use MongoDB\Driver\Exception\InvalidArgumentException as DriverInvalidArgumentException;
 
 use function array_pop;
+use function assert;
 use function count;
 use function get_debug_type;
 use function implode;
@@ -31,32 +32,31 @@ class InvalidArgumentException extends DriverInvalidArgumentException implements
     /**
      * Thrown when an argument or option has an invalid type.
      *
-     * @param string          $name         Name of the argument or option
-     * @param mixed           $value        Actual value (used to derive the type)
-     * @param string|string[] $expectedType Expected type
+     * @param string              $name         Name of the argument or option
+     * @param mixed               $value        Actual value (used to derive the type)
+     * @param string|list<string> $expectedType Expected type as a string or an array containing one or more strings
      * @return self
      */
     public static function invalidType(string $name, $value, $expectedType)
     {
         if (is_array($expectedType)) {
-            switch (count($expectedType)) {
-                case 1:
-                    $typeString = array_pop($expectedType);
-                    break;
-
-                case 2:
-                    $typeString = implode('" or "', $expectedType);
-                    break;
-
-                default:
-                    $lastType = array_pop($expectedType);
-                    $typeString = sprintf('%s", or "%s', implode('", "', $expectedType), $lastType);
-                    break;
-            }
-
-            $expectedType = $typeString;
+            $expectedType = self::expectedTypesToString($expectedType);
         }
 
         return new static(sprintf('Expected %s to have type "%s" but found "%s"', $name, $expectedType, get_debug_type($value)));
     }
+
+    /** @param list<string> $types */
+    private static function expectedTypesToString(array $types): string
+    {
+        assert(count($types) > 0);
+
+        if (count($types) < 3) {
+            return implode('" or "', $types);
+        }
+
+        $lastType = array_pop($types);
+
+        return sprintf('%s", or "%s', implode('", "', $types), $lastType);
+    }
 }

tests/Exception/InvalidArgumentExceptionTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace MongoDB\Tests\Exception;
+
+use AssertionError;
+use MongoDB\Exception\InvalidArgumentException;
+use MongoDB\Tests\TestCase;
+
+class InvalidArgumentExceptionTest extends TestCase
+{
+    /**
+     * @dataProvider provideExpectedTypes
+     */
+    public function testExpectedTypeFormatting($expectedType, $typeString): void
+    {
+        $e = InvalidArgumentException::invalidType('$arg', null, $expectedType);
+        $this->assertStringContainsString($typeString, $e->getMessage());
+    }
+
+    public function provideExpectedTypes()
+    {
+        yield 'expectedType is a string' => [
+            'array',
+            'type "array"',
+        ];
+
+        yield 'expectedType is an array with one string' => [
+            ['array'],
+            'type "array"',
+        ];
+
+        yield 'expectedType is an array with two strings' => [
+            ['array', 'integer'],
+            'type "array" or "integer"',
+        ];
+
+        yield 'expectedType is an array with three strings' => [
+            ['array', 'integer', 'object'],
+            'type "array", "integer", or "object"',
+        ];
+    }
+
+    public function testExpectedTypeArrayMustNotBeEmpty(): void
+    {
+        $this->expectException(AssertionError::class);
+        InvalidArgumentException::invalidType('$arg', null, []);
+    }
+}