Cloudevents events pubsub (GoogleCloudPlatform#4532)

cumason123 · leahecole · web-flow · commit 73d474237e19 · 2020-08-27T11:28:29.000-07:00
* Added additional cloudevent error handling

Signed-off-by: Curtis Mason &lt;cumason@google.com&gt;

* Added cloudevents from github.com/cloudevents/sdk-python

Signed-off-by: Curtis Mason &lt;cumason@google.com&gt;

* cloudevents version bump 1.2.0

Signed-off-by: Curtis Mason &lt;cumason@google.com&gt;

* lint fixes

Signed-off-by: Curtis Mason &lt;cumason@google.com&gt;

* README nit

Signed-off-by: Curtis Mason &lt;cumason@google.com&gt;

* cloudevents==1.2.0

Signed-off-by: Curtis Mason &lt;cumason@google.com&gt;

* removed flask and cloudevents from req-test

Signed-off-by: Curtis Mason &lt;cumason@bu.edu&gt;

Co-authored-by: Leah E. Cole &lt;6719667+leahecole@users.noreply.github.com&gt;
diff --git a/run/events-pubsub/README.md b/run/events-pubsub/README.md
@@ -1,6 +1,7 @@
 # Events for Cloud Run – Pub/Sub tutorial
 
-This sample shows how to create a service that processes Pub/Sub events.
+This sample shows how to create a service that processes Pub/Sub events using 
+[the CloudEvents SDK](https://github.com/cloudevents/sdk-python).
 
 ## Setup
 
diff --git a/run/events-pubsub/main.py b/run/events-pubsub/main.py
@@ -14,8 +14,12 @@
 
 # [START run_events_pubsub_server_setup]
 import base64
+
 import os
 
+import cloudevents.exceptions as cloud_exceptions
+from cloudevents.http import from_http
+
 from flask import Flask, request
 
 
@@ -28,13 +32,24 @@
 # [START run_events_pubsub_handler]
 @app.route('/', methods=['POST'])
 def index():
-    for field in required_fields:
-        if field not in request.headers:
-            errmsg = f'Bad Request: missing required header {field}'
-            print(errmsg)
-            return errmsg, 400
+    # Create CloudEvent from HTTP headers and body
+    try:
+        event = from_http(request.headers, request.get_data())
+
+    except cloud_exceptions.MissingRequiredFields as e:
+        print(f"cloudevents.exceptions.MissingRequiredFields: {e}")
+        return "Failed to find all required cloudevent fields. ", 400
+
+    except cloud_exceptions.InvalidStructuredJSON as e:
+        print(f"cloudevents.exceptions.InvalidStructuredJSON: {e}")
+        return "Could not deserialize the payload as JSON. ", 400
+
+    except cloud_exceptions.InvalidRequiredFields as e:
+        print(f"cloudevents.exceptions.InvalidRequiredFields: {e}")
+        return "Request contained invalid required cloudevent fields. ", 400
+
+    envelope = event.data
 
-    envelope = request.get_json()
     if not envelope:
         msg = 'no Pub/Sub message received'
         print(f'error: {msg}')
@@ -51,8 +66,7 @@ def index():
     if isinstance(pubsub_message, dict) and 'data' in pubsub_message:
         name = base64.b64decode(pubsub_message['data']).decode('utf-8').strip()
 
-    ce_id = request.headers.get('Ce-Id')
-    resp = f'Hello, {name}! ID: {ce_id}'
+    resp = f"Hello, {name}! ID: {event['id']}"
     print(resp)
     return (resp, 200)
 # [END run_events_pubsub_handler]
diff --git a/run/events-pubsub/main_test.py b/run/events-pubsub/main_test.py
@@ -22,9 +22,12 @@
 import main
 
 
-required_fields = ['Ce-Id', 'Ce-Source', 'Ce-Type', 'Ce-Specversion']
-
-header_data = {field: str(uuid4()) for field in required_fields}
+binary_headers = {
+    "ce-id": str(uuid4),
+    "ce-type": "com.pytest.sample.event",
+    "ce-source": "<my-test-source>",
+    "ce-specversion": "1.0"
+}
 
 
 @pytest.fixture
@@ -34,48 +37,49 @@ def client():
 
 
 def test_empty_payload(client):
-    r = client.post('/', json='', headers=header_data)
+    r = client.post('/', json='', headers=binary_headers)
     assert r.status_code == 400
 
 
 def test_invalid_payload(client):
-    r = client.post('/', json={'nomessage': 'invalid'}, headers=header_data)
+    r = client.post('/', json={'nomessage': 'invalid'}, headers=binary_headers)
     assert r.status_code == 400
 
 
 def test_invalid_mimetype(client):
-    r = client.post('/', json="{ message: true }", headers=header_data)
+    r = client.post('/', json="{ message: true }", headers=binary_headers)
     assert r.status_code == 400
 
 
 def test_minimally_valid_message(client, capsys):
-    r = client.post('/', json={'message': True}, headers=header_data)
+    r = client.post('/', json={'message': True}, headers=binary_headers)
     assert r.status_code == 200
 
     out, _ = capsys.readouterr()
-    ce_id = header_data['Ce-Id']
+    ce_id = binary_headers['ce-id']
+
     assert f'Hello, World! ID: {ce_id}' in out
 
 
 def test_populated_message(client, capsys):
     name = str(uuid4())
     data = base64.b64encode(name.encode()).decode()
 
-    r = client.post('/', json={'message': {'data': data}}, headers=header_data)
+    r = client.post('/', json={'message': {'data': data}}, headers=binary_headers)
     assert r.status_code == 200
 
     out, _ = capsys.readouterr()
-    ce_id = header_data['Ce-Id']
+    ce_id = binary_headers['ce-id']
     assert f'Hello, {name}! ID: {ce_id}' in out
 
 
 def test_missing_required_fields(client, capsys):
-    for field in required_fields:
-        test_headers = copy.copy(header_data)
+    for field in binary_headers:
+        test_headers = copy.copy(binary_headers)
         test_headers.pop(field)
 
         r = client.post('/', headers=test_headers)
         assert r.status_code == 400
 
         out, _ = capsys.readouterr()
-        assert f'Bad Request: missing required header {field}' in out
+        assert 'MissingRequiredFields' in out
diff --git a/run/events-pubsub/requirements.txt b/run/events-pubsub/requirements.txt
@@ -1,2 +1,3 @@
 Flask==1.1.2
 gunicorn==20.0.4
+cloudevents==1.2.0

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`Flask==1.1.2`
`2`	`2`	`gunicorn==20.0.4`
	`3`	`+cloudevents==1.2.0`