Merge pull request GoogleCloudPlatform#1057 from jdpedrie/cloudsql/mysql

feat: add mysql sample

Author: shubha-rajan

.gitignore

@@ -10,3 +10,4 @@ credentials.*
 .php_cs.cache
 .vscode/
 .kokoro/secrets.sh
+.phpunit.result.cache

cloud_sql/mysql/pdo/README.md

@@ -0,0 +1,92 @@
+# Connection to Cloud SQL - MySQL
+
+## Before you begin
+
+1. Before you use this code sample, you need to have [Composer](https://getcomposer.org/) installed or downloaded into this folder. Download instructions can be found [here](https://getcomposer.org/download/). Once you've installed composer, use it to install required dependencies by running `composer install`.
+2. Create a MySQL Cloud SQL Instance by following these [instructions](https://cloud.google.com/sql/docs/mysql/create-instance). Note the connection string, database user, and database password that you create.
+3. Create a database for your application by following these [instructions](https://cloud.google.com/sql/docs/mysql/create-manage-databases). Note the database name.
+4. Create a service account with the 'Cloud SQL Client' permissions by following these [instructions](https://cloud.google.com/sql/docs/mysql/connect-external-app#4_if_required_by_your_authentication_method_create_a_service_account). Download a JSON key to use to authenticate your connection.
+
+## Running Locally
+
+To run this application locally, download and install the `cloud_sql_proxy` by following the instructions [here](https://cloud.google.com/sql/docs/mysql/sql-proxy#install).
+
+To authenticate with Cloud SQL, set the `$GOOGLE_APPLICATION_CREDENTIALS` environment variable:
+
+```bash
+export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
+```
+
+To run the Cloud SQL proxy, you need to set the instance connection name. See the instructions [here](https://cloud.google.com/sql/docs/mysql/quickstart-proxy-test#get_the_instance_connection_name) for finding the instance connection name.
+
+```bash
+export CLOUD_SQL_CONNECTION_NAME='::'
+```
+
+Once the proxy is ready, use one of the following commands to start the proxy in the background.
+
+You may connect to your instance via either unix sockets or TCP. To connect using a socket, you must provide the `-dir` option when starting the proxy. To connect via TCP, you must provide a port as part of the instance name. Both are demonstrated below.
+
+### Unix Socket mode
+
+```bash
+$ ./cloud_sql_proxy -dir=/cloudsql \
+    --instances=$CLOUD_SQL_CONNECTION_NAME \
+    --credential_file=$GOOGLE_APPLICATION_CREDENTIALS
+```
+
+Note: Make sure to run the command under a user with write access in the `/cloudsql` directory. This proxy will use this folder to create a unix socket the application will use to connect to Cloud SQL.
+
+### TCP mode
+
+```bash
+$ ./cloud_sql_proxy \
+    --instances=$CLOUD_SQL_CONNECTION_NAME=tcp:3306 \
+    --credential_file=$GOOGLE_APPLICATION_CREDENTIALS
+```
+
+### Set Configuration Values
+Set the required environment variables for your connection to Cloud SQL. If you are using TCP mode as described above, do not set the `CLOUD_SQL_CONNECTION_NAME` variable.
+
+```bash
+export DB_USER='my-db-user'
+export DB_PASS='my-db-pass'
+export DB_NAME='my-db-name'
+export DB_HOSTNAME='localhost'
+```
+
+Note: Saving credentials in environment variables is convenient, but not secure - consider a more secure solution such as [Secret Manager](https://cloud.google.com/secret-manager/) to help keep secrets safe.
+
+Execute the following:
+
+```bash
+$ php -S localhost:8080
+```
+
+Navigate towards http://localhost:8080 to verify your application is running correctly.
+
+## Google App Engine Flex
+
+To run on App Engine Flex, create an App Engine project by following the setup for these [instructions](https://cloud.google.com/appengine/docs/standard/php7/quickstart#before-you-begin).
+
+First, update `app.yaml` with the correct values to pass the environment variables into the runtime.
+
+Then, make sure that the service account `service-{PROJECT_NUMBER}>@gae-api-prod.google.com.iam.gserviceaccount.com` has the IAM role `Cloud SQL Client`.
+
+Next, the following command will deploy the application to your Google Cloud project:
+
+```bash
+$ gcloud beta app deploy
+```
+
+## Google App Engine Standard
+
+To run on GAE-Standard, create an App Engine project by following the setup for these [instructions](https://cloud.google.com/appengine/docs/standard/php7/quickstart#before-you-begin).
+
+First, update `app.yaml` with the correct values to pass the environment variables into the runtime.
+
+Next, the following command will deploy the application to your Google Cloud project:
+
+```bash
+$ gcloud app deploy app-standard.yaml
+```

cloud_sql/mysql/pdo/app-standard.yaml

@@ -0,0 +1,29 @@
+# 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.
+
+runtime: php72
+
+# Remember - storing secrets in plaintext is potentially unsafe. Consider using
+# something like https://cloud.google.com/secret-manager/ to help keep secrets secret.
+env_variables:
+  CLOUD_SQL_CONNECTION_NAME: ::
+  DB_USER: my-db-user
+  DB_PASS: my-db-pass
+  DB_NAME: my-db
+
+# Defaults to "serve index.php" and "serve public/index.php". Can be used to
+# serve a custom PHP front controller (e.g. "serve backend/index.php") or to
+# run a long-running PHP script as a worker process (e.g. "php worker.php").
+#
+# entrypoint: serve index.php

cloud_sql/mysql/pdo/app.yaml

@@ -0,0 +1,37 @@
+# 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.
+
+runtime: php
+env: flex
+
+# Remember - storing secrets in plaintext is potentially unsafe. Consider using
+# something like https://cloud.google.com/secret-manager/ to help keep secrets
+# secret.
+env_variables:
+  CLOUD_SQL_CONNECTION_NAME: "::"
+  DB_USER: my-db-user
+  DB_PASS: my-db-pass
+  DB_NAME: my-db
+
+beta_settings:
+  cloud_sql_instances: "::"
+
+runtime_config:
+  document_root: .
+
+# Defaults to "serve index.php" and "serve public/index.php". Can be used to
+# serve a custom PHP front controller (e.g. "serve backend/index.php") or to
+# run a long-running PHP script as a worker process (e.g. "php worker.php").
+#
+# entrypoint: serve index.php

cloud_sql/mysql/pdo/composer.json

@@ -0,0 +1,24 @@
+{
+    "name": "google/cloud-sql-mysql-example",
+    "autoload": {
+        "psr-4": {
+            "Google\\Cloud\\Samples\\CloudSQL\\MySQL\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Google\\Cloud\\Samples\\CloudSQL\\MySQL\\Tests\\": "src"
+        }
+    },
+    "require": {
+        "php": ">= 7.2",
+        "slim/slim": "^4.5",
+        "slim/twig-view": "^3.1",
+        "pimple/pimple": "^3.3",
+        "guzzlehttp/psr7": "^1.6",
+        "http-interop/http-factory-guzzle": "^1.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8.5"
+    }
+}

cloud_sql/mysql/pdo/index.php

@@ -0,0 +1,54 @@
+
+/*
+ * 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);
+
+use GuzzleHttp\Psr7;
+
+include __DIR__ . '/vendor/autoload.php';
+
+$app = include __DIR__ . '/src/app.php';
+
+$app->get('/', function ($request, $response) {
+    $this->get('votes')->createTableIfNotExists();
+
+    return $this->get('view')->render($response, 'template.twig', [
+        'votes' => $this->get('votes')->listVotes(),
+        'tabCount' => $this->get('votes')->getCountByValue('TABS'),
+        'spaceCount' => $this->get('votes')->getCountByValue('SPACES'),
+    ]);
+});
+
+$app->post('/', function ($request, $response) {
+    $this->get('votes')->createTableIfNotExists();
+
+    $message = 'Invalid vote. Choose Between TABS and SPACES';
+
+    $formData = $request->getParsedBody() + [
+        'voteValue' => ''
+    ];
+
+    if (in_array($formData['voteValue'], ['SPACES', 'TABS'])) {
+        $message = $this->get('votes')->insertVote($formData['voteValue'])
+            ? 'Vote cast for ' . $formData['voteValue']
+            : 'An error occurred';
+    }
+
+    return $response->withBody(Psr7\stream_for($message));
+});
+
+$app->run();

cloud_sql/mysql/pdo/phpunit.xml.dist

@@ -0,0 +1,13 @@
+xml version="1.0" encoding="UTF-8"?>
+<phpunit colors="true">
+  <testsuites>
+    <testsuite name="CloudSQLMySQLSample">
+      <directory>testsdirectory>
+    testsuite>
+  testsuites>
+  <filter>
+    <whitelist>
+      <directory suffix=".php">srcdirectory>
+    whitelist>
+  filter>
+phpunit>

cloud_sql/mysql/pdo/src/Votes.php

@@ -0,0 +1,127 @@
+
+/*
+ * 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\CloudSQL\MySQL;
+
+use PDO;
+use PDOException;
+use RuntimeException;
+
+/**
+ * Manage votes using the Cloud SQL database.
+ */
+class Votes
+{
+    /**
+     * @var PDO
+     */
+    private $connection;
+
+    /**
+     * @param PDO $connection A connection to the database.
+     */
+    public function __construct(PDO $connection)
+    {
+        $this->connection = $connection;
+    }
+
+    /**
+     * Creates the table if it does not yet exist.
+     *
+     * @return void
+     */
+    public function createTableIfNotExists()
+    {
+        try {
+            $stmt = $this->connection->prepare('SELECT 1 FROM votes');
+            $stmt->execute();
+        } catch (PDOException $e) {
+            $sql = "CREATE TABLE votes (
+                vote_id INT NOT NULL AUTO_INCREMENT,
+                time_cast DATETIME NOT NULL,
+                vote_value VARCHAR(6) NOT NULL,
+                PRIMARY KEY (vote_id)
+            );";
+
+            $this->connection->exec($sql);
+        }
+    }
+
+    /**
+     * Returns a list of the last five votes
+     *
+     * @return array
+     */
+    public function listVotes() : array
+    {
+        $sql = "SELECT vote_value, time_cast FROM votes ORDER BY time_cast DESC LIMIT 5";
+        $statement = $this->connection->prepare($sql);
+        $statement->execute();
+        return $statement->fetchAll(PDO::FETCH_ASSOC);
+    }
+
+    /**
+     * Get the number of votes cast for a given value.
+     *
+     * @param string $value
+     * @param int
+     */
+    public function getCountByValue(string $value) : int
+    {
+        $sql = "SELECT COUNT(vote_id) as voteCount FROM votes WHERE vote_value = ?";
+
+        $statement = $this->connection->prepare($sql);
+        $statement->execute([$value]);
+
+        return (int) $statement->fetch(PDO::FETCH_COLUMN);
+    }
+
+    /**
+     * Insert a new vote into the database
+     *
+     * @param string $value The value to vote for.
+     * @return boolean
+     */
+    public function insertVote(string $value) : bool
+    {
+        $conn = $this->connection;
+        $res = false;
+
+        # [START cloud_sql_mysql_pdo_connection]
+        // Use prepared statements to guard against SQL injection.
+        $sql = "INSERT INTO votes (time_cast, vote_value) VALUES (NOW(), :voteValue)";
+
+        try {
+            $statement = $conn->prepare($sql);
+            $statement->bindParam('voteValue', $value);
+
+            $res = $statement->execute();
+        } catch (PDOException $e) {
+            throw new RuntimeException(
+                "Could not insert vote into database. The PDO exception was " .
+                $e->getMessage(),
+                $e->getCode(),
+                $e
+            );
+        }
+        # [END cloud_sql_mysql_pdo_connection]
+
+        return $res;
+    }
+}