Memorystore sample for App Engine PHP 7.2 (GoogleCloudPlatform#908)

Author: bshaffer

appengine/php72/memorystore/README.md

@@ -0,0 +1,130 @@
+# Connect to Cloud Memorystore from Google App Engine
+
+This sample application demonstrates how to use
+[Cloud Memorystore for Redis](https://cloud.google.com/memorystore/docs/)
+with Google App Engine for PHP 7.2.
+
+**Prerequisites**
+
+- Install the [Google Cloud SDK](https://developers.google.com/cloud/sdk/).
+
+## Setup
+
+Before you can run or deploy the sample, you will need to do the following:
+
+1. Create a [Memorystore instance][memorystore_create]. You can do this from the
+   [Cloud Console](https://console.developers.google.com) or via the
+   [Cloud SDK](https://cloud.google.com/sdk). To create it via the SDK use the
+   following command:
+
+        $ gcloud beta redis instances create YOUR_INSTANCE_NAME --region=REGION_ID
+
+1. Update the environment variables `REDIS_HOST` and `REDIS_PORT` in `app.yaml`
+   with your configuration values. These values are used when the application is
+   deployed. Run the following command to get the values for your isntance:
+
+        $ gcloud beta redis instances describe YOUR_INSTANCE_NAME --region=REGION_ID
+
+[memorystore_create]: https://cloud.google.com/memorystore/docs/redis/creating-managing-instances
+
+## Run locally
+
+You can connect to a local database instance by setting the `REDIS_` environment
+variables to your local instance. Alternatively, you can set them to your Cloud
+Memorystore instance, but you will need to create a firewall rule for this,
+which may be a safety concern.
+
+```sh
+cd php-docs-samples/appengine/php72/memorystore
+
+# set local connection parameters
+export REDIS_HOST=127.0.0.1
+export REDIS_PORT=6379
+
+php -S localhost:8080
+```
+
+> be sure the `REDIS_` environment variables are appropriate for your Redis
+  instance.
+
+Now you can view the app running at [http://localhost:8080](http://localhost:8080)
+in your browser.
+
+## Set up Serverless VPC Access
+
+**IMPORTANT** App Engine requires a [Serverless VPC Access][vpc-access]
+connector to connect to Memorystore.
+
+In order for App Engine to connect to Memorystore, you must first
+[configure a Serverless VPC Access connector][configure-vpc]. For example:
+
+```
+# Example command to create a VPC connector. See the docs for more details.
+$ gcloud beta compute networks vpc-access connectors create CONNECTOR_NAME \
+	--region=REGION_ID \
+	--range="10.8.0.0/28"
+	--project=PROJECT_ID
+```
+
+Next, you neded to [configure App Engine to connect to your VPC network][connecting-appengine].
+This is done by modifying [`app.yaml`](app.yaml) and setting the full name of
+the connector you just created under `vpc_access_connector`.
+
+```
+vpc_access_connector:
+  name: "projects/PROJECT_ID/locations/REGION_ID/connectors/CONNECTOR_NAME"
+```
+
+**Note**: Serverless VPC Access incurs additional billing. See
+[pricing][vpc-pricing] for details.
+
+[vpc-access]: https://cloud.google.com/vpc
+[configure-vpc]: https://cloud.google.com/vpc/docs/configure-serverless-vpc-access
+[connecting-appengine]: https://cloud.google.com/appengine/docs/standard/python/connecting-vpc#configuring
+[vpc-pricing]: https://cloud.google.com/compute/pricing#network
+
+## Deploy to App Engine
+
+**IMPORTANT** Because Serverless VPC Connector is in *beta*, you must deploy to App Engine
+using the `gcloud beta app deploy` command. Without this, the connection to
+Memorystore *will not work*.
+
+```
+$ gcloud beta app deploy --project PROJECT_ID
+```
+
+Now open `https://{YOUR_PROJECT_ID}.appspot.com/` in your browser to see the running
+app.
+
+**Note**: This example requires the `redis.so` extension to be enabled on your App Engine
+instance. This is done by including [`php.ini`](php.ini) in your project root.
+
+## Troubleshooting
+
+### Connection timed out
+
+If you receive the error "Error: Connection timed out", it's possible your VPC Connector
+is not fully set up. Run the following and check the property `state` is set to READY:
+
+```
+$ gcloud beta compute networks vpc-access connectors describe CONNECTOR_NAME --region=REGION_ID
+```
+
+If you continue to see the timeout error, try creating a new VPC connector with a different
+CIDR `range`.
+
+### Name or service not known
+
+If you receive the following error, make sure you set the `REDIS_HOST` environment variable in `app.yaml` to be the
+host of your Memorystore for Redis instance.
+
+```
+PHP message: PHP Warning: Redis::connect(): php_network_getaddresses: getaddrinfo failed: Name or service not known in /srv/index.php
+```
+
+### Request contains an invalid argument
+
+If you receive this error, it is because either the `gcloud` command to create the VPC 
+Access connector was missing the `--range` option, or the value supplied to the
+`--range` option did not use the `/28` CIDR mask as required. Be sure to supply a valid
+CIDR range ending in `/28`.

appengine/php72/memorystore/app.yaml

@@ -0,0 +1,15 @@
+# This app.yaml is for deploying to instances of Cloud SQL running MySQL.
+# See app-postgres.yaml for running Cloud SQL with PostgreSQL.
+
+runtime: php72
+
+# [START gae_memorystore_app_yaml]
+# update with Redis instance host IP, port
+env_variables:
+  REDIS_HOST: YOUR_REDIS_HOST
+  REDIS_PORT: 6379
+
+# Configure your VPC Access connector here
+vpc_access_connector:
+  name: "projects/YOUR_PROJECT_ID/locations/YOUR_REGION/connectors/YOUR_CONNECTOR_NAME"
+# [END gae_memorystore_app_yaml]

appengine/php72/memorystore/composer.json

@@ -0,0 +1,7 @@
+{
+    "require-dev": {
+        "phpunit/phpunit": "~5",
+        "google/cloud-tools": "dev-master",
+        "paragonie/random_compat": "^2.0"
+    }
+}

appengine/php72/memorystore/index.php

@@ -0,0 +1,44 @@
+
+/**
+ * Copyright 2019 Google Inc.
+ *
+ * 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.
+ */
+
+// Only serve traffic from "/"
+switch (@parse_url($_SERVER['REQUEST_URI'])['path']) {
+    case '/':
+        break;
+    default:
+        http_response_code(404);
+        exit('Not Found');
+}
+
+// Connect to Memorystore from App Engine.
+if (!$host = getenv('REDIS_HOST')) {
+    throw new Exception('The REDIS_HOST environment variable is required');
+}
+
+# Memorystore Redis port defaults to 6379
+$port = getenv('REDIS_PORT') ?: '6379';
+
+try {
+    $redis = new Redis();
+    $redis->connect($host, $port);
+} catch (Exception $e) {
+    return print('Error: ' . $e->getMessage());
+}
+
+$value = $redis->incr('counter');
+
+printf('Visitor number: %s', $value);

appengine/php72/memorystore/php.ini

@@ -0,0 +1,2 @@
+; Enable the Redis extension on App Engine
+extension=redis.so

appengine/php72/memorystore/phpunit.xml.dist

@@ -0,0 +1,26 @@
+xml version="1.0" encoding="UTF-8"?>
+
+<phpunit>
+    <testsuites>
+        <testsuite name="AppEngine for PHP 7.2 Memorystore test">
+            <directory>testdirectory>
+        testsuite>
+    testsuites>
+    <logging>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    logging>
+phpunit>

appengine/php72/memorystore/test/DeployTest.php

@@ -0,0 +1,61 @@
+
+/**
+ * Copyright 2019 Google Inc.
+ *
+ * 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\Cloud\Test\Memorystore;
+
+use Google\Cloud\TestUtils\AppEngineDeploymentTrait;
+use Google\Cloud\TestUtils\TestTrait;
+use Google\Cloud\TestUtils\FileUtil;
+use Symfony\Component\Yaml\Yaml;
+
+class DeployTest extends \PHPUnit_Framework_TestCase
+{
+    use TestTrait;
+    use AppEngineDeploymentTrait;
+
+    public function testIndex()
+    {
+        $resp = $this->client->request('GET', '/');
+
+        $this->assertEquals('200', $resp->getStatusCode());
+        $this->assertRegExp('/Visitor number: \d+/', (string) $resp->getBody());
+    }
+
+    public static function beforeDeploy()
+    {
+        $host = self::requireEnv('REDIS_HOST');
+        $connectorName = self::requireEnv('GOOGLE_VPC_ACCESS_CONNECTOR_NAME');
+
+        $tmpDir = FileUtil::cloneDirectoryIntoTmp(__DIR__ . '/..');
+        self::$gcloudWrapper->setDir($tmpDir);
+        chdir($tmpDir);
+
+        $appYaml = Yaml::parse(file_get_contents('app.yaml'));
+        $appYaml['env_variables']['REDIS_HOST'] = $host;
+        if ($port = getenv('REDIS_PORT')) {
+            $appYaml['env_variables']['REDIS_PORT'] = $port;
+        }
+        $appYaml['vpc_access_connector']['name'] = $connectorName;
+
+        file_put_contents('app.yaml', Yaml::dump($appYaml));
+    }
+
+    private static function doDeploy()
+    {
+        // Ensure we use gcloud "beta" deploy
+        return self::$gcloudWrapper->deploy(['release_version' => 'beta']);
+    }
+}