ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

add azure_rm_webapp_facts module (#43631)

Browse source 
* add webapp facts module

* remove certified

* remove useless argument

* add tests

* return curated output

* add description of return value, move test to webapp folder

* fix lint

* fix lint

* fix lint

* fix test

* fix bug

* fix test, will get all webapp with same tag created by previous test

* fix test

* fix test

* fix test

* add properties description, refine return name

* refine properties, add request_id when exception

* fix bug

* update doc, add publish profile

* fix error

* flatten properties, add option for return publish profile
This commit is contained in:
Yunge Zhu 2018-08-30 17:49:06 +08:00 committed by Zim Kalinowski
parent 3b5b15ee5a
commit b731732616
4 changed files with 406 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_facts.py
View file

@ -107,7 +107,7 @@ vms:
- Resource ID.
returned: always
type: str
sample: /subscriptions/075da289-5dfd-466b-800e-a8c3a9ed3b05/resourceGroups/myclusterrg/providers/Microsoft.Compute/virtualMachines/mycluster-node-2
sample: /subscriptions/xxxx/resourceGroups/myclusterrg/providers/Microsoft.Compute/virtualMachines/mycluster-node-2
image:
description:
- Image specification

361
lib/ansible/modules/cloud/azure/azure_rm_webapp_facts.py Normal file
View file

@ -0,0 +1,361 @@
#!/usr/bin/python
#
# Copyright (c) 2018 Yunge Zhu, <yungez@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_webapp_facts
version_added: "2.7"
short_description: Get azure web app facts.
description:
- Get facts for a specific web app or all web app in a resource group, or all web app in current subscription.
options:
name:
description:
- Only show results for a specific web app.
resource_group:
description:
- Limit results by resource group.
return_publish_profile:
description:
- Indicate wheather to return publishing profile of the web app.
default: False
type: bool
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
extends_documentation_fragment:
- azure
author:
- "Yunge Zhu (@yungezz)"
'''
EXAMPLES = '''
- name: Get facts for web app by name
azure_rm_webapp_facts:
resource_group: testrg
name: winwebapp1
- name: Get facts for web apps in resource group
azure_rm_webapp_facts:
resource_group: testrg
- name: Get facts for web apps with tags
azure_rm_webapp_facts:
tags:
- testtag
- foo:bar
'''
RETURN = '''
webapps:
description: List of web apps.
returned: always
type: complex
contains:
id:
description:
- Id of the web app.
returned: always
type: str
sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Web/sites/xx
name:
description:
- Name of the web app.
returned: always
type: str
resource_group:
description:
- Resource group of the web app.
returned: always
type: str
location:
description:
- Location of the web app.
returned: always
type: str
plan:
description:
- Id of app service plan used by the web app.
returned: always
type: str
sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Web/serverfarms/xxx
app_settings:
description:
- App settings of the application. Only returned when web app has app settings.
type: complex
frameworks:
description:
- Frameworks of the application. Only returned when web app has frameworks.
type: complex
availability_state:
description: Availability of this web app.
type: str
default_host_name:
description: Host name of the web app.
type: str
enabled:
description: Indicates the web app enabled or not.
type: bool
enabled_host_names:
description: Enabled host names of the web app.
type: list
host_name_ssl_states:
description: SSL state per host names of the web app.
type: list
host_names:
description: Host names of the web app.
type: list
outbound_ip_addresses:
description: Outbound ip address of the web app.
type: str
state:
description: State of the web app. eg. running.
type: str
publishing_username:
description: Publishing profle user name.
returned: only when I(return_publish_profile) is True.
type: str
publishing_password:
description: Publishing profile password.
returned: only when I(return_publish_profile) is True.
type: str
'''
try:
from msrestazure.azure_exceptions import CloudError
from msrestazure.azure_operation import AzureOperationPoller
from azure.common import AzureMissingResourceHttpError, AzureHttpError
except:
# This is handled in azure_rm_common
pass
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
AZURE_OBJECT_CLASS = 'WebApp'
class AzureRMWebAppFacts(AzureRMModuleBase):
def __init__(self):
self.module_arg_spec = dict(
name=dict(type='str'),
resource_group=dict(type='str'),
tags=dict(type='list'),
return_publish_profile=dict(type=bool, default=False)
)
self.results = dict(
changed=False,
webapps=[]
)
self.name = None
self.resource_group = None
self.tags = None
self.return_publish_profile = False
self.framework_names = ['net_framework', 'java', 'php', 'node', 'python', 'dotnetcore', 'ruby']
super(AzureRMWebAppFacts, self).__init__(self.module_arg_spec,
supports_tags=False,
facts_module=True)
def exec_module(self, **kwargs):
for key in self.module_arg_spec:
setattr(self, key, kwargs[key])
if self.name:
self.results['webapps'] = self.list_by_name()
elif self.resource_group:
self.results['webapps'] = self.list_by_resource_group()
else:
self.results['webapps'] = self.list_all()
return self.results
def list_by_name(self):
self.log('Get web app {0}'.format(self.name))
item = None
result = []
try:
item = self.web_client.web_apps.get(self.resource_group, self.name)
except CloudError:
pass
if item and self.has_tags(item.tags, self.tags):
curated_result = self.get_curated_webapp(self.resource_group, self.name, item)
result = [curated_result]
return result
def list_by_resource_group(self):
self.log('List web apps in resource groups {0}'.format(self.resource_group))
try:
response = list(self.web_client.web_apps.list_by_resource_group(self.resource_group))
except CloudError as exc:
request_id = exc.request_id if exc.request_id else ''
self.fail("Error listing web apps in resource groups {0}, request id: {1} - {2}".format(self.resource_group, request_id, str(exc)))
results = []
for item in response:
if self.has_tags(item.tags, self.tags):
curated_output = self.get_curated_webapp(self.resource_group, item.name, item)
results.append(curated_output)
return results
def list_all(self):
self.log('List web apps in current subscription')
try:
response = list(self.web_client.web_apps.list())
except CloudError as exc:
request_id = exc.request_id if exc.request_id else ''
self.fail("Error listing web apps, request id {0} - {1}".format(request_id, str(exc)))
results = []
for item in response:
if self.has_tags(item.tags, self.tags):
curated_output = self.get_curated_webapp(item.resource_group, item.name, item)
results.append(curated_output)
return results
def list_webapp_configuration(self, resource_group, name):
self.log('Get web app {0} configuration'.format(name))
response = []
try:
response = self.web_client.web_apps.get_configuration(resource_group_name=resource_group, name=name)
except CloudError as ex:
request_id = ex.request_id if ex.request_id else ''
self.fail('Error getting web app {0} configuration, request id {1} - {2}'.format(name, request_id, str(ex)))
return response.as_dict()
def list_webapp_appsettings(self, resource_group, name):
self.log('Get web app {0} app settings'.format(name))
response = []
try:
response = self.web_client.web_apps.list_application_settings(resource_group_name=resource_group, name=name)
except CloudError as ex:
request_id = ex.request_id if ex.request_id else ''
self.fail('Error getting web app {0} app settings, request id {1} - {2}'.format(name, request_id, str(ex)))
return response.as_dict()
def get_publish_credentials(self, resource_group, name):
self.log('Get web app {0} publish credentials'.format(name))
try:
poller = self.web_client.web_apps.list_publishing_credentials(resource_group, name)
if isinstance(poller, AzureOperationPoller):
response = self.get_poller_result(poller)
except CloudError as ex:
request_id = ex.request_id if ex.request_id else ''
self.fail('Error getting web app {0} publishing credentials - {1}'.format(request_id, str(ex)))
return response
def get_curated_webapp(self, resource_group, name, webapp):
pip = self.serialize_obj(webapp, AZURE_OBJECT_CLASS)
try:
site_config = self.list_webapp_configuration(resource_group, name)
app_settings = self.list_webapp_appsettings(resource_group, name)
publish_cred = self.get_publish_credentials(resource_group, name)
except CloudError as ex:
pass
return self.construct_curated_webapp(webapp=pip,
configuration=site_config,
app_settings=app_settings,
deployment_slot=None,
publish_credentials=publish_cred)
def construct_curated_webapp(self, webapp, configuration=None, app_settings=None, deployment_slot=None, publish_credentials=None):
curated_output = dict()
curated_output['id'] = webapp['id']
curated_output['name'] = webapp['name']
curated_output['resource_group'] = webapp['properties']['resourceGroup']
curated_output['location'] = webapp['location']
curated_output['plan'] = webapp['properties']['serverFarmId']
curated_output['tags'] = webapp.get('tags', None)
# important properties from output. not match input arguments.
curated_output['app_state'] = webapp['properties']['state']
curated_output['availability_state'] = webapp['properties']['availabilityState']
curated_output['default_host_name'] = webapp['properties']['defaultHostName']
curated_output['host_names'] = webapp['properties']['hostNames']
curated_output['enabled'] = webapp['properties']['enabled']
curated_output['enabled_host_names'] = webapp['properties']['enabledHostNames']
curated_output['host_name_ssl_states'] = webapp['properties']['hostNameSslStates']
curated_output['outbound_ip_addresses'] = webapp['properties']['outboundIpAddresses']
# curated site_config
if configuration:
curated_output['frameworks'] = []
for fx_name in self.framework_names:
fx_version = configuration.get(fx_name + '_version', None)
if fx_version:
fx = {
'name': fx_name,
'version': fx_version
}
# java container setting
if fx_name == 'java':
if configuration['java_container'] and configuration['java_container_version']:
settings = {
'java_container': configuration['java_container'].lower(),
'java_container_version': configuration['java_container_version']
}
fx['settings'] = settings
curated_output['frameworks'].append(fx)
# linux_fx_version
if configuration.get('linux_fx_version', None):
tmp = configuration.get('linux_fx_version').split("|")
if len(tmp) == 2:
curated_output['frameworks'].append({'name': tmp[0].lower(), 'version': tmp[1]})
# curated app_settings
if app_settings and app_settings.get('properties', None):
curated_output['app_settings'] = dict()
for item in app_settings['properties']:
curated_output['app_settings'][item] = app_settings['properties'][item]
# curated deploymenet_slot
if deployment_slot:
curated_output['deployment_slot'] = deployment_slot
# curated publish credentials
if publish_credentials and self.return_publish_profile:
curated_output['publishing_username'] = publish_credentials.publishing_user_name
curated_output['publishing_password'] = publish_credentials.publishing_password
return curated_output
def main():
AzureRMWebAppFacts()
if __name__ == '__main__':
main()

3
test/integration/targets/azure_rm_webapp/aliases
View file

@ -1,3 +1,4 @@
cloud/azure
shippable/azure/group4
destructive
destructive
azure_rm_webapp_facts

45
test/integration/targets/azure_rm_webapp/tasks/main.yml
View file

@ -54,8 +54,22 @@
plan: "{{ win_plan_name }}"
dns_registration: true
https_only: true
tags:
testwebapptag: test
register: output
- name: get web app with resource group and tag
azure_rm_webapp_facts:
resource_group: "{{ resource_group }}"
name: "{{ win_app_name }}3"
tags:
- testwebapptag
register: output
- assert:
that:
- output.webapps | length == 1
- name: Create a win web app with java run time specific
azure_rm_webapp:
resource_group: "{{ resource_group }}"
@ -71,10 +85,22 @@
testkey: "testvalue"
register: output
- name: assert the function was created
- name: assert the web app was created
assert:
that: output.changed
- name: get web app with name
azure_rm_webapp_facts:
resource_group: "{{ resource_group }}"
name: "{{ win_app_name }}4"
register: output
- assert:
that:
- output.webapps | length == 1
- output.webapps[0].app_settings | length == 1
- output.webapps[0].frameworks | length > 1 # there's default frameworks eg net_framework
- name: Update app settings
azure_rm_webapp:
resource_group: "{{ resource_group }}"
@ -90,10 +116,23 @@
testkey2: "testvalue2"
register: output
- name: Assert the web app was created
- name: Assert the web app was updated
assert:
that: output.changed
- name: get web app with return publishing profile
azure_rm_webapp_facts:
resource_group: "{{ resource_group }}"
name: "{{ win_app_name }}4"
return_publish_profile: true
register: output
- assert:
that:
- output.webapps | length == 1
- output.webapps[0].publishing_username != ""
- output.webapps[0].publishing_password != ""
- name: Purge all existing app settings
azure_rm_webapp:
resource_group: "{{ resource_group }}"
@ -102,7 +141,7 @@
purge_app_settings: true
register: output
- name: Assert the web app was created
- name: Assert the web app was updated
assert:
that: output.changed