Cloud Run Hello World (#4428)

* Cloud Run Hello World

* lint

* updates

* Update ignore files

Author: averikitsch

run/README.md

@@ -109,7 +109,7 @@ for more information.
 [run_docs]: https://cloud.google.com/run/docs/
 [run_build]: https://cloud.google.com/run/docs/building/containers
 [run_deploy]: https://cloud.google.com/run/docs/deploying
-[helloworld]: https://github.com/knative/docs/tree/master/docs/serving/samples/hello-world/helloworld-python
+[helloworld]: helloworld/
 [pubsub]: pubsub/
 [mysql]: ../cloud-sql/mysql/sqlalchemy
 [postgres]: ../cloud-sql/postgres/sqlalchemy

run/helloworld/.dockerignore

@@ -0,0 +1,7 @@
+Dockerfile
+README.md
+*.pyc
+*.pyo
+*.pyd
+__pycache__
+.pytest_cache

run/helloworld/.gcloudignore

@@ -0,0 +1,6 @@
+README.md
+*.pyc
+*.pyo
+*.pyd
+__pycache__
+.pytest_cache

run/helloworld/Dockerfile

@@ -0,0 +1,38 @@
+# 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
+#
+#    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.
+
+# [START run_hello_dockerfile]
+
+# Use the official lightweight Python image.
+# https://hub.docker.com/_/python
+FROM python:3.8-slim
+
+# Allow statements and log messages to immediately appear in the Knative logs
+ENV PYTHONUNBUFFERED True
+
+# Copy local code to the container image.
+ENV APP_HOME /app
+WORKDIR $APP_HOME
+COPY . ./
+
+# Install production dependencies.
+RUN pip install Flask gunicorn
+
+# Run the web service on container startup. Here we use the gunicorn
+# webserver, with one worker process and 8 threads.
+# For environments with multiple CPU cores, increase the number of workers
+# to be equal to the cores available.
+CMD exec gunicorn --bind :$PORT --workers 1 --threads 8 --timeout 0 main:app
+
+# [END run_hello_dockerfile]

run/helloworld/README.md

@@ -0,0 +1,45 @@
+# Cloud Run Hello World Sample
+
+This sample shows how to deploy a Hello World application to Cloud Run.
+
+[![Run in Google Cloud][run_img]][run_link]
+
+[run_img]: https://storage.googleapis.com/cloudrun/button.svg
+[run_link]: https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&cloudshell_working_dir=run/helloworld
+
+## Build
+
+```
+docker build --tag helloworld:python .
+```
+
+## Run Locally
+
+```
+docker run --rm -p 9090:8080 -e PORT=8080 helloworld:python
+```
+
+## Test
+
+```
+pytest
+```
+
+_Note: you may need to install `pytest` using `pip install pytest`._
+
+## Deploy
+
+```sh
+# Set an environment variable with your GCP Project ID
+export GOOGLE_CLOUD_PROJECT=<PROJECT_ID>
+
+# Submit a build using Google Cloud Build
+gcloud builds submit --tag gcr.io/${GOOGLE_CLOUD_PROJECT}/helloworld
+
+# Deploy to Cloud Run
+gcloud run deploy helloworld \
+--image gcr.io/${GOOGLE_CLOUD_PROJECT}/helloworld
+```
+
+
+For more details on how to work with this sample read the [Python Cloud Run Samples README](https://github.com/GoogleCloudPlatform/python-docs-samples/tree/master/run)

run/helloworld/e2e_test.py

@@ -0,0 +1,97 @@
+# 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
+#
+#    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.
+
+# This sample creates a secure two-service application running on Cloud Run.
+# This test builds and deploys the two secure services
+# to test that they interact properly together.
+
+import os
+import subprocess
+from urllib import request
+import uuid
+
+import pytest
+
+
+@pytest.fixture()
+def services():
+    # Unique suffix to create distinct service names
+    suffix = uuid.uuid4().hex
+    project = os.environ["GOOGLE_CLOUD_PROJECT"]
+
+    # Build and Deploy Cloud Run Services
+    subprocess.run(
+        [
+            "gcloud",
+            "builds",
+            "submit",
+            f"--project={project}",
+            f"--substitutions=_SUFFIX={suffix}",
+            "--config=e2e_test_setup.yaml",
+            "--quiet",
+        ],
+        check=True,
+    )
+
+    # Get the URL for the service and the token
+    service = subprocess.run(
+        [
+            "gcloud",
+            "run",
+            f"--project={project}",
+            "--platform=managed",
+            "--region=us-central1",
+            "services",
+            "describe",
+            f"helloworld-{suffix}",
+            "--format=value(status.url)",
+        ],
+        stdout=subprocess.PIPE,
+        check=True,
+    ).stdout.strip()
+
+    token = subprocess.run(
+        ["gcloud", "auth", "print-identity-token"], stdout=subprocess.PIPE, check=True
+    ).stdout.strip()
+
+    yield service, token
+
+    subprocess.run(
+        [
+            "gcloud",
+            "run",
+            "services",
+            "delete",
+            f"helloworld-{suffix}",
+            f"--project={project}",
+            "--platform=managed",
+            "--region=us-central1",
+            "--quiet",
+        ],
+        check=True,
+    )
+
+
+def test_end_to_end(services):
+    service = services[0].decode()
+    token = services[1].decode()
+
+    req = request.Request(
+        f"{service}/", headers={"Authorization": f"Bearer {token}"}
+    )
+    response = request.urlopen(req)
+    assert response.status == 200
+
+    body = response.read()
+    assert "Hello Test!" == body.decode()

run/helloworld/e2e_test_setup.yaml

@@ -0,0 +1,37 @@
+# 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
+#
+#    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.
+
+steps:
+- # Build the renderer image
+  name: gcr.io/cloud-builders/docker:latest
+  args: ['build', '--tag=gcr.io/$PROJECT_ID/helloworld-${_SUFFIX}', '.']
+
+- # Push the container image to Container Registry
+  name: gcr.io/cloud-builders/docker
+  args: ['push', 'gcr.io/$PROJECT_ID/helloworld-${_SUFFIX}']
+
+- # Deploy to Cloud Run
+  name: gcr.io/cloud-builders/gcloud
+  args:
+  - run
+  - deploy
+  - helloworld-${_SUFFIX}
+  - --image=gcr.io/$PROJECT_ID/helloworld-${_SUFFIX}
+  - --region=us-central1
+  - --platform=managed
+  - --no-allow-unauthenticated
+  - --set-env-vars=NAME=Test
+
+images:
+  - 'gcr.io/$PROJECT_ID/helloworld-${_SUFFIX}'

run/helloworld/main.py

@@ -0,0 +1,31 @@
+# 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
+#
+#    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.
+
+# [START run_hello_service]
+import os
+
+from flask import Flask
+
+app = Flask(__name__)
+
+
+@app.route('/')
+def hello_world():
+    name = os.environ.get('NAME', 'World')
+    return 'Hello {}!'.format(name)
+
+
+if __name__ == "__main__":
+    app.run(debug=True, host='0.0.0.0', port=int(os.environ.get('PORT', 8080)))
+# [END run_hello_service]

run/helloworld/main_test.py

@@ -0,0 +1,40 @@
+# 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
+#
+#    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 pytest
+
+import main
+
+
+@pytest.fixture
+def client():
+    main.app.testing = True
+    return main.app.test_client()
+
+
+def test_handler_no_env_variable(client):
+    r = client.get("/")
+
+    assert r.data.decode() == "Hello World!"
+    assert r.status_code == 200
+
+
+def test_handler_with_env_variable(client):
+    os.environ["NAME"] = "Foo"
+    r = client.get("/")
+
+    assert r.data.decode() == "Hello Foo!"
+    assert r.status_code == 200

run/helloworld/noxfile_config.py

@@ -0,0 +1,39 @@
+# 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
+#
+#      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.
+
+# Default TEST_CONFIG_OVERRIDE for python repos.
+
+# You can copy this file into your directory, then it will be inported from
+# the noxfile.py.
+
+# The source of truth:
+# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/noxfile_config.py
+
+TEST_CONFIG_OVERRIDE = {
+    # You can opt out from the test for specific Python versions.
+
+    # We only run the cloud run tests in py38 session.
+    'ignored_versions': ["2.7", "3.6", "3.7"],
+
+    # An envvar key for determining the project id to use. Change it
+    # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
+    # build specific Cloud project. You can also use your own string
+    # to use your own Cloud project.
+    'gcloud_project_env': 'GCLOUD_PROJECT',
+    # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT',
+
+    # A dictionary you want to inject into your test. Don't put any
+    # secrets here. These values will override predefined values.
+    'envs': {},
+}

run/helloworld/requirements-test.txt

@@ -0,0 +1 @@
+pytest==6.0.1

run/helloworld/requirements.txt

@@ -0,0 +1,2 @@
+Flask==1.1.2
+gunicorn==20.0.4