"Hello Broken" python sample (GoogleCloudPlatform#2618)

* Hello broken python sample

* Updating README

* Updating test file

* Fixing README nits

* Fixing README link

* Updating test instructions in README and moving region tag

* Noxfile change to signal only python 3 tests

Co-authored-by: Leah E. Cole <[email protected]>

Author: dinagraves

noxfile.py

@@ -175,6 +175,7 @@ def _setup_appengine_sdk(session):
         or sample.startswith("./functions/")
         or sample.startswith("./bigquery/pandas-gbq-migration")
         or sample.startswith("./run/system-package")
+        or sample.startswith("./run/hello-broken")
     )
 ]
 NON_GAE_STANDARD_SAMPLES_PY2 = sorted(

run/hello-broken/Dockerfile

@@ -0,0 +1,35 @@
+# Copyright 2019 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.
+
+# Use the official Python image.
+# https://hub.docker.com/_/python
+FROM python:3.7
+
+# Copy application dependency manifests to the container image.
+# Copying this separately prevents re-running pip install on every code change.
+COPY requirements.txt .
+
+# Install production dependencies.
+RUN pip install -r requirements.txt
+
+# Copy local code to the container image.
+ENV APP_HOME /app
+WORKDIR $APP_HOME
+COPY . .
+
+# Run the web service on container startup. 
+# Use 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 main:app

run/hello-broken/README.md

@@ -0,0 +1,47 @@
+# Cloud Run Broken Sample
+
+This sample presents broken code in need of troubleshooting. View [improved](main.py#L43) for a more stable implementation. 
+
+Troubleshoot this code by following the [Local Container Troubleshooting Tutorial](http://cloud.google.com/run/docs/tutorials/local-troubleshooting).
+
+[![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/hello-broken
+
+## Build
+
+```
+docker build --tag hello-broken:python .
+```
+
+## Run Locally
+
+```
+docker run --rm -p 9090:8080 hello-broken:python
+```
+
+## Test
+
+```
+nox -s "py36(sample='./run/hello-broken')"
+```
+
+_Note: you may need to install `nox` using `pip install nox`._
+
+## 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}/hello-broken
+
+# Deploy to Cloud Run
+gcloud run deploy hello-broken \
+--image gcr.io/${GOOGLE_CLOUD_PROJECT}/hello-broken 
+```
+
+
+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/hello-broken/main.py

@@ -0,0 +1,72 @@
+# Copyright 2019 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_broken_service]
+from flask import Flask
+import json
+import os
+import sys
+
+app = Flask(__name__)
+
+
+@app.route("/", methods=["GET"])
+def index():
+    print("hello: received request.")
+
+    # [START run_broken_service_problem]
+    NAME = os.getenv("NAME")
+
+    if not NAME:
+        print("Environment validation failed.")
+        raise Exception("Missing required service parameter.")
+    # [END run_broken_service_problem]
+
+    # Flush the stdout to avoid log buffering.
+    sys.stdout.flush()
+
+    return f"Hello {NAME}"
+# [END run_broken_service]
+
+
+@app.route("/improved", methods=["GET"])
+def improved():
+    print("hello: received request.")
+
+    # [START run_broken_service_upgrade]
+    NAME = os.getenv("NAME")
+
+    if not NAME:
+        NAME = "World"
+        error_message = {
+            "severity": "WARNING",
+            "message": f"NAME not set, default to {NAME}",
+        }
+        print(json.dumps(error_message))
+    # [END run_broken_service_upgrade]
+
+    # Flush the stdout to avoid log buffering.
+    sys.stdout.flush()
+
+    return f"Hello {NAME}"
+
+
+# [START run_broken_service]
+if __name__ == "__main__":
+    PORT = int(os.getenv("PORT")) if os.getenv("PORT") else 8080
+
+    # This is used when running locally. Gunicorn is used to run the
+    # application on Cloud Run. See entrypoint in Dockerfile.
+    app.run(host="127.0.0.1", port=PORT, debug=True)
+# [END run_broken_service]

run/hello-broken/main_test.py

@@ -0,0 +1,54 @@
+# Copyright 2019 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_broken_handler(client):
+    with pytest.raises(Exception) as e:
+        client.get("/")
+
+    assert "Missing required service parameter" in str(e.value)
+
+
+def test_broken_handler_with_env_variable(client):
+    os.environ["NAME"] = "Foo"
+    r = client.get("/")
+
+    assert r.data.decode() == "Hello Foo"
+    assert r.status_code == 200
+
+
+def test_improved_handler_no_env_variable(client):
+    os.environ["NAME"] = ""
+    r = client.get("/improved")
+
+    assert r.data.decode() == "Hello World"
+    assert r.status_code == 200
+
+
+def test_improved_handler_with_env_variable(client):
+    os.environ["NAME"] = "Foo"
+    r = client.get("/improved")
+
+    assert r.data.decode() == "Hello Foo"
+    assert r.status_code == 200

run/hello-broken/requirements.txt

@@ -0,0 +1,4 @@
+Flask==1.1.1
+pytest==5.3.0; python_version > "3.0"
+pytest==4.6.6; python_version < "3.0"
+gunicorn==19.9.0