feat: Add new gcloud commands, API clients, and third-party libraries across various services.

This commit is contained in:
2026-01-01 20:26:35 +01:00
parent 5e23cbece0
commit a19e592eb7
25221 changed files with 8324611 additions and 0 deletions

View File

@@ -0,0 +1,24 @@
Want to contribute? Great! First, read this page (including the small print at the end).
### Before you contribute
Before we can use your code, you must sign the
[Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual?csw=1)
(CLA), which you can do online. The CLA is necessary mainly because you own the
copyright to your changes, even after your contribution becomes part of our
codebase, so we need your permission to use and distribute your code. We also
need to be sure of various other things—for instance that you'll tell us if you
know that your code infringes on other people's patents. You don't have to sign
the CLA until after you've submitted your code for review and a member has
approved it, but you must do it before we can put your code into our codebase.
Before you start working on a larger contribution, you should get in touch with
us first through the issue tracker with your idea so that we can help out and
possibly guide you. Coordinating up front makes it much easier to avoid
frustration later on.
### Code reviews
All submissions, including submissions by project members, require review. We
use Github pull requests for this purpose.
### The small print
Contributions made by corporations are covered by a different agreement than
the one above, the Software Grant and Corporate Contributor License Agreement.

View File

@@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2016 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.

View File

@@ -0,0 +1,25 @@
PHP Externalized Runtime
============================
This is the PHP runtime definition that is used by gcloud to generate
Dockerfiles for GAE.
How to Run Tests
============================
In order to test your runtime changes you will need to run the following
commands.
```
$ sudo apt-get install python-pip
$ sudo pip install virtualenv
$ cd $CODE_DIRECTORY
$ git clone $GIT_HOST/ext-runtime-sdk
$ virtualenv test_env
$ . test_env/bin/activate
(test_env)$ pip install ext-runtime-sdk/
(test_env)$ pip install PyYaml appengine-config-transformer
(test_env)$ cd gae-xrt-php
(test_env)$ python test/runtime_test.py
```

View File

@@ -0,0 +1,90 @@
#!/usr/bin/python
# Copyright 2016 Google Inc. All Rights Reserved.
#
# 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.
# PHP detection script.
import json
import os
import posixpath
import sys
def get_config():
"""Requests the current runtime configuration.
Returns:
A dictionary containing the current runtime configuration.
Raises:
IOError: An error occurred writing to the controller.
"""
json.dump({'type': 'get_config'}, sys.stdout)
sys.stdout.write('\n')
sys.stdout.flush()
return json.loads(sys.stdin.readline())
def main(args):
if len(args) != 2:
print 'Invalid Usage: {} <source-root-directory>'.format(args[0])
return 1
config = get_config()
params = config['params']
appinfo = params['appinfo']
entrypoint = None
if appinfo and 'entrypoint' in appinfo:
entrypoint = appinfo['entrypoint']
if isinstance(entrypoint, list):
entrypoint = json.dumps(entrypoint)
root = '.'
document_root = '/app'
if appinfo and 'runtime_config' in appinfo:
if 'document_root' in appinfo['runtime_config']:
root = appinfo['runtime_config']['document_root']
document_root = posixpath.normpath(posixpath.join('/app', root))
directory = args[1]
for dirpath, _, filenames in os.walk(directory):
for filename in filenames:
if filename.endswith('.php'):
# "appinfo" writes to the app.yaml when it's generated, and
# "runtime_data" writes to the Dockerfile
json_config = {
'type': 'runtime_parameters',
'appinfo': {
'runtime': 'custom' if params['custom'] else 'php',
'env': 'flex',
'runtime_config': {
'document_root': root,
},
},
'runtime_data': {
'entrypoint': entrypoint,
'document_root': document_root,
},
}
# Prevent "entrypoint: null" in generated app.yaml
#if entrypoint:
# json_config['appinfo']['entrypoint'] = entrypoint
json.dump(json_config, sys.stdout)
sys.stdout.write('\n')
sys.stdout.flush()
return 0
return 1
if __name__ == '__main__':
sys.exit(main(sys.argv))

View File

