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

Interfaces file spaces fix (#6131)

* interfaces_file: added test case for #6120

* interfaces_file: reverted code to #fafabed

* interfaces_file: added changelog fragment

* interfaces_file: added missing licenses

* interfaces_file: improved test coverage

* interfaces_file: fixed retrieving option values

* Update plugins/modules/interfaces_file.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/interfaces_file.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update tests/unit/plugins/modules/interfaces_file/test_interfaces_file.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/interfaces_file.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/interfaces_file.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/interfaces_file.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/interfaces_file.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/interfaces_file.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/interfaces_file.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update tests/unit/plugins/modules/interfaces_file/test_interfaces_file.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* interfaces_file: spacing fix

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Roman Belyakovsky 2023-03-09 21:09:13 +02:00 committed by GitHub
parent 6b8a1cd8e6
commit abcba9dbbe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
93 changed files with 995 additions and 63 deletions

View file

@ -0,0 +1,2 @@
bugfixes:
- interfaces_file - fix reading options in lines not starting with a space (https://github.com/ansible-collections/community.general/issues/6120).

View file

@ -156,20 +156,22 @@ 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 line_dict(line): def lineDict(line):
return {'line': line, 'line_type': 'unknown'} return {'line': line, 'line_type': 'unknown'}
def make_option_dict(line, iface, option, value, address_family): def optionDict(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 get_option_value(line): def getValueFromLine(s):
patt = re.compile(r'^\s+(?P<option>\S+)\s+(?P<value>\S?.*\S)\s*$') spaceRe = re.compile(r'\s+')
match = patt.match(line) m = list(spaceRe.finditer(s))[-1]
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)
return s[optionLen + optionStart:].strip()
def read_interfaces_file(module, filename): def read_interfaces_file(module, filename):
@ -177,27 +179,32 @@ def read_interfaces_file(module, filename):
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
for i, line in enumerate(line_strings): i = 0
for line in line_strings:
i += 1
words = line.split() words = line.split()
if not words or words[0].startswith("#"): if len(words) < 1:
lines.append(line_dict(line)) lines.append(lineDict(line))
continue
if words[0][0] == "#":
lines.append(lineDict(line))
continue continue
if words[0] == "mapping": if words[0] == "mapping":
lines.append(line_dict(line)) # currmap = calloc(1, sizeof *currmap);
lines.append(lineDict(line))
currently_processing = "MAPPING" currently_processing = "MAPPING"
elif _is_line_processing_none(words[0]): elif words[0] == "source":
lines.append(line_dict(line)) lines.append(lineDict(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 = {
@ -220,25 +227,57 @@ 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, value = get_option_value(line) option_name = words[0]
# 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(line_dict(line)) lines.append(lineDict(line))
elif currently_processing == "NONE": elif currently_processing == "NONE":
lines.append(line_dict(line)) lines.append(lineDict(line))
else: else:
module.fail_json(msg="misplaced option %s in line %d" % (line, i + 1)) module.fail_json(msg="misplaced option %s in line %d" % (line, i))
return None, None
return lines, ifaces return lines, ifaces
def get_interface_options(iface_lines):
return [i for i in iface_lines if i['line_type'] == 'option']
def get_target_options(iface_options, option):
return [i for i in iface_options if i['option'] == option]
def update_existing_option_line(target_option, value):
old_line = target_option['line']
old_value = target_option['value']
prefix_start = old_line.find(target_option["option"])
optionLen = len(target_option["option"])
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 + optionLen
end = old_value_position.end() + prefix_start + optionLen
line = old_line[:start] + value + old_line[end:]
return line
def set_interface_option(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
@ -248,41 +287,35 @@ def set_interface_option(module, lines, iface, option, raw_value, state, address
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 not iface_lines: if len(iface_lines) < 1:
# 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 = [il for il in iface_lines if il['line_type'] == 'option'] iface_options = get_interface_options(iface_lines)
target_options = [io for io in iface_options if io['option'] == option] target_options = get_target_options(iface_options, option)
if state == "present": if state == "present":
if not target_options: if len(target_options) < 1:
changed = True
# add new option # add new option
last_line_dict = iface_lines[-1] last_line_dict = iface_lines[-1]
return add_option_after_line(option, value, iface, lines, last_line_dict, iface_options, address_family) changed, lines = addOptionAfterLine(option, value, iface, lines, last_line_dict, iface_options, address_family)
else:
if option in ["pre-up", "up", "down", "post-up"] and all(ito['value'] != value for ito in target_options): if option in ["pre-up", "up", "down", "post-up"]:
return add_option_after_line(option, value, iface, lines, target_options[-1], iface_options, address_family) if len(list(filter(lambda i: i['value'] == value, target_options))) < 1:
changed, lines = addOptionAfterLine(option, value, iface, lines, target_options[-1], iface_options, address_family)
# if more than one option found edit the last one else:
if target_options[-1]['value'] != value: # if more than one option found edit the last one
changed = True if target_options[-1]['value'] != value:
target_option = target_options[-1] changed = True
old_line = target_option['line'] target_option = target_options[-1]
old_value = target_option['value'] line = update_existing_option_line(target_option, value)
address_family = target_option['address_family'] address_family = target_option['address_family']
prefix_start = old_line.find(option) index = len(lines) - lines[::-1].index(target_option) - 1
option_len = len(option) lines[index] = optionDict(line, iface, option, value, address_family)
old_value_position = re.search(r"\s+".join(map(re.escape, old_value.split())), old_line[prefix_start + option_len:]) elif state == "absent":
start = old_value_position.start() + prefix_start + option_len if len(target_options) >= 1:
end = old_value_position.end() + prefix_start + option_len
line = old_line[:start] + value + old_line[end:]
index = len(lines) - lines[::-1].index(target_option) - 1
lines[index] = make_option_dict(line, iface, option, value, address_family)
return changed, lines
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 [ito for ito in target_options if ito['value'] == value]: for target_option in [ito for ito in target_options if ito['value'] == value]:
changed = True changed = True
@ -291,11 +324,13 @@ def set_interface_option(module, lines, iface, option, raw_value, state, address
changed = True changed = True
for target_option in target_options: for target_option in target_options:
lines = [ln for ln in lines if ln != target_option] 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 add_option_after_line(option, value, iface, lines, last_line_dict, iface_options, address_family): def addOptionAfterLine(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
@ -311,18 +346,19 @@ def add_option_after_line(option, value, iface, lines, last_line_dict, iface_opt
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 not iface_options: if len(iface_options) < 1:
# 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 = make_option_dict(line, iface, option, value, address_family) option_dict = optionDict(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()
with os.fdopen(tmpfd, 'wb') as f: 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'))

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,8 @@
[0] fail_json message: Error: interface aggi not found
options:
{
"iface": "aggi",
"option": "up",
"state": "present",
"value": "route add -net 224.0.0.0 netmask 240.0.0.0 dev aggi"
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,17 @@
[0] fail_json message: Error: interface aggi not found
options:
{
"iface": "aggi",
"option": "up",
"state": "present",
"value": "route add -net 224.0.0.0 netmask 240.0.0.0 dev aggi"
}
=====
[1] fail_json message: Error: interface aggi not found
options:
{
"iface": "aggi",
"option": "up",
"state": "present",
"value": "route add -net 224.0.0.0 netmask 240.0.0.0 dev aggi"
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,17 @@
[0] fail_json message: Error: interface aggi not found
options:
{
"iface": "aggi",
"option": "up",
"state": "present",
"value": "route add -net 224.0.0.0 netmask 240.0.0.0 dev aggi"
}
=====
[1] fail_json message: Error: interface aggi not found
options:
{
"iface": "aggi",
"option": "up",
"state": "absent",
"value": null
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,17 @@
[0] fail_json message: Error: interface aggi not found
options:
{
"iface": "aggi",
"option": "up",
"state": "absent",
"value": null
}
=====
[1] fail_json message: Error: interface aggi not found
options:
{
"iface": "aggi",
"option": "up",
"state": "present",
"value": "route add -net 224.0.0.0 netmask 240.0.0.0 dev aggi"
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 192.168.0.42
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,9 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500
post-up XXXX_ipv4

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,9 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500
pre-up XXXX_ipv4

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,9 @@
fail_json message: Error: interface eth0 not found
options:
{
"address_family": "inet6",
"iface": "eth0",
"option": "address",
"state": "present",
"value": "fc00::42"
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,9 @@
fail_json message: Error: interface eth0 not found
options:
{
"address_family": "inet6",
"iface": "eth0",
"option": "post-up",
"state": "present",
"value": "XXXX_ipv6"
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,9 @@
fail_json message: Error: interface eth0 not found
options:
{
"address_family": "inet6",
"iface": "eth0",
"option": "pre-up",
"state": "present",
"value": "XXXX_ipv6"
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,8 @@
fail_json message: Error: interface eth1 not found
options:
{
"iface": "eth1",
"option": "method",
"state": "present",
"value": "dhcp"
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,7 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1350

View file

@ -0,0 +1,8 @@
[0] fail_json message: Error: interface aggi not found
options:
{
"iface": "aggi",
"option": "mtu",
"state": "present",
"value": "1350"
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,8 @@
[0] fail_json message: Error: interface aggi not found
options:
{
"iface": "aggi",
"option": "slaves",
"state": "present",
"value": "int1 int3"
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,21 @@
{
"eth0": {
"address": "10.0.0.1",
"address_family": "inet",
"down": [],
"method": "static",
"mtu": "1500",
"netmask": "255.255.255.0",
"post-up": [],
"pre-up": [],
"up": []
},
"lo": {
"address_family": "inet",
"down": [],
"method": "loopback",
"post-up": [],
"pre-up": [],
"up": []
}
}

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -0,0 +1,8 @@
iface lo inet loopback
auto lo
auto eth0
iface eth0 inet static
address 10.0.0.1
netmask 255.255.255.0
mtu 1500

View file

@ -0,0 +1,3 @@
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: Ansible Project

View file

@ -44,6 +44,8 @@ golden_output_path = os.path.join(os.path.dirname(__file__), 'interfaces_file_fi
class TestInterfacesFileModule(unittest.TestCase): class TestInterfacesFileModule(unittest.TestCase):
unittest.TestCase.maxDiff = None
def getTestFiles(self, include_filter=None, exclude_filter=None): def getTestFiles(self, include_filter=None, exclude_filter=None):
flist = next(os.walk(fixture_path))[2] flist = next(os.walk(fixture_path))[2]
flist = [file for file in flist if not file.endswith('.license')] flist = [file for file in flist if not file.endswith('.license')]
@ -73,10 +75,22 @@ class TestInterfacesFileModule(unittest.TestCase):
def compareInterfacesToFile(self, ifaces, path, testname=None): def compareInterfacesToFile(self, ifaces, path, testname=None):
if not testname: if not testname:
testname = "%s.%s.json" % (path, inspect.stack()[1][3]) testname = "%s.%s.json" % (path, inspect.stack()[1][3])
self.compareStringWithFile(json.dumps(ifaces, sort_keys=True, indent=4, separators=(',', ': ')), testname)
testfilepath = os.path.join(golden_output_path, testname)
string = json.dumps(ifaces, sort_keys=True, indent=4, separators=(',', ': '))
if string and not string.endswith('\n'):
string += '\n'
goldenstring = string
goldenData = ifaces
if not os.path.isfile(testfilepath):
with io.open(testfilepath, 'wb') as f:
f.write(string.encode())
else:
with open(testfilepath, 'r') as goldenfile:
goldenData = json.load(goldenfile)
self.assertEqual(goldenData, ifaces)
def compareStringWithFile(self, string, path): def compareStringWithFile(self, string, path):
# self.assertEqual("","_",msg=path)
testfilepath = os.path.join(golden_output_path, path) testfilepath = os.path.join(golden_output_path, path)
if string and not string.endswith('\n'): if string and not string.endswith('\n'):
string += '\n' string += '\n'
@ -89,7 +103,7 @@ class TestInterfacesFileModule(unittest.TestCase):
with open(testfilepath, 'r') as goldenfile: with open(testfilepath, 'r') as goldenfile:
goldenstring = goldenfile.read() goldenstring = goldenfile.read()
goldenfile.close() goldenfile.close()
self.assertEqual(string, goldenstring) self.assertEqual(goldenstring, string)
def test_no_changes(self): def test_no_changes(self):
for testfile in self.getTestFiles(): for testfile in self.getTestFiles():
@ -224,7 +238,9 @@ class TestInterfacesFileModule(unittest.TestCase):
self.compareInterfacesLinesToFile(lines, testfile, "%s_%s" % (testfile, testname)) self.compareInterfacesLinesToFile(lines, testfile, "%s_%s" % (testfile, testname))
self.compareInterfacesToFile(ifaces, testfile, "%s_%s.json" % (testfile, testname)) self.compareInterfacesToFile(ifaces, testfile, "%s_%s.json" % (testfile, testname))
self.compareFileToBackup(path, backupp) if testfile not in ["no_leading_spaces"]:
# skip if eth0 has MTU value
self.compareFileToBackup(path, backupp)
def test_change_method(self): def test_change_method(self):
testcases = { testcases = {
@ -269,6 +285,195 @@ class TestInterfacesFileModule(unittest.TestCase):
# Restore backup # Restore backup
move(backupp, path) move(backupp, path)
def test_getValueFromLine(self):
testcases = [
{
"line": " address 1.2.3.5",
"value": "1.2.3.5",
}
]
for testcase in testcases:
value = interfaces_file.getValueFromLine(testcase["line"])
self.assertEqual(testcase["value"], value)
def test_get_interface_options(self):
testcases = {
"basic": {
"iface_lines": [
{
"address_family": "inet",
"iface": "eno1",
"line": "iface eno1 inet static",
"line_type": "iface",
"params": {
"address": "",
"address_family": "inet",
"down": [],
"gateway": "",
"method": "static",
"netmask": "",
"post-up": [],
"pre-up": [],
"up": []
}
},
{
"address_family": "inet",
"iface": "eno1",
"line": " address 1.2.3.5",
"line_type": "option",
"option": "address",
"value": "1.2.3.5"
},
{
"address_family": "inet",
"iface": "eno1",
"line": " netmask 255.255.255.0",
"line_type": "option",
"option": "netmask",
"value": "255.255.255.0"
},
{
"address_family": "inet",
"iface": "eno1",
"line": " gateway 1.2.3.1",
"line_type": "option",
"option": "gateway",
"value": "1.2.3.1"
}
],
"iface_options": [
{
"address_family": "inet",
"iface": "eno1",
"line": " address 1.2.3.5",
"line_type": "option",
"option": "address",
"value": "1.2.3.5"
},
{
"address_family": "inet",
"iface": "eno1",
"line": " netmask 255.255.255.0",
"line_type": "option",
"option": "netmask",
"value": "255.255.255.0"
},
{
"address_family": "inet",
"iface": "eno1",
"line": " gateway 1.2.3.1",
"line_type": "option",
"option": "gateway",
"value": "1.2.3.1"
}
]
},
}
for testname in testcases.keys():
iface_options = interfaces_file.get_interface_options(testcases[testname]["iface_lines"])
self.assertEqual(testcases[testname]["iface_options"], iface_options)
def test_get_interface_options(self):
testcases = {
"select address": {
"iface_options": [
{
"address_family": "inet",
"iface": "eno1",
"line": " address 1.2.3.5",
"line_type": "option",
"option": "address",
"value": "1.2.3.5"
},
{
"address_family": "inet",
"iface": "eno1",
"line": " netmask 255.255.255.0",
"line_type": "option",
"option": "netmask",
"value": "255.255.255.0"
},
{
"address_family": "inet",
"iface": "eno1",
"line": " gateway 1.2.3.1",
"line_type": "option",
"option": "gateway",
"value": "1.2.3.1"
}
],
"target_options": [
{
"address_family": "inet",
"iface": "eno1",
"line": " address 1.2.3.5",
"line_type": "option",
"option": "address",
"value": "1.2.3.5"
}
],
"option": "address"
},
}
for testname in testcases.keys():
target_options = interfaces_file.get_target_options(testcases[testname]["iface_options"], testcases[testname]["option"])
self.assertEqual(testcases[testname]["target_options"], target_options)
def test_update_existing_option_line(self):
testcases = {
"update address": {
"target_option": {
"address_family": "inet",
"iface": "eno1",
"line": " address 1.2.3.5",
"line_type": "option",
"option": "address",
"value": "1.2.3.5"
},
"value": "1.2.3.4",
"result": " address 1.2.3.4",
},
}
for testname in testcases.keys():
updated = interfaces_file.update_existing_option_line(testcases[testname]["target_option"], testcases[testname]["value"])
self.assertEqual(testcases[testname]["result"], updated)
def test_predefined(self):
testcases = {
"idempotency": {
"source_lines": [
"iface eno1 inet static",
" address 1.2.3.5",
" netmask 255.255.255.0",
" gateway 1.2.3.1",
],
"input": {
"iface": "eno1",
"option": "address",
"value": "1.2.3.5",
'state': 'present',
},
"result_lines": [
"iface eno1 inet static",
" address 1.2.3.5",
" netmask 255.255.255.0",
" gateway 1.2.3.1",
],
"changed": False,
},
}
for testname in testcases.keys():
lines, ifaces = interfaces_file.read_interfaces_lines(module, testcases[testname]["source_lines"])
changed, lines = interfaces_file.set_interface_option(module, lines, testcases[testname]["input"]['iface'], testcases[testname]["input"]['option'],
testcases[testname]["input"]['value'], testcases[testname]["input"]['state'])
self.assertEqual(testcases[testname]["result_lines"], [d['line'] for d in lines if 'line' in d])
assert testcases[testname]['changed'] == changed
def test_inet_inet6(self): def test_inet_inet6(self):
testcases = { testcases = {
"change_ipv4": [ "change_ipv4": [