From e4737ce7307decd39996896de162f31ac1dc585f Mon Sep 17 00:00:00 2001 From: Alex Stephen Date: Wed, 23 Jan 2019 13:44:46 -0800 Subject: [PATCH] New GCP module: gcp_sourcerepo_repository_facts (#51250) --- lib/ansible/module_utils/gcp_utils.py | 8 +- .../google/gcp_sourcerepo_repository_facts.py | 137 ++++++++++++++++++ 2 files changed, 141 insertions(+), 4 deletions(-) create mode 100644 lib/ansible/modules/cloud/google/gcp_sourcerepo_repository_facts.py diff --git a/lib/ansible/module_utils/gcp_utils.py b/lib/ansible/module_utils/gcp_utils.py index 9649468b4ab..46bb2b88637 100644 --- a/lib/ansible/module_utils/gcp_utils.py +++ b/lib/ansible/module_utils/gcp_utils.py @@ -72,7 +72,7 @@ def replace_resource_dict(item, value): return new_item -# Handles all authentation and HTTP sessions for GCP API calls. +# Handles all authentication and HTTP sessions for GCP API calls. class GcpSession(object): def __init__(self, module, product): self.module = module @@ -140,12 +140,12 @@ class GcpSession(object): if self.module.params.get('service_account_email') is not None and self.module.params['auth_kind'] != 'machineaccount': self.module.fail_json( - msg="Service Acccount Email only works with Machine Account-based authentication" + msg="Service Account Email only works with Machine Account-based authentication" ) if self.module.params.get('service_account_file') is not None and self.module.params['auth_kind'] != 'serviceaccount': self.module.fail_json( - msg="Service Acccount File only works with Service Account-based authentication" + msg="Service Account File only works with Service Account-based authentication" ) def _credentials(self): @@ -160,7 +160,7 @@ class GcpSession(object): return google.auth.compute_engine.Credentials( self.module.params['service_account_email']) else: - self.module.fail_json(msg="Credential type '%s' not implmented" % cred_type) + self.module.fail_json(msg="Credential type '%s' not implemented" % cred_type) def _headers(self): return { diff --git a/lib/ansible/modules/cloud/google/gcp_sourcerepo_repository_facts.py b/lib/ansible/modules/cloud/google/gcp_sourcerepo_repository_facts.py new file mode 100644 index 00000000000..cdf028f27e2 --- /dev/null +++ b/lib/ansible/modules/cloud/google/gcp_sourcerepo_repository_facts.py @@ -0,0 +1,137 @@ +#!/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_sourcerepo_repository_facts +description: +- Gather facts for GCP Repository +short_description: Gather facts for GCP Repository +version_added: 2.8 +author: Google Inc. (@googlecloudplatform) +requirements: +- python >= 2.6 +- requests >= 2.18.4 +- google-auth >= 1.3.0 +options: {} +extends_documentation_fragment: gcp +''' + +EXAMPLES = ''' +- name: a repository facts + gcp_sourcerepo_repository_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: + - Resource name of the repository, of the form projects/{{project}}/repos/{{repo}}. + - The repo name may contain slashes. eg, projects/myproject/repos/name/with/slash + . + returned: success + type: str + url: + description: + - URL to clone the repository from Google Cloud Source Repositories. + returned: success + type: str + size: + description: + - The disk usage of the repo, in bytes. + returned: success + type: int +''' + +################################################################################ +# Imports +################################################################################ +from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest +import json + +################################################################################ +# Main +################################################################################ + + +def main(): + module = GcpModule(argument_spec=dict()) + + if not module.params['scopes']: + module.params['scopes'] = ['https://www.googleapis.com/auth/cloud-platform'] + + items = fetch_list(module, collection(module)) + if items.get('repos'): + items = items.get('repos') + else: + items = [] + return_value = {'items': items} + module.exit_json(**return_value) + + +def collection(module): + return "https://sourcerepo.googleapis.com/v1/projects/{project}/repos".format(**module.params) + + +def fetch_list(module, link): + auth = GcpSession(module, 'sourcerepo') + 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()