@@ -0,0 +1,84 @@
#!/usr/bin/python
# Copyright 2016 Google Inc. All Rights Reserved.
#
# 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.
import json
import os
import sys
def get_config():
"""Requests the current runtime configuration.
Returns:
A dictionary containing the current runtime configuration.
Raises:
IOError: An error occurred writing to the controller.
"""
json.dump({'type': 'get_config'}, sys.stdout)
sys.stdout.write('\n')
sys.stdout.flush()
return json.loads(sys.stdin.readline())
def send_file(filename, data):
"""Sends file data to be saved by the controller.
send_file currently only supports sending ASCII-encoded data. For binary
data it must be Base64 encoded and additional "encoding" parameter must be
sent indicating the data has been encoded.
Args:
filename: (str) Target filename.
data: (str) File contents.
Raises:
IOError: An error occurred writing to the controller.
"""
json.dump({
'type': 'gen_file',
'filename': filename,
'contents': data}, sys.stdout)
sys.stdout.write('\n')
sys.stdout.flush()
def main(args):
config = get_config()
params = config['params']
if not params['custom'] and not params['deploy']:
return 0
# Locate template directory.
template_dir = os.path.join(os.path.dirname(__file__), '..', 'templates')
# Generate Dockerfile
entrypoint = config['runtime_data']['entrypoint']
template_name = 'Dockerfile.entrypoint.template' if entrypoint else 'Dockerfile.template'
path = os.path.join(template_dir, template_name)
with open(path, 'r') as f:
data = f.read()
document_root = config['runtime_data']['document_root']
send_file('Dockerfile', data.format(document_root=document_root,
entrypoint=entrypoint))
# Generate .dockerignore
path = os.path.join(template_dir, 'dockerignore.template')
with open(path, 'r') as f:
send_file('.dockerignore', f.read())
return 0
if __name__ == '__main__':
sys.exit(main(sys.argv))

View File

@@ -0,0 +1,8 @@
author: adamtanner@google.com
name: php
description: Official Google PHP runtime definition.
api_version: 0.1
detect:
python: bin/detect
generate_configs:
python: bin/generate_configs

View File

@@ -0,0 +1,10 @@
# Dockerfile extending the generic PHP image with application files for a
# single application.
FROM gcr.io/google-appengine/php:latest
# The Docker image will configure the document root according to this
# environment variable.
ENV DOCUMENT_ROOT {document_root}
# Allow custom CMD
CMD {entrypoint}

View File

@@ -0,0 +1,7 @@
# Dockerfile extending the generic PHP image with application files for a
# single application.
FROM gcr.io/google-appengine/php:latest
# The Docker image will configure the document root according to this
# environment variable.
ENV DOCUMENT_ROOT {document_root}

View File

@@ -0,0 +1,19 @@
# Copyright 2015 Google Inc. All Rights Reserved.
#
# 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.
.dockerignore
Dockerfile
.git
.hg
.svn

View File

