Feature: add bundled services samples from jinglundong (GoogleCloudPlatform#8070)

* Feature: add bundled services samples from jinglundong

* Feature: texted bundled email

* add debugging

* Alternate command version

* Flask mail app and tests

* Flask Mail example complete

* Django mail sample complete

* WSGI version of Mail sample

* Flask Blobstore sample finished

* Django Blobstore sample done

* WSGI Blobstore sample done

* Deferred Flask sample done

* Feature: app engine bundled services samples

* Fix: address review comments

* Temporary debug helper

* Fixed debug typo

* Fix: Use standard test configurations for each sample

* Fix: copyright date

* Fix: nox config

* Fix: assign version numbers

* Fix: blobstore and deferred passing

* Fix: log permissions

* Fix: show failures for debugging

* Fix: run command variation

* Fix: turn off type hint check for old ported samples

* Fix: fix lint error

* Fix: remove whitespace

* Fix: more wiggle room for deferred timing

Co-authored-by: Maciej Strzelczyk <[email protected]>

Author: engelke

appengine/standard_python3/bundled-services/blobstore/README.md

@@ -0,0 +1,36 @@
+# Access bundled Blobstore services API in Python 3
+
+This folder contains functionally identical apps that allow users to upload
+and download files to and from the App Engine Blobstore.
+
+The apps are written using three different web frameworks:
+[Flask](https://palletsprojects.com/p/flask/),
+[Django](https://www.djangoproject.com/), and the [App Engine bundled services
+wsgi functionality](https://github.com/GoogleCloudPlatform/appengine-python-standard).
+
+When run in App Engine, a GET request to the home page (`/` path) will display
+a page with a form for selecting a local file and submitting it. When the
+form is submitted, the app will save the file in Blobstore and then redirect
+the browser to a page that fetches and displays the file.
+
+Deploy this app to App Engine via `gcloud app deploy`. More about App Engine
+Bundled Blobstore API at:
+https://cloud.google.com/appengine/docs/standard/python3/services/blobstore#python-3-flask
+
+## Testing
+
+The App Engine bundled services can be used from within properly configured App
+Engine applications, so testing these apps requires deploying them to App Engine.
+
+Each version of the app includes a test program that will:
+
+1. Launch a new version of the app to App Engine without routing network
+requests to it.
+1. Interact with the launched app via web requests to the URL of the
+specific version that was launched.
+1. Delete the newly launched app version. This is possible because it did not
+have requests routed to it.
+
+Since each test uses a separate version and addresses test messages and web
+requests to that version, multiple tests can run simultaneously without
+interfering with each other.

appengine/standard_python3/bundled-services/blobstore/django/.gcloudignore

@@ -0,0 +1,19 @@
+# This file specifies files that are *not* uploaded to Google Cloud Platform
+# using gcloud. It follows the same syntax as .gitignore, with the addition of
+# "#!include" directives (which insert the entries of the given .gitignore-style
+# file at that point).
+#
+# For more information, run:
+#   $ gcloud topic gcloudignore
+#
+.gcloudignore
+# If you would like to upload your .git directory, .gitignore file or files
+# from your .gitignore file, remove the corresponding line
+# below:
+.git
+.gitignore
+
+# Python pycache:
+__pycache__/
+# Ignored by the build system
+/setup.cfg

appengine/standard_python3/bundled-services/blobstore/django/README.md

@@ -0,0 +1,4 @@
+# Django app to access bundled Blobstore services API in Python 3
+
+See the [main README](../README.md) for the bundled Blobstore services examples
+for information.

appengine/standard_python3/bundled-services/blobstore/django/app.yaml

@@ -0,0 +1,20 @@
+# Copyright 2022 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.
+
+runtime: python39
+app_engine_apis: true
+
+handlers:
+- url: .*
+  script: auto

appengine/standard_python3/bundled-services/blobstore/django/main.py

@@ -0,0 +1,105 @@
+# Copyright 2022 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.
+
+from django.conf import settings
+from django.core.wsgi import get_wsgi_application
+from django.http import HttpResponse
+from django.shortcuts import redirect
+from django.urls import path
+from google.appengine.api import wrap_wsgi_app
+from google.appengine.ext import blobstore
+from google.appengine.ext import ndb
+from google.cloud import logging
+
+# Logging client in Python 3
+logging_client = logging.Client()
+
+# This log can be found in the Cloud Logging console under 'Custom Logs'.
+logger = logging_client.logger("django-app-logs")
+
+
+# This datastore model keeps track of which users uploaded which photos.
+class UserPhoto(ndb.Model):
+    blob_key = ndb.BlobKeyProperty()
+
+
+class PhotoUploadHandler(blobstore.BlobstoreUploadHandler):
+    def post(self, environ):
+        upload = self.get_uploads(environ)[0]
+        photo_key = upload.key()
+        user_photo = UserPhoto(blob_key=photo_key)
+        user_photo.put()
+        logger.log_text("Photo key: %s" % photo_key)
+        return redirect("view_photo", key=photo_key)
+
+
+class ViewPhotoHandler(blobstore.BlobstoreDownloadHandler):
+    def get(self, environ, photo_key):
+        if not blobstore.get(photo_key):
+            return HttpResponse("Photo key not found", status=404)
+        else:
+            response = HttpResponse(headers=self.send_blob(environ, photo_key))
+
+            # Prevent Django from setting a default content-type.
+            # GAE sets it to a guessed type if the header is not set.
+            response["Content-Type"] = None
+            return response
+
+
+def upload_form(request):
+    """Create the HTML form to upload a file."""
+    upload_url = blobstore.create_upload_url("/upload_photo")
+
+    response = """
+  <html><body>
+  <form action="{0}" method="POST" enctype="multipart/form-data">
+    Upload File: <input type="file" name="file"><br>
+    <input type="submit" name="submit" value="Submit">
+  </form>
+  </body></html>""".format(
+        upload_url
+    )
+
+    return HttpResponse(response)
+
+
+def view_photo(request, key):
+    """View photo given a key."""
+    return ViewPhotoHandler().get(request.environ, key)
+
+
+def upload_photo(request):
+    """Upload handler called by blobstore when a blob is uploaded in the test."""
+    return PhotoUploadHandler().post(request.environ)
+
+
+urlpatterns = (
+    path("", upload_form, name="upload_form"),
+    path("view_photo/<key>", view_photo, name="view_photo"),
+    path("upload_photo", upload_photo, name="upload_photo"),
+)
+
+settings.configure(
+    DEBUG=True,
+    SECRET_KEY="thisisthesecretkey",
+    ROOT_URLCONF=__name__,
+    MIDDLEWARE_CLASSES=(
+        "django.middleware.common.CommonMiddleware",
+        "django.middleware.csrf.CsrfViewMiddleware",
+        "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    ),
+    ALLOWED_HOSTS=["*"],
+)
+
+app = wrap_wsgi_app(get_wsgi_application())

appengine/standard_python3/bundled-services/blobstore/django/main_test.py

@@ -0,0 +1,71 @@
+# Copyright 2022 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 json
+import re
+import subprocess
+import uuid
+
+import pytest
+import requests
+
+
+@pytest.fixture
+def version():
+    """Launch a new version of the app for testing, and yield the
+    project and version number so tests can invoke it, then delete it.
+    """
+
+    output = subprocess.run(
+        f"gcloud app deploy --no-promote --quiet --format=json --version={uuid.uuid4().hex}",
+        capture_output=True,
+        shell=True,
+    )
+
+    try:
+        result = json.loads(output.stdout)
+        version_id = result["versions"][0]["id"]
+        project_id = result["versions"][0]["project"]
+    except Exception as e:
+        print(f"New version deployment output not usable: {e}")
+        print(f"Command stderr is '{output.stderr}'")
+        raise ValueError
+
+    yield project_id, version_id
+
+    output = subprocess.run(
+        f"gcloud app versions delete {version_id}",
+        capture_output=True,
+        shell=True,
+    )
+
+
+def test_upload_and_view(version):
+    project_id, version_id = version
+    version_hostname = f"{version_id}-dot-{project_id}.appspot.com"
+
+    # Check that version is serving form in home page
+    response = requests.get(f"https://{version_hostname}/")
+    assert response.status_code == 200
+    assert '<form action="' in response.text
+
+    matches = re.search(r'action="(.*?)"', response.text)
+    assert matches is not None
+    upload_url = matches.group(1)
+
+    with open("./main.py", "rb") as f:
+        response = requests.post(upload_url, files={"file": f})
+
+    assert response.status_code == 200
+    assert b"from google.appengine.api" in response.content

appengine/standard_python3/bundled-services/blobstore/django/noxfile_config.py

@@ -0,0 +1,42 @@
+# Copyright 2022 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 imported from
+# the noxfile.py.
+
+# The source of truth:
+# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/noxfile_config.py
+
+TEST_CONFIG_OVERRIDE = {
+    # You can opt out from the test for specific Python versions.
+    "ignored_versions": ["2.7", "3.6"],
+    # Old samples are opted out of enforcing Python type hints
+    # All new samples should feature them
+    "enforce_type_hints": False,
+    # 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": "GOOGLE_CLOUD_PROJECT",
+    "gcloud_project_env": "BUILD_SPECIFIC_GCLOUD_PROJECT",
+    # If you need to use a specific version of pip,
+    # change pip_version_override to the string representation
+    # of the version number, for example, "20.2.4"
+    "pip_version_override": None,
+    # A dictionary you want to inject into your test. Don't put any
+    # secrets here. These values will override predefined values.
+    "envs": {},
+}

appengine/standard_python3/bundled-services/blobstore/django/requirements-test.txt

@@ -0,0 +1,2 @@
+pytest==7.1.2
+requests==2.28.1

appengine/standard_python3/bundled-services/blobstore/django/requirements.txt

@@ -0,0 +1,4 @@
+Django==3.2.8
+django-environ==0.7.0
+google-cloud-logging==2.6.0
+appengine-python-standard>=0.2.3

appengine/standard_python3/bundled-services/blobstore/flask/.gcloudignore

@@ -0,0 +1,19 @@
+# This file specifies files that are *not* uploaded to Google Cloud Platform
+# using gcloud. It follows the same syntax as .gitignore, with the addition of
+# "#!include" directives (which insert the entries of the given .gitignore-style
+# file at that point).
+#
+# For more information, run:
+#   $ gcloud topic gcloudignore
+#
+.gcloudignore
+# If you would like to upload your .git directory, .gitignore file or files
+# from your .gitignore file, remove the corresponding line
+# below:
+.git
+.gitignore
+
+# Python pycache:
+__pycache__/
+# Ignored by the build system
+/setup.cfg