Adding postgresql firewall rule facts (#45078)

* adding postgresql firewall rule facts

* fixed sanity

* fixed sanity

* updating tests

* firewall rule facts updated

* fixed test

* fix crash

* small updates

* updated postgresql firewall rule

* removed unnecessary type

* fixed postgresql facts

* fixed azure

* one more fix

* test fixes

* fix class name
This commit is contained in:
Zim Kalinowski 2018-10-19 15:13:45 +08:00 committed by GitHub
parent d2f524fb27
commit b0c88ddab1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 261 additions and 0 deletions

View file

@ -0,0 +1,197 @@
#!/usr/bin/python
#
# Copyright (c) 2018 Zim Kalinowski, <zikalino@microsoft.com>
#
# 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: azure_rm_postgresqlfirewallrule_facts
version_added: "2.8"
short_description: Get Azure PostgreSQL Firewall Rule facts.
description:
- Get facts of Azure PostgreSQL Firewall Rule.
options:
resource_group:
description:
- The name of the resource group.
required: True
server_name:
description:
- The name of the server.
required: True
name:
description:
- The name of the server firewall rule.
extends_documentation_fragment:
- azure
author:
- "Zim Kalinowski (@zikalino)"
'''
EXAMPLES = '''
- name: Get instance of PostgreSQL Firewall Rule
azure_rm_postgresqlfirewallrule_facts:
resource_group: resource_group_name
server_name: server_name
name: firewall_rule_name
- name: List instances of PostgreSQL Firewall Rule
azure_rm_postgresqlfirewallrule_facts:
resource_group: resource_group_name
server_name: server_name
'''
RETURN = '''
rules:
description: A list of dictionaries containing facts for PostgreSQL Firewall Rule.
returned: always
type: complex
contains:
id:
description:
- Resource ID
returned: always
type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/fire
wallRules/rule1"
server_name:
description:
- The name of the server.
returned: always
type: str
sample: testserver
name:
description:
- Resource name.
returned: always
type: str
sample: rule1
start_ip_address:
description:
- The start IP address of the PostgreSQL firewall rule.
returned: always
type: str
sample: 10.0.0.16
end_ip_address:
description:
- The end IP address of the PostgreSQL firewall rule.
returned: always
type: str
sample: 10.0.0.18
'''
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
try:
from msrestazure.azure_exceptions import CloudError
from msrestazure.azure_operation import AzureOperationPoller
from azure.mgmt.rdbms.postgresql import PostgreSQLManagementClient
from msrest.serialization import Model
except ImportError:
# This is handled in azure_rm_common
pass
class AzureRMPostgreSQLFirewallRulesFacts(AzureRMModuleBase):
def __init__(self):
# define user inputs into argument
self.module_arg_spec = dict(
resource_group=dict(
type='str',
required=True
),
server_name=dict(
type='str',
required=True
),
name=dict(
type='str'
)
)
# store the results of the module operation
self.results = dict(
changed=False
)
self.mgmt_client = None
self.resource_group = None
self.server_name = None
self.name = None
super(AzureRMPostgreSQLFirewallRulesFacts, self).__init__(self.module_arg_spec, supports_tags=False)
def exec_module(self, **kwargs):
for key in self.module_arg_spec:
setattr(self, key, kwargs[key])
self.mgmt_client = self.get_mgmt_svc_client(PostgreSQLManagementClient,
base_url=self._cloud_environment.endpoints.resource_manager)
if (self.name is not None):
self.results['rules'] = self.get()
else:
self.results['rules'] = self.list_by_server()
return self.results
def get(self):
response = None
results = []
try:
response = self.mgmt_client.firewall_rules.get(resource_group_name=self.resource_group,
server_name=self.server_name,
firewall_rule_name=self.name)
self.log("Response : {0}".format(response))
except CloudError as e:
self.log('Could not get facts for FirewallRules.')
if response is not None:
results.append(self.format_item(response))
return results
def list_by_server(self):
response = None
results = []
try:
response = self.mgmt_client.firewall_rules.list_by_server(resource_group_name=self.resource_group,
server_name=self.server_name)
self.log("Response : {0}".format(response))
except CloudError as e:
self.log('Could not get facts for FirewallRules.')
if response is not None:
for item in response:
results.append(self.format_item(item))
return results
def format_item(self, item):
d = item.as_dict()
d = {
'resource_group': self.resource_group,
'id': d['id'],
'server_name': self.server_name,
'name': d['name'],
'start_ip_address': d['start_ip_address'],
'end_ip_address': d['end_ip_address']
}
return d
def main():
AzureRMPostgreSQLFirewallRulesFacts()
if __name__ == '__main__':
main()

View file

@ -300,6 +300,51 @@
that:
- output.changed == false
- name: Create Firewall Rule - second
azure_rm_postgresqlfirewallrule:
resource_group: "{{ resource_group }}"
server_name: postgresqlsrv{{ rpfx }}
name: firewallrule{{ rpfx }}second
start_ip_address: 172.28.10.136
end_ip_address: 172.28.10.138
- name: Gather facts PostgreSQL Firewall Rule
azure_rm_postgresqlfirewallrule_facts:
resource_group: "{{ resource_group }}"
server_name: postgresqlsrv{{ rpfx }}
name: firewallrule{{ rpfx }}
register: output
- name: Assert that facts are returned
assert:
that:
- output.changed == False
- output.rules[0].id != None
- output.rules[0].server_name != None
- output.rules[0].name != None
- output.rules[0].start_ip_address != None
- output.rules[0].end_ip_address != None
- "output.rules | length == 1"
- name: Gather facts PostgreSQL Firewall Rule
azure_rm_postgresqlfirewallrule_facts:
resource_group: "{{ resource_group }}"
server_name: postgresqlsrv{{ rpfx }}
register: output
- name: Assert that facts are returned
assert:
that:
- output.changed == False
- output.rules[0].id != None
- output.rules[0].server_name != None
- output.rules[0].name != None
- output.rules[0].start_ip_address != None
- output.rules[0].end_ip_address != None
- output.rules[1].id != None
- output.rules[1].name != None
- output.rules[1].start_ip_address != None
- output.rules[1].end_ip_address != None
- "output.rules | length == 2"
- name: Delete instance of Firewall Rule -- check mode
azure_rm_postgresqlfirewallrule:
resource_group: "{{ resource_group }}"
@ -337,6 +382,25 @@
that:
- output.changed == false
- name: Delete instance of Firewall Rule - second
azure_rm_postgresqlfirewallrule:
resource_group: "{{ resource_group }}"
server_name: postgresqlsrv{{ rpfx }}
name: firewallrule{{ rpfx }}second
state: absent
- name: Gather facts PostgreSQL Firewall Rule
azure_rm_postgresqlfirewallrule_facts:
resource_group: "{{ resource_group }}"
server_name: postgresqlsrv{{ rpfx }}
name: firewallrule{{ rpfx }}
register: output
- name: Assert that empty list was returned
assert:
that:
- output.changed == False
- "output.rules | length == 0"
#
# azure_rm_postgresqlserver continuation / clean up
#