Ansible IAM Role (#195)

Signed-off-by: Modular Magician <magic-modules@google.com>

plugins/module_utils/gcp_utils.py

@@ -280,22 +280,13 @@ class GcpRequest(object):
         # Have to convert each thing over to unicode.
         # Python doesn't handle equality checks between unicode + non-unicode well.
         difference = []
-        new_req_list = self._convert_value(req_list)
-        new_resp_list = self._convert_value(resp_list)
-
-        # We have to compare each thing in the request to every other thing
-        # in the response.
-        # This is because the request value will be a subset of the response value.
-        # The assumption is that these lists will be small enough that it won't
-        # be a performance burden.
-        for req_item in new_req_list:
-            found_item = False
-            for resp_item in new_resp_list:
-                # Looking for a None value here.
-                if not self._compare_value(req_item, resp_item):
-                    found_item = True
-            if not found_item:
-                difference.append(req_item)
+        list1.sort()
+        list2.sort()
+        for index in range(len(list1)):
+            value1 = list1[index]
+            if index < len(list2):
+                value2 = list2[index]
+                difference.append(self._compare_value(value1, value2))
 
         difference2 = []
         for value in difference:

plugins/modules/gcp_cloudbuild_trigger_facts.py

@@ -0,0 +1,271 @@
+#!/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_cloudbuild_trigger_facts
+description:
+- Gather facts for GCP Trigger
+short_description: Gather facts for GCP Trigger
+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 trigger facts
+  gcp_cloudbuild_trigger_facts:
+      project: test_project
+      auth_kind: serviceaccount
+      service_account_file: "/tmp/auth.pem"
+'''
+
+RETURN = '''
+items:
+  description: List of items
+  returned: always
+  type: complex
+  contains:
+    id:
+      description:
+      - The unique identifier for the trigger.
+      returned: success
+      type: str
+    description:
+      description:
+      - Human-readable description of the trigger.
+      returned: success
+      type: str
+    disabled:
+      description:
+      - Whether the trigger is disabled or not. If true, the trigger will never result
+        in a build.
+      returned: success
+      type: str
+    createTime:
+      description:
+      - Time when the trigger was created.
+      returned: success
+      type: str
+    substitutions:
+      description:
+      - Substitutions data for Build resource.
+      returned: success
+      type: dict
+    filename:
+      description:
+      - Path, from the source root, to a file whose contents is used for the template.
+      returned: success
+      type: str
+    ignoredFiles:
+      description:
+      - ignoredFiles and includedFiles are file glob matches using http://godoc/pkg/path/filepath#Match
+        extended with support for `**`.
+      - If ignoredFiles and changed files are both empty, then they are not used to
+        determine whether or not to trigger a build.
+      - If ignoredFiles is not empty, then we ignore any files that match any of the
+        ignored_file globs. If the change has no files that are outside of the ignoredFiles
+        globs, then we do not trigger a build.
+      returned: success
+      type: list
+    includedFiles:
+      description:
+      - ignoredFiles and includedFiles are file glob matches using http://godoc/pkg/path/filepath#Match
+        extended with support for `**`.
+      - If any of the files altered in the commit pass the ignoredFiles filter and
+        includedFiles is empty, then as far as this filter is concerned, we should
+        trigger the build.
+      - If any of the files altered in the commit pass the ignoredFiles filter and
+        includedFiles is not empty, then we make sure that at least one of those files
+        matches a includedFiles glob. If not, then we do not trigger a build.
+      returned: success
+      type: list
+    triggerTemplate:
+      description:
+      - Template describing the types of source changes to trigger a build.
+      - Branch and tag names in trigger templates are interpreted as regular expressions.
+        Any branch or tag change that matches that regular expression will trigger
+        a build.
+      returned: success
+      type: complex
+      contains:
+        projectId:
+          description:
+          - ID of the project that owns the Cloud Source Repository. If omitted, the
+            project ID requesting the build is assumed.
+          returned: success
+          type: str
+        repoName:
+          description:
+          - Name of the Cloud Source Repository. If omitted, the name "default" is
+            assumed.
+          returned: success
+          type: str
+        dir:
+          description:
+          - Directory, relative to the source root, in which to run the build.
+          - This must be a relative path. If a step's dir is specified and is an absolute
+            path, this value is ignored for that step's execution.
+          returned: success
+          type: str
+        branchName:
+          description:
+          - Name of the branch to build.
+          returned: success
+          type: str
+        tagName:
+          description:
+          - Name of the tag to build.
+          returned: success
+          type: str
+        commitSha:
+          description:
+          - Explicit commit SHA to build.
+          returned: success
+          type: str
+    build:
+      description:
+      - Contents of the build template.
+      returned: success
+      type: complex
+      contains:
+        tags:
+          description:
+          - Tags for annotation of a Build. These are not docker tags.
+          returned: success
+          type: list
+        images:
+          description:
+          - A list of images to be pushed upon the successful completion of all build
+            steps.
+          - The images are pushed using the builder service account's credentials.
+          - The digests of the pushed images will be stored in the Build resource's
+            results field.
+          - If any of the images fail to be pushed, the build status is marked FAILURE.
+          returned: success
+          type: list
+        steps:
+          description:
+          - The operations to be performed on the workspace.
+          returned: success
+          type: complex
+          contains:
+            name:
+              description:
+              - The name of the container image that will run this particular build
+                step.
+              - If the image is available in the host's Docker daemon's cache, it
+                will be run directly. If not, the host will attempt to pull the image
+                first, using the builder service account's credentials if necessary.
+              - The Docker daemon's cache will already have the latest versions of
+                all of the officially supported build steps (U(https://github.com/GoogleCloudPlatform/cloud-builders).)
+              - The Docker daemon will also have cached many of the layers for some
+                popular images, like "ubuntu", "debian", but they will be refreshed
+                at the time you attempt to use them.
+              - If you built an image in a previous build step, it will be stored
+                in the host's Docker daemon's cache and is available to use as the
+                name for a later build step.
+              returned: success
+              type: str
+            args:
+              description:
+              - A list of arguments that will be presented to the step when it is
+                started.
+              - If the image used to run the step's container has an entrypoint, the
+                args are used as arguments to that entrypoint. If the image does not
+                define an entrypoint, the first element in args is used as the entrypoint,
+                and the remainder will be used as arguments.
+              returned: success
+              type: list
+'''
+
+################################################################################
+# 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('triggers'):
+        items = items.get('triggers')
+    else:
+        items = []
+    return_value = {'items': items}
+    module.exit_json(**return_value)
+
+
+def collection(module):
+    return "https://cloudbuild.googleapis.com/v1/projects/{project}/triggers".format(**module.params)
+
+
+def fetch_list(module, link):
+    auth = GcpSession(module, 'cloudbuild')
+    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()

plugins/modules/gcp_iam_role.py

@@ -81,17 +81,17 @@ extends_documentation_fragment: gcp
 EXAMPLES = '''
 - name: create a role
   gcp_iam_role:
-    name: myCustomRole2
-    title: My Custom Role
-    description: My custom role description
-    included_permissions:
-    - iam.roles.list
-    - iam.roles.create
-    - iam.roles.delete
-    project: test_project
-    auth_kind: serviceaccount
-    service_account_file: "/tmp/auth.pem"
-    state: present
+      name: myCustomRole2
+      title: My Custom Role
+      description: My custom role description
+      included_permissions:
+      - iam.roles.list
+      - iam.roles.create
+      - iam.roles.delete
+      project: "test_project"
+      auth_kind: "serviceaccount"
+      service_account_file: "/tmp/auth.pem"
+      state: present
 '''
 
 RETURN = '''

plugins/modules/gcp_iam_role_facts.py

@@ -0,0 +1,151 @@
+#!/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_iam_role_facts
+description:
+- Gather facts for GCP Role
+short_description: Gather facts for GCP Role
+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 role facts
+  gcp_iam_role_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:
+      - The name of the role.
+      returned: success
+      type: str
+    title:
+      description:
+      - A human-readable title for the role. Typically this is limited to 100 UTF-8
+        bytes.
+      returned: success
+      type: str
+    description:
+      description:
+      - Human-readable description for the role.
+      returned: success
+      type: str
+    includedPermissions:
+      description:
+      - Names of permissions this role grants when bound in an IAM policy.
+      returned: success
+      type: list
+    stage:
+      description:
+      - The current launch stage of the role.
+      returned: success
+      type: str
+    deleted:
+      description:
+      - The current deleted state of the role.
+      returned: success
+      type: bool
+'''
+
+################################################################################
+# 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/iam']
+
+    items = fetch_list(module, collection(module))
+    if items.get('roles'):
+        items = items.get('roles')
+    else:
+        items = []
+    return_value = {'items': items}
+    module.exit_json(**return_value)
+
+
+def collection(module):
+    return "https://iam.googleapis.com/v1/projects/{project}/roles".format(**module.params)
+
+
+def fetch_list(module, link):
+    auth = GcpSession(module, 'iam')
+    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()

tests/integration/gcp_iam_role/defaults/main.yml

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

tests/integration/gcp_iam_role/tasks/main.yml

@@ -15,31 +15,31 @@
 # Pre-test setup
 - name: delete a role
   gcp_iam_role:
-    name: myCustomRole2
-    title: My Custom Role
-    description: My custom role description
-    included_permissions:
-    - iam.roles.list
-    - iam.roles.create
-    - iam.roles.delete
-    project: "{{ gcp_project }}"
-    auth_kind: "{{ gcp_cred_kind }}"
-    service_account_file: "{{ gcp_cred_file }}"
-    state: absent
+      name: myCustomRole2
+      title: My Custom Role
+      description: My custom role description
+      included_permissions:
+      - iam.roles.list
+      - iam.roles.create
+      - iam.roles.delete
+      project: "{{ gcp_project }}"
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      state: absent
 #----------------------------------------------------------
 - name: create a role
   gcp_iam_role:
-    name: myCustomRole2
-    title: My Custom Role
-    description: My custom role description
-    included_permissions:
-    - iam.roles.list
-    - iam.roles.create
-    - iam.roles.delete
-    project: "{{ gcp_project }}"
-    auth_kind: "{{ gcp_cred_kind }}"
-    service_account_file: "{{ gcp_cred_file }}"
-    state: present
+      name: myCustomRole2
+      title: My Custom Role
+      description: My custom role description
+      included_permissions:
+      - iam.roles.list
+      - iam.roles.create
+      - iam.roles.delete
+      project: "{{ gcp_project }}"
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      state: present
   register: result
 - name: assert changed is true
   assert:
@@ -60,17 +60,17 @@
 # ----------------------------------------------------------------------------
 - name: create a role that already exists
   gcp_iam_role:
-    name: myCustomRole2
-    title: My Custom Role
-    description: My custom role description
-    included_permissions:
-    - iam.roles.list
-    - iam.roles.create
-    - iam.roles.delete
-    project: "{{ gcp_project }}"
-    auth_kind: "{{ gcp_cred_kind }}"
-    service_account_file: "{{ gcp_cred_file }}"
-    state: present
+      name: myCustomRole2
+      title: My Custom Role
+      description: My custom role description
+      included_permissions:
+      - iam.roles.list
+      - iam.roles.create
+      - iam.roles.delete
+      project: "{{ gcp_project }}"
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      state: present
   register: result
 - name: assert changed is false
   assert:
@@ -79,17 +79,17 @@
 #----------------------------------------------------------
 - name: delete a role
   gcp_iam_role:
-    name: myCustomRole2
-    title: My Custom Role
-    description: My custom role description
-    included_permissions:
-    - iam.roles.list
-    - iam.roles.create
-    - iam.roles.delete
-    project: "{{ gcp_project }}"
-    auth_kind: "{{ gcp_cred_kind }}"
-    service_account_file: "{{ gcp_cred_file }}"
-    state: absent
+      name: myCustomRole2
+      title: My Custom Role
+      description: My custom role description
+      included_permissions:
+      - iam.roles.list
+      - iam.roles.create
+      - iam.roles.delete
+      project: "{{ gcp_project }}"
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      state: absent
   register: result
 - name: assert changed is true
   assert:
@@ -110,17 +110,17 @@
 # ----------------------------------------------------------------------------
 - name: delete a role that does not exist
   gcp_iam_role:
-    name: myCustomRole2
-    title: My Custom Role
-    description: My custom role description
-    included_permissions:
-    - iam.roles.list
-    - iam.roles.create
-    - iam.roles.delete
-    project: "{{ gcp_project }}"
-    auth_kind: "{{ gcp_cred_kind }}"
-    service_account_file: "{{ gcp_cred_file }}"
-    state: absent
+      name: myCustomRole2
+      title: My Custom Role
+      description: My custom role description
+      included_permissions:
+      - iam.roles.list
+      - iam.roles.create
+      - iam.roles.delete
+      project: "{{ gcp_project }}"
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      state: absent
   register: result
 - name: assert changed is false
   assert: