New GCP Module: gcp_pubsub_topic_facts (#46923)

lib/ansible/module_utils/gcp_utils.py

@@ -152,7 +152,10 @@ class GcpModule(AnsibleModule):
         kwargs['argument_spec'] = self._merge_dictionaries(
             arg_spec,
             dict(
-                project=dict(required=True, type='str'),
+                project=dict(
+                    required=True,
+                    type='str',
+                    fallback=(env_fallback, ['GCP_PROJECT'])),
                 auth_kind=dict(
                     required=False,
                     fallback=(env_fallback, ['GCP_AUTH_KIND']),

lib/ansible/modules/cloud/google/gcp_pubsub_topic_facts.py

@@ -0,0 +1,130 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2017 Google
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+# ----------------------------------------------------------------------------
+#
+#     ***     AUTO GENERATED CODE    ***    AUTO GENERATED CODE     ***
+#
+# ----------------------------------------------------------------------------
+#
+#     This file is automatically generated by Magic Modules and manual
+#     changes will be clobbered when the file is regenerated.
+#
+#     Please read more about how to change this file at
+#     https://www.github.com/GoogleCloudPlatform/magic-modules
+#
+# ----------------------------------------------------------------------------
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+################################################################################
+# Documentation
+################################################################################
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ["preview"],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: gcp_pubsub_topic_facts
+description:
+  - Gather facts for GCP Topic
+short_description: Gather facts for GCP Topic
+version_added: 2.8
+author: Google Inc. (@googlecloudplatform)
+requirements:
+    - python >= 2.6
+    - requests >= 2.18.4
+    - google-auth >= 1.3.0
+extends_documentation_fragment: gcp
+'''
+
+EXAMPLES = '''
+- name:  a topic facts
+  gcp_pubsub_topic_facts:
+      project: test_project
+      auth_kind: serviceaccount
+      service_account_file: "/tmp/auth.pem"
+'''
+
+RETURN = '''
+items:
+    description: List of items
+    returned: always
+    type: complex
+    contains:
+        name:
+            description:
+                - Name of the topic.
+            returned: success
+            type: str
+'''
+
+################################################################################
+# Imports
+################################################################################
+from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest
+import json
+
+################################################################################
+# Main
+################################################################################
+
+
+def main():
+    module = GcpModule(
+        argument_spec=dict(
+        )
+    )
+
+    if 'scopes' not in module.params:
+        module.params['scopes'] = ['https://www.googleapis.com/auth/pubsub']
+
+    items = fetch_list(module, collection(module))
+    if items.get('topics'):
+        items = items.get('topics')
+    else:
+        items = []
+    return_value = {
+        'items': items
+    }
+    module.exit_json(**return_value)
+
+
+def collection(module):
+    return "https://pubsub.googleapis.com/v1/projects/{project}/topics".format(**module.params)
+
+
+def fetch_list(module, link):
+    auth = GcpSession(module, 'pubsub')
+    response = auth.get(link)
+    return return_if_object(module, response)
+
+
+def return_if_object(module, response):
+    # If not found, return nothing.
+    if response.status_code == 404:
+        return None
+
+    # If no content, return nothing.
+    if response.status_code == 204:
+        return None
+
+    try:
+        module.raise_for_status(response)
+        result = response.json()
+    except getattr(json.decoder, 'JSONDecodeError', ValueError) as inst:
+        module.fail_json(msg="Invalid JSON response with error: %s" % inst)
+
+    if navigate_hash(result, ['error', 'errors']):
+        module.fail_json(msg=navigate_hash(result, ['error', 'errors']))
+
+    return result
+
+
+if __name__ == "__main__":
+    main()