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

Interfaces_file - improvements (#3328)

Browse source 
* pythonific!! no camel cases, bitte

* simplified iface attributes parsing

* some improvements, passing tests

* simplified set_interface_option()

* further simplifications

* remove unreachable stmt

* pythonified a file open

* added changelog fragment

* adjustment per PR

* PR: fixed the auto- case

* PR: added testcase and chglog frag for the misleading change report

* extra line removed

* integration is not destructive
This commit is contained in:
Alexei Znamensky 2021-09-19 23:44:37 +12:00 committed by GitHub
parent 8ab96d9533
commit 7aae8d5386
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 123 additions and 105 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
changelogs/fragments/3328-interfaces_file-improvements.yaml Normal file
View file

@ -0,0 +1,4 @@
bugfixes:
- interfaces_file - no longer reporting change when none happened (https://github.com/ansible-collections/community.general/pull/3328).
minor_changes:
- interfaces_file - minor refactor (https://github.com/ansible-collections/community.general/pull/3328).

161
plugins/modules/system/interfaces_file.py
View file

@ -148,57 +148,48 @@ from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.common.text.converters import to_bytes from ansible.module_utils.common.text.converters import to_bytes
def lineDict(line): def line_dict(line):
return {'line': line, 'line_type': 'unknown'} return {'line': line, 'line_type': 'unknown'}
def optionDict(line, iface, option, value, address_family): def make_option_dict(line, iface, option, value, address_family):
return {'line': line, 'iface': iface, 'option': option, 'value': value, 'line_type': 'option', 'address_family': address_family} return {'line': line, 'iface': iface, 'option': option, 'value': value, 'line_type': 'option', 'address_family': address_family}
def getValueFromLine(s): def get_option_value(line):
spaceRe = re.compile(r'\s+') patt = re.compile(r'^\s+(?P<option>\S+)\s+(?P<value>\S?.*\S)\s*$')
for m in spaceRe.finditer(s): match = patt.match(line)
pass if not match:
valueEnd = m.start() return None, None
option = s.split()[0] return match.group("option"), match.group("value")
optionStart = s.find(option)
optionLen = len(option)
valueStart = re.search(r'\s', s[optionLen + optionStart:]).end() + optionLen + optionStart
return s[valueStart:valueEnd]
def read_interfaces_file(module, filename): def read_interfaces_file(module, filename):
f = open(filename, 'r') with open(filename, 'r') as f:
return read_interfaces_lines(module, f) return read_interfaces_lines(module, f)
def _is_line_processing_none(first_word):
return first_word in ("source", "source-dir", "source-directory", "auto", "no-auto-down", "no-scripts") or first_word.startswith("auto-")
def read_interfaces_lines(module, line_strings): def read_interfaces_lines(module, line_strings):
lines = [] lines = []
ifaces = {} ifaces = {}
iface_name = None
address_family = None
currif = {}
currently_processing = None currently_processing = None
i = 0 for i, line in enumerate(line_strings):
for line in line_strings:
i += 1
words = line.split() words = line.split()
if len(words) < 1: if not words or words[0].startswith("#"):
lines.append(lineDict(line)) lines.append(line_dict(line))
continue
if words[0][0] == "#":
lines.append(lineDict(line))
continue continue
if words[0] == "mapping": if words[0] == "mapping":
# currmap = calloc(1, sizeof *currmap); lines.append(line_dict(line))
lines.append(lineDict(line))
currently_processing = "MAPPING" currently_processing = "MAPPING"
elif words[0] == "source": elif _is_line_processing_none(words[0]):
lines.append(lineDict(line)) lines.append(line_dict(line))
currently_processing = "NONE"
elif words[0] == "source-dir":
lines.append(lineDict(line))
currently_processing = "NONE"
elif words[0] == "source-directory":
lines.append(lineDict(line))
currently_processing = "NONE" currently_processing = "NONE"
elif words[0] == "iface": elif words[0] == "iface":
currif = { currif = {
@ -221,39 +212,26 @@ def read_interfaces_lines(module, line_strings):
ifaces[iface_name] = currif ifaces[iface_name] = currif
lines.append({'line': line, 'iface': iface_name, 'line_type': 'iface', 'params': currif, 'address_family': address_family}) lines.append({'line': line, 'iface': iface_name, 'line_type': 'iface', 'params': currif, 'address_family': address_family})
currently_processing = "IFACE" currently_processing = "IFACE"
elif words[0] == "auto":
lines.append(lineDict(line))
currently_processing = "NONE"
elif words[0].startswith("allow-"):
lines.append(lineDict(line))
currently_processing = "NONE"
elif words[0] == "no-auto-down":
lines.append(lineDict(line))
currently_processing = "NONE"
elif words[0] == "no-scripts":
lines.append(lineDict(line))
currently_processing = "NONE"
else: else:
if currently_processing == "IFACE": if currently_processing == "IFACE":
option_name = words[0] option_name, value = get_option_value(line)
# TODO: if option_name in currif.options # TODO: if option_name in currif.options
value = getValueFromLine(line) lines.append(make_option_dict(line, iface_name, option_name, value, address_family))
lines.append(optionDict(line, iface_name, option_name, value, address_family))
if option_name in ["pre-up", "up", "down", "post-up"]: if option_name in ["pre-up", "up", "down", "post-up"]:
currif[option_name].append(value) currif[option_name].append(value)
else: else:
currif[option_name] = value currif[option_name] = value
elif currently_processing == "MAPPING": elif currently_processing == "MAPPING":
lines.append(lineDict(line)) lines.append(line_dict(line))
elif currently_processing == "NONE": elif currently_processing == "NONE":
lines.append(lineDict(line)) lines.append(line_dict(line))
else: else:
module.fail_json(msg="misplaced option %s in line %d" % (line, i)) module.fail_json(msg="misplaced option %s in line %d" % (line, i + 1))
return None, None
return lines, ifaces return lines, ifaces
def setInterfaceOption(module, lines, iface, option, raw_value, state, address_family=None): def set_interface_option(module, lines, iface, option, raw_value, state, address_family=None):
value = str(raw_value) value = str(raw_value)
changed = False changed = False
@ -262,57 +240,54 @@ def setInterfaceOption(module, lines, iface, option, raw_value, state, address_f
iface_lines = [item for item in iface_lines iface_lines = [item for item in iface_lines
if "address_family" in item and item["address_family"] == address_family] if "address_family" in item and item["address_family"] == address_family]
if len(iface_lines) < 1: if not iface_lines:
# interface not found # interface not found
module.fail_json(msg="Error: interface %s not found" % iface) module.fail_json(msg="Error: interface %s not found" % iface)
return changed, None
iface_options = list(filter(lambda i: i['line_type'] == 'option', iface_lines)) iface_options = [il for il in iface_lines if il['line_type'] == 'option']
target_options = list(filter(lambda i: i['option'] == option, iface_options)) target_options = [io for io in iface_options if io['option'] == option]
if state == "present": if state == "present":
if len(target_options) < 1: if not target_options:
changed = True
# add new option # add new option
last_line_dict = iface_lines[-1] last_line_dict = iface_lines[-1]
changed, lines = addOptionAfterLine(option, value, iface, lines, last_line_dict, iface_options, address_family) return add_option_after_line(option, value, iface, lines, last_line_dict, iface_options, address_family)
else:
if option in ["pre-up", "up", "down", "post-up"]: if option in ["pre-up", "up", "down", "post-up"] and all(ito for ito in target_options if ito['value'] != value):
if len(list(filter(lambda i: i['value'] == value, target_options))) < 1: return add_option_after_line(option, value, iface, lines, target_options[-1], iface_options, address_family)
changed, lines = addOptionAfterLine(option, value, iface, lines, target_options[-1], iface_options, address_family)
else: # if more than one option found edit the last one
# if more than one option found edit the last one if target_options[-1]['value'] != value:
if target_options[-1]['value'] != value: changed = True
changed = True target_option = target_options[-1]
target_option = target_options[-1] old_line = target_option['line']
old_line = target_option['line'] old_value = target_option['value']
old_value = target_option['value'] address_family = target_option['address_family']
address_family = target_option['address_family'] prefix_start = old_line.find(option)
prefix_start = old_line.find(option) option_len = len(option)
optionLen = len(option) old_value_position = re.search(r"\s+".join(map(re.escape, old_value.split())), old_line[prefix_start + option_len:])
old_value_position = re.search(r"\s+".join(map(re.escape, old_value.split())), old_line[prefix_start + optionLen:]) start = old_value_position.start() + prefix_start + option_len
start = old_value_position.start() + prefix_start + optionLen end = old_value_position.end() + prefix_start + option_len
end = old_value_position.end() + prefix_start + optionLen line = old_line[:start] + value + old_line[end:]
line = old_line[:start] + value + old_line[end:] index = len(lines) - lines[::-1].index(target_option) - 1
index = len(lines) - lines[::-1].index(target_option) - 1 lines[index] = make_option_dict(line, iface, option, value, address_family)
lines[index] = optionDict(line, iface, option, value, address_family) return changed, lines
elif state == "absent":
if len(target_options) >= 1: if state == "absent":
if target_options:
if option in ["pre-up", "up", "down", "post-up"] and value is not None and value != "None": if option in ["pre-up", "up", "down", "post-up"] and value is not None and value != "None":
for target_option in filter(lambda i: i['value'] == value, target_options): for target_option in [ito for ito in target_options if ito['value'] == value]:
changed = True changed = True
lines = list(filter(lambda ln: ln != target_option, lines)) lines = [ln for ln in lines if ln != target_option]
else: else:
changed = True changed = True
for target_option in target_options: for target_option in target_options:
lines = list(filter(lambda ln: ln != target_option, lines)) lines = [ln for ln in lines if ln != target_option]
else:
module.fail_json(msg="Error: unsupported state %s, has to be either present or absent" % state)
return changed, lines return changed, lines
def addOptionAfterLine(option, value, iface, lines, last_line_dict, iface_options, address_family): def add_option_after_line(option, value, iface, lines, last_line_dict, iface_options, address_family):
# Changing method of interface is not an addition # Changing method of interface is not an addition
if option == 'method': if option == 'method':
changed = False changed = False
@ -328,23 +303,21 @@ def addOptionAfterLine(option, value, iface, lines, last_line_dict, iface_option
suffix_start = last_line.rfind(last_line.split()[-1]) + len(last_line.split()[-1]) suffix_start = last_line.rfind(last_line.split()[-1]) + len(last_line.split()[-1])
prefix = last_line[:prefix_start] prefix = last_line[:prefix_start]
if len(iface_options) < 1: if not iface_options:
# interface has no options, ident # interface has no options, ident
prefix += " " prefix += " "
line = prefix + "%s %s" % (option, value) + last_line[suffix_start:] line = prefix + "%s %s" % (option, value) + last_line[suffix_start:]
option_dict = optionDict(line, iface, option, value, address_family) option_dict = make_option_dict(line, iface, option, value, address_family)
index = len(lines) - lines[::-1].index(last_line_dict) index = len(lines) - lines[::-1].index(last_line_dict)
lines.insert(index, option_dict) lines.insert(index, option_dict)
return True, lines return True, lines
def write_changes(module, lines, dest): def write_changes(module, lines, dest):
tmpfd, tmpfile = tempfile.mkstemp() tmpfd, tmpfile = tempfile.mkstemp()
f = os.fdopen(tmpfd, 'wb') with os.fdopen(tmpfd, 'wb') as f:
f.write(to_bytes(''.join(lines), errors='surrogate_or_strict')) f.write(to_bytes(''.join(lines), errors='surrogate_or_strict'))
f.close()
module.atomic_move(tmpfile, os.path.realpath(dest)) module.atomic_move(tmpfile, os.path.realpath(dest))
@ -382,7 +355,7 @@ def main():
changed = False changed = False
if option is not None: if option is not None:
changed, lines = setInterfaceOption(module, lines, iface, option, value, state, address_family) changed, lines = set_interface_option(module, lines, iface, option, value, state, address_family)
if changed: if changed:
dummy, ifaces = read_interfaces_lines(module, [d['line'] for d in lines if 'line' in d]) dummy, ifaces = read_interfaces_lines(module, [d['line'] for d in lines if 'line' in d])

1
tests/integration/targets/interfaces_file/aliases Normal file
View file

@ -0,0 +1 @@
shippable/posix/group2

7
tests/integration/targets/interfaces_file/files/interfaces_ff Normal file
View file

@ -0,0 +1,7 @@
iface eno1 inet static
address 1.2.3.4
netmask 255.255.255.0
gateway 1.2.3.1
up route add -net 1.2.3.4 netmask 255.255.255.0 gw 1.2.3.1 eno1
up ip addr add 4.3.2.1/32 dev eno1
down ip addr add 4.3.2.1/32 dev eno1

33
tests/integration/targets/interfaces_file/tasks/main.yml Normal file
View file

@ -0,0 +1,33 @@
---
- name:
set_fact:
interfaces_testfile: '{{ output_dir }}/interfaces'
- name: Copy interfaces file
copy:
src: 'files/interfaces_ff'
dest: '{{ interfaces_testfile }}'
- name: Change IP address to 1.2.3.5
community.general.interfaces_file:
dest: "{{ interfaces_testfile }}"
iface: eno1
option: address
value: 1.2.3.5
register: ifile_1
- assert:
that:
- ifile_1 is changed
- name: Change IP address to 1.2.3.5 again
community.general.interfaces_file:
dest: "{{ interfaces_testfile }}"
iface: eno1
option: address
value: 1.2.3.5
register: ifile_2
- assert:
that:
- ifile_2 is not changed

22
tests/unit/plugins/modules/system/interfaces_file/test_interfaces_file.py
View file

@ -24,7 +24,7 @@ class AnsibleFailJson(Exception):
pass pass
class ModuleMocked(): class ModuleMocked:
def atomic_move(self, src, dst): def atomic_move(self, src, dst):
move(src, dst) move(src, dst)
@ -148,8 +148,8 @@ class TestInterfacesFileModule(unittest.TestCase):
fail_json_iterations = [] fail_json_iterations = []
for i, options in enumerate(options_list): for i, options in enumerate(options_list):
try: try:
dummy, lines = interfaces_file.setInterfaceOption(module, lines, options['iface'], options['option'], dummy, lines = interfaces_file.set_interface_option(module, lines, options['iface'], options['option'],
options['value'], options['state']) options['value'], options['state'])
except AnsibleFailJson as e: except AnsibleFailJson as e:
fail_json_iterations.append("[%d] fail_json message: %s\noptions:\n%s" % fail_json_iterations.append("[%d] fail_json message: %s\noptions:\n%s" %
(i, str(e), json.dumps(options, sort_keys=True, indent=4, separators=(',', ': ')))) (i, str(e), json.dumps(options, sort_keys=True, indent=4, separators=(',', ': '))))
@ -181,8 +181,8 @@ class TestInterfacesFileModule(unittest.TestCase):
fail_json_iterations = [] fail_json_iterations = []
options['state'] = state options['state'] = state
try: try:
dummy, lines = interfaces_file.setInterfaceOption(module, lines, dummy, lines = interfaces_file.set_interface_option(module, lines,
options['iface'], options['option'], options['value'], options['state']) options['iface'], options['option'], options['value'], options['state'])
except AnsibleFailJson as e: except AnsibleFailJson as e:
fail_json_iterations.append("fail_json message: %s\noptions:\n%s" % fail_json_iterations.append("fail_json message: %s\noptions:\n%s" %
(str(e), json.dumps(options, sort_keys=True, indent=4, separators=(',', ': ')))) (str(e), json.dumps(options, sort_keys=True, indent=4, separators=(',', ': '))))
@ -216,12 +216,12 @@ class TestInterfacesFileModule(unittest.TestCase):
options = options_list[0] options = options_list[0]
fail_json_iterations = [] fail_json_iterations = []
try: try:
changed, lines = interfaces_file.setInterfaceOption(module, lines, options['iface'], options['option'], changed, lines = interfaces_file.set_interface_option(module, lines, options['iface'], options['option'],
options['value'], options['state']) options['value'], options['state'])
# When a changed is made try running it again for proper idempotency # When a changed is made try running it again for proper idempotency
if changed: if changed:
changed_again, lines = interfaces_file.setInterfaceOption(module, lines, options['iface'], changed_again, lines = interfaces_file.set_interface_option(module, lines, options['iface'],
options['option'], options['value'], options['state']) options['option'], options['value'], options['state'])
self.assertFalse(changed_again, self.assertFalse(changed_again,
msg='Second request for change should return false for {0} running on {1}'.format(testname, msg='Second request for change should return false for {0} running on {1}'.format(testname,
testfile)) testfile))
@ -305,8 +305,8 @@ class TestInterfacesFileModule(unittest.TestCase):
options = options_list[0] options = options_list[0]
fail_json_iterations = [] fail_json_iterations = []
try: try:
dummy, lines = interfaces_file.setInterfaceOption(module, lines, options['iface'], options['option'], dummy, lines = interfaces_file.set_interface_option(module, lines, options['iface'], options['option'],
options['value'], options['state'], options['address_family']) options['value'], options['state'], options['address_family'])
except AnsibleFailJson as e: except AnsibleFailJson as e:
fail_json_iterations.append("fail_json message: %s\noptions:\n%s" % fail_json_iterations.append("fail_json message: %s\noptions:\n%s" %
(str(e), json.dumps(options, sort_keys=True, indent=4, separators=(',', ': ')))) (str(e), json.dumps(options, sort_keys=True, indent=4, separators=(',', ': '))))