[Cloud Tasks] Add task with authentication sample (#2113)

* Add task with authentication sample

* Fix linting

* Fix linting

* Fix spacing

* Update tests with service account

* Move samples and update READMEs

* Update version and linting

Author: averikitsch

appengine/flexible/tasks/Dockerfile

@@ -0,0 +1,17 @@
+# Use the official Python image.
+# https://hub.docker.com/_/python
+FROM python:3.7
+
+# 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 main:app

appengine/flexible/tasks/README.md

@@ -101,24 +101,3 @@ endpoint, with a payload specified:
 ```
 python create_app_engine_queue_task.py --project=$PROJECT_ID --queue=$QUEUE_ID --location=$LOCATION_ID --payload=hello
 ```
-
-### Using HTTP Push Queues
-
-Set an environment variable for the endpoint to your task handler. This is an
-example url to send requests to the App Engine task handler:
-```
-export URL=https://<project_id>.appspot.com/example_task_handler
-```
-
-Running the sample will create a task and send the task to the specific URL
-endpoint, with a payload specified:
-
-```
-python create_http_task.py --project=$PROJECT_ID --queue=$QUEUE_ID --location=$LOCATION_ID --url=$URL --payload=hello
-```
-
-Now view that the payload was received and verify the payload:
-
-```
-gcloud app logs read
-```

appengine/flexible/tasks/requirements.txt

@@ -1,3 +1,3 @@
 Flask==1.0.2
 gunicorn==19.9.0
-google-cloud-tasks==0.6.0
+google-cloud-tasks==0.7.0

tasks/README.md

@@ -12,8 +12,11 @@ App Engine queues push tasks to an App Engine HTTP target. This directory
 contains both the App Engine app to deploy, as well as the snippets to run
 locally to push tasks to it, which could also be called on App Engine.
 
-`create_app_engine_queue_task.py` is a simple command-line program to create
-tasks to be pushed to the App Engine app.
+`create_http_task.py` is a simple command-line program to create
+tasks to be pushed to an URL endpoint.
+
+`create_http_task_with_token.py` is a simple command-line program to create
+tasks to be pushed to an URL endpoint with authorization header.
 
 `main.py` is the main App Engine app. This app serves as an endpoint to receive
 App Engine task attempts.
@@ -41,33 +44,6 @@ gcloud beta tasks queues create-app-engine-queue my-appengine-queue
 Note: A newly created queue will route to the default App Engine service and
 version unless configured to do otherwise.
 
-## Deploying the App Engine App
-
-Deploy the App Engine app with gcloud:
-
-* To deploy to the Standard environment:
-  ```
-  gcloud app deploy app.yaml
-  ```
-* To deploy to the Flexible environment:
-  ```
-  gcloud app deploy app.flexible.yaml
-  ```
-
-Verify the index page is serving:
-
-```
-gcloud app browse
-```
-
-The App Engine app serves as a target for the push requests. It has an
-endpoint `/example_task_handler` that reads the payload (i.e., the request body)
-of the HTTP POST request and logs it. The log output can be viewed with:
-
-```
-gcloud app logs read
-```
-
 ## Run the Sample Using the Command Line
 
 Set environment variables:

tasks/create_http_task_with_token.py

@@ -0,0 +1,80 @@
+# Copyright 2019 Google LLC 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.
+
+from __future__ import print_function
+
+import datetime
+
+
+def create_http_task(project,
+                     queue,
+                     location,
+                     url,
+                     service_account_email,
+                     payload=None,
+                     in_seconds=None):
+    # [START cloud_tasks_create_http_task_with_token]
+    """Create a task for a given queue with an arbitrary payload."""
+
+    from google.cloud import tasks_v2beta3
+    from google.protobuf import timestamp_pb2
+
+    # Create a client.
+    client = tasks_v2beta3.CloudTasksClient()
+
+    # TODO(developer): Uncomment these lines and replace with your values.
+    # project = 'my-project-id'
+    # queue = 'my-appengine-queue'
+    # location = 'us-central1'
+    # url = 'https://example.com/example_task_handler'
+    # payload = 'hello'
+
+    # Construct the fully qualified queue name.
+    parent = client.queue_path(project, location, queue)
+
+    # Construct the request body.
+    task = {
+            'http_request': {  # Specify the type of request.
+                'http_method': 'POST',
+                'url': url,  # The full url path that the task will be sent to.
+                'oidc_token': {
+                    'service_account_email': service_account_email
+                }
+            }
+    }
+
+    if payload is not None:
+        # The API expects a payload of type bytes.
+        converted_payload = payload.encode()
+
+        # Add the payload to the request.
+        task['http_request']['body'] = converted_payload
+
+    if in_seconds is not None:
+        # Convert "seconds from now" into an rfc3339 datetime string.
+        d = datetime.datetime.utcnow() + datetime.timedelta(seconds=in_seconds)
+
+        # Create Timestamp protobuf.
+        timestamp = timestamp_pb2.Timestamp()
+        timestamp.FromDatetime(d)
+
+        # Add the timestamp to the tasks.
+        task['schedule_time'] = timestamp
+
+    # Use the client to build and send the task.
+    response = client.create_task(parent, task)
+
+    print('Created task {}'.format(response.name))
+    return response
+# [END cloud_tasks_create_http_task_with_token]

tasks/create_http_task_with_token_test.py

@@ -0,0 +1,33 @@
+# Copyright 2019 Google LLC 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 create_http_task_with_token
+
+TEST_PROJECT_ID = os.getenv('GCLOUD_PROJECT')
+TEST_LOCATION = os.getenv('TEST_QUEUE_LOCATION', 'us-central1')
+TEST_QUEUE_NAME = os.getenv('TEST_QUEUE_NAME', 'my-appengine-queue')
+TEST_SERVICE_ACCOUNT = (
+    'test-run-invoker@python-docs-samples-tests.iam.gserviceaccount.com')
+
+
+def test_create_http_task_with_token():
+    url = 'https://example.com/example_task_handler'
+    result = create_http_task_with_token.create_http_task(TEST_PROJECT_ID,
+                                                          TEST_QUEUE_NAME,
+                                                          TEST_LOCATION,
+                                                          url,
+                                                          TEST_SERVICE_ACCOUNT)
+    assert TEST_QUEUE_NAME in result.name

tasks/requirements.txt

@@ -1,3 +1,3 @@
 Flask==1.0.2
 gunicorn==19.9.0
-google-cloud-tasks==0.6.0
+google-cloud-tasks==0.7.0