refactor: clean up cloud_scheduler samples (GoogleCloudPlatform#10095)

Co-authored-by: gcf-merge-on-green[bot] <60162190+gcf-merge-on-green[bot]@users.noreply.github.com>

Author: MonochromaticCoder

scheduler/snippets/app.yaml renamed to cloud_scheduler/snippets/app.yaml

@@ -14,11 +14,12 @@
 
 # [START cloudscheduler_create_job]
 
-from google.cloud import scheduler
-from google.cloud.scheduler_v1 import Job
+from google.cloud import scheduler_v1
 
 
-def create_scheduler_job(project_id: str, location_id: str, service_id: str) -> Job:
+def create_scheduler_job(
+    project_id: str, location_id: str, service_id: str
+) -> scheduler_v1.Job:
     """Create a job with an App Engine target via the Cloud Scheduler API.
 
     Args:
@@ -31,27 +32,29 @@ def create_scheduler_job(project_id: str, location_id: str, service_id: str) ->
     """
 
     # Create a client.
-    client = scheduler.CloudSchedulerClient()
-
-    # Construct the fully qualified location path.
-    parent = f"projects/{project_id}/locations/{location_id}"
-
-    # Construct the request body.
-    job = {
-        "app_engine_http_target": {
-            "app_engine_routing": {"service": service_id},
-            "relative_uri": "/log_payload",
-            "http_method": 1,
-            "body": b"Hello World",
-        },
-        "schedule": "* * * * *",
-        "time_zone": "America/Los_Angeles",
-    }
+    client = scheduler_v1.CloudSchedulerClient()
+
+    # Construct the job.
+    job = scheduler_v1.Job(
+        app_engine_http_target=scheduler_v1.AppEngineHttpTarget(
+            app_engine_routing=scheduler_v1.AppEngineRouting(service=service_id),
+            relative_uri="/log_payload",
+            http_method=scheduler_v1.HttpMethod.POST,
+            body=b"Hello World",
+        ),
+        schedule="* * * * *",
+        time_zone="America/Los_Angeles",
+    )
 
     # Use the client to send the job creation request.
-    response = client.create_job(request={"parent": parent, "job": job})
+    response = client.create_job(
+        scheduler_v1.CreateJobRequest(
+            parent=client.common_location_path(project_id, location_id),
+            job=job,
+        )
+    )
 
-    print(f"Created job: {response.name}")
     return response
 
+
 # [END cloudscheduler_create_job]

scheduler/snippets/create_job.py renamed to cloud_scheduler/snippets/create_job.py

@@ -14,10 +14,10 @@
 
 # [START cloudscheduler_delete_job]
 
-from google.cloud import scheduler
+from google.cloud import scheduler_v1
 
 
-def delete_scheduler_job(project_id: str, location_id: str, job_id: str) -> bool:
+def delete_scheduler_job(project_id: str, location_id: str, job_id: str) -> None:
     """Delete a job via the Cloud Scheduler API.
 
     Args:
@@ -27,14 +27,14 @@ def delete_scheduler_job(project_id: str, location_id: str, job_id: str) -> bool
     """
 
     # Create a client.
-    client = scheduler.CloudSchedulerClient()
-
-    # Construct the fully qualified job path.
-    job = f"projects/{project_id}/locations/{location_id}/jobs/{job_id}"
+    client = scheduler_v1.CloudSchedulerClient()
 
     # Use the client to send the job deletion request.
-    client.delete_job(name=job)
-    print("Job deleted.")
-    return True
+    client.delete_job(
+        scheduler_v1.DeleteJobRequest(
+            name=client.job_path(project_id, location_id, job_id)
+        )
+    )
+
 
 # [END cloudscheduler_delete_job]

scheduler/snippets/delete_job.py renamed to cloud_scheduler/snippets/delete_job.py

@@ -0,0 +1,69 @@
+# 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 uuid
+
+from google.api_core import exceptions
+from google.cloud import scheduler_v1
+
+import pytest
+
+import create_job
+import delete_job
+
+TEST_PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+TEST_LOCATION = os.getenv("LOCATION_ID", "us-central1")
+TEST_JOB_ID = f"my-job-{uuid.uuid4().hex}"
+
+
+def test_create_job() -> None:
+    client = scheduler_v1.CloudSchedulerClient()
+
+    job = create_job.create_scheduler_job(TEST_PROJECT_ID, TEST_LOCATION, "my-service")
+    assert job.name.startswith(
+        client.common_location_path(TEST_PROJECT_ID, TEST_LOCATION)
+    )
+
+    client.delete_job(scheduler_v1.DeleteJobRequest(name=job.name))
+
+
+def test_delete_job() -> None:
+    client = scheduler_v1.CloudSchedulerClient()
+
+    client.create_job(
+        scheduler_v1.CreateJobRequest(
+            parent=client.common_location_path(TEST_PROJECT_ID, TEST_LOCATION),
+            job=scheduler_v1.Job(
+                name=client.job_path(TEST_PROJECT_ID, TEST_LOCATION, TEST_JOB_ID),
+                app_engine_http_target=scheduler_v1.AppEngineHttpTarget(
+                    app_engine_routing=scheduler_v1.AppEngineRouting(
+                        service="service-id"
+                    ),
+                    relative_uri="/log_payload",
+                    http_method=scheduler_v1.HttpMethod.POST,
+                    body=b"Hello World",
+                ),
+                schedule="* * * * *",
+                time_zone="America/Los_Angeles",
+            ),
+        )
+    )
+
+    # Deleting an existant job succeeds
+    delete_job.delete_scheduler_job(TEST_PROJECT_ID, TEST_LOCATION, TEST_JOB_ID)
+
+    # Deleting a non-existant job fails with a not found error
+    with pytest.raises(exceptions.NotFound):
+        delete_job.delete_scheduler_job(TEST_PROJECT_ID, TEST_LOCATION, TEST_JOB_ID)

cloud_scheduler/snippets/job_test.py

@@ -28,6 +28,7 @@ def example_task_handler() -> str:
     print(f"Received job with payload: {payload}")
     return f"Printed job payload: {payload}"
 
+
 # [END cloudscheduler_app]
 
 

scheduler/snippets/main.py renamed to cloud_scheduler/snippets/main.py

@@ -25,7 +25,7 @@
     "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,
+    "enforce_type_hints": True,
     # 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