Add Symfony sample for PHP 7.2 on App Engine Standard (GoogleCloudPlatform#682)

Author: bshaffer

.kokoro/secrets-example.sh

@@ -112,3 +112,9 @@ export LARAVEL_CLOUDSQL_CONNECTION_NAME=$CLOUDSQL_CONNECTION_NAME_MYSQL
 export LARAVEL_DB_DATABASE=laravel
 export LARAVEL_DB_USERNAME=$CLOUDSQL_USER
 export LARAVEL_DB_PASSWORD=$CLOUDSQL_PASSWORD
+
+# Symfony
+export SYMFONY_CLOUDSQL_CONNECTION_NAME=$CLOUDSQL_CONNECTION_NAME_MYSQL
+export SYMFONY_DB_DATABASE=symfony
+export SYMFONY_DB_USERNAME=$CLOUDSQL_USER
+export SYMFONY_DB_PASSWORD=$CLOUDSQL_PASSWORD

appengine/php72/symfony-framework/README.md

@@ -0,0 +1,232 @@
+## Run Symfony on App Engine Standard for PHP 7.2
+
+This tutorial will walk you through how to create and deploy a Symfony project
+to App Engine Standard for PHP 7.2. You will learn how to:
+
+1. Create a [Symfony][symfony] project
+1. Configure it to run in the App Engine environment
+1. Deploy it to App Engine
+1. Set up a [Cloud SQL][cloud-sql] database
+1. Configure Doctrine to communicate with Cloud SQL
+
+> **Note**: This repository is just a tutorial and is not a Symfony project in 
+  and of itself. The steps will require you to set up a new Symfony project in a
+  separate directory.
+  
+## Prerequisites
+
+1. [Create a project][create-project] in the Google Cloud Platform Console
+   and make note of your project ID.
+1. [Enable billing][enable-billing] for your project.
+1. Install the [Google Cloud SDK](https://cloud.google.com/sdk/).
+
+## Install
+
+This tutorial uses the [Symfony Demo][symfony-demo] application. Run the
+following command to install it:
+
+```sh
+PROJECT_DIR='symfony-on-appengine'
+composer create-project symfony/symfony-demo:^1.2 $PROJECT_DIR
+```
+
+## Run
+
+1. Run the app with the following command:
+
+        php bin/console server:run
+
+1. Visit [http://localhost:8000](http://localhost:8000) to see the Symfony
+   Welcome page.
+
+## Deploy
+
+1. Remove the `scripts` section from `composer.json` in the root of your
+   project. You can do this manually, or by running the following line of code
+   below in the root of your Symfony project:
+
+   ```sh
+   php -r "file_put_contents('composer.json', json_encode(array_diff_key(json_decode(file_get_contents('composer.json'), true), ['scripts' => 1]), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));"
+   ```
+
+   > **Note**: The composer scripts run on the [Cloud Build][cloud-build] server.
+    This is a temporary fix to prevent errors prior to deployment.
+
+1. Copy the [`app.yaml`](app.yaml) file from this repository into the root of
+   your project and replace `YOUR_APP_SECRET` with a new secret or the generated
+   secret in `.env`:
+
+    ```yaml
+    runtime: php72
+
+    env_variables:
+        APP_ENV: prod
+        APP_SECRET: YOUR_APP_SECRET
+
+    # URL handlers
+    # ...
+    ```
+
+    > **NOTE** Read more about the [env][symfony-env] and [secret][symfony-secret]
+    parameters in Symfony's documentation.
+
+1. [Override the cache and log directories][symfony-override-cache] so that
+   they use `/tmp` in production. This is done by modifying the functions
+   `getCacheDir` and `getLogDir` to the following in `src/Kernel.php`:
+
+
+    ```php
+    class Kernel extends BaseKernel
+    {
+        //...
+
+        public function getCacheDir()
+        {
+            if ($this->environment === 'prod') {
+                return sys_get_temp_dir();
+            }
+            return $this->getProjectDir() . '/var/cache/' . $this->environment;
+        }
+
+        public function getLogDir()
+        {
+            if ($this->environment === 'prod') {
+                return sys_get_temp_dir();
+            }
+            return $this->getProjectDir() . '/var/log';
+        }
+
+        // ...
+    }
+    ```
+
+    > **NOTE**: This is required because App Engine's file system is **read-only**.
+
+1. Deploy your application to App Engine:
+
+        gcloud app deploy
+
+1. Visit `http://YOUR_PROJECT_ID.appspot.com` to see the Symfony demo landing
+   page.
+
+The homepage will load when you view your application, but browsing to any of
+the other demo pages will result in a **500** error. This is because you haven't
+set up a database yet. Let's do that now!
+
+## Connect to Cloud SQL with Doctrine
+
+Next, connect your Symfony demo application with a [Cloud SQL][cloud-sql]
+database. This tutorial uses the database name `symfonydb` and the username
+`root`, but you can use whatever you like.
+
+### Setup
+
+1. Follow the instructions to set up a
+   [Google Cloud SQL Second Generation instance for MySQL][cloud-sql-create].
+
+1. Create a database for your Symfony application. Replace `INSTANCE_NAME`
+   with the name of your instance:
+
+       gcloud sql databases create symfonydb --instance=INSTANCE_NAME
+
+1. Enable the [Cloud SQL APIs][cloud-sql-apis] in your project.
+
+1. Follow the instructions to
+   [install and run the Cloud SQL proxy client on your local machine][cloud-sql-install].
+   The Cloud SQL proxy is used to connect to your Cloud SQL instance when
+   running locally. This is so you can run database migrations locally to set up
+   your production database.
+
+    * Use the [Cloud SDK][cloud-sdk] from the command line to run the following
+      command. Copy the `connectionName` value for the next step. Replace
+      `INSTANCE_NAME` with the name of your instance:
+
+          gcloud sql instances describe INSTANCE_NAME
+
+    * Start the Cloud SQL proxy and replace `INSTANCE_CONNECTION_NAME` with
+      the connection name you retrieved in the previous step:
+
+          cloud_sql_proxy -instances=INSTANCE_CONNECTION_NAME=tcp:3306 &
+
+    **Note:** Include the `-credential_file` option when using the proxy, or
+    authenticate with `gcloud`, to ensure proper authentication.
+
+### Configure
+
+1.  Modify your Doctrine configuration in `config/packages/doctrine.yml` and
+    change the parameters under `doctrine.dbal` to be the following:
+
+    ```yaml
+    # Doctrine Configuration
+    doctrine:
+        dbal:
+            driver: pdo_mysql
+            url: '%env(resolve:DATABASE_URL)%'
+
+        # ORM configuration
+        # ...
+    ```
+
+1.  Use the Symfony CLI to connect to your instance and create a database for
+    the application. Be sure to replace `DB_PASSWORD` with the root password you
+    configured:
+
+        # create the database using doctrine
+        DATABASE_URL="mysql://root:[email protected]:3306/symfonydb" \
+            bin/console doctrine:schema:create
+
+1.  Modify your `app.yaml` file with the following contents. Be sure to replace
+    `DB_PASSWORD` and `INSTANCE_CONNECTION_NAME` with the values you created for
+    your Cloud SQL instance:
+
+    ```yaml
+    runtime: php72
+
+    env_variables:
+      APP_ENV: prod
+      APP_SECRET: YOUR_APP_SECRET
+
+      # Add the DATABASE_URL environment variable
+      DATABASE_URL: mysql://root:DB_PASSWORD@localhost?unix_socket=/cloudsql/INSTANCE_CONNECTION_NAME;dbname=symfonydb
+
+    # URL handlers
+    # ...
+    ```
+
+### Run
+
+1.  Now you can run locally and verify the connection works as expected.
+
+        DB_HOST="127.0.0.1" DB_DATABASE=symfony DB_USERNAME=root DB_PASSWORD=YOUR_DB_PASSWORD \
+            php bin/console server:run
+
+1.  Reward all your hard work by running the following command and deploying
+    your application to App Engine:
+
+        gcloud app deploy
+
+### What's Next
+
+1. Check out the [Databases and the Doctrine ORM][symfony-doctrine] documentation for Symfony.
+1. View a [Symfony Demo Application][symfony-sample-app] for App Engine Flex.
+
+[php-gcp]: https://cloud.google.com/php
+[cloud-sdk]: https://cloud.google.com/sdk/
+[cloud-build]: https://cloud.google.com/cloud-build/
+[cloud-sql]: https://cloud.google.com/sql/docs/
+[cloud-sql-create]: https://cloud.google.com/sql/docs/mysql/create-instance
+[cloud-sql-install]: https://cloud.google.com/sql/docs/mysql/connect-external-app#install
+[cloud-sql-apis]:https://pantheon.corp.google.com/apis/library/sqladmin.googleapis.com/?pro
+[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
+[enable-billing]: https://support.google.com/cloud/answer/6293499?hl=en
+[php-gcp]: https://cloud.google.com/php
+[symfony]: http://symfony.com
+[symfony-install]: http://symfony.com/doc/current/setup.html
+[symfony-welcome]: https://symfony.com/doc/current/_images/welcome.png
+[composer-json]: https://storage.googleapis.com/gcp-community/tutorials/run-symfony-on-appengine-flexible/composer-json.png
+[symfony-doctrine]: https://symfony.com/doc/current/doctrine.html
+[symfony-sample-app]: https://github.com/bshaffer/symfony-on-app-engine-flex
+[symfony-demo]: https://github.com/symfony/demo
+[symfony-secret]: http://symfony.com/doc/current/reference/configuration/framework.html#secret
+[symfony-env]: https://symfony.com/doc/current/configuration/environments.html#executing-an-application-in-different-environments
+[symfony-override-cache]: https://symfony.com/doc/current/configuration/override_dir_structure.html#override-the-cache-directory

appengine/php72/symfony-framework/app.yaml

@@ -0,0 +1,27 @@
+runtime: php72
+
+env_variables:
+  APP_ENV: prod
+  APP_SECRET: YOUR_APP_SECRET
+  # APP_DEBUG: true
+
+  ## For connecting to Cloud SQL with Doctrine
+  ## This is used in part two of the README:
+  # DATABASE_URL: mysql://root:DB_PASSWORD@localhost?unix_socket=/cloudsql/INSTANCE_CONNECTION_NAME;dbname=symfonydb
+
+handlers:
+  # Declare the build and bundles directory as static assets to be served by the
+  # App Engine CDN.
+  - url: /build
+    static_dir: public/build
+  - url: /bundles
+    static_dir: public/bundles
+
+  # Declare any media files in the public directory as static assets as well.
+  - url: /(.*\.(ico|txt|gif|png|jpg))$
+    static_files: public/\1
+    upload: public/.*\.(ico|txt|gif|png|jpg)$
+
+  # Declare a catch-all to send all other routes to be handled by the application.
+  - url: .*
+    script: auto

appengine/php72/symfony-framework/composer.json

@@ -0,0 +1,10 @@
+{
+    "require": {
+        "php": "^7.1.3"
+    },
+    "require-dev": {
+        "google/cloud-tools": "^0.8.2",
+        "monolog/monolog": "^1.19",
+        "nikic/php-parser": "^4.0"
+    }
+}