From 3614f78bc5cd4883053a82e42ecae286623cf968 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:31 +0100 Subject: [PATCH] Add hcloud_server_type_facts module (#53852) --- .../cloud/hcloud/hcloud_server_type_facts.py | 174 ++++++++++++++++++ .../targets/hcloud_server_type_facts/aliases | 2 + .../defaults/main.yml | 5 + .../hcloud_server_type_facts/tasks/main.yml | 34 ++++ 4 files changed, 215 insertions(+) create mode 100644 lib/ansible/modules/cloud/hcloud/hcloud_server_type_facts.py create mode 100644 test/integration/targets/hcloud_server_type_facts/aliases create mode 100644 test/integration/targets/hcloud_server_type_facts/defaults/main.yml create mode 100644 test/integration/targets/hcloud_server_type_facts/tasks/main.yml diff --git a/lib/ansible/modules/cloud/hcloud/hcloud_server_type_facts.py b/lib/ansible/modules/cloud/hcloud/hcloud_server_type_facts.py new file mode 100644 index 0000000000..fcdb084ab6 --- /dev/null +++ b/lib/ansible/modules/cloud/hcloud/hcloud_server_type_facts.py @@ -0,0 +1,174 @@ +#!/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_server_type_facts + +short_description: Gather facts about the Hetzner Cloud server types. + +version_added: "2.8" + +description: + - Gather facts about your Hetzner Cloud server types. + +author: + - Lukas Kaemmerling (@lkaemmerling) + +options: + id: + description: + - The ID of the server type you want to get. + type: int + name: + description: + - The name of the server type you want to get. + type: str +extends_documentation_fragment: hcloud +""" + +EXAMPLES = """ +- name: Gather hcloud server type facts + local_action: + module: hcloud_server_type_facts + +- name: Print the gathered facts + debug: + var: ansible_facts.hcloud_server_type_facts +""" + +RETURN = """ +hcloud_server_type_facts: + description: The server type facts as list + returned: always + type: complex + contains: + id: + description: Numeric identifier of the server type + returned: always + type: int + sample: 1937415 + name: + description: Name of the server type + returned: always + type: str + sample: fsn1 + description: + description: Detail description of the server type + returned: always + type: str + sample: Falkenstein DC Park 1 + cores: + description: Number of cpu cores a server of this type will have + returned: always + type: int + sample: 1 + memory: + description: Memory a server of this type will have in GB + returned: always + type: int + sample: 1 + disk: + description: Disk size a server of this type will have in GB + returned: always + type: int + sample: 25 + storage_type: + description: Type of server boot drive + returned: always + type: str + sample: local + cpu_type: + description: Type of cpu + returned: always + type: str + sample: shared +""" + +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_server_type_facts") + self.hcloud_server_type_facts = None + + def _prepare_result(self): + tmp = [] + + for server_type in self.hcloud_server_type_facts: + if server_type is not None: + tmp.append({ + "id": to_native(server_type.id), + "name": to_native(server_type.name), + "description": to_native(server_type.description), + "cores": server_type.cores, + "memory": server_type.memory, + "disk": server_type.disk, + "storage_type": to_native(server_type.storage_type), + "cpu_type": to_native(server_type.cpu_type) + }) + return tmp + + def get_server_types(self): + try: + if self.module.params.get("id") is not None: + self.hcloud_server_type_facts = [self.client.server_types.get_by_id( + self.module.params.get("id") + )] + elif self.module.params.get("name") is not None: + self.hcloud_server_type_facts = [self.client.server_types.get_by_name( + self.module.params.get("name") + )] + else: + self.hcloud_server_type_facts = self.client.server_types.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_server_types() + result = hcloud.get_result() + ansible_facts = { + 'hcloud_server_type_facts': result['hcloud_server_type_facts'] + } + module.exit_json(ansible_facts=ansible_facts) + + +if __name__ == "__main__": + main() diff --git a/test/integration/targets/hcloud_server_type_facts/aliases b/test/integration/targets/hcloud_server_type_facts/aliases new file mode 100644 index 0000000000..51742ee23f --- /dev/null +++ b/test/integration/targets/hcloud_server_type_facts/aliases @@ -0,0 +1,2 @@ +cloud/hcloud +unsupported diff --git a/test/integration/targets/hcloud_server_type_facts/defaults/main.yml b/test/integration/targets/hcloud_server_type_facts/defaults/main.yml new file mode 100644 index 0000000000..05502aa91b --- /dev/null +++ b/test/integration/targets/hcloud_server_type_facts/defaults/main.yml @@ -0,0 +1,5 @@ +# 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_server_type_name: "cx11" +hcloud_server_type_id: 1 diff --git a/test/integration/targets/hcloud_server_type_facts/tasks/main.yml b/test/integration/targets/hcloud_server_type_facts/tasks/main.yml new file mode 100644 index 0000000000..c0d2e50296 --- /dev/null +++ b/test/integration/targets/hcloud_server_type_facts/tasks/main.yml @@ -0,0 +1,34 @@ +# 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 server type facts + hcloud_server_type_facts: +- name: verify test gather hcloud server type facts + assert: + that: + - ansible_facts.hcloud_server_type_facts| list | count > 2 + +- name: test gather hcloud server type facts in check mode + hcloud_server_type_facts: + check_mode: yes + +- name: verify test gather hcloud server type facts in check mode + assert: + that: + - ansible_facts.hcloud_server_type_facts| list | count > 2 + +- name: test gather hcloud server type facts with name + hcloud_server_type_facts: + name: "{{hcloud_server_type_name}}" +- name: verify test gather hcloud server type with name + assert: + that: + - ansible_facts.hcloud_server_type_facts|selectattr('name','equalto','{{ hcloud_server_type_name }}') | list | count == 1 + +- name: test gather hcloud server type facts with correct id + hcloud_server_type_facts: + id: "{{hcloud_server_type_id}}" +- name: verify test gather hcloud server type with correct id + assert: + that: + - ansible_facts.hcloud_server_type_facts|selectattr('name','equalto','{{ hcloud_server_type_name }}') | list | count == 1