Vultr: Introducing vr_firewall_group_facts module (#42997)

This commit introduces a new module called vr_firewall_group_facts.

This module aims to return the list of firewall groups avaiable
avaiable in Vultr.

Sample available here:

```
"vultr_firewall_group_facts": [
  {
    "date_created": "2018-07-17 12:22:51",
    "date_modified": "2018-07-17 12:24:47",
    "description": "ansible-firewall-group",
    "id": "fb5a0876",
    "instance_count": 0,
    "max_rule_count": 50,
    "rule_count": 1
  }
]
```

lib/ansible/modules/cloud/vultr/vr_firewall_group_facts.py

@@ -0,0 +1,126 @@
+#!/usr/bin/python
+#
+# (c) 2018, Yanis Guenane <yanis+ansible@guenane.org>
+# 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: vr_firewall_group_facts
+short_description: Gather facts about the Vultr firewall groups available.
+description:
+  - Gather facts about firewall groups available in Vultr.
+version_added: "2.7"
+author: "Yanis Guenane (@Spredzy)"
+extends_documentation_fragment: vultr
+'''
+
+EXAMPLES = r'''
+- name: Gather Vultr firewall groups facts
+  local_action:
+    module: vr_firewall_group_facts
+
+- name: Print the gathered facts
+  debug:
+    var: ansible_facts.vultr_firewall_group_facts
+'''
+
+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: string
+      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: string
+      sample: "https://api.vultr.com"
+vultr_firewall_group_facts:
+  description: Response from Vultr API
+  returned: success
+  type: complex
+  contains:
+    "vultr_firewall_group_facts": [
+      {
+        "date_created": "2018-07-12 10:27:14",
+        "date_modified": "2018-07-12 10:27:14",
+        "description": "test",
+        "id": "5e128ff0",
+        "instance_count": 0,
+        "max_rule_count": 50,
+        "rule_count": 0
+      }
+    ]
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.vultr import (
+    Vultr,
+    vultr_argument_spec,
+)
+
+
+class AnsibleVultrFirewallGroupFacts(Vultr):
+
+    def __init__(self, module):
+        super(AnsibleVultrFirewallGroupFacts, self).__init__(module, "vultr_firewall_group_facts")
+
+        self.returns = {
+            "FIREWALLGROUPID": dict(key='id'),
+            "date_created": dict(),
+            "date_modified": dict(),
+            "description": dict(),
+            "instance_count": dict(convert_to='int'),
+            "max_rule_count": dict(convert_to='int'),
+            "rule_count": dict(convert_to='int')
+        }
+
+    def get_firewall_group(self):
+        return self.api_query(path="/v1/firewall/group_list")
+
+
+def parse_fw_group_list(fwgroups_list):
+    return [group for id, group in fwgroups_list.items()]
+
+
+def main():
+    argument_spec = vultr_argument_spec()
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+    )
+
+    fw_group_facts = AnsibleVultrFirewallGroupFacts(module)
+    result = fw_group_facts.get_result(parse_fw_group_list(fw_group_facts.get_firewall_group()))
+    ansible_facts = {
+        'vultr_firewall_group_facts': result['vultr_firewall_group_facts']
+    }
+    module.exit_json(ansible_facts=ansible_facts, **result)
+
+
+if __name__ == '__main__':
+    main()

test/legacy/roles/vr_firewall_group_facts/defaults/main.yml

@@ -0,0 +1 @@
+firewall_group_name: mytestfirewallgroup

test/legacy/roles/vr_firewall_group_facts/tasks/main.yml

@@ -0,0 +1,28 @@
+# Copyright (c) 2018, Yanis Guenane <yanis+ansible@guenane.org>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+---
+- name: Create the firewall group
+  vr_firewall_group:
+    name: '{{ firewall_group_name }}'
+
+- name: test gather vultr firewall group facts in check mode
+  vr_firewall_group_facts:
+  check_mode: yes
+
+- name: verify test gather vultr firewall group facts in check mode
+  assert:
+    that:
+    - ansible_facts.vultr_firewall_group_facts|selectattr('description','equalto','{{ firewall_group_name }}') | list | count == 1
+
+- name: test gather vultr firewall group facts
+  vr_firewall_group_facts:
+
+- name: verify test gather vultr firewall group facts
+  assert:
+    that:
+    - ansible_facts.vultr_firewall_group_facts|selectattr('description','equalto','{{ firewall_group_name }}') | list | count == 1
+
+- name: Delete the firewall group
+  vr_firewall_group:
+    name: '{{ firewall_group_name }}'
+    state: absent

test/legacy/vultr.yml

@@ -10,6 +10,7 @@
     - { role: vr_dns_domain_facts, tags: test_vr_dns_domain_facts }
     - { role: vr_dns_record, tags: test_vr_dns_record }
     - { role: vr_firewall_group, tags: test_vr_firewall_group }
+    - { role: vr_firewall_group_facts, tags: test_vr_firewall_group_facts }
     - { role: vr_firewall_rule, tags: test_vr_firewall_rule }
     - { role: vr_os_facts, tags: test_vr_os_facts }
     - { role: vr_plan_facts, tags: test_vr_plan_facts }