scheduler tutorial draft

averikitsch · averikitsch · commit 61019cdaa5f6 · 2019-01-09T11:39:42.000-08:00
diff --git a/scheduler/README.md b/scheduler/README.md
diff --git a/scheduler/app.yaml b/scheduler/app.yaml
@@ -1,9 +1,7 @@
 runtime: python
+service: my-service
 env: flex
 entrypoint: gunicorn -b :$PORT main:app
 
 runtime_config:
   python_version: 3
-
-env_variables:
-  PYTHONUNBUFFERED: TRUE
diff --git a/scheduler/create_job.py b/scheduler/create_job.py
@@ -1,42 +1,51 @@
- # Copyright 2018 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 cloud_scheduler_create_job]
-from google.cloud import scheduler
-
-client = scheduler.CloudSchedulerClient()
-
-# TODO(developer): Uncomment and set the following variables
-# project_id = "PROJECT_ID"
-# location_id = "LOCATION_ID"
-# app_engine_version = "VERSION_ID"
-
-parent = client.location_path(project_id, location_id)
-
-job = {
-    'app_engine_http_target': {
-      'app_engine_routing': {
-        'service':'default',
-        'version': app_engine_version
+# Copyright 2018 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.
+
+
+def create_scheduler_job(project_id, location_id, service_id):
+    # [START cloud_scheduler_quickstart]
+    """Create a job with an App Engine target via the Cloud Scheduler API"""
+    from google.cloud import scheduler
+
+    # Create a client.
+    client = scheduler.CloudSchedulerClient()
+
+    # TODO(developer): Uncomment and set the following variables
+    # project_id = 'PROJECT_ID'
+    # location_id = 'LOCATION_ID'
+    # service_id = 'my-service'
+
+    # Construct the fully qualified location path.
+    parent = client.location_path(project_id, location_id)
+
+    # Construct the request body.
+    job = {
+        'app_engine_http_target': {
+            'app_engine_routing': {
+                'service': service_id
+            },
+            'relative_uri': '/log_payload',
+            'http_method': 'POST',
+            'body': 'Hello World'.encode()
         },
-      'relative_uri': '/log_payload',
-      'http_method': 'POST',
-      'body': 'Hello World'.encode()
-    },
-    'schedule': "* * * * *",
-    'time_zone': "America/Los_Angeles"
-}
-
-response = client.create_job(parent, job)
-# [END cloud_scheduler_create_job]
+        'schedule': '* * * * *',
+        'time_zone': 'America/Los_Angeles'
+    }
+
+    # Use the client to send job creation request.
+    response = client.create_job(parent, job)
+
+    print('Created job: {}'.format(response.name))
+    return response
+# [END cloud_scheduler_quickstart]
diff --git a/scheduler/create_job_test.py b/scheduler/create_job_test.py
@@ -0,0 +1,26 @@
+# Copyright 2018 Google Inc. 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_job
+
+TEST_PROJECT_ID = os.getenv('GCLOUD_PROJECT')
+TEST_LOCATION = os.getenv('TEST_QUEUE_LOCATION', 'us-central1')
+
+
+def test_create_job():
+    result = create_job.create_scheduler_job(
+        TEST_PROJECT_ID, TEST_LOCATION, 'my-service')
+    assert TEST_PROJECT_ID in result.name
diff --git a/scheduler/main.py b/scheduler/main.py
@@ -14,7 +14,7 @@
 
 """App Engine app to serve as an endpoint for Cloud Scheduler samples."""
 
-# [START cloud_scheduler_quickstart]
+# [START cloud_scheduler_app]
 from flask import Flask, request
 
 app = Flask(__name__)
@@ -24,9 +24,9 @@
 def example_task_handler():
     """Log the request payload."""
     payload = request.get_data(as_text=True) or '(empty payload)'
-    print('Received job with payload: {}'.format(payload), flush=True)
+    print('Received job with payload: {}'.format(payload))
     return 'Printed job payload: {}'.format(payload)
-# [END cloud_scheduler_quickstart]
+# [END cloud_scheduler_app]
 
 
 @app.route('/')
diff --git a/scheduler/main_test.py b/scheduler/main_test.py
@@ -0,0 +1,45 @@
+# Copyright 2018 Google Inc. 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 pytest
+
+
+@pytest.fixture
+def app():
+    import main
+    main.app.testing = True
+    return main.app.test_client()
+
+
+def test_index(app):
+    r = app.get('/')
+    assert r.status_code == 200
+
+
+def test_log_payload(capsys, app):
+    payload = 'test_payload'
+
+    r = app.post('/log_payload', data=payload)
+    assert r.status_code == 200
+
+    out, _ = capsys.readouterr()
+    assert payload in out
+
+
+def test_empty_payload(capsys, app):
+    r = app.post('/log_payload')
+    assert r.status_code == 200
+
+    out, _ = capsys.readouterr()
+    assert 'empty payload' in out
