google / cloud-tools
PHP tools for Google Cloud Platform
Installs: 781 284
Dependents: 5
Suggesters: 0
Security: 0
Stars: 23
Watchers: 19
Forks: 21
Open Issues: 10
Requires
- php: >=8.0
- guzzlehttp/guzzle: ~7.0
- symfony/browser-kit: ^5.0
- symfony/console: ^5.0
- symfony/filesystem: ^5.0
- symfony/process: ^5.0
- symfony/yaml: ^5
- twig/twig: ~3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.62
- google/cloud-core: ^1.20
- google/cloud-dlp: ^1.10
- google/cloud-secret-manager: ^1.12
- google/cloud-storage: ^1.33
- google/gax: ^1.0.0
- paragonie/random_compat: >=2
- phpspec/prophecy-phpunit: ^2.0
- phpunit/phpunit: ^9
- dev-main
- v0.15.0
- v0.14.0
- v0.13.0
- v0.12.0
- v0.11.0
- v0.10.0
- v0.9.1
- v0.9.0
- v0.8.5
- v0.8.4
- v0.8.3
- v0.8.2
- v0.8.1
- v0.8.0
- v0.7.2
- v0.7.1
- v0.7.0
- v0.6.9
- v0.6.8
- v0.6.7
- v0.6.6
- v0.6.5
- v0.6.4
- v0.6.3
- v0.6.2
- v0.6.1
- v0.6.0
- v0.5.0
- v0.4.0
- v0.3.0
- v0.2.0
- v0.1.0
- dev-add-php84
- dev-add-rules-for-cs-fixer
- dev-doctum
- dev-better-fixer-rules
- dev-add-client-fixer
- dev-bshaffer-patch-3
- dev-bshaffer-patch-1
- dev-move-sample-runner-into-php-tools
- dev-add-grpc-install
This package is auto-updated.
Last update: 2024-12-04 15:31:24 UTC
README
Install
Add google/cloud-tools
to the require-dev
section of your
composer.json
.
You can also run the following command:
$ composer require google/cloud-tools --dev
Utilities
flex_exec
The cli script src/Utils/Flex/flex_exec
is a tool for running a
command with using the same Docker image as the application running on
App Engine Flex.
It spins up a Docker image of a Deployed App Engine Flexible App, and
runs a command in that image. For example, if you are running Laravel
application, you can invoke a command like php artisan migrate
in
the image.
If the Flex application is requesting the cloudsql access
(beta_settings
, cloud_sql_instances
), this tool also provides the
connection to the same Cloud SQL instances.
The command runs on virtual machines provided by Google Cloud Container Builder, and has access to the credentials of the Cloud Container Builder service account.
Prerequisites
To use flex_exec, you will need:
- An app deployed to Google App Engine Flex
- The gcloud SDK installed and configured. See https://cloud.google.com/sdk/
- The
google/cloud-tools
composer package
You may also need to grant the Cloud Container Builder service account
any permissions needed by your command. For accessing Cloud SQL, you
need to add Cloud SQL Client
permission to the service account.
You can find the service account configuration in the IAM tab in the
Cloud Console under the name [your-project-number]@cloudbuild.gserviceaccount.com
.
Resource usage and billing
The tool uses virtual machine resources provided by Google Cloud Container Builder. Although a certain number of usage minutes per day is covered under a free tier, additional compute usage beyond that time is billed to your Google Cloud account. For more details, see: https://cloud.google.com/container-builder/pricing
If your command makes API calls or utilizes other cloud resources, you
may also be billed for that usage. However, flex_exec
does not use
actual App Engine instances, and you will not be billed for additional
App Engine instance usage.
Example
src/Utils/Flex/flex_exec run -- php artisan migrate
Testing Utilities
There are various test utilities in the Google\Cloud\TestUtils
namespace.
Test examples
The example test cases are available in
test/fixtures/appengine-standard
directory.
Environment variables
There are multiple environment variables to control the behavior of our test traits.
All Traits
GOOGLE_PROJECT_ID
: The project id for deploying the application.GOOGLE_VERSION_ID
: The version id for deploying the application.
AppEngineDeploymentTrait
GOOGLE_DEPLOYMENT_DELAY
: Number of seconds to wait after the deployment has been triggered before continuing to execute tests.GOOGLE_KEEP_DEPLOYMENT
: Set totrue
to keep deployed app in place after test completion.GOOGLE_SKIP_DEPLOYMENT
: Set totrue
if you want to skip deployment.RUN_DEPLOYMENT_TESTS
: Set totrue
if you want to run deploy tests.
DevAppserverTestTrait
LOCAL_TEST_TARGETS
: You can specify multiple yaml files if your test need multiple services.PHP_CGI_PATH
: Path tophp-cgi
for running dev_appserver.RUN_DEVSERVER_TESTS
: Set totrue
if you want to run tests.