@@ -0,0 +1,279 @@
#!/usr/bin/python
# Copyright 2016 Google Inc. All Rights Reserved.
#
# 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.
import os
import textwrap
import unittest
from gae_ext_runtime import testutil
RUNTIME_DEF_ROOT = os.path.dirname(os.path.dirname(__file__))
class RuntimeTestCase(testutil.TestBase):
"""Tests for the PHP external runtime fingerprinter."""
def license(self):
return textwrap.dedent('''\
# Copyright 2015 Google Inc. All Rights Reserved.
#
# 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.
''')
def preamble(self):
return textwrap.dedent('''\
# Dockerfile extending the generic PHP image with application files for a
# single application.
FROM gcr.io/google-appengine/php:latest
# The Docker image will configure the document root according to this
# environment variable.
''')
def setUp(self):
self.runtime_def_root = RUNTIME_DEF_ROOT
super(RuntimeTestCase, self).setUp()
def file_contents(self, filename):
with open(self.full_path(filename)) as f:
return f.read()
def test_generate_without_php_files(self):
self.write_file('index.html', 'index')
self.assertFalse(self.generate_configs())
self.assertFalse(os.path.exists(self.full_path('app.yaml')))
self.assertFalse(os.path.exists(self.full_path('Dockerfile')))
self.assertFalse(os.path.exists(self.full_path('.dockerignore')))
def test_generate_with_php_files(self):
self.write_file('index.php', 'index')
self.generate_configs()
app_yaml = self.file_contents('app.yaml')
self.assertIn('runtime: php\n', app_yaml)
self.assertIn('env: flex\n', app_yaml)
self.assertIn('runtime_config:\n document_root: .\n', app_yaml)
self.assertNotIn('entrypoint', app_yaml)
self.assertFalse(os.path.exists(self.full_path('Dockerfile')))
self.assertFalse(os.path.exists(self.full_path('.dockerignore')))
def test_generate_with_php_files_no_write(self):
"""Test generate_config_data with a .php file.
Checks app.yaml contents, app.yaml is written to disk, and
Dockerfile and .dockerignore not in the directory.
"""
self.write_file('index.php', 'index')
self.generate_config_data()
app_yaml = self.file_contents('app.yaml')
self.assertIn('runtime: php\n', app_yaml)
self.assertIn('env: flex\n', app_yaml)
self.assertIn('runtime_config:\n document_root: .\n', app_yaml)
self.assertFalse(os.path.exists(self.full_path('Dockerfile')))
self.assertFalse(os.path.exists(self.full_path('.dockerignore')))
def test_generate_custom_runtime(self):
self.write_file('index.php', 'index')
self.generate_configs(custom=True)
dockerfile = self.file_contents('Dockerfile')
self.assertEqual(dockerfile, self.preamble() + textwrap.dedent('''\
ENV DOCUMENT_ROOT /app
'''))
self.assert_file_exists_with_contents(
'.dockerignore',
self.license() + textwrap.dedent('''\
.dockerignore
Dockerfile
.git
.hg
.svn
'''))
def test_generate_custom_runtime_no_write(self):
"""Tests generate_config_data with custom runtime."""
self.write_file('index.php', 'index')
cfg_files = self.generate_config_data(custom=True)
self.assert_genfile_exists_with_contents(
cfg_files,
'Dockerfile',
self.preamble() + textwrap.dedent('''\
ENV DOCUMENT_ROOT /app
'''))
self.assert_genfile_exists_with_contents(
cfg_files,
'.dockerignore',
self.license() + textwrap.dedent('''\
.dockerignore
Dockerfile
.git
.hg
.svn
'''))
def test_generate_with_deploy(self):
self.write_file('index.php', 'index')
self.generate_configs(deploy=True)
dockerfile = self.file_contents('Dockerfile')
self.assertEqual(dockerfile, textwrap.dedent('''\
# Dockerfile extending the generic PHP image with application files for a
# single application.
FROM gcr.io/google-appengine/php:latest
# The Docker image will configure the document root according to this
# environment variable.
ENV DOCUMENT_ROOT /app
'''))
dockerignore = self.file_contents('.dockerignore')
self.assertEqual(dockerignore, self.license() + textwrap.dedent('''\
.dockerignore
Dockerfile
.git
.hg
.svn
'''))
def test_generate_with_deploy_no_write(self):
"""Tests generate_config_data with deploy=True."""
self.write_file('index.php', 'index')
cfg_files = self.generate_config_data(deploy=True)
self.assert_genfile_exists_with_contents(
cfg_files,
'Dockerfile',
self.preamble() + textwrap.dedent('''\
ENV DOCUMENT_ROOT /app
'''))
self.assert_genfile_exists_with_contents(
cfg_files,
'.dockerignore',
self.license() + textwrap.dedent('''\
.dockerignore
Dockerfile
.git
.hg
.svn
'''))
def test_generate_with_existing_appinfo(self):
self.write_file('index.php', 'index')
appinfo = testutil.AppInfoFake(
runtime_config={'document_root': 'wordpress'},
entrypoint='["/bin/bash", "my-cmd.sh"]')
self.generate_configs(deploy=True, appinfo=appinfo)
dockerfile = self.file_contents('Dockerfile')
self.assertEqual(dockerfile, self.preamble() + textwrap.dedent('''\
ENV DOCUMENT_ROOT /app/wordpress
# Allow custom CMD
CMD ["/bin/bash", "my-cmd.sh"]
'''))
dockerignore = self.file_contents('.dockerignore')
self.assertEqual(dockerignore, self.license() + textwrap.dedent('''\
.dockerignore
Dockerfile
.git
.hg
.svn
'''))
def test_generate_with_existing_appinfo_no_write(self):
"""Tests generate_config_data with fake appinfo."""
self.write_file('index.php', 'index')
appinfo = testutil.AppInfoFake(
runtime_config={'document_root': 'wordpress'},
entrypoint='["/bin/bash", "my-cmd.sh"]')
cfg_files = self.generate_config_data(deploy=True, appinfo=appinfo)
self.assert_genfile_exists_with_contents(
cfg_files,
'Dockerfile',
self.preamble() + textwrap.dedent('''\
ENV DOCUMENT_ROOT /app/wordpress
# Allow custom CMD
CMD ["/bin/bash", "my-cmd.sh"]
'''))
self.assert_genfile_exists_with_contents(
cfg_files,
'.dockerignore',
self.license() + textwrap.dedent('''\
.dockerignore
Dockerfile
.git
.hg
.svn
'''))
def test_generate_with_array_entrypoint(self):
self.write_file('index.php', 'index')
appinfo = testutil.AppInfoFake(
runtime_config={'document_root': 'wordpress'},
entrypoint=['/bin/bash', 'my-cmd.sh'])
self.generate_configs(deploy=True, appinfo=appinfo)
dockerfile = self.file_contents('Dockerfile')
self.assertEqual(dockerfile, self.preamble() + textwrap.dedent('''\
ENV DOCUMENT_ROOT /app/wordpress
# Allow custom CMD
CMD ["/bin/bash", "my-cmd.sh"]
'''))
def test_generate_with_array_entrypoint_no_write(self):
"""Tests generate_config_data with an array entrypoint."""
self.write_file('index.php', 'index')
appinfo = testutil.AppInfoFake(
runtime_config={'document_root': 'wordpress'},
entrypoint=["/bin/bash", "my-cmd.sh"])
cfg_files = self.generate_config_data(deploy=True, appinfo=appinfo)
self.assert_genfile_exists_with_contents(
cfg_files,
'Dockerfile',
self.preamble() + textwrap.dedent('''\
ENV DOCUMENT_ROOT /app/wordpress
# Allow custom CMD
CMD ["/bin/bash", "my-cmd.sh"]
'''))
if __name__ == '__main__':
unittest.main()