mirror of https://github.com/ansible/ansible.git
Add hcloud network info (#60932)
* Add hcloud network facts * Add tests * Rename fact to info, adjust tests * Fix style * Fix test * Fix typo * Adjust test * Adjust test * Rename subnets to subnetworks * Adjustments * Apply suggestions from code review Co-Authored-By: Lukas Kämmerling <4281581+LKaemmerling@users.noreply.github.com>pull/61021/head
Christopher Schmitt
5 years ago
committed by
Felix Fontein
parent
145a6a8756
commit
4e7cd76c56
@ -0,0 +1,207 @@
|
||||
#!/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_network_info
|
||||
|
||||
short_description: Gather info about your Hetzner Cloud networks.
|
||||
|
||||
version_added: "2.9"
|
||||
|
||||
description:
|
||||
- Gather info about your Hetzner Cloud networks.
|
||||
|
||||
author:
|
||||
- Christopher Schmitt (@cschmitt-hcloud)
|
||||
|
||||
options:
|
||||
id:
|
||||
description:
|
||||
- The ID of the network you want to get.
|
||||
type: int
|
||||
name:
|
||||
description:
|
||||
- The name of the network you want to get.
|
||||
type: str
|
||||
label_selector:
|
||||
description:
|
||||
- The label selector for the network you want to get.
|
||||
type: str
|
||||
extends_documentation_fragment: hcloud
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: Gather hcloud network info
|
||||
local_action:
|
||||
module: hcloud_network_info
|
||||
|
||||
- name: Print the gathered info
|
||||
debug:
|
||||
var: hcloud_network_info
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
hcloud_network_info:
|
||||
description: The network info as list
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
id:
|
||||
description: Numeric identifier of the network
|
||||
returned: always
|
||||
type: int
|
||||
sample: 1937415
|
||||
name:
|
||||
description: Name of the network
|
||||
returned: always
|
||||
type: str
|
||||
sample: awsome-network
|
||||
ip_range:
|
||||
description: IP range of the network
|
||||
returned: always
|
||||
type: str
|
||||
sample: 10.0.0.0/16
|
||||
subnetworks:
|
||||
description: Subnetworks belonging to the network
|
||||
returned: always
|
||||
type: complex
|
||||
routes:
|
||||
description: Routes belonging to the network
|
||||
returned: always
|
||||
type: complex
|
||||
servers:
|
||||
description: Servers attached to the network
|
||||
returned: always
|
||||
type: complex
|
||||
labels:
|
||||
description: Labels of the network
|
||||
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 AnsibleHcloudNetworkInfo(Hcloud):
|
||||
def __init__(self, module):
|
||||
Hcloud.__init__(self, module, "hcloud_network_info")
|
||||
self.hcloud_network_info = None
|
||||
|
||||
def _prepare_result(self):
|
||||
tmp = []
|
||||
|
||||
for network in self.hcloud_network_info:
|
||||
if network is not None:
|
||||
subnets = []
|
||||
for subnet in network.subnets:
|
||||
prepared_subnet = {
|
||||
"type": subnet.type,
|
||||
"ip_range": subnet.ip_range,
|
||||
"network_zone": subnet.network_zone,
|
||||
"gateway": subnet.gateway,
|
||||
}
|
||||
subnets.append(prepared_subnet)
|
||||
routes = []
|
||||
for route in network.routes:
|
||||
prepared_route = {
|
||||
"destination": route.destination,
|
||||
"gateway": route.gateway
|
||||
}
|
||||
routes.append(prepared_route)
|
||||
|
||||
servers = []
|
||||
for server in network.servers:
|
||||
prepared_server = {
|
||||
"id": to_native(server.id),
|
||||
"name": to_native(server.name),
|
||||
"ipv4_address": to_native(server.public_net.ipv4.ip),
|
||||
"ipv6": to_native(server.public_net.ipv6.ip),
|
||||
"image": to_native(server.image.name),
|
||||
"server_type": to_native(server.server_type.name),
|
||||
"datacenter": to_native(server.datacenter.name),
|
||||
"location": to_native(server.datacenter.location.name),
|
||||
"rescue_enabled": server.rescue_enabled,
|
||||
"backup_window": to_native(server.backup_window),
|
||||
"labels": server.labels,
|
||||
"status": to_native(server.status),
|
||||
}
|
||||
servers.append(prepared_server)
|
||||
|
||||
tmp.append({
|
||||
"id": to_native(network.id),
|
||||
"name": to_native(network.name),
|
||||
"ip_range": to_native(network.ip_range),
|
||||
"subnetworks": subnets,
|
||||
"routes": routes,
|
||||
"servers": servers,
|
||||
"labels": network.labels,
|
||||
})
|
||||
return tmp
|
||||
|
||||
def get_networks(self):
|
||||
try:
|
||||
if self.module.params.get("id") is not None:
|
||||
self.hcloud_network_info = [self.client.networks.get_by_id(
|
||||
self.module.params.get("id")
|
||||
)]
|
||||
elif self.module.params.get("name") is not None:
|
||||
self.hcloud_network_info = [self.client.networks.get_by_name(
|
||||
self.module.params.get("name")
|
||||
)]
|
||||
elif self.module.params.get("label_selector") is not None:
|
||||
self.hcloud_network_info = self.client.networks.get_all(
|
||||
label_selector=self.module.params.get("label_selector"))
|
||||
else:
|
||||
self.hcloud_network_info = self.client.networks.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 = AnsibleHcloudNetworkInfo.define_module()
|
||||
|
||||
hcloud = AnsibleHcloudNetworkInfo(module)
|
||||
hcloud.get_networks()
|
||||
result = hcloud.get_result()
|
||||
info = {
|
||||
'hcloud_network_info': result['hcloud_network_info']
|
||||
}
|
||||
module.exit_json(**info)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@ -0,0 +1,2 @@
|
||||
cloud/hcloud
|
||||
shippable/hcloud/group1
|
||||
@ -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_network_name: "{{hcloud_prefix}}-integration"
|
||||
@ -0,0 +1,116 @@
|
||||
# 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 network is absent
|
||||
hcloud_network:
|
||||
name: "{{ hcloud_network_name }}"
|
||||
state: absent
|
||||
register: result
|
||||
|
||||
- name: create network
|
||||
hcloud_network:
|
||||
name: "{{ hcloud_network_name }}"
|
||||
ip_range: "10.0.0.0/16"
|
||||
labels:
|
||||
key: value
|
||||
register: main_network
|
||||
- name: verify create network
|
||||
assert:
|
||||
that:
|
||||
- main_network is changed
|
||||
- main_network.hcloud_network.name == "{{ hcloud_network_name }}"
|
||||
- main_network.hcloud_network.ip_range == "10.0.0.0/16"
|
||||
- name: create subnetwork
|
||||
hcloud_subnetwork:
|
||||
network: "{{ hcloud_network_name }}"
|
||||
type: server
|
||||
network_zone: eu-central
|
||||
ip_range: "10.0.1.0/24"
|
||||
register: main_subnetwork
|
||||
- name: verify create subnetwork
|
||||
assert:
|
||||
that:
|
||||
- main_subnetwork is changed
|
||||
- main_subnetwork.hcloud_subnetwork.network == "{{ hcloud_network_name }}"
|
||||
- name: create route
|
||||
hcloud_route:
|
||||
network: "{{ hcloud_network_name }}"
|
||||
destination: "10.0.3.0/24"
|
||||
gateway: "10.0.2.1"
|
||||
register: main_route
|
||||
- name: verify create route
|
||||
assert:
|
||||
that:
|
||||
- main_route is changed
|
||||
- main_route.hcloud_route.network == "{{ hcloud_network_name }}"
|
||||
|
||||
- name: test gather hcloud network info in check mode
|
||||
hcloud_network_info:
|
||||
check_mode: yes
|
||||
register: hcloud_network
|
||||
- name: verify test gather hcloud network info in check mode
|
||||
assert:
|
||||
that:
|
||||
- hcloud_network.hcloud_network_info | selectattr('name','equalto','{{ hcloud_network_name }}') | list | count == 1
|
||||
- hcloud_network.hcloud_network_info[0].subnetworks | list | count == 1
|
||||
- hcloud_network.hcloud_network_info[0].routes | list | count == 1
|
||||
|
||||
- name: test gather hcloud network info with correct label selector
|
||||
hcloud_network_info:
|
||||
label_selector: "key=value"
|
||||
register: hcloud_network
|
||||
- name: verify test gather hcloud network with correct label selector
|
||||
assert:
|
||||
that:
|
||||
- hcloud_network.hcloud_network_info | selectattr('name','equalto','{{ hcloud_network_name }}') | list | count == 1
|
||||
|
||||
- name: test gather hcloud network info with wrong label selector
|
||||
hcloud_network_info:
|
||||
label_selector: "key!=value"
|
||||
register: hcloud_network
|
||||
- name: verify test gather hcloud network with wrong label selector
|
||||
assert:
|
||||
that:
|
||||
- hcloud_network.hcloud_network_info | list | count == 0
|
||||
|
||||
- name: test gather hcloud network info with correct name
|
||||
hcloud_network_info:
|
||||
name: "{{hcloud_network_name}}"
|
||||
register: hcloud_network
|
||||
- name: verify test gather hcloud network with correct name
|
||||
assert:
|
||||
that:
|
||||
- hcloud_network.hcloud_network_info | selectattr('name','equalto','{{ hcloud_network_name }}') | list | count == 1
|
||||
|
||||
- name: test gather hcloud network info with wrong name
|
||||
hcloud_network_info:
|
||||
name: "{{hcloud_network_name}}1"
|
||||
register: hcloud_network
|
||||
- name: verify test gather hcloud network with wrong name
|
||||
assert:
|
||||
that:
|
||||
- hcloud_network.hcloud_network_info | list | count == 0
|
||||
|
||||
- name: test gather hcloud network info with correct id
|
||||
hcloud_network_info:
|
||||
id: "{{main_network.hcloud_network.id}}"
|
||||
register: hcloud_network
|
||||
- name: verify test gather hcloud network with correct id
|
||||
assert:
|
||||
that:
|
||||
- hcloud_network.hcloud_network_info | selectattr('name','equalto','{{ hcloud_network_name }}') | list | count == 1
|
||||
|
||||
- name: test gather hcloud network info with wrong id
|
||||
hcloud_network_info:
|
||||
name: "4711"
|
||||
register: hcloud_network
|
||||
- name: verify test gather hcloud network with wrong id
|
||||
assert:
|
||||
that:
|
||||
- hcloud_network.hcloud_network_info | list | count == 0
|
||||
|
||||
- name: cleanup
|
||||
hcloud_network:
|
||||
name: "{{ hcloud_network_name }}"
|
||||
state: absent
|
||||
Loading…
Reference in New Issue