New GCP module: gcp_resourcemanager_project (#50683)

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

@@ -0,0 +1,378 @@
+#!/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_resourcemanager_project
+description:
+- Represents a GCP Project. A project is a container for ACLs, APIs, App Engine Apps,
+  VMs, and other Google Cloud Platform resources.
+short_description: Creates a GCP Project
+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:
+    - 'The user-assigned display name of the Project. It must be 4 to 30 characters.
+      Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote,
+      double-quote, space, and exclamation point.'
+    required: false
+  labels:
+    description:
+    - The labels associated with this Project.
+    - 'Label keys must be between 1 and 63 characters long and must conform to the
+      following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.'
+    - Label values must be between 0 and 63 characters long and must conform to the
+      regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
+    - No more than 256 labels can be associated with a given resource.
+    - Clients should store labels in a representation such as JSON that does not depend
+      on specific characters being disallowed .
+    required: false
+  parent:
+    description:
+    - A parent organization.
+    required: false
+    suboptions:
+      type:
+        description:
+        - Must be organization.
+        required: false
+      id:
+        description:
+        - Id of the organization.
+        required: false
+  id:
+    description:
+    - The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters,
+      digits, or hyphens. It must start with a letter.
+    - Trailing hyphens are prohibited.
+    required: true
+extends_documentation_fragment: gcp
+'''
+
+EXAMPLES = '''
+- name: create a project
+  gcp_resourcemanager_project:
+      name: My Sample Project
+      id: alextest-{{ 10000000000 | random }}
+      auth_kind: "serviceaccount"
+      service_account_file: "/tmp/auth.pem"
+      parent:
+        type: organization
+        id: 636173955921
+      state: present
+'''
+
+RETURN = '''
+number:
+  description:
+  - Number uniquely identifying the project.
+  returned: success
+  type: int
+lifecycleState:
+  description:
+  - The Project lifecycle state.
+  returned: success
+  type: str
+name:
+  description:
+  - 'The user-assigned display name of the Project. It must be 4 to 30 characters.
+    Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote,
+    double-quote, space, and exclamation point.'
+  returned: success
+  type: str
+createTime:
+  description:
+  - Time of creation.
+  returned: success
+  type: str
+labels:
+  description:
+  - The labels associated with this Project.
+  - 'Label keys must be between 1 and 63 characters long and must conform to the following
+    regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.'
+  - Label values must be between 0 and 63 characters long and must conform to the
+    regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
+  - No more than 256 labels can be associated with a given resource.
+  - Clients should store labels in a representation such as JSON that does not depend
+    on specific characters being disallowed .
+  returned: success
+  type: dict
+parent:
+  description:
+  - A parent organization.
+  returned: success
+  type: complex
+  contains:
+    type:
+      description:
+      - Must be organization.
+      returned: success
+      type: str
+    id:
+      description:
+      - Id of the organization.
+      returned: success
+      type: str
+id:
+  description:
+  - The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters,
+    digits, or hyphens. It must start with a letter.
+  - Trailing hyphens are prohibited.
+  returned: success
+  type: str
+'''
+
+################################################################################
+# Imports
+################################################################################
+
+from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest, remove_nones_from_dict, replace_resource_dict
+import json
+import time
+
+################################################################################
+# Main
+################################################################################
+
+
+def main():
+    """Main function"""
+
+    module = GcpModule(
+        argument_spec=dict(
+            state=dict(default='present', choices=['present', 'absent'], type='str'),
+            name=dict(type='str'),
+            labels=dict(type='dict'),
+            parent=dict(type='dict', options=dict(
+                type=dict(type='str'),
+                id=dict(type='str')
+            )),
+            id=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, 'resourcemanager')
+    return wait_for_operation(module, auth.post(link, resource_to_request(module)))
+
+
+def update(module, link):
+    auth = GcpSession(module, 'resourcemanager')
+    return wait_for_operation(module, auth.put(link, resource_to_request(module)))
+
+
+def delete(module, link):
+    auth = GcpSession(module, 'resourcemanager')
+    return wait_for_operation(module, auth.delete(link))
+
+
+def resource_to_request(module):
+    request = {
+        u'projectId': module.params.get('id'),
+        u'name': module.params.get('name'),
+        u'labels': module.params.get('labels'),
+        u'parent': ProjectParent(module.params.get('parent', {}), module).to_request()
+    }
+    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, 'resourcemanager')
+    return return_if_object(module, auth.get(link), allow_not_found)
+
+
+def self_link(module):
+    return "https://cloudresourcemanager.googleapis.com/v1/projects/{id}".format(**module.params)
+
+
+def collection(module):
+    return "https://cloudresourcemanager.googleapis.com/v1/projects".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
+
+    # SQL only: return on 403 if not exist
+    if allow_not_found and response.status_code == 403:
+        return None
+
+    try:
+        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', 'message']):
+        module.fail_json(msg=navigate_hash(result, ['error', 'message']))
+
+    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'projectNumber': response.get(u'number'),
+        u'lifecycleState': response.get(u'lifecycleState'),
+        u'name': response.get(u'name'),
+        u'createTime': response.get(u'createTime'),
+        u'labels': response.get(u'labels'),
+        u'parent': ProjectParent(response.get(u'parent', {}), module).from_response()
+    }
+
+
+def async_op_url(module, extra_data=None):
+    if extra_data is None:
+        extra_data = {}
+    url = "https://cloudresourcemanager.googleapis.com/v1/{op_id}"
+    combined = extra_data.copy()
+    combined.update(module.params)
+    return url.format(**combined)
+
+
+def wait_for_operation(module, response):
+    op_result = return_if_object(module, response)
+    if op_result is None:
+        return {}
+    status = navigate_hash(op_result, ['done'])
+    wait_done = wait_for_completion(status, op_result, module)
+    return navigate_hash(wait_done, ['response'])
+
+
+def wait_for_completion(status, op_result, module):
+    op_id = navigate_hash(op_result, ['name'])
+    op_uri = async_op_url(module, {'op_id': op_id})
+    if not status:
+        raise_if_errors(op_result, ['error'], 'message')
+        time.sleep(1.0)
+        op_result = fetch_resource(module, op_uri)
+        status = navigate_hash(op_result, ['done'])
+    return op_result
+
+
+def raise_if_errors(response, err_path, module):
+    errors = navigate_hash(response, err_path)
+    if errors is not None:
+        module.fail_json(msg=errors)
+
+
+class ProjectParent(object):
+    def __init__(self, request, module):
+        self.module = module
+        if request:
+            self.request = request
+        else:
+            self.request = {}
+
+    def to_request(self):
+        return remove_nones_from_dict({
+            u'type': self.request.get('type'),
+            u'id': self.request.get('id')
+        })
+
+    def from_response(self):
+        return remove_nones_from_dict({
+            u'type': self.request.get(u'type'),
+            u'id': self.request.get(u'id')
+        })
+
+
+if __name__ == '__main__':
+    main()

test/integration/targets/gcp_resourcemanager_project/aliases

@@ -0,0 +1,2 @@
+cloud/gcp
+unsupported

test/integration/targets/gcp_resourcemanager_project/defaults/main.yml

@@ -0,0 +1,3 @@
+---
+# defaults file
+resource_name: '{{resource_prefix}}'

test/integration/targets/gcp_resourcemanager_project/tasks/main.yml

@@ -0,0 +1,113 @@
+---
+# ----------------------------------------------------------------------------
+#
+#     ***     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 project
+  gcp_resourcemanager_project:
+      name: My Sample Project
+      id: alextest-{{ 10000000000 | random }}
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      parent:
+        type: organization
+        id: 636173955921
+      state: absent
+#----------------------------------------------------------
+- name: create a project
+  gcp_resourcemanager_project:
+      name: My Sample Project
+      id: alextest-{{ 10000000000 | random }}
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      parent:
+        type: organization
+        id: 636173955921
+      state: present
+  register: result
+- name: assert changed is true
+  assert:
+    that:
+      - result.changed == true
+- name: verify that project was created
+  gcp_resourcemanager_project_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 project that already exists
+  gcp_resourcemanager_project:
+      name: My Sample Project
+      id: alextest-{{ 10000000000 | random }}
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      parent:
+        type: organization
+        id: 636173955921
+      state: present
+  register: result
+- name: assert changed is false
+  assert:
+    that:
+      - result.changed == false
+#----------------------------------------------------------
+- name: delete a project
+  gcp_resourcemanager_project:
+      name: My Sample Project
+      id: alextest-{{ 10000000000 | random }}
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      parent:
+        type: organization
+        id: 636173955921
+      state: absent
+  register: result
+- name: assert changed is true
+  assert:
+    that:
+      - result.changed == true
+- name: verify that project was deleted
+  gcp_resourcemanager_project_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 project that does not exist
+  gcp_resourcemanager_project:
+      name: My Sample Project
+      id: alextest-{{ 10000000000 | random }}
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      parent:
+        type: organization
+        id: 636173955921
+      state: absent
+  register: result
+- name: assert changed is false
+  assert:
+    that:
+      - result.changed == false