Merge pull request GoogleCloudPlatform#1199 from GoogleCloudPlatform/functions-scopes

feat(functions): add scopes sample

Author: Ace Nassri

functions/tips_scopes/composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "google/cloud-functions-framework": "^0.7.1"
+    }
+}

functions/tips_scopes/index.php

@@ -0,0 +1,64 @@
+
+/**
+ * Copyright 2020 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.
+ */
+
+function _heavyComputation(): int
+{
+    return 1 * 2 * 3 * 4 * 5;
+}
+
+function _lightComputation(): int
+{
+    return 1 + 2 + 3 + 4 + 5;
+}
+
+// [START functions_tips_scopes]
+
+use Psr\Http\Message\ServerRequestInterface;
+
+function scopeDemo(ServerRequestInterface $request): string
+{
+    // Heavy computations should be cached between invocations.
+    // The PHP runtime does NOT preserve variables between invocations, so we
+    // must write their values to a file or otherwise cache them.
+    // (All writable directories in Cloud Functions are in-memory, so
+    // file-based caching operations are typically fast.)
+    // You can also use PSR-6 caching libraries for this task:
+    // https://packagist.org/providers/psr/cache-implementation
+    $cachePath = sys_get_temp_dir() . '/cached_value.txt';
+
+    $response = '';
+    if (file_exists($cachePath)) {
+        // Read cached value from file
+        $response .= "Reading cached value." . PHP_EOL;
+        $instanceVar = file_get_contents($cachePath);
+    } else {
+        // Compute cached value + write to file
+        $response .= "Cache empty, computing value." . PHP_EOL;
+        $instanceVar = _heavyComputation();
+        file_put_contents($cachePath, $instanceVar);
+    }
+
+    // Lighter computations can re-run on each function invocation.
+    $functionVar = _lightComputation();
+
+    $response .= 'Per instance: ' . $instanceVar . PHP_EOL;
+    $response .= 'Per function: ' . $functionVar . PHP_EOL;
+
+    return $response;
+}
+
+// [END functions_tips_scopes]

functions/tips_scopes/phpunit.xml.dist

@@ -0,0 +1,34 @@
+xml version="1.0" encoding="UTF-8"?>
+
+<phpunit bootstrap="../../testing/bootstrap.php" convertWarningsToExceptions="false">
+    <testsuites>
+        <testsuite name="Cloud Functions Scope Test Suite">
+            <directory>testdirectory>
+        testsuite>
+    testsuites>
+    <logging>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    logging>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">.directory>
+            <exclude>
+              <directory>./vendordirectory>
+            exclude>
+        whitelist>
+    filter>
+phpunit>

functions/tips_scopes/test/DeployTest.php

@@ -0,0 +1,66 @@
+
+/**
+ * Copyright 2020 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.
+ */
+
+declare(strict_types=1);
+
+namespace Google\Cloud\Samples\Functions\HelloworldGet\Test;
+
+use Google\Cloud\TestUtils\CloudFunctionDeploymentTrait;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Class DeployTest.
+ *
+ * This test is not run by the CI system.
+ *
+ * To skip deployment of a new function, run with "GOOGLE_SKIP_DEPLOYMENT=true".
+ * To skip deletion of the tested function, run with "GOOGLE_KEEP_DEPLOYMENT=true".
+ */
+class DeployTest extends TestCase
+{
+    use CloudFunctionDeploymentTrait;
+
+    private static $entryPoint = 'scopeDemo';
+
+    public function testFunction(): void
+    {
+        // Send a request to the function.
+        $firstResp = $this->client->post('', [
+            // Uncomment and CURLOPT_VERBOSE debug content will be sent to stdout.
+            // 'debug' => true
+        ]);
+        $secondResp = $this->client->post('', [
+            // Uncomment and CURLOPT_VERBOSE debug content will be sent to stdout.
+            // 'debug' => true
+        ]);
+
+        // Assert status codes.
+        $this->assertEquals('200', $firstResp->getStatusCode());
+        $this->assertEquals('200', $secondResp->getStatusCode());
+
+        $firstOutput = trim((string) $firstResp->getBody());
+        $secondOutput = trim((string) $secondResp->getBody());
+
+        // Assert generic function output.
+        $this->assertContains('Per instance: 120', $firstOutput);
+        $this->assertContains('Per function: 15', $firstOutput);
+
+        // Assert caching behavior.
+        $this->assertContains('Cache empty', $firstOutput);
+        $this->assertContains('Reading cached value', $secondOutput);
+    }
+}

functions/tips_scopes/test/IntegrationTest.php

@@ -0,0 +1,44 @@
+
+/**
+ * Copyright 2020 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.
+ */
+declare(strict_types=1);
+
+namespace Google\Cloud\Samples\Functions\HelloworldGet\Test;
+
+use PHPUnit\Framework\TestCase;
+use Google\Cloud\TestUtils\CloudFunctionLocalTestTrait;
+
+/**
+ * Class IntegrationTest.
+ */
+class IntegrationTest extends TestCase
+{
+    use CloudFunctionLocalTestTrait;
+
+    private static $entryPoint = 'scopeDemo';
+
+    public function testFunction(): void
+    {
+        // Send two requests to the function.
+        // (This tests cross-request caching behavior.)
+        $firstResp = $this->client->post('/');
+        $secondResp = $this->client->post('/');
+
+        // Assert status codes.
+        $this->assertEquals('200', $firstResp->getStatusCode());
+        $this->assertEquals('200', $secondResp->getStatusCode());
+    }
+}

functions/tips_scopes/test/UnitTest.php

@@ -0,0 +1,48 @@
+
+/**
+ * Copyright 2020 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.
+ */
+declare(strict_types=1);
+
+namespace Google\Cloud\Samples\Functions\HelloworldGet\Test;
+
+use GuzzleHttp\Psr7\ServerRequest;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Unit tests for the Cloud Function.
+ */
+class UnitTest extends TestCase
+{
+    private static $entryPoint = 'scopeDemo';
+
+    public static function setUpBeforeClass(): void
+    {
+        require_once __DIR__ . '/../index.php';
+    }
+
+    public function testFunction(): void
+    {
+        $request = new ServerRequest('POST', '/');
+        $output = $this->runFunction(self::$entryPoint, [$request]);
+        $this->assertContains('Per instance: 120', $output);
+        $this->assertContains('Per function: 15', $output);
+    }
+
+    private static function runFunction($functionName, array $params = []): string
+    {
+        return call_user_func_array($functionName, $params);
+    }
+}