ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-31 17:11:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

cs_volume: fix CloudStackException dependency (#30389)

Browse source 
fixes pep8
This commit is contained in:
René Moser 2017-09-15 20:40:28 +02:00 • committed by GitHub
commit f128796782
4 changed files with 115 additions and 179 deletions
Download patch file Download diff file Expand all files Collapse all files

13
lib/ansible/module_utils/cloudstack.py
View file

@ -428,6 +428,19 @@ class AnsibleCloudStack(object):
return self._get_by_key(key, self.vm) return self._get_by_key(key, self.vm)
self.fail_json(msg="Virtual machine '%s' not found" % vm) self.fail_json(msg="Virtual machine '%s' not found" % vm)
def get_disk_offering(self, key=None):
disk_offering = self.module.params.get('disk_offering')
if not disk_offering:
return None
# Do not add domain filter for disk offering listing.
disk_offerings = self.query_api('listDiskOfferings')
if disk_offerings:
for d in disk_offerings['diskoffering']:
if disk_offering in [d['displaytext'], d['name'], d['id']]:
return self._get_by_key(key, d)
self.fail_json(msg="Disk offering '%s' not found" % disk_offering)
def get_zone(self, key=None): def get_zone(self, key=None):
if self.zone: if self.zone:
return self._get_by_key(key, self.zone) return self._get_by_key(key, self.zone)

17
lib/ansible/modules/cloud/cloudstack/cs_instance.py
View file

@ -500,21 +500,6 @@ class AnsibleCloudStackInstance(AnsibleCloudStack):
return self._get_by_key(key, self.iso) return self._get_by_key(key, self.iso)
self.module.fail_json(msg="ISO '%s' not found" % iso) self.module.fail_json(msg="ISO '%s' not found" % iso)
def get_disk_offering_id(self):
disk_offering = self.module.params.get('disk_offering')
if not disk_offering:
return None
disk_offerings = self.cs.listDiskOfferings()
if disk_offerings:
for d in disk_offerings['diskoffering']:
if disk_offering in [ d['displaytext'], d['name'], d['id'] ]:
return d['id']
self.module.fail_json(msg="Disk offering '%s' not found" % disk_offering)
def get_instance(self): def get_instance(self):
instance = self.instance instance = self.instance
if not instance: if not instance:
@ -713,7 +698,7 @@ class AnsibleCloudStackInstance(AnsibleCloudStack):
args['account'] = self.get_account(key='name') args['account'] = self.get_account(key='name')
args['domainid'] = self.get_domain(key='id') args['domainid'] = self.get_domain(key='id')
args['projectid'] = self.get_project(key='id') args['projectid'] = self.get_project(key='id')
args['diskofferingid'] = self.get_disk_offering_id() args['diskofferingid'] = self.get_disk_offering(key='id')
args['networkids'] = networkids args['networkids'] = networkids
args['iptonetworklist'] = self.get_iptonetwork_mappings() args['iptonetworklist'] = self.get_iptonetwork_mappings()
args['userdata'] = self.get_user_data() args['userdata'] = self.get_user_data()

263
lib/ansible/modules/cloud/cloudstack/cs_volume.py
View file

@ -43,104 +43,75 @@ options:
account: account:
description: description:
- Account the volume is related to. - Account the volume is related to.
required: false
default: null
custom_id: custom_id:
description: description:
- Custom id to the resource. - Custom id to the resource.
- Allowed to Root Admins only. - Allowed to Root Admins only.
required: false
default: null
disk_offering: disk_offering:
description: description:
- Name of the disk offering to be used. - Name of the disk offering to be used.
- Required one of C(disk_offering), C(snapshot) if volume is not already C(state=present). - Required one of C(disk_offering), C(snapshot) if volume is not already C(state=present).
required: false
default: null
display_volume: display_volume:
description: description:
- Whether to display the volume to the end user or not. - Whether to display the volume to the end user or not.
- Allowed to Root Admins only. - Allowed to Root Admins only.
required: false
default: true default: true
domain: domain:
description: description:
- Name of the domain the volume to be deployed in. - Name of the domain the volume to be deployed in.
required: false
default: null
max_iops: max_iops:
description: description:
- Max iops - Max iops
required: false
default: null
min_iops: min_iops:
description: description:
- Min iops - Min iops
required: false
default: null
project: project:
description: description:
- Name of the project the volume to be deployed in. - Name of the project the volume to be deployed in.
required: false
default: null
size: size:
description: description:
- Size of disk in GB - Size of disk in GB
required: false
default: null
snapshot: snapshot:
description: description:
- The snapshot name for the disk volume. - The snapshot name for the disk volume.
- Required one of C(disk_offering), C(snapshot) if volume is not already C(state=present). - Required one of C(disk_offering), C(snapshot) if volume is not already C(state=present).
required: false
default: null
force: force:
description: description:
- Force removal of volume even it is attached to a VM. - Force removal of volume even it is attached to a VM.
- Considered on C(state=absnet) only. - Considered on C(state=absnet) only.
required: false
default: false default: false
shrink_ok: shrink_ok:
description: description:
- Whether to allow to shrink the volume. - Whether to allow to shrink the volume.
required: false
default: false default: false
vm: vm:
description: description:
- Name of the virtual machine to attach the volume to. - Name of the virtual machine to attach the volume to.
required: false
default: null
zone: zone:
description: description:
- Name of the zone in which the volume should be deployed. - Name of the zone in which the volume should be deployed.
- If not set, default zone is used. - If not set, default zone is used.
required: false
default: null
state: state:
description: description:
- State of the volume. - State of the volume.
required: false default: present
default: 'present' choices: [ present, absent, attached, detached ]
choices: [ 'present', 'absent', 'attached', 'detached' ]
poll_async: poll_async:
description: description:
- Poll async jobs until job has finished. - Poll async jobs until job has finished.
required: false
default: true default: true
tags: tags:
description: description:
- List of tags. Tags are a list of dictionaries having keys C(key) and C(value). - List of tags. Tags are a list of dictionaries having keys C(key) and C(value).
- "To delete all tags, set a empty list e.g. C(tags: [])." - "To delete all tags, set a empty list e.g. C(tags: [])."
required: false
default: null
aliases: [ 'tag' ] aliases: [ 'tag' ]
version_added: "2.4" version_added: "2.4"
extends_documentation_fragment: cloudstack extends_documentation_fragment: cloudstack
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Create volume within project, zone with specified storage options - name: create volume within project and zone with specified storage options
- local_action: local_action:
module: cs_volume module: cs_volume
name: web-vm-1-volume name: web-vm-1-volume
project: Integration project: Integration
@ -148,8 +119,8 @@ EXAMPLES = '''
disk_offering: PerfPlus Storage disk_offering: PerfPlus Storage
size: 20 size: 20
# Create/attach volume to instance - name: create/attach volume to instance
- local_action: local_action:
module: cs_volume module: cs_volume
name: web-vm-1-volume name: web-vm-1-volume
disk_offering: PerfPlus Storage disk_offering: PerfPlus Storage
@ -157,14 +128,14 @@ EXAMPLES = '''
vm: web-vm-1 vm: web-vm-1
state: attached state: attached
# Detach volume - name: detach volume
- local_action: local_action:
module: cs_volume module: cs_volume
name: web-vm-1-volume name: web-vm-1-volume
state: detached state: detached
# Remove volume - name: remove volume
- local_action: local_action:
module: cs_volume module: cs_volume
name: web-vm-1-volume name: web-vm-1-volume
state: absent state: absent
@ -243,8 +214,12 @@ device_id:
sample: 1 sample: 1
''' '''
# import cloudstack common from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.cloudstack import * from ansible.module_utils.cloudstack import (
AnsibleCloudStack,
cs_required_together,
cs_argument_spec
)
class AnsibleCloudStackVolume(AnsibleCloudStack): class AnsibleCloudStackVolume(AnsibleCloudStack):
@ -252,41 +227,26 @@ class AnsibleCloudStackVolume(AnsibleCloudStack):
def __init__(self, module): def __init__(self, module):
super(AnsibleCloudStackVolume, self).__init__(module) super(AnsibleCloudStackVolume, self).__init__(module)
self.returns = { self.returns = {
'group': 'group', 'group': 'group',
'attached': 'attached', 'attached': 'attached',
'vmname': 'vm', 'vmname': 'vm',
'deviceid': 'device_id', 'deviceid': 'device_id',
'type': 'type', 'type': 'type',
'size': 'size', 'size': 'size',
} }
self.volume = None self.volume = None
#TODO implement in cloudstack utils
def get_disk_offering(self, key=None):
disk_offering = self.module.params.get('disk_offering')
if not disk_offering:
return None
# Do not add domain filter for disk offering listing.
disk_offerings = self.cs.listDiskOfferings()
if disk_offerings:
for d in disk_offerings['diskoffering']:
if disk_offering in [d['displaytext'], d['name'], d['id']]:
return self._get_by_key(key, d)
self.module.fail_json(msg="Disk offering '%s' not found" % disk_offering)
def get_volume(self): def get_volume(self):
if not self.volume: if not self.volume:
args = {} args = {
args['account'] = self.get_account(key='name') 'account': self.get_account(key='name'),
args['domainid'] = self.get_domain(key='id') 'domainid': self.get_domain(key='id'),
args['projectid'] = self.get_project(key='id') 'projectid': self.get_project(key='id'),
args['zoneid'] = self.get_zone(key='id') 'zoneid': self.get_zone(key='id'),
args['displayvolume'] = self.module.params.get('display_volume') 'displayvolume': self.module.params.get('display_volume'),
args['type'] = 'DATADISK' 'type': 'DATADISK',
}
volumes = self.cs.listVolumes(**args) volumes = self.query_api('listVolumes', **args)
if volumes: if volumes:
volume_name = self.module.params.get('name') volume_name = self.module.params.get('name')
for v in volumes['volume']: for v in volumes['volume']:
@ -295,24 +255,22 @@ class AnsibleCloudStackVolume(AnsibleCloudStack):
break break
return self.volume return self.volume
def get_snapshot(self, key=None): def get_snapshot(self, key=None):
snapshot = self.module.params.get('snapshot') snapshot = self.module.params.get('snapshot')
if not snapshot: if not snapshot:
return None return None
args = {} args = {
args['name'] = snapshot 'name': snapshot,
args['account'] = self.get_account('name') 'account': self.get_account('name'),
args['domainid'] = self.get_domain('id') 'domainid': self.get_domain('id'),
args['projectid'] = self.get_project('id') 'projectid': self.get_project('id'),
}
snapshots = self.cs.listSnapshots(**args) snapshots = self.query_api('listSnapshots', **args)
if snapshots: if snapshots:
return self._get_by_key(key, snapshots['snapshot'][0]) return self._get_by_key(key, snapshots['snapshot'][0])
self.module.fail_json(msg="Snapshot with name %s not found" % snapshot) self.module.fail_json(msg="Snapshot with name %s not found" % snapshot)
def present_volume(self): def present_volume(self):
volume = self.get_volume() volume = self.get_volume()
if volume: if volume:
@ -326,21 +284,21 @@ class AnsibleCloudStackVolume(AnsibleCloudStack):
self.result['changed'] = True self.result['changed'] = True
args = {} args = {
args['name'] = self.module.params.get('name') 'name': self.module.params.get('name'),
args['account'] = self.get_account(key='name') 'account': self.get_account(key='name'),
args['domainid'] = self.get_domain(key='id') 'domainid': self.get_domain(key='id'),
args['diskofferingid'] = disk_offering_id 'diskofferingid': disk_offering_id,
args['displayvolume'] = self.module.params.get('display_volume') 'displayvolume': self.module.params.get('display_volume'),
args['maxiops'] = self.module.params.get('max_iops') 'maxiops': self.module.params.get('max_iops'),
args['miniops'] = self.module.params.get('min_iops') 'miniops': self.module.params.get('min_iops'),
args['projectid'] = self.get_project(key='id') 'projectid': self.get_project(key='id'),
args['size'] = self.module.params.get('size') 'size': self.module.params.get('size'),
args['snapshotid'] = snapshot_id 'snapshotid': snapshot_id,
args['zoneid'] = self.get_zone(key='id') 'zoneid': self.get_zone(key='id')
}
if not self.module.check_mode: if not self.module.check_mode:
res = self.cs.createVolume(**args) res = self.query_api('createVolume', **args)
if 'errortext' in res: if 'errortext' in res:
self.module.fail_json(msg="Failed: '%s'" % res['errortext']) self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
poll_async = self.module.params.get('poll_async') poll_async = self.module.params.get('poll_async')
@ -348,11 +306,10 @@ class AnsibleCloudStackVolume(AnsibleCloudStack):
volume = self.poll_job(res, 'volume') volume = self.poll_job(res, 'volume')
if volume: if volume:
volume = self.ensure_tags(resource=volume, resource_type='Volume') volume = self.ensure_tags(resource=volume, resource_type='Volume')
self.volume=volume self.volume = volume
return volume return volume
def attached_volume(self): def attached_volume(self):
volume = self.present_volume() volume = self.present_volume()
@ -366,21 +323,18 @@ class AnsibleCloudStackVolume(AnsibleCloudStack):
if 'attached' not in volume: if 'attached' not in volume:
self.result['changed'] = True self.result['changed'] = True
args = {} args = {
args['id'] = volume['id'] 'id': volume['id'],
args['virtualmachineid'] = self.get_vm(key='id') 'virtualmachineid': self.get_vm(key='id'),
args['deviceid'] = self.module.params.get('device_id') 'deviceid': self.module.params.get('device_id'),
}
if not self.module.check_mode: if not self.module.check_mode:
res = self.cs.attachVolume(**args) res = self.query_api('attachVolume', **args)
if 'errortext' in res:
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
poll_async = self.module.params.get('poll_async') poll_async = self.module.params.get('poll_async')
if poll_async: if poll_async:
volume = self.poll_job(res, 'volume') volume = self.poll_job(res, 'volume')
return volume return volume
def detached_volume(self): def detached_volume(self):
volume = self.present_volume() volume = self.present_volume()
@ -391,15 +345,12 @@ class AnsibleCloudStackVolume(AnsibleCloudStack):
self.result['changed'] = True self.result['changed'] = True
if not self.module.check_mode: if not self.module.check_mode:
res = self.cs.detachVolume(id=volume['id']) res = self.query_api('detachVolume', id=volume['id'])
if 'errortext' in volume:
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
poll_async = self.module.params.get('poll_async') poll_async = self.module.params.get('poll_async')
if poll_async: if poll_async:
volume = self.poll_job(res, 'volume') volume = self.poll_job(res, 'volume')
return volume return volume
def absent_volume(self): def absent_volume(self):
volume = self.get_volume() volume = self.get_volume()
@ -410,25 +361,21 @@ class AnsibleCloudStackVolume(AnsibleCloudStack):
self.result['changed'] = True self.result['changed'] = True
if not self.module.check_mode: if not self.module.check_mode:
volume = self.detached_volume() volume = self.detached_volume()
res = self.query_api('deleteVolume', id=volume['id'])
res = self.cs.deleteVolume(id=volume['id'])
if 'errortext' in res:
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
poll_async = self.module.params.get('poll_async') poll_async = self.module.params.get('poll_async')
if poll_async: if poll_async:
res = self.poll_job(res, 'volume') self.poll_job(res, 'volume')
return volume return volume
def update_volume(self, volume): def update_volume(self, volume):
args_resize = {} args_resize = {
args_resize['id'] = volume['id'] 'id': volume['id'],
args_resize['diskofferingid'] = self.get_disk_offering(key='id') 'diskofferingid': self.get_disk_offering(key='id'),
args_resize['maxiops'] = self.module.params.get('max_iops') 'maxiops': self.module.params.get('max_iops'),
args_resize['miniops'] = self.module.params.get('min_iops') 'miniops': self.module.params.get('min_iops'),
args_resize['size'] = self.module.params.get('size') 'size': self.module.params.get('size')
}
# change unit from bytes to giga bytes to compare with args # change unit from bytes to giga bytes to compare with args
volume_copy = volume.copy() volume_copy = volume.copy()
volume_copy['size'] = volume_copy['size'] / (2**30) volume_copy['size'] = volume_copy['size'] / (2**30)
@ -438,9 +385,7 @@ class AnsibleCloudStackVolume(AnsibleCloudStack):
self.result['changed'] = True self.result['changed'] = True
if not self.module.check_mode: if not self.module.check_mode:
args_resize['shrinkok'] = self.module.params.get('shrink_ok') args_resize['shrinkok'] = self.module.params.get('shrink_ok')
res = self.cs.resizeVolume(**args_resize) res = self.query_api('resizeVolume', **args_resize)
if 'errortext' in res:
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
poll_async = self.module.params.get('poll_async') poll_async = self.module.params.get('poll_async')
if poll_async: if poll_async:
volume = self.poll_job(res, 'volume') volume = self.poll_job(res, 'volume')
@ -452,59 +397,53 @@ class AnsibleCloudStackVolume(AnsibleCloudStack):
def main(): def main():
argument_spec = cs_argument_spec() argument_spec = cs_argument_spec()
argument_spec.update(dict( argument_spec.update(dict(
name = dict(required=True), name=dict(required=True),
disk_offering = dict(default=None), disk_offering=dict(),
display_volume = dict(type='bool', default=None), display_volume=dict(type='bool'),
max_iops = dict(type='int', default=None), max_iops=dict(type='int'),
min_iops = dict(type='int', default=None), min_iops=dict(type='int'),
size = dict(type='int', default=None), size=dict(type='int'),
snapshot = dict(default=None), snapshot=dict(),
vm = dict(default=None), vm=dict(),
device_id = dict(type='int', default=None), device_id=dict(type='int'),
custom_id = dict(default=None), custom_id=dict(),
force = dict(type='bool', default=False), force=dict(type='bool', default=False),
shrink_ok = dict(type='bool', default=False), shrink_ok=dict(type='bool', default=False),
state = dict(choices=['present', 'absent', 'attached', 'detached'], default='present'), state=dict(choices=['present', 'absent', 'attached', 'detached'], default='present'),
zone = dict(default=None), zone=dict(),
domain = dict(default=None), domain=dict(),
account = dict(default=None), account=dict(),
project = dict(default=None), project=dict(),
poll_async = dict(type='bool', default=True), poll_async=dict(type='bool', default=True),
tags=dict(type='list', aliases=['tag'], default=None), tags=dict(type='list', aliases=['tag']),
)) ))
module = AnsibleModule( module = AnsibleModule(
argument_spec=argument_spec, argument_spec=argument_spec,
required_together=cs_required_together(), required_together=cs_required_together(),
mutually_exclusive = ( mutually_exclusive=(
['snapshot', 'disk_offering'], ['snapshot', 'disk_offering'],
), ),
supports_check_mode=True supports_check_mode=True
) )
try: acs_vol = AnsibleCloudStackVolume(module)
acs_vol = AnsibleCloudStackVolume(module)
state = module.params.get('state') state = module.params.get('state')
if state in ['absent']: if state in ['absent']:
volume = acs_vol.absent_volume() volume = acs_vol.absent_volume()
elif state in ['attached']: elif state in ['attached']:
volume = acs_vol.attached_volume() volume = acs_vol.attached_volume()
elif state in ['detached']: elif state in ['detached']:
volume = acs_vol.detached_volume() volume = acs_vol.detached_volume()
else: else:
volume = acs_vol.present_volume() volume = acs_vol.present_volume()
result = acs_vol.get_result(volume) result = acs_vol.get_result(volume)
except CloudStackException as e:
module.fail_json(msg='CloudStackException: %s' % str(e))
module.exit_json(**result) module.exit_json(**result)
# import module snippets
from ansible.module_utils.basic import *
if __name__ == '__main__': if __name__ == '__main__':
main() main()

1
test/sanity/pep8/legacy-files.txt
View file

@ -82,7 +82,6 @@ lib/ansible/modules/cloud/cloudstack/cs_securitygroup.py
lib/ansible/modules/cloud/cloudstack/cs_securitygroup_rule.py lib/ansible/modules/cloud/cloudstack/cs_securitygroup_rule.py
lib/ansible/modules/cloud/cloudstack/cs_snapshot_policy.py lib/ansible/modules/cloud/cloudstack/cs_snapshot_policy.py
lib/ansible/modules/cloud/cloudstack/cs_template.py lib/ansible/modules/cloud/cloudstack/cs_template.py
lib/ansible/modules/cloud/cloudstack/cs_volume.py
lib/ansible/modules/cloud/docker/_docker.py lib/ansible/modules/cloud/docker/_docker.py
lib/ansible/modules/cloud/docker/docker_container.py lib/ansible/modules/cloud/docker/docker_container.py
lib/ansible/modules/cloud/docker/docker_image.py lib/ansible/modules/cloud/docker/docker_image.py