Add hcloud_location_facts module (#53848)

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

@@ -0,0 +1,156 @@
+#!/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_location_facts
+
+short_description: Gather facts about your Hetzner Cloud locations.
+
+version_added: "2.8"
+
+description:
+    - Gather facts about your Hetzner Cloud locations.
+
+author:
+    - Lukas Kaemmerling (@lkaemmerling)
+
+options:
+    id:
+        description:
+            - The ID of the location you want to get.
+        type: int
+    name:
+        description:
+            - The name of the location you want to get.
+        type: str
+extends_documentation_fragment: hcloud
+"""
+
+EXAMPLES = """
+- name: Gather hcloud location facts
+  local_action:
+    module: hcloud_location_facts
+
+- name: Print the gathered facts
+  debug:
+    var: ansible_facts.hcloud_location_facts
+"""
+
+RETURN = """
+hcloud_location_facts:
+    description: The location facts as list
+    returned: always
+    type: complex
+    contains:
+        id:
+            description: Numeric identifier of the location
+            returned: always
+            type: int
+            sample: 1937415
+        name:
+            description: Name of the location
+            returned: always
+            type: str
+            sample: fsn1
+        description:
+            description: Detail description of the location
+            returned: always
+            type: str
+            sample: Falkenstein DC Park 1
+        country:
+            description: Country code of the location
+            returned: always
+            type: str
+            sample: DE
+        city:
+            description: City of the location
+            returned: always
+            type: str
+            sample: Falkenstein
+"""
+
+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 AnsibleHcloudLocationFacts(Hcloud):
+    def __init__(self, module):
+        Hcloud.__init__(self, module, "hcloud_location_facts")
+        self.hcloud_location_facts = None
+
+    def _prepare_result(self):
+        tmp = []
+
+        for location in self.hcloud_location_facts:
+            if location is not None:
+                tmp.append({
+                    "id": to_native(location.id),
+                    "name": to_native(location.name),
+                    "description": to_native(location.description),
+                    "city": to_native(location.city),
+                    "country": to_native(location.country)
+                })
+        return tmp
+
+    def get_locations(self):
+        try:
+            if self.module.params.get("id") is not None:
+                self.hcloud_location_facts = [self.client.locations.get_by_id(
+                    self.module.params.get("id")
+                )]
+            elif self.module.params.get("name") is not None:
+                self.hcloud_location_facts = [self.client.locations.get_by_name(
+                    self.module.params.get("name")
+                )]
+            else:
+                self.hcloud_location_facts = self.client.locations.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"},
+                **Hcloud.base_module_arguments()
+            ),
+            supports_check_mode=True,
+        )
+
+
+def main():
+    module = AnsibleHcloudLocationFacts.define_module()
+
+    hcloud = AnsibleHcloudLocationFacts(module)
+    hcloud.get_locations()
+    result = hcloud.get_result()
+    ansible_facts = {
+        'hcloud_location_facts': result['hcloud_location_facts']
+    }
+    module.exit_json(ansible_facts=ansible_facts)
+
+
+if __name__ == "__main__":
+    main()

test/integration/targets/hcloud_location_facts/aliases

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

test/integration/targets/hcloud_location_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_location_name: "fsn1"
+hcloud_location_id: 1

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

@@ -0,0 +1,52 @@
+# 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: test gather hcloud location facts
+  hcloud_location_facts:
+
+- name: verify test gather hcloud location facts
+  assert:
+    that:
+      - ansible_facts.hcloud_location_facts| list | count == 3
+
+- name: test gather hcloud location facts in check mode
+  hcloud_location_facts:
+  check_mode: yes
+
+- name: verify test gather hcloud location facts in check mode
+  assert:
+    that:
+      - ansible_facts.hcloud_location_facts| list | count == 3
+
+
+- name: test gather hcloud location facts with correct name
+  hcloud_location_facts:
+    name: "{{hcloud_location_name}}"
+- name: verify test gather hcloud location with correct name
+  assert:
+    that:
+      - ansible_facts.hcloud_location_facts|selectattr('name','equalto','{{ hcloud_location_name }}') | list | count == 1
+
+- name: test gather hcloud location facts with wrong name
+  hcloud_location_facts:
+      name: "{{hcloud_location_name}}1"
+- name: verify test gather hcloud location with wrong name
+  assert:
+    that:
+      - ansible_facts.hcloud_location_facts | list | count == 0
+
+- name: test gather hcloud location facts with correct id
+  hcloud_location_facts:
+    id: "{{hcloud_location_id}}"
+- name: verify test gather hcloud location with correct id
+  assert:
+    that:
+      - ansible_facts.hcloud_location_facts|selectattr('name','equalto','{{ hcloud_location_name }}') | list | count == 1
+
+- name: test gather hcloud location facts with wrong id
+  hcloud_location_facts:
+      name: "4711"
+- name: verify test gather hcloud location with wrong id
+  assert:
+    that:
+      - ansible_facts.hcloud_location_facts | list | count == 0