Add hcloud_volume_facts (#54666)

* Add hcloud_volume_facts

* Fix server name

lib/ansible/modules/cloud/hcloud/hcloud_volume_facts.py

@@ -0,0 +1,172 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2019, Hetzner Cloud GmbH <info@hetzner-cloud.de>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+ANSIBLE_METADATA = {
+    "metadata_version": "1.1",
+    "status": ["preview"],
+    "supported_by": "community",
+}
+
+DOCUMENTATION = """
+---
+module: hcloud_volume_facts
+
+short_description: Gather facts about your Hetzner Cloud volumes.
+
+version_added: "2.8"
+description:
+    - Gather facts about your Hetzner Cloud volumes.
+
+author:
+    - Lukas Kaemmerling (@lkaemmerling)
+
+options:
+    id:
+        description:
+            - The ID of the volume you want to get.
+        type: int
+    name:
+        description:
+            - The name of the volume you want to get.
+        type: str
+    label_selector:
+        description:
+            - The label selector for the volume you want to get.
+        type: str
+extends_documentation_fragment: hcloud
+"""
+
+EXAMPLES = """
+- name: Gather hcloud volume facts
+  local_action:
+    module: hcloud_volume_facts
+- name: Print the gathered facts
+  debug:
+    var: ansible_facts.hcloud_volume_facts
+"""
+
+RETURN = """
+hcloud_volume_facts:
+    description: The volume facts as list
+    returned: always
+    type: complex
+    contains:
+        id:
+            description: Numeric identifier of the volume
+            returned: always
+            type: int
+            sample: 1937415
+        name:
+            description: Name of the volume
+            returned: always
+            type: str
+            sample: my-volume
+        size:
+            description: Size of the volume
+            returned: always
+            type: str
+            sample: 10
+        location:
+            description: Name of the location where the volume resides in
+            returned: always
+            type: str
+            sample: fsn1
+        server:
+            description: Name of the server where the volume is attached to
+            returned: always
+            type: str
+            sample: my-server
+        labels:
+            description: User-defined labels (key-value pairs)
+            returned: always
+            type: dict
+"""
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils._text import to_native
+from ansible.module_utils.hcloud import Hcloud
+
+try:
+    from hcloud import APIException
+except ImportError:
+    pass
+
+
+class AnsibleHcloudVolumeFacts(Hcloud):
+    def __init__(self, module):
+        Hcloud.__init__(self, module, "hcloud_volume_facts")
+        self.hcloud_volume_facts = None
+
+    def _prepare_result(self):
+        tmp = []
+
+        for volume in self.hcloud_volume_facts:
+            if volume is not None:
+                server_name = None
+                if volume.server is not None:
+                    server_name = volume.server.name
+                tmp.append({
+                    "id": to_native(volume.id),
+                    "name": to_native(volume.name),
+                    "size": volume.size,
+                    "location": to_native(volume.location.name),
+                    "labels": volume.labels,
+                    "server": to_native(server_name),
+                })
+
+        return tmp
+
+    def get_volumes(self):
+        try:
+            if self.module.params.get("id") is not None:
+                self.hcloud_volume_facts = [self.client.volumes.get_by_id(
+                    self.module.params.get("id")
+                )]
+            elif self.module.params.get("name") is not None:
+                self.hcloud_volume_facts = [self.client.volumes.get_by_name(
+                    self.module.params.get("name")
+                )]
+            elif self.module.params.get("label_selector") is not None:
+                self.hcloud_volume_facts = self.client.servers.get_all(
+                    label_selector=self.module.params.get("label_selector"))
+            else:
+                self.hcloud_volume_facts = self.client.volumes.get_all()
+
+        except APIException as e:
+            self.module.fail_json(msg=e.message)
+
+    @staticmethod
+    def define_module():
+        return AnsibleModule(
+            argument_spec=dict(
+                id={"type": "int"},
+                name={"type": "str"},
+                label_selector={"type": "str"},
+                **Hcloud.base_module_arguments()
+            ),
+            supports_check_mode=True,
+        )
+
+
+def main():
+    module = AnsibleHcloudVolumeFacts.define_module()
+
+    hcloud = AnsibleHcloudVolumeFacts(module)
+
+    hcloud.get_volumes()
+    result = hcloud.get_result()
+    ansible_facts = {
+        'hcloud_volume_facts': result['hcloud_volume_facts']
+    }
+    module.exit_json(ansible_facts=ansible_facts)
+
+
+if __name__ == "__main__":
+    main()

test/integration/targets/hcloud_volume_facts/aliases

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

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

@@ -0,0 +1,5 @@
+# Copyright: (c) 2019, Hetzner Cloud GmbH <info@hetzner-cloud.de>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+---
+hcloud_prefix: "tests"
+hcloud_volume_name: "{{hcloud_prefix}}-integ"

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

@@ -0,0 +1,95 @@
+# Copyright: (c) 2019, Hetzner Cloud GmbH <info@hetzner-cloud.de>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+---
+- name: setup ensure volume is absent
+  hcloud_volume:
+    name: "{{ hcloud_volume_name }}"
+    state: absent
+  register: result
+
+- name: test gather hcloud volume facts - empty resources
+  hcloud_volume_facts:
+- name: verify test gather hcloud volume facts - empty resources
+  assert:
+    that:
+      - ansible_facts.hcloud_volume_facts | count == 0
+
+- name: setup volume
+  hcloud_volume:
+    name: "{{hcloud_volume_name}}"
+    size: 10
+    location: "fsn1"
+    labels:
+      key: value
+  register: main_volume
+- name: verify setup volume
+  assert:
+    that:
+      - main_volume is changed
+
+- name: test gather hcloud volume facts in check mode
+  hcloud_volume_facts:
+  check_mode: yes
+
+- name: verify test gather hcloud volume facts in check mode
+  assert:
+    that:
+      - ansible_facts.hcloud_volume_facts|selectattr('name','equalto','{{ hcloud_volume_name }}') | list | count == 1
+
+- name: test gather hcloud volume facts with correct label selector
+  hcloud_volume_facts:
+    label_selector: "key=value"
+- name: verify test gather hcloud volume with correct label selector
+  assert:
+    that:
+      - ansible_facts.hcloud_volume_facts|selectattr('name','equalto','{{ hcloud_volume_name }}') | list | count == 1
+
+- name: test gather hcloud volume facts with wrong label selector
+  hcloud_volume_facts:
+    label_selector: "key!=value"
+- name: verify test gather hcloud volume with wrong label selector
+  assert:
+    that:
+      - ansible_facts.hcloud_volume_facts | list | count == 0
+
+- name: test gather hcloud volume facts with correct name
+  hcloud_volume_facts:
+    name: "{{hcloud_volume_name}}"
+- name: verify test gather hcloud volume with correct name
+  assert:
+    that:
+      - ansible_facts.hcloud_volume_facts|selectattr('name','equalto','{{ hcloud_volume_name }}') | list | count == 1
+
+- name: test gather hcloud volume facts with wrong name
+  hcloud_volume_facts:
+      name: "{{hcloud_volume_name}}1"
+- name: verify test gather hcloud volume with wrong name
+  assert:
+    that:
+      - ansible_facts.hcloud_volume_facts | list | count == 0
+
+- name: test gather hcloud volume facts with correct id
+  hcloud_volume_facts:
+    id: "{{main_volume.hcloud_volume.id}}"
+- name: verify test gather hcloud volume with correct id
+  assert:
+    that:
+      - ansible_facts.hcloud_volume_facts|selectattr('name','equalto','{{ hcloud_volume_name }}') | list | count == 1
+
+- name: test gather hcloud volume facts with wrong id
+  hcloud_volume_facts:
+      name: "4711"
+- name: verify test gather hcloud volume with wrong id
+  assert:
+    that:
+      - ansible_facts.hcloud_volume_facts | list | count == 0
+
+- name: cleanup
+  hcloud_volume:
+    name: "{{ hcloud_volume_name }}"
+    state: absent
+  register: result
+- name: verify cleanup
+  assert:
+    that:
+    - result is success