ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-25 20:01:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Add check for correct parsing of sysctl (#24540)

Browse source 
* PEP8 fixes
* Refactoring of code
* Check to skip non-comment lines which doesn't
  contain = character

Fixes #24453

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde 2017-08-19 01:01:26 +05:30 • committed by ansibot
parent 2f732a621d
commit be86d77a70
2 changed files with 24 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

48
lib/ansible/modules/system/sysctl.py
View file

@ -111,6 +111,7 @@ import tempfile
from ansible.module_utils.basic import get_platform, AnsibleModule from ansible.module_utils.basic import get_platform, AnsibleModule
from ansible.module_utils.six import string_types from ansible.module_utils.six import string_types
from ansible.module_utils.parsing.convert_bool import BOOLEANS_FALSE, BOOLEANS_TRUE from ansible.module_utils.parsing.convert_bool import BOOLEANS_FALSE, BOOLEANS_TRUE
from ansible.module_utils._text import to_native
class SysctlModule(object): class SysctlModule(object):
@ -129,7 +130,7 @@ class SysctlModule(object):
self.changed = False # will change occur self.changed = False # will change occur
self.set_proc = False # does sysctl need to set value self.set_proc = False # does sysctl need to set value
self.write_file = False # does the sysctl file need to be reloaded self.write_file = False # does the sysctl file need to be reloaded
self.process() self.process()
@ -229,7 +230,7 @@ class SysctlModule(object):
thiscmd = "%s -n %s" % (self.sysctl_cmd, token) thiscmd = "%s -n %s" % (self.sysctl_cmd, token)
else: else:
thiscmd = "%s -e -n %s" % (self.sysctl_cmd, token) thiscmd = "%s -e -n %s" % (self.sysctl_cmd, token)
rc,out,err = self.module.run_command(thiscmd) rc, out, err = self.module.run_command(thiscmd)
if rc != 0: if rc != 0:
return None return None
else: else:
@ -253,7 +254,7 @@ class SysctlModule(object):
if self.args['ignoreerrors']: if self.args['ignoreerrors']:
ignore_missing = '-e' ignore_missing = '-e'
thiscmd = "%s %s -w %s=%s" % (self.sysctl_cmd, ignore_missing, token, value) thiscmd = "%s %s -w %s=%s" % (self.sysctl_cmd, ignore_missing, token, value)
rc,out,err = self.module.run_command(thiscmd) rc, out, err = self.module.run_command(thiscmd)
if rc != 0: if rc != 0:
self.module.fail_json(msg='setting %s failed: %s' % (token, out + err)) self.module.fail_json(msg='setting %s failed: %s' % (token, out + err))
else: else:
@ -264,7 +265,7 @@ class SysctlModule(object):
# do it # do it
if self.platform == 'freebsd': if self.platform == 'freebsd':
# freebsd doesn't support -p, so reload the sysctl service # freebsd doesn't support -p, so reload the sysctl service
rc,out,err = self.module.run_command('/etc/rc.d/sysctl reload') rc, out, err = self.module.run_command('/etc/rc.d/sysctl reload')
elif self.platform == 'openbsd': elif self.platform == 'openbsd':
# openbsd doesn't support -p and doesn't have a sysctl service, # openbsd doesn't support -p and doesn't have a sysctl service,
# so we have to set every value with its own sysctl call # so we have to set every value with its own sysctl call
@ -282,7 +283,7 @@ class SysctlModule(object):
if self.args['ignoreerrors']: if self.args['ignoreerrors']:
sysctl_args.insert(1, '-e') sysctl_args.insert(1, '-e')
rc,out,err = self.module.run_command(sysctl_args) rc, out, err = self.module.run_command(sysctl_args)
if rc != 0: if rc != 0:
self.module.fail_json(msg="Failed to reload sysctl: %s" % str(out) + str(err)) self.module.fail_json(msg="Failed to reload sysctl: %s" % str(out) + str(err))
@ -297,21 +298,20 @@ class SysctlModule(object):
lines = [] lines = []
if os.path.isfile(self.sysctl_file): if os.path.isfile(self.sysctl_file):
try: try:
f = open(self.sysctl_file, "r") with open(self.sysctl_file, "r") as read_file:
lines = f.readlines() lines = read_file.readlines()
f.close()
except IOError as e: except IOError as e:
self.module.fail_json(msg="Failed to open %s: %s" % (self.sysctl_file, str(e))) self.module.fail_json(msg="Failed to open %s: %s" % (self.sysctl_file, to_native(e)))
for line in lines: for line in lines:
line = line.strip() line = line.strip()
self.file_lines.append(line) self.file_lines.append(line)
# don't split empty lines or comments # don't split empty lines or comments or line without equal sign
if not line or line.startswith(("#", ";")): if not line or line.startswith(("#", ";")) or "=" not in line:
continue continue
k, v = line.split('=',1) k, v = line.split('=', 1)
k = k.strip() k = k.strip()
v = v.strip() v = v.strip()
self.file_values[k] = v.strip() self.file_values[k] = v.strip()
@ -321,11 +321,11 @@ class SysctlModule(object):
checked = [] checked = []
self.fixed_lines = [] self.fixed_lines = []
for line in self.file_lines: for line in self.file_lines:
if not line.strip() or line.strip().startswith(("#", ";")): if not line.strip() or line.strip().startswith(("#", ";")) or "=" not in line:
self.fixed_lines.append(line) self.fixed_lines.append(line)
continue continue
tmpline = line.strip() tmpline = line.strip()
k, v = tmpline.split('=',1) k, v = tmpline.split('=', 1)
k = k.strip() k = k.strip()
v = v.strip() v = v.strip()
if k not in checked: if k not in checked:
@ -346,12 +346,12 @@ class SysctlModule(object):
def write_sysctl(self): def write_sysctl(self):
# open a tmp file # open a tmp file
fd, tmp_path = tempfile.mkstemp('.conf', '.ansible_m_sysctl_', os.path.dirname(self.sysctl_file)) fd, tmp_path = tempfile.mkstemp('.conf', '.ansible_m_sysctl_', os.path.dirname(self.sysctl_file))
f = open(tmp_path,"w") f = open(tmp_path, "w")
try: try:
for l in self.fixed_lines: for l in self.fixed_lines:
f.write(l.strip() + "\n") f.write(l.strip() + "\n")
except IOError as e: except IOError as e:
self.module.fail_json(msg="Failed to write to file %s: %s" % (tmp_path, str(e))) self.module.fail_json(msg="Failed to write to file %s: %s" % (tmp_path, to_native(e)))
f.flush() f.flush()
f.close() f.close()
@ -366,14 +366,14 @@ def main():
# defining module # defining module
module = AnsibleModule( module = AnsibleModule(
argument_spec = dict( argument_spec=dict(
name = dict(aliases=['key'], required=True), name=dict(aliases=['key'], required=True),
value = dict(aliases=['val'], required=False, type='str'), value=dict(aliases=['val'], required=False, type='str'),
state = dict(default='present', choices=['present', 'absent']), state=dict(default='present', choices=['present', 'absent']),
reload = dict(default=True, type='bool'), reload=dict(default=True, type='bool'),
sysctl_set = dict(default=False, type='bool'), sysctl_set=dict(default=False, type='bool'),
ignoreerrors = dict(default=False, type='bool'), ignoreerrors=dict(default=False, type='bool'),
sysctl_file = dict(default='/etc/sysctl.conf', type='path') sysctl_file=dict(default='/etc/sysctl.conf', type='path')
), ),
supports_check_mode=True, supports_check_mode=True,
required_if=[('state', 'present', ['value'])], required_if=[('state', 'present', ['value'])],

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

@ -460,7 +460,6 @@ lib/ansible/modules/system/seport.py
lib/ansible/modules/system/service.py lib/ansible/modules/system/service.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/sysctl.py
lib/ansible/modules/system/systemd.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