feat: add class for testing (GoogleCloudPlatform#119)

bshaffer · web-flow · commit 41ab52514051 · 2021-12-02T10:31:55.000-08:00
diff --git a/src/FunctionsFrameworkTesting.php b/src/FunctionsFrameworkTesting.php
@@ -0,0 +1,46 @@
+<?php
+
+/**
+ * Copyright 2021 Google LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Google\CloudFunctions;
+
+use ReflectionClass;
+
+class FunctionsFrameworkTesting
+{
+    private function __construct()
+    {
+        // Constructor disabled because this class should only be used statically.
+    }
+
+    public static function getRegisteredFunction(string $functionName)
+    {
+        $registeredFunctionsReflection = (new ReflectionClass(Invoker::class))
+            ->getProperty('registeredFunctions');
+        $registeredFunctionsReflection->setAccessible(true);
+
+        $fn = $registeredFunctionsReflection->getValue()[$functionName] ?? null;
+
+        if ($fn) {
+            $functionReflection = (new ReflectionClass($fn))
+                ->getProperty('function');
+            $functionReflection->setAccessible(true);
+
+            return $functionReflection->getValue($fn);
+        }
+    }
+}
diff --git a/tests/FunctionsFrameworkTest.php b/tests/FunctionsFrameworkTest.php
@@ -0,0 +1,65 @@
+<?php
+/**
+ * Copyright 2021 Google LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Google\CloudFunctions\Tests;
+
+use Google\CloudFunctions\FunctionsFramework;
+use Google\CloudFunctions\FunctionsFrameworkTesting;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\ServerRequestInterface;
+use CloudEvents\V1\CloudEventInterface;
+
+/**
+ * @group gcf-framework
+ */
+class FunctionsFrameworkTest extends TestCase
+{
+    public function testRegisterAndRetrieveHttpFunction(): void
+    {
+        $fn = function (ServerRequestInterface $request) {
+            return "this is a test function";
+        };
+
+        FunctionsFramework::http('testFn', $fn);
+
+        $this->assertEquals(
+            $fn,
+            FunctionsFrameworkTesting::getRegisteredFunction('testFn')
+        );
+    }
+
+    public function testRegisterAndRetrieveCloudEventFunction(): void
+    {
+        $fn = function (CloudEventInterface $event) {
+            return "this is a test function";
+        };
+
+        FunctionsFramework::cloudEvent('testFn', $fn);
+
+        $this->assertEquals(
+            $fn,
+            FunctionsFrameworkTesting::getRegisteredFunction('testFn')
+        );
+    }
+
+    public function testRetrieveNonexistantFunction(): void
+    {
+        $this->assertNull(
+            FunctionsFrameworkTesting::getRegisteredFunction('thisDoesntExist')
+        );
+    }
+}
