systemd: PEP8 compliancy and doc fixes (#30892)

This PR includes:
- PEP8 compliancy fixes
- Documentation fixes
This commit is contained in:
Dag Wieers 2017-10-30 01:04:57 +01:00 committed by GitHub
parent 8b2bf09c49
commit 63edeb1644
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 45 deletions

View file

@ -1,77 +1,66 @@
#!/usr/bin/python #!/usr/bin/python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# (c) 2016, Brian Coca <bcoca@ansible.com>
# Copyright: (c) 2016, Brian Coca <bcoca@ansible.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # 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 from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1', ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['stableinterface'], 'status': ['stableinterface'],
'supported_by': 'core'} 'supported_by': 'core'}
DOCUMENTATION = ''' DOCUMENTATION = '''
module: systemd module: systemd
author: author:
- "Ansible Core Team" - Ansible Core Team
version_added: "2.2" version_added: "2.2"
short_description: Manage services. short_description: Manage services
description: description:
- Controls systemd services on remote hosts. - Controls systemd services on remote hosts.
options: options:
name: name:
required: false
description: description:
- Name of the service. When using in a chroot environment you always need to specify the full name i.e. (crond.service). - Name of the service. When using in a chroot environment you always need to specify the full name i.e. (crond.service).
aliases: ['unit', 'service'] aliases: [ service, unit ]
state: state:
required: false
default: null
choices: [ 'started', 'stopped', 'restarted', 'reloaded' ]
description: description:
- C(started)/C(stopped) are idempotent actions that will not run commands unless necessary. - C(started)/C(stopped) are idempotent actions that will not run commands unless necessary.
C(restarted) will always bounce the service. C(reloaded) will always reload. C(restarted) will always bounce the service. C(reloaded) will always reload.
choices: [ reloaded, restarted, started, stopped ]
enabled: enabled:
required: false
choices: [ "yes", "no" ]
default: null
description: description:
- Whether the service should start on boot. B(At least one of state and enabled are required.) - Whether the service should start on boot. B(At least one of state and enabled are required.)
type: bool
masked: masked:
required: false
choices: [ "yes", "no" ]
default: null
description: description:
- Whether the unit should be masked or not, a masked unit is impossible to start. - Whether the unit should be masked or not, a masked unit is impossible to start.
type: bool
daemon_reload: daemon_reload:
required: false
default: no
choices: [ "yes", "no" ]
description: description:
- run daemon-reload before doing any other operations, to make sure systemd has read any changes. - run daemon-reload before doing any other operations, to make sure systemd has read any changes.
aliases: ['daemon-reload'] type: bool
default: 'no'
aliases: [ daemon-reload ]
user: user:
required: false
default: no
choices: [ "yes", "no" ]
description: description:
- run systemctl talking to the service manager of the calling user, rather than the service manager - run systemctl talking to the service manager of the calling user, rather than the service manager
of the system. of the system.
type: bool
default: 'no'
no_block: no_block:
required: false
default: no
choices: [ "yes", "no" ]
description: description:
- Do not synchronously wait for the requested operation to finish. - Do not synchronously wait for the requested operation to finish.
Enqueued job will continue without Ansible blocking on its completion. Enqueued job will continue without Ansible blocking on its completion.
type: bool
default: 'no'
version_added: "2.3" version_added: "2.3"
notes: notes:
- Since 2.4, one of the following options is required 'state', 'enabled', 'masked', 'daemon_reload', and all except 'daemon_reload' also require 'name'. - Since 2.4, one of the following options is required 'state', 'enabled', 'masked', 'daemon_reload', and all except 'daemon_reload' also require 'name'.
- Before 2.4 you always required 'name'. - Before 2.4 you always required 'name'.
requirements: requirements:
- A system managed by systemd - A system managed by systemd.
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -246,9 +235,11 @@ from ansible.module_utils._text import to_native
def is_running_service(service_status): def is_running_service(service_status):
return service_status['ActiveState'] in set(['active', 'activating']) return service_status['ActiveState'] in set(['active', 'activating'])
def request_was_ignored(out): def request_was_ignored(out):
return '=' not in out and 'ignoring request' in out return '=' not in out and 'ignoring request' in out
def parse_systemctl_show(lines): def parse_systemctl_show(lines):
# The output of 'systemctl show' can contain values that span multiple lines. At first glance it # The output of 'systemctl show' can contain values that span multiple lines. At first glance it
# appears that such values are always surrounded by {}, so the previous version of this code # appears that such values are always surrounded by {}, so the previous version of this code
@ -291,8 +282,8 @@ def main():
# initialize # initialize
module = AnsibleModule( module = AnsibleModule(
argument_spec=dict( argument_spec=dict(
name = dict(aliases=['unit', 'service']), name=dict(type='str', aliases=['service', 'unit']),
state = dict(choices=[ 'started', 'stopped', 'restarted', 'reloaded'], type='str'), state=dict(type='str', choices=['reloaded,' 'restarted', 'started', 'stopped']),
enabled=dict(type='bool'), enabled=dict(type='bool'),
masked=dict(type='bool'), masked=dict(type='bool'),
daemon_reload=dict(type='bool', default=False, aliases=['daemon-reload']), daemon_reload=dict(type='bool', default=False, aliases=['daemon-reload']),
@ -311,11 +302,11 @@ def main():
unit = module.params['name'] unit = module.params['name']
rc = 0 rc = 0
out = err = '' out = err = ''
result = { result = dict(
'name': unit, name=unit,
'changed': False, changed=False,
'status': {}, status=dict(),
} )
for requires in ('state', 'enabled', 'masked'): for requires in ('state', 'enabled', 'masked'):
if module.params[requires] is not None and unit is None: if module.params[requires] is not None and unit is None:
@ -379,7 +370,6 @@ def main():
# some versions of system CAN mask/unmask non existing services, we only fail on missing if they don't # some versions of system CAN mask/unmask non existing services, we only fail on missing if they don't
fail_if_missing(module, found, unit, msg='host') fail_if_missing(module, found, unit, msg='host')
# Enable/disable service startup at boot if requested # Enable/disable service startup at boot if requested
if module.params['enabled'] is not None: if module.params['enabled'] is not None:
@ -451,8 +441,8 @@ def main():
# this should not happen? # this should not happen?
module.fail_json(msg="Service is in unknown state", status=result['status']) module.fail_json(msg="Service is in unknown state", status=result['status'])
module.exit_json(**result) module.exit_json(**result)
if __name__ == '__main__': if __name__ == '__main__':
main() main()

View file

@ -360,7 +360,6 @@ lib/ansible/modules/system/runit.py
lib/ansible/modules/system/seport.py lib/ansible/modules/system/seport.py
lib/ansible/modules/system/solaris_zone.py lib/ansible/modules/system/solaris_zone.py
lib/ansible/modules/system/svc.py lib/ansible/modules/system/svc.py
lib/ansible/modules/system/systemd.py
lib/ansible/modules/system/timezone.py lib/ansible/modules/system/timezone.py
lib/ansible/modules/system/ufw.py lib/ansible/modules/system/ufw.py
lib/ansible/modules/system/user.py lib/ansible/modules/system/user.py