From 8c3382ec7080ff913d203ece80ccc04bf3635b64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Moser?= Date: Tue, 11 Jun 2019 07:51:24 +0200 Subject: [PATCH] vultr: vultr_os_facts -> info (#57565) * vultr: vultr_os_facts: rename to info * vultr: vultr_os_facts: rename tests to info * vultr: adjust tests * vultr: new vultr_os_info module --- .../{vultr_os_facts.py => _vultr_os_facts.py} | 6 +- .../modules/cloud/vultr/vultr_os_info.py | 133 ++++++++++++++++++ .../targets/vultr_os_facts/tasks/main.yml | 19 --- .../{vultr_os_facts => vultr_os_info}/aliases | 0 .../targets/vultr_os_info/tasks/main.yml | 22 +++ 5 files changed, 160 insertions(+), 20 deletions(-) rename lib/ansible/modules/cloud/vultr/{vultr_os_facts.py => _vultr_os_facts.py} (94%) create mode 100644 lib/ansible/modules/cloud/vultr/vultr_os_info.py delete mode 100644 test/integration/targets/vultr_os_facts/tasks/main.yml rename test/integration/targets/{vultr_os_facts => vultr_os_info}/aliases (100%) create mode 100644 test/integration/targets/vultr_os_info/tasks/main.yml diff --git a/lib/ansible/modules/cloud/vultr/vultr_os_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_os_facts.py similarity index 94% rename from lib/ansible/modules/cloud/vultr/vultr_os_facts.py rename to lib/ansible/modules/cloud/vultr/_vultr_os_facts.py index 339753fbd9..961490d72f 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_os_facts.py +++ b/lib/ansible/modules/cloud/vultr/_vultr_os_facts.py @@ -8,7 +8,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} DOCUMENTATION = r''' @@ -19,6 +19,10 @@ description: - Gather facts about OSes available to boot servers. version_added: "2.7" author: "Yanis Guenane (@Spredzy)" +deprecated: + removed_in: "2.12" + why: Transformed into an info module. + alternative: Use M(vultr_os_info) instead. extends_documentation_fragment: vultr ''' diff --git a/lib/ansible/modules/cloud/vultr/vultr_os_info.py b/lib/ansible/modules/cloud/vultr/vultr_os_info.py new file mode 100644 index 0000000000..d6dc3f2f1b --- /dev/null +++ b/lib/ansible/modules/cloud/vultr/vultr_os_info.py @@ -0,0 +1,133 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# +# Copyright (c) 2018, Yanis Guenane +# Copyright (c) 2019, René Moser +# 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 = r''' +--- +module: vultr_os_info +short_description: Get infos about the Vultr OSes available. +description: + - Get infos about OSes available to boot servers. +version_added: "2.9" +author: + - "Yanis Guenane (@Spredzy)" + - "René Moser (@resmo)" +extends_documentation_fragment: vultr +''' + +EXAMPLES = r''' +- name: Get Vultr OSes infos + vultr_os_info: + register: results + +- name: Print the gathered infos + debug: + var: results.vultr_os_info +''' + +RETURN = r''' +--- +vultr_api: + description: Response from Vultr API with a few additions/modification + returned: success + type: complex + contains: + api_account: + description: Account used in the ini file to select the key + returned: success + type: str + sample: default + api_timeout: + description: Timeout used for the API requests + returned: success + type: int + sample: 60 + api_retries: + description: Amount of max retries for the API requests + returned: success + type: int + sample: 5 + api_endpoint: + description: Endpoint used for the API requests + returned: success + type: str + sample: "https://api.vultr.com" +vultr_os_info: + description: Response from Vultr API as list + returned: available + type: complex + contains: + arch: + description: OS Architecture + returned: success + type: str + sample: x64 + family: + description: OS family + returned: success + type: str + sample: openbsd + name: + description: OS name + returned: success + type: str + sample: OpenBSD 6 x64 + windows: + description: OS is a MS Windows + returned: success + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.vultr import ( + Vultr, + vultr_argument_spec, +) + + +class AnsibleVultrOSInfo(Vultr): + + def __init__(self, module): + super(AnsibleVultrOSInfo, self).__init__(module, "vultr_os_info") + + self.returns = { + "OSID": dict(key='id', convert_to='int'), + "arch": dict(), + "family": dict(), + "name": dict(), + "windows": dict(convert_to='bool') + } + + def get_oses(self): + return self.api_query(path="/v1/os/list") + + +def parse_oses_list(oses_list): + return [os for id, os in oses_list.items()] + + +def main(): + argument_spec = vultr_argument_spec() + + module = AnsibleModule( + argument_spec=argument_spec, + supports_check_mode=True, + ) + + os_info = AnsibleVultrOSInfo(module) + result = os_info.get_result(parse_oses_list(os_info.get_oses())) + module.exit_json(**result) + + +if __name__ == '__main__': + main() diff --git a/test/integration/targets/vultr_os_facts/tasks/main.yml b/test/integration/targets/vultr_os_facts/tasks/main.yml deleted file mode 100644 index ca920aab00..0000000000 --- a/test/integration/targets/vultr_os_facts/tasks/main.yml +++ /dev/null @@ -1,19 +0,0 @@ -# Copyright (c) 2018, Yanis Guenane -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) ---- -- name: test gather vultr os facts in check mode - vultr_os_facts: - check_mode: yes - -- name: verify test gather vultr os facts in check mode - assert: - that: - - ansible_facts.vultr_os_facts|selectattr('name','equalto', 'CentOS 7 x64') | list | count == 1 - -- name: test gather vultr os fact - vultr_os_facts: - -- name: verify test gather vultr os facts - assert: - that: - - ansible_facts.vultr_os_facts|selectattr('name','equalto', 'CentOS 7 x64') | list | count == 1 diff --git a/test/integration/targets/vultr_os_facts/aliases b/test/integration/targets/vultr_os_info/aliases similarity index 100% rename from test/integration/targets/vultr_os_facts/aliases rename to test/integration/targets/vultr_os_info/aliases diff --git a/test/integration/targets/vultr_os_info/tasks/main.yml b/test/integration/targets/vultr_os_info/tasks/main.yml new file mode 100644 index 0000000000..a48133e4ca --- /dev/null +++ b/test/integration/targets/vultr_os_info/tasks/main.yml @@ -0,0 +1,22 @@ +# Copyright (c) 2018, Yanis Guenane +# Copyright (c) 2019, René Moser +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: test get vultr os infos in check mode + vultr_os_info: + check_mode: yes + register: result + +- name: verify test get vultr os infos in check mode + assert: + that: + - result.vultr_os_info|selectattr('name','equalto', 'CentOS 7 x64') | list | count == 1 + +- name: test get vultr os fact + vultr_os_info: + register: result + +- name: verify test get vultr os infos + assert: + that: + - result.vultr_os_info|selectattr('name','equalto', 'CentOS 7 x64') | list | count == 1