Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(dhcpcd): Make lease parsing more robust #5129

Merged
merged 3 commits into from
Apr 2, 2024
Merged

fix(dhcpcd): Make lease parsing more robust #5129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aec9035
fix(dhcpcd): Make lease parsing more robust
holmanb Apr 1, 2024
0ef7ea8
comments
holmanb Apr 2, 2024
638c65c
black
holmanb Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 10 additions & 2 deletions cloudinit/net/dhcp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,12 +791,20 @@ def parse_dhcpcd_lease(lease_dump: str, interface: str) -> Dict:
try:
lease = dict(
[
a.split("=")
a.split("=", maxsplit=1)
for a in lease_dump.strip().replace("'", "").split("\n")
if "=" in a
]
)
if not lease:
msg = (
"No valid DHCP lease configuration "
"found in dhcpcd lease: %r"
)
LOG.error(msg, lease_dump)
raise InvalidDHCPLeaseFileError(msg % lease_dump)
except ValueError as error:
holmanb marked this conversation as resolved.
Show resolved Hide resolved
LOG.error("Error parsing dhcpcd lease: %r", error)
LOG.error("Error parsing dhcpcd lease: %r", lease_dump)
raise InvalidDHCPLeaseFileError from error

# this is expected by cloud-init's code
Expand Down
63 changes: 58 additions & 5 deletions tests/unittests/net/test_dhcp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1199,17 +1199,70 @@ def test_parse_lease_dump(self):
assert "255.255.240.0" == parsed_lease["subnet-mask"]
assert "192.168.0.1" == parsed_lease["routers"]

@pytest.mark.parametrize(
"lease, parsed",
(
pytest.param(
"""

domain_name='us-east-2.compute.internal'

domain_name_servers='192.168.0.2'

""",
{
"domain_name": "us-east-2.compute.internal",
"domain_name_servers": "192.168.0.2",
},
id="lease_has_empty_lines",
),
pytest.param(
"""
domain_name='us-east-2.compute.internal'
not-a-kv-pair
domain_name_servers='192.168.0.2'
""",
{
"domain_name": "us-east-2.compute.internal",
"domain_name_servers": "192.168.0.2",
},
id="lease_has_values_that_arent_key_value_pairs",
),
pytest.param(
"""
domain_name='us-east=2.compute.internal'
""",
{
"domain_name": "us-east=2.compute.internal",
},
id="lease_has_kv_pair_including_equals_sign_in_value",
),
),
)
def test_parse_lease_dump_resilience(self, lease, parsed):
with mock.patch("cloudinit.net.dhcp.util.load_binary_file"):
Dhcpcd.parse_dhcpcd_lease(dedent(lease), "eth0")

def test_parse_lease_dump_fails(self):
lease = dedent(
"""
fail
"""
)
def _raise():
raise ValueError()

lease = mock.Mock()
lease.strip = _raise

with pytest.raises(InvalidDHCPLeaseFileError):
with mock.patch("cloudinit.net.dhcp.util.load_binary_file"):
Dhcpcd.parse_dhcpcd_lease(lease, "eth0")

with pytest.raises(InvalidDHCPLeaseFileError):
with mock.patch("cloudinit.net.dhcp.util.load_binary_file"):
lease = dedent(
"""
fail
"""
)
Dhcpcd.parse_dhcpcd_lease(lease, "eth0")

@pytest.mark.parametrize(
"lease_file, option_245",
(
Expand Down