mijo/gae-flow

Use composer.json to deploy to Google App Engine and serve in development with the same logic.

1.0.2 2019-12-05 19:00 UTC

Requires

• symfony/yaml: *
• vlucas/phpdotenv: *

Requires (Dev)

• composer/composer: *
• phpunit/phpunit: *

MIT

• Michael Johansen

README

Deploy and devserver for Google App Engine for PHP. This is not a general liberary, but an opinionated way of doing "things". Google App Engine have no good way of storing secrets out of the box. I have choosen to add environment variables to app.yaml at deploy-time. This would work both from your local machine and from a pipeline. The secrets I store in a normal propfile stored at users home-directory. This way it could be shared between applications which is deployed in the same Google App Engine project.

To have a consistent way between the production environment and the development environment we do the same with variables used during local development.

Needless to say, this approach will work best for soloprojects, or projects with few developers.

Environment variables

These are stored in standard INI files which has to be placed in the users home directory outside of the current project.

• ~/.{{myprojectkey}}/prod.env for the production deploys.
• ~/.{{myprojectkey}}/dev.env for the devserver.

This way they can be shared between applications in the same project and is kept relatively secure outside the project. Not ideally, but at least you don't have to check in files in the project.

Scripts

This liberary contains two scripts, deploy and serve. They are configured with using the "extra" field of composer.json.a

Deploy (to Google App Engine)

This uses the gcloud command-line tool for deploying. This has to be on the PATH for this to work.

Configuration

In composer.json add the following to the extra data fields.

{
  "extra": {
    "gcloud:project": "myprojectkey",
  }
}

Serve (with the build in server)

This is just a simple wrapper around that the PHP built-in webserver. But it does call a router script which is configured to mimic the default behaviour when you deploy an application with Google App Engine. This does not read app.yaml to resolve static routes. But if you have a fairly simple setup that should not be a problem.

Configuration

In composer.json add the following to the extra data fields.

{
  "extra": {
    "serve:addr": "0.0.0.0",
    "serve:docroot": "/",
    "serve:entrypoint": "entrypoint.php",
    "serve:port": 2004
  }
}

In the script section you could/should add the deploy-command.

{
  "scripts": {
    "deploy": "GaeFlow\\Script::deploy",
    "serve": "GaeFlow\\Script::serve"
  }
}

If you want to run scripts before the deploy-script. For instance build an frontend, that can be done by passing an array of commands like this:

{
  "scripts": {
    "deploy": [
      "yarn build",
      "GaeFlow\\Script::deploy"
    ]
  }
}

Tests

Test can be ran with composer test and the project is using phpunit as a testrunner.