From 87554da4d670d58f3a0668c2bfc45c09cf1d5f59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20K=C3=A4mmerling?= <4281581+LKaemmerling@users.noreply.github.com> Date: Wed, 27 Mar 2019 11:52:04 +0100 Subject: [PATCH] Add hcloud_datacenter_facts module (#53851) --- .../cloud/hcloud/hcloud_datacenter_facts.py | 155 ++++++++++++++++++ .../targets/hcloud_datacenter_facts/aliases | 2 + .../hcloud_datacenter_facts/defaults/main.yml | 6 + .../hcloud_datacenter_facts/tasks/main.yml | 36 ++++ 4 files changed, 199 insertions(+) create mode 100644 lib/ansible/modules/cloud/hcloud/hcloud_datacenter_facts.py create mode 100644 test/integration/targets/hcloud_datacenter_facts/aliases create mode 100644 test/integration/targets/hcloud_datacenter_facts/defaults/main.yml create mode 100644 test/integration/targets/hcloud_datacenter_facts/tasks/main.yml diff --git a/lib/ansible/modules/cloud/hcloud/hcloud_datacenter_facts.py b/lib/ansible/modules/cloud/hcloud/hcloud_datacenter_facts.py new file mode 100644 index 00000000000..34ccb605e55 --- /dev/null +++ b/lib/ansible/modules/cloud/hcloud/hcloud_datacenter_facts.py @@ -0,0 +1,155 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# Copyright: (c) 2019, Hetzner Cloud GmbH +# 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_datacenter_facts + +short_description: Gather facts about the Hetzner Cloud datacenters. + +version_added: "2.8" +description: + - Gather facts about your Hetzner Cloud datacenters. + +author: + - Lukas Kaemmerling (@lkaemmerling) + +options: + id: + description: + - The ID of the datacenter you want to get. + type: int + name: + description: + - The name of the datacenter you want to get. + type: str +extends_documentation_fragment: hcloud +""" + +EXAMPLES = """ +- name: Gather hcloud datacenter facts + local_action: + module: hcloud_datacenter_facts +- name: Print the gathered facts + debug: + var: ansible_facts.hcloud_datacenter_facts +""" + +RETURN = """ +hcloud_datacenter_facts: + description: The datacenter 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-dc8 + description: + description: Detail description of the location + returned: always + type: str + sample: Falkenstein DC 8 + location: + description: Name of the location where the datacenter resides in + returned: always + type: str + sample: fsn1 + city: + description: City of the location + returned: always + type: str + sample: fsn1 +""" + +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 AnsibleHcloudDatacenterFacts(Hcloud): + def __init__(self, module): + Hcloud.__init__(self, module, "hcloud_datacenter_facts") + self.hcloud_datacenter_facts = None + + def _prepare_result(self): + tmp = [] + + for datacenter in self.hcloud_datacenter_facts: + if datacenter is not None: + tmp.append({ + "id": to_native(datacenter.id), + "name": to_native(datacenter.name), + "description": to_native(datacenter.description), + "location": to_native(datacenter.location.name) + }) + + return tmp + + def get_datacenters(self): + try: + if self.module.params.get("id") is not None: + self.hcloud_datacenter_facts = [self.client.datacenters.get_by_id( + self.module.params.get("id") + )] + elif self.module.params.get("name") is not None: + self.hcloud_datacenter_facts = [self.client.datacenters.get_by_name( + self.module.params.get("name") + )] + else: + self.hcloud_datacenter_facts = self.client.datacenters.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 = AnsibleHcloudDatacenterFacts.define_module() + + hcloud = AnsibleHcloudDatacenterFacts(module) + + hcloud.get_datacenters() + result = hcloud.get_result() + ansible_facts = { + 'hcloud_datacenter_facts': result['hcloud_datacenter_facts'] + } + module.exit_json(ansible_facts=ansible_facts) + + +if __name__ == "__main__": + main() diff --git a/test/integration/targets/hcloud_datacenter_facts/aliases b/test/integration/targets/hcloud_datacenter_facts/aliases new file mode 100644 index 00000000000..51742ee23f7 --- /dev/null +++ b/test/integration/targets/hcloud_datacenter_facts/aliases @@ -0,0 +1,2 @@ +cloud/hcloud +unsupported diff --git a/test/integration/targets/hcloud_datacenter_facts/defaults/main.yml b/test/integration/targets/hcloud_datacenter_facts/defaults/main.yml new file mode 100644 index 00000000000..b9e045f4074 --- /dev/null +++ b/test/integration/targets/hcloud_datacenter_facts/defaults/main.yml @@ -0,0 +1,6 @@ +# Copyright: (c) 2019, Hetzner Cloud GmbH +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +hcloud_datacenter_name: "fsn1-dc14" +hcloud_datacenter_id: 4 +hcloud_location_name: "fsn1" diff --git a/test/integration/targets/hcloud_datacenter_facts/tasks/main.yml b/test/integration/targets/hcloud_datacenter_facts/tasks/main.yml new file mode 100644 index 00000000000..09723be49c0 --- /dev/null +++ b/test/integration/targets/hcloud_datacenter_facts/tasks/main.yml @@ -0,0 +1,36 @@ +# Copyright: (c) 2019, Hetzner Cloud GmbH +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: test gather hcloud datacenter facts + hcloud_datacenter_facts: + +- name: verify test gather hcloud datacenter facts + assert: + that: + - ansible_facts.hcloud_datacenter_facts| list | count == 3 + +- name: test gather hcloud datacenter facts in check mode + hcloud_datacenter_facts: + check_mode: yes + +- name: verify test gather hcloud datacenter facts in check mode + assert: + that: + - ansible_facts.hcloud_datacenter_facts| list | count == 3 + + +- name: test gather hcloud datacenter facts with correct name + hcloud_datacenter_facts: + name: "{{hcloud_datacenter_name}}" +- name: verify test gather hcloud datacenter with correct name + assert: + that: + - ansible_facts.hcloud_datacenter_facts|selectattr('name','equalto','{{ hcloud_datacenter_name }}') |selectattr('location','equalto','{{ hcloud_location_name }}') | list | count == 1 + +- name: test gather hcloud datacenter facts with correct id + hcloud_datacenter_facts: + id: "{{hcloud_datacenter_id}}" +- name: verify test gather hcloud datacenter with correct id + assert: + that: + - ansible_facts.hcloud_datacenter_facts|selectattr('name','equalto','{{ hcloud_datacenter_name }}') | list | count == 1