add python snippets and tests for creating, listing, and deleting queues

tasks/create_queue.py

@@ -0,0 +1,73 @@
+# Copyright 2020 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 __future__ import print_function
+
+import argparse
+
+
+def create_queue(project,
+                 queue_name,
+                 location):
+    # [START cloud_tasks_create_queue]
+    """Create a task queue."""
+
+    from google.cloud import tasks_v2
+
+    # Create a client.
+    client = tasks_v2.CloudTasksClient()
+
+    # Construct the fully qualified location path.
+    parent = client.location_path(project, location)
+
+    # Construct the queue.
+    queue = {
+        'name': client.queue_path(project, location, queue_name)
+    }
+
+    # Use the client to create the queue.
+    response = client.create_queue(parent, queue)
+
+    print('Created queue {}'.format(response.name))
+    return response
+# [END cloud_tasks_create_queue]
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(
+        description=create_queue.__doc__,
+        formatter_class=argparse.RawDescriptionHelpFormatter)
+
+    parser.add_argument(
+        '--project',
+        help='Project to add the queue to.',
+        required=True,
+    )
+
+    parser.add_argument(
+        '--queue',
+        help='ID (short name) of the queue to be created.',
+        required=True,
+    )
+
+    parser.add_argument(
+        '--location',
+        help='Location of the project to add the queue to.',
+        required=True,
+    )
+
+    args = parser.parse_args()
+
+    create_queue(
+        args.project, args.queue, args.location)

tasks/create_queue_test.py

@@ -0,0 +1,31 @@
+# Copyright 2020 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 create_queue
+
+TEST_PROJECT_ID = os.getenv('GOOGLE_CLOUD_PROJECT')
+TEST_LOCATION = os.getenv('TEST_QUEUE_LOCATION', 'us-central1')
+TEST_QUEUE_NAME = os.getenv('TEST_QUEUE_NAME', 'my-queue')
+
+
+def test_create_queue():
+    result = create_queue.create_queue(
+        TEST_PROJECT_ID, TEST_QUEUE_NAME, TEST_LOCATION)
+    assert TEST_QUEUE_NAME in result.name
+
+
+if __name__ == '__main__':
+    test_create_queue()

tasks/delete_queue.py

@@ -0,0 +1,71 @@
+# Copyright 2020 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 __future__ import print_function
+
+import argparse
+
+
+def delete_queue(project,
+                 queue_name,
+                 location):
+    # [START cloud_tasks_delete_queue]
+    """Delete a task queue."""
+
+    from google.cloud import tasks_v2
+    from google.api_core import exceptions
+
+    # Create a client.
+    client = tasks_v2.CloudTasksClient()
+
+    # Get the fully qualified path to queue.
+    queue = client.queue_path(project, location, queue_name)
+
+    # Use the client to delete the queue.
+    try:
+        client.delete_queue(queue)
+        print('Deleted queue')
+    except exceptions.NotFound:
+        print('Queue not found')
+
+# [END cloud_tasks_delete_queue]
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(
+        description=delete_queue.__doc__,
+        formatter_class=argparse.RawDescriptionHelpFormatter)
+
+    parser.add_argument(
+        '--project',
+        help='Project to delete the queue from.',
+        required=True,
+    )
+
+    parser.add_argument(
+        '--queue',
+        help='ID (short name) of the queue to be deleted.',
+        required=True,
+    )
+
+    parser.add_argument(
+        '--location',
+        help='Location of the queue.',
+        required=True,
+    )
+
+    args = parser.parse_args()
+
+    delete_queue(
+        args.project, args.queue, args.location)

tasks/delete_queue_test.py

@@ -0,0 +1,37 @@
+# Copyright 2020 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 sys
+import io
+
+import delete_queue
+
+TEST_PROJECT_ID = os.getenv('GOOGLE_CLOUD_PROJECT')
+TEST_LOCATION = os.getenv('TEST_QUEUE_LOCATION', 'us-central1')
+TEST_QUEUE_NAME = os.getenv('TEST_QUEUE_NAME', 'my-queue')
+
+
+def test_delete_queue():
+    output_capture = io.StringIO()
+    sys.stdout = output_capture
+    delete_queue.delete_queue(
+        TEST_PROJECT_ID, TEST_QUEUE_NAME, TEST_LOCATION)
+    sys.stdout = sys.__stdout__
+    assert(output_capture.getvalue().rstrip()
+           in ['Deleted Queue', 'Queue not found'])
+
+
+if __name__ == '__main__':
+    test_delete_queue()

tasks/list_queues.py

@@ -0,0 +1,67 @@
+# Copyright 2020 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 __future__ import print_function
+
+import argparse
+
+
+def list_queues(project,
+                location):
+    # [START cloud_tasks_list_queues]
+    """List all task queues."""
+
+    from google.cloud import tasks_v2
+
+    # Create a client.
+    client = tasks_v2.CloudTasksClient()
+
+    # Construct the fully qualified location path.
+    parent = client.location_path(project, location)
+
+    # Use the client to obtain the queues.
+    response = client.list_queues(parent)
+
+    # Convert the response to a list containing all queues.
+    queue_list = list(response)
+
+    # Print the results.
+    for queue in queue_list:
+        print(queue.name)
+
+    return response
+# [END cloud_tasks_list_queues]
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(
+        description=list_queues.__doc__,
+        formatter_class=argparse.RawDescriptionHelpFormatter)
+
+    parser.add_argument(
+        '--project',
+        help='Project to list queues for.',
+        required=True,
+    )
+
+    parser.add_argument(
+        '--location',
+        help='Location of the project to list queues for.',
+        required=True,
+    )
+
+    args = parser.parse_args()
+
+    list_queues(
+        args.project, args.location)

tasks/list_queues_test.py

@@ -0,0 +1,30 @@
+# Copyright 2020 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 list_queues
+
+TEST_PROJECT_ID = os.getenv('GOOGLE_CLOUD_PROJECT')
+TEST_LOCATION = os.getenv('TEST_QUEUE_LOCATION', 'us-central1')
+
+
+def test_list_queues():
+    result = list_queues.list_queues(
+        TEST_PROJECT_ID, TEST_LOCATION)
+    assert(result)
+
+
+if __name__ == '__main__':
+    test_list_queues()