From 7ceffb7ba22e224e5a0d5da2ec9ab5e66c365c13 Mon Sep 17 00:00:00 2001
From: Alex Stephen <alexstephen@google.com>
Date: Wed, 23 Jan 2019 13:44:54 -0800
Subject: [PATCH] New GCP module: gcp_sourcerepo_repository (#51249)
---
.../cloud/google/gcp_sourcerepo_repository.py | 222 ++++++++++++++++++
.../targets/gcp_sourcerepo_repository/aliases | 2 +
.../defaults/main.yml | 3 +
.../gcp_sourcerepo_repository/meta/main.yml | 0
.../gcp_sourcerepo_repository/tasks/main.yml | 98 ++++++++
5 files changed, 325 insertions(+)
create mode 100644 lib/ansible/modules/cloud/google/gcp_sourcerepo_repository.py
create mode 100644 test/integration/targets/gcp_sourcerepo_repository/aliases
create mode 100644 test/integration/targets/gcp_sourcerepo_repository/defaults/main.yml
create mode 100644 test/integration/targets/gcp_sourcerepo_repository/meta/main.yml
create mode 100644 test/integration/targets/gcp_sourcerepo_repository/tasks/main.yml
diff --git a/lib/ansible/modules/cloud/google/gcp_sourcerepo_repository.py b/lib/ansible/modules/cloud/google/gcp_sourcerepo_repository.py
new file mode 100644
index 00000000000..43cb36efc1b
--- /dev/null
+++ b/lib/ansible/modules/cloud/google/gcp_sourcerepo_repository.py
@@ -0,0 +1,222 @@
+#!/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
+description:
+- A repository (or repo) is a Git repository storing versioned source content.
+short_description: Creates a GCP Repository
+version_added: 2.8
+author: Google Inc. (@googlecloudplatform)
+requirements:
+- python >= 2.6
+- requests >= 2.18.4
+- google-auth >= 1.3.0
+options:
+ state:
+ description:
+ - Whether the given object should exist in GCP
+ choices:
+ - present
+ - absent
+ default: present
+ 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
+ .
+ required: true
+extends_documentation_fragment: gcp
+notes:
+- 'API Reference: U(https://cloud.google.com/source-repositories/docs/reference/rest/v1/projects.repos)'
+- 'Official Documentation: U(https://cloud.google.com/source-repositories/)'
+'''
+
+EXAMPLES = '''
+- name: create a repository
+ gcp_sourcerepo_repository:
+ name: projects/test_project/repos/test_object
+ project: "test_project"
+ auth_kind: "serviceaccount"
+ service_account_file: "/tmp/auth.pem"
+ state: present
+'''
+
+RETURN = '''
+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, replace_resource_dict
+import json
+
+################################################################################
+# Main
+################################################################################
+
+
+def main():
+ """Main function"""
+
+ module = GcpModule(argument_spec=dict(state=dict(default='present', choices=['present', 'absent'], type='str'), name=dict(required=True, type='str')))
+
+ if not module.params['scopes']:
+ module.params['scopes'] = ['https://www.googleapis.com/auth/cloud-platform']
+
+ state = module.params['state']
+
+ fetch = fetch_resource(module, self_link(module))
+ changed = False
+
+ if fetch:
+ if state == 'present':
+ if is_different(module, fetch):
+ update(module, self_link(module))
+ fetch = fetch_resource(module, self_link(module))
+ changed = True
+ else:
+ delete(module, self_link(module))
+ fetch = {}
+ changed = True
+ else:
+ if state == 'present':
+ fetch = create(module, collection(module))
+ changed = True
+ else:
+ fetch = {}
+
+ fetch.update({'changed': changed})
+
+ module.exit_json(**fetch)
+
+
+def create(module, link):
+ auth = GcpSession(module, 'sourcerepo')
+ return return_if_object(module, auth.post(link, resource_to_request(module)))
+
+
+def update(module, link):
+ module.fail_json(msg="Repository cannot be edited")
+
+
+def delete(module, link):
+ auth = GcpSession(module, 'sourcerepo')
+ return return_if_object(module, auth.delete(link))
+
+
+def resource_to_request(module):
+ request = {u'name': module.params.get('name')}
+ return_vals = {}
+ for k, v in request.items():
+ if v or v is False:
+ return_vals[k] = v
+
+ return return_vals
+
+
+def fetch_resource(module, link, allow_not_found=True):
+ auth = GcpSession(module, 'sourcerepo')
+ return return_if_object(module, auth.get(link), allow_not_found)
+
+
+def self_link(module):
+ return "https://sourcerepo.googleapis.com/v1/{name}".format(**module.params)
+
+
+def collection(module):
+ return "https://sourcerepo.googleapis.com/v1/projects/{project}/repos".format(**module.params)
+
+
+def return_if_object(module, response, allow_not_found=False):
+ # If not found, return nothing.
+ if allow_not_found and 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):
+ module.fail_json(msg="Invalid JSON response with error: %s" % response.text)
+
+ if navigate_hash(result, ['error', 'errors']):
+ module.fail_json(msg=navigate_hash(result, ['error', 'errors']))
+
+ return result
+
+
+def is_different(module, response):
+ request = resource_to_request(module)
+ response = response_to_hash(module, response)
+
+ # Remove all output-only from response.
+ response_vals = {}
+ for k, v in response.items():
+ if k in request:
+ response_vals[k] = v
+
+ request_vals = {}
+ for k, v in request.items():
+ if k in response:
+ request_vals[k] = v
+
+ return GcpRequest(request_vals) != GcpRequest(response_vals)
+
+
+# Remove unnecessary properties from the response.
+# This is for doing comparisons with Ansible's current parameters.
+def response_to_hash(module, response):
+ return {u'name': module.params.get('name'), u'url': response.get(u'url'), u'size': response.get(u'size')}
+
+
+if __name__ == '__main__':
+ main()
diff --git a/test/integration/targets/gcp_sourcerepo_repository/aliases b/test/integration/targets/gcp_sourcerepo_repository/aliases
new file mode 100644
index 00000000000..9812f019ca4
--- /dev/null
+++ b/test/integration/targets/gcp_sourcerepo_repository/aliases
@@ -0,0 +1,2 @@
+cloud/gcp
+unsupported
diff --git a/test/integration/targets/gcp_sourcerepo_repository/defaults/main.yml b/test/integration/targets/gcp_sourcerepo_repository/defaults/main.yml
new file mode 100644
index 00000000000..aa87a2a8e0e
--- /dev/null
+++ b/test/integration/targets/gcp_sourcerepo_repository/defaults/main.yml
@@ -0,0 +1,3 @@
+---
+# defaults file
+resource_name: '{{resource_prefix}}'
diff --git a/test/integration/targets/gcp_sourcerepo_repository/meta/main.yml b/test/integration/targets/gcp_sourcerepo_repository/meta/main.yml
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/test/integration/targets/gcp_sourcerepo_repository/tasks/main.yml b/test/integration/targets/gcp_sourcerepo_repository/tasks/main.yml
new file mode 100644
index 00000000000..bd3048a3c30
--- /dev/null
+++ b/test/integration/targets/gcp_sourcerepo_repository/tasks/main.yml
@@ -0,0 +1,98 @@
+---
+# ----------------------------------------------------------------------------
+#
+# *** 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
+#
+# ----------------------------------------------------------------------------
+# Pre-test setup
+- name: delete a repository
+ gcp_sourcerepo_repository:
+ name: projects/{{ gcp_project }}/repos/{{ resource_name }}
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: absent
+#----------------------------------------------------------
+- name: create a repository
+ gcp_sourcerepo_repository:
+ name: projects/{{ gcp_project }}/repos/{{ resource_name }}
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: present
+ register: result
+- name: assert changed is true
+ assert:
+ that:
+ - result.changed == true
+- name: verify that repository was created
+ gcp_sourcerepo_repository_facts:
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ scopes:
+ - https://www.googleapis.com/auth/cloud-platform
+ register: results
+- name: verify that command succeeded
+ assert:
+ that:
+ - results['items'] | length >= 1
+# ----------------------------------------------------------------------------
+- name: create a repository that already exists
+ gcp_sourcerepo_repository:
+ name: projects/{{ gcp_project }}/repos/{{ resource_name }}
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: present
+ register: result
+- name: assert changed is false
+ assert:
+ that:
+ - result.changed == false
+#----------------------------------------------------------
+- name: delete a repository
+ gcp_sourcerepo_repository:
+ name: projects/{{ gcp_project }}/repos/{{ resource_name }}
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: absent
+ register: result
+- name: assert changed is true
+ assert:
+ that:
+ - result.changed == true
+- name: verify that repository was deleted
+ gcp_sourcerepo_repository_facts:
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ scopes:
+ - https://www.googleapis.com/auth/cloud-platform
+ register: results
+- name: verify that command succeeded
+ assert:
+ that:
+ - results['items'] | length == 0
+# ----------------------------------------------------------------------------
+- name: delete a repository that does not exist
+ gcp_sourcerepo_repository:
+ name: projects/{{ gcp_project }}/repos/{{ resource_name }}
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: absent
+ register: result
+- name: assert changed is false
+ assert:
+ that:
+ - result.changed == false