add validateOptions helper method

Author: bshaffer

Core/src/ApiHelperTrait.php

@@ -20,6 +20,7 @@
 use Google\ApiCore\ArrayTrait;
 use Google\ApiCore\Options\CallOptions;
 use Google\Protobuf\NullValue;
+use Google\Protobuf\Internal\Message;
 
 /**
  * @internal
@@ -264,4 +265,42 @@ private function splitOptionalArgs(array $input, array $extraAllowedKeys = []):
 
         return [$input, $callOptions];
     }
+
+    /**
+     * Helper method used to validate optons based on the supplied $optionTypes
+     * $optionTypes can be an array of string keys, a protobuf Message classname, or a
+     * the CallOptions classname. Parameters are split and returned in the order
+     * that the options types are provided.
+     */
+    private function validateOptions(array $options, array|string ...$optionTypes): array
+    {
+        $splitOptions = [];
+        foreach ($optionTypes as $optionType) {
+            if (is_array($optionType)) {
+                $splitOptions[] = $this->pluckArray($optionType, $options);
+            } elseif (is_string($optionType)) {
+                if (is_subclass_of($optionType, Message::class)) {
+                    $messageKeys = array_map(
+                        fn ($method) => lcfirst(substr($method, 3)),
+                        array_filter(
+                            get_class_methods($optionType),
+                            fn ($m) => 0 === strpos($m, 'get')
+                        )
+                    );
+                    $splitOptions[] = $this->pluckArray($messageKeys, $options);
+                } elseif ($optionType === CallOptions::class) {
+                    $callOptionKeys = array_keys((new CallOptions([]))->toArray());
+                    $splitOptions[] = $this->pluckArray($callOptionKeys, $options);
+                }
+            }
+        }
+
+        if (!empty($options)) {
+            throw new \Exception(
+                'Unexpected option(s) provided: ' . implode(', ', array_keys($options))
+            );
+        }
+
+        return $splitOptions;
+    }
 }

Core/tests/Unit/ApiHelperTraitTest.php

@@ -17,9 +17,11 @@
 
 namespace Google\Cloud\Core\Tests\Unit;
 
+use Google\ApiCore\Options\CallOptions;
 use Google\Cloud\Core\Duration;
 use Google\Cloud\Core\Testing\GrpcTestTrait;
 use Google\Cloud\Core\Tests\Unit\Stubs\ApiHelpersTraitImpl;
+use Google\Cloud\Core\Tests\Unit\Stubs\TestMessage;
 use PHPUnit\Framework\TestCase;
 use Prophecy\PhpUnit\ProphecyTrait;
 
@@ -258,4 +260,83 @@ public function unpackValueProvider()
             ]
         ];
     }
+
+    /**
+     * @dataProvider validateOptionsProvider
+     */
+    public function testValidateOptions($options, $optionTypes, $expected)
+    {
+        $this->assertEquals(
+            $expected,
+            $this->implementation->validateOptions($options, ...$optionTypes)
+        );
+    }
+
+    public function validateOptionsProvider()
+    {
+        return [
+            [
+                [
+                    'foo' => 'bar',
+                    'baz' => 'bat',
+                    'qux' => 'quux',
+                ],
+                [
+                    ['foo', 'baz', 'qux'],
+                ],
+                [
+                    [
+                        'foo' => 'bar',
+                        'baz' => 'bat',
+                        'qux' => 'quux',
+                    ],
+                ]
+            ],
+            [
+                [
+                    'baz' => 'bat',
+                    'qux' => 'quux',
+                    'timeoutMillis' => 123,
+                ],
+                [
+                    CallOptions::class,
+                    TestMessage::class,
+                    ['qux'],
+                ],
+                [
+                    ['timeoutMillis' => 123],
+                    ['baz' => 'bat'],
+                    ['qux' => 'quux'],
+                ]
+            ],
+            [
+                [
+                    'baz' => 'bat',
+                ],
+                [
+                    ['baz'],
+                    TestMessage::class,
+                    CallOptions::class,
+                ],
+                [
+                    ['baz' => 'bat'],
+                    [],
+                    [],
+                ]
+            ],
+        ];
+    }
+
+    public function testValidateOptionsThrowsException()
+    {
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage('Unexpected option(s) provided: bar');
+
+        $options = [
+            'foo' => 'bar',
+            'bar' => 'baz',
+        ];
+
+        $this->implementation->validateOptions($options, ['foo']);
+    }
 }

Core/tests/Unit/Stubs/ApiHelpersTraitImpl.php

@@ -31,5 +31,6 @@ class ApiHelpersTraitImpl
         formatDurationForApi as public;
         formatValueForApi as public;
         unpackValue as public;
+        validateOptions as public;
     }
 }