-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add templates for python samples projects (#506)
These templates will be used for templates in python-docs-samples and in Python client libraries. The README generation code is a modified version of https://github.com/GoogleCloudPlatform/python-docs-samples/tree/master/scripts/readme-gen. Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>
- Loading branch information
1 parent
10197ed
commit ffe1040
Showing
36 changed files
with
1,086 additions
and
4 deletions.
There are no files selected for viewing
34 changes: 34 additions & 0 deletions
34
synthtool/gcp/templates/python_library/.kokoro/samples/lint/common.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
# Build logs will be here | ||
action { | ||
define_artifacts { | ||
regex: "**/*sponge_log.xml" | ||
} | ||
} | ||
|
||
# Specify which tests to run | ||
env_vars: { | ||
key: "RUN_TESTS_SESSION" | ||
value: "lint" | ||
} | ||
|
||
env_vars: { | ||
key: "TRAMPOLINE_BUILD_FILE" | ||
value: "github/{{ metadata['repo']['repo'].split('/')[1] }}/.kokoro/test-samples.sh" | ||
} | ||
|
||
# Configure the docker image for kokoro-trampoline. | ||
env_vars: { | ||
key: "TRAMPOLINE_IMAGE" | ||
value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker" | ||
} | ||
|
||
# Download secrets for samples | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" | ||
|
||
# Download trampoline resources. | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" | ||
|
||
# Use the trampoline script to run in docker. | ||
build_file: "{{ metadata['repo']['repo'].split('/')[1] }}/.kokoro/trampoline.sh" |
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/lint/continuous.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "True" | ||
} |
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/lint/periodic.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "False" | ||
} |
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/lint/presubmit.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "True" | ||
} |
34 changes: 34 additions & 0 deletions
34
synthtool/gcp/templates/python_library/.kokoro/samples/python3.6/common.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
# Build logs will be here | ||
action { | ||
define_artifacts { | ||
regex: "**/*sponge_log.xml" | ||
} | ||
} | ||
|
||
# Specify which tests to run | ||
env_vars: { | ||
key: "RUN_TESTS_SESSION" | ||
value: "py-3.6" | ||
} | ||
|
||
env_vars: { | ||
key: "TRAMPOLINE_BUILD_FILE" | ||
value: "github/{{ metadata['repo']['repo'].split('/')[1] }}/.kokoro/test-samples.sh" | ||
} | ||
|
||
# Configure the docker image for kokoro-trampoline. | ||
env_vars: { | ||
key: "TRAMPOLINE_IMAGE" | ||
value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker" | ||
} | ||
|
||
# Download secrets for samples | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" | ||
|
||
# Download trampoline resources. | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" | ||
|
||
# Use the trampoline script to run in docker. | ||
build_file: "{{ metadata['repo']['repo'].split('/')[1] }}/.kokoro/trampoline.sh" |
7 changes: 7 additions & 0 deletions
7
synthtool/gcp/templates/python_library/.kokoro/samples/python3.6/continuous.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "True" | ||
} | ||
|
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/python3.6/periodic.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "False" | ||
} |
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/python3.6/presubmit.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "True" | ||
} |
34 changes: 34 additions & 0 deletions
34
synthtool/gcp/templates/python_library/.kokoro/samples/python3.7/common.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
# Build logs will be here | ||
action { | ||
define_artifacts { | ||
regex: "**/*sponge_log.xml" | ||
} | ||
} | ||
|
||
# Specify which tests to run | ||
env_vars: { | ||
key: "RUN_TESTS_SESSION" | ||
value: "py-3.7" | ||
} | ||
|
||
env_vars: { | ||
key: "TRAMPOLINE_BUILD_FILE" | ||
value: "github/{{ metadata['repo']['repo'].split('/')[1] }}/.kokoro/test-samples.sh" | ||
} | ||
|
||
# Configure the docker image for kokoro-trampoline. | ||
env_vars: { | ||
key: "TRAMPOLINE_IMAGE" | ||
value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker" | ||
} | ||
|
||
# Download secrets for samples | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" | ||
|
||
# Download trampoline resources. | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" | ||
|
||
# Use the trampoline script to run in docker. | ||
build_file: "{{ metadata['repo']['repo'].split('/')[1] }}/.kokoro/trampoline.sh" |
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/python3.7/continuous.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "True" | ||
} |
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/python3.7/periodic.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "False" | ||
} |
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/python3.7/presubmit.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "True" | ||
} |
34 changes: 34 additions & 0 deletions
34
synthtool/gcp/templates/python_library/.kokoro/samples/python3.8/common.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
# Build logs will be here | ||
action { | ||
define_artifacts { | ||
regex: "**/*sponge_log.xml" | ||
} | ||
} | ||
|
||
# Specify which tests to run | ||
env_vars: { | ||
key: "RUN_TESTS_SESSION" | ||
value: "py-3.8" | ||
} | ||
|
||
env_vars: { | ||
key: "TRAMPOLINE_BUILD_FILE" | ||
value: "github/{{ metadata['repo']['repo'].split('/')[1] }}/.kokoro/test-samples.sh" | ||
} | ||
|
||
# Configure the docker image for kokoro-trampoline. | ||
env_vars: { | ||
key: "TRAMPOLINE_IMAGE" | ||
value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker" | ||
} | ||
|
||
# Download secrets for samples | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" | ||
|
||
# Download trampoline resources. | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" | ||
|
||
# Use the trampoline script to run in docker. | ||
build_file: "{{ metadata['repo']['repo'].split('/')[1] }}/.kokoro/trampoline.sh" |
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/python3.8/continuous.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "True" | ||
} |
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/python3.8/periodic.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "False" | ||
} |
6 changes: 6 additions & 0 deletions
6
synthtool/gcp/templates/python_library/.kokoro/samples/python3.8/presubmit.cfg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
env_vars: { | ||
key: "INSTALL_LIBRARY_FROM_SOURCE" | ||
value: "True" | ||
} |
104 changes: 104 additions & 0 deletions
104
synthtool/gcp/templates/python_library/.kokoro/test-samples.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
#!/bin/bash | ||
# 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 | ||
# | ||
# https://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. | ||
|
||
|
||
# `-e` enables the script to automatically fail when a command fails | ||
# `-o pipefail` sets the exit code to the rightmost comment to exit with a non-zero | ||
set -eo pipefail | ||
# Enables `**` to include files nested inside sub-folders | ||
shopt -s globstar | ||
|
||
cd github/{{ metadata['repo']['repo'].split('/')[1] }} | ||
|
||
# Run periodic samples tests at latest release | ||
if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then | ||
LATEST_RELEASE=$(git describe --abbrev=0 --tags) | ||
git checkout $LATEST_RELEASE | ||
fi | ||
|
||
# Disable buffering, so that the logs stream through. | ||
export PYTHONUNBUFFERED=1 | ||
|
||
# Debug: show build environment | ||
env | grep KOKORO | ||
|
||
# Install nox | ||
python3.6 -m pip install --upgrade --quiet nox | ||
|
||
# Use secrets acessor service account to get secrets | ||
if [[ -f "${KOKORO_GFILE_DIR}/secrets_viewer_service_account.json" ]]; then | ||
gcloud auth activate-service-account \ | ||
--key-file="${KOKORO_GFILE_DIR}/secrets_viewer_service_account.json" \ | ||
--project="cloud-devrel-kokoro-resources" | ||
fi | ||
|
||
# This script will create 3 files: | ||
# - testing/test-env.sh | ||
# - testing/service-account.json | ||
# - testing/client-secrets.json | ||
./scripts/decrypt-secrets.sh | ||
|
||
source ./testing/test-env.sh | ||
export GOOGLE_APPLICATION_CREDENTIALS=$(pwd)/testing/service-account.json | ||
|
||
# For cloud-run session, we activate the service account for gcloud sdk. | ||
gcloud auth activate-service-account \ | ||
--key-file "${GOOGLE_APPLICATION_CREDENTIALS}" | ||
|
||
export GOOGLE_CLIENT_SECRETS=$(pwd)/testing/client-secrets.json | ||
|
||
echo -e "\n******************** TESTING PROJECTS ********************" | ||
|
||
# Switch to 'fail at end' to allow all tests to complete before exiting. | ||
set +e | ||
# Use RTN to return a non-zero value if the test fails. | ||
RTN=0 | ||
ROOT=$(pwd) | ||
# Find all requirements.txt in the samples directory (may break on whitespace). | ||
for file in samples/**/requirements.txt; do | ||
cd "$ROOT" | ||
# Navigate to the project folder. | ||
file=$(dirname "$file") | ||
cd "$file" | ||
|
||
echo "------------------------------------------------------------" | ||
echo "- testing $file" | ||
echo "------------------------------------------------------------" | ||
|
||
# Use nox to execute the tests for the project. | ||
python3.6 -m nox -s "$RUN_TESTS_SESSION" | ||
EXIT=$? | ||
|
||
# If this is a periodic build, send the test log to the Build Cop Bot. | ||
# See https://github.com/googleapis/repo-automation-bots/tree/master/packages/buildcop. | ||
if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then | ||
chmod +x $KOKORO_GFILE_DIR/linux_amd64/buildcop | ||
$KOKORO_GFILE_DIR/linux_amd64/buildcop | ||
fi | ||
|
||
if [[ $EXIT -ne 0 ]]; then | ||
RTN=1 | ||
echo -e "\n Testing failed: Nox returned a non-zero exit code. \n" | ||
else | ||
echo -e "\n Testing completed.\n" | ||
fi | ||
|
||
done | ||
cd "$ROOT" | ||
|
||
# Workaround for Kokoro permissions issue: delete secrets | ||
rm testing/{test-env.sh,client-secrets.json,service-account.json} | ||
|
||
exit "$RTN" |
1 change: 1 addition & 0 deletions
1
synthtool/gcp/templates/python_library/samples/AUTHORING_GUIDE.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
See https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/AUTHORING_GUIDE.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
See https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/CONTRIBUTING.md |
33 changes: 33 additions & 0 deletions
33
synthtool/gcp/templates/python_library/scripts/decrypt-secrets.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
#!/bin/bash | ||
|
||
# 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. | ||
|
||
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" | ||
ROOT=$( dirname "$DIR" ) | ||
|
||
# Work from the project root. | ||
cd $ROOT | ||
|
||
# Use SECRET_MANAGER_PROJECT if set, fallback to cloud-devrel-kokoro-resources. | ||
PROJECT_ID="${SECRET_MANAGER_PROJECT:-cloud-devrel-kokoro-resources}" | ||
|
||
gcloud secrets versions access latest --secret="python-docs-samples-test-env" \ | ||
> testing/test-env.sh | ||
gcloud secrets versions access latest \ | ||
--secret="python-docs-samples-service-account" \ | ||
> testing/service-account.json | ||
gcloud secrets versions access latest \ | ||
--secret="python-docs-samples-client-secrets" \ | ||
> testing/client-secrets.json |
Oops, something went wrong.