Skip to content

providers/base: fix race condition in turn_down_nm_connections (BugFix) #2449

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

Draft
eugene-yujinwu wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

providers/base: fix race condition in turn_down_nm_connections (BugFix) #2449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
83718c2
providers/base: fix race condition in turn_down_nm_connections
eugene-yujinwu Apr 3, 2026
a8e6158
providers/base: fix black formatting in test_wifi_nmcli_test.py
eugene-yujinwu Apr 3, 2026
7cdd029
providers/base: refactor turn_down_nm_connections to use try/except
eugene-yujinwu Apr 14, 2026
6cd1772
providers/base: fix race condition by pre-checking UUID state before …
eugene-yujinwu Apr 14, 2026
05dee4a
providers/base: fix black formatting in test_wifi_nmcli_test.py
eugene-yujinwu Apr 14, 2026
b90e2db
providers/base: handle exit code 10 from nmcli c down as success
eugene-yujinwu Apr 14, 2026
c14a863
providers/base: revert exit code 10 handling from nmcli c down
eugene-yujinwu Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions providers/base/bin/wifi_nmcli_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,18 @@ def turn_down_nm_connections():
continue
uuid = value["uuid"]
print("Turn down connection", name)
# Re-check this specific UUID's state right before calling down
# to handle the race condition where a connection becomes inactive
# between the initial query and this point (e.g. another connection
# was brought down first, causing NM to deactivate this one too).
check_cmd = "nmcli -t -f GENERAL.STATE c show {}".format(uuid)
print_cmd(check_cmd)
current_state = sp.check_output(
shlex.split(check_cmd), universal_newlines=True
).strip()
if current_state != "GENERAL.STATE:activated":
print("WARN: {} is no longer active, skipping".format(name))
continue
cmd = "nmcli c down {}".format(uuid)
print_cmd(cmd)
sp.check_call(shlex.split(cmd))
Expand Down
57 changes: 47 additions & 10 deletions providers/base/tests/test_wifi_nmcli_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,15 +140,21 @@ def test_connection_activation_fails_due_to_exception(


class TestTurnDownNmConnections(unittest.TestCase):
@patch("wifi_nmcli_test.sp.call")
@patch("wifi_nmcli_test.sp.check_output")
@patch("wifi_nmcli_test.sp.check_call")
@patch("wifi_nmcli_test._get_nm_wireless_connections", return_value={})
def test_no_connections_to_turn_down(
self, get_connections_mock, sp_call_mock
self, get_connections_mock, sp_check_call_mock, sp_check_output_mock
):
turn_down_nm_connections()
self.assertEqual(get_connections_mock.call_count, 1)
sp_call_mock.assert_not_called()
sp_check_output_mock.assert_not_called()
sp_check_call_mock.assert_not_called()

@patch(
"wifi_nmcli_test.sp.check_output",
return_value="GENERAL.STATE:activated",
)
@patch("wifi_nmcli_test.sp.check_call")
@patch(
"wifi_nmcli_test._get_nm_wireless_connections",
Expand All @@ -158,30 +164,60 @@ def test_no_connections_to_turn_down(
},
)
def test_turn_down_single_connection(
self, get_connections_mock, sp_check_call_mock
self, get_connections_mock, sp_check_call_mock, sp_check_output_mock
):
turn_down_nm_connections()
self.assertEqual(get_connections_mock.call_count, 1)
sp_check_output_mock.assert_called_once_with(
"nmcli -t -f GENERAL.STATE c show uuid1".split(),
universal_newlines=True,
)
sp_check_call_mock.assert_called_once_with(
"nmcli c down uuid1".split()
)

@patch(
"wifi_nmcli_test.sp.check_output",
return_value="GENERAL.STATE:deactivated",
)
@patch("wifi_nmcli_test.sp.check_call")
@patch(
"wifi_nmcli_test._get_nm_wireless_connections",
return_value={"Wireless1": {"uuid": "uuid1", "state": "activated"}},
)
def test_turn_down_connection_already_inactive(
self, get_connections_mock, sp_check_call_mock, sp_check_output_mock
):
# UUID state re-check shows connection already inactive — skip down
turn_down_nm_connections()
sp_check_output_mock.assert_called_once_with(
"nmcli -t -f GENERAL.STATE c show uuid1".split(),
universal_newlines=True,
)
sp_check_call_mock.assert_not_called()

Comment on lines +187 to +197

Copilot AI Apr 14, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new test test_turn_down_connection_already_inactive covers the pre-check path (state becomes deactivated before calling down), but it doesn’t cover the failure reported in the PR description where nmcli c down returns exit code 10. Add a unit test that simulates the down command returning/raising with rc=10 (e.g., check_call raising CalledProcessError(returncode=10, ...) or sp.call returning 10, depending on the chosen implementation) and assert turn_down_nm_connections() does not raise.

Copilot uses AI. Check for mistakes.
@patch(
"wifi_nmcli_test.sp.check_output",
return_value="GENERAL.STATE:activated",
)
@patch("wifi_nmcli_test.sp.check_call")
@patch(
"wifi_nmcli_test._get_nm_wireless_connections",
return_value={"Wireless1": {"uuid": "uuid1", "state": "activated"}},
)
def test_turn_down_single_connection_with_exception(
self, get_connections_mock, sp_check_call_mock
self, get_connections_mock, sp_check_call_mock, sp_check_output_mock
):
sp_check_call_mock.side_effect = subprocess.CalledProcessError("", 1)
sp_check_call_mock.side_effect = subprocess.CalledProcessError(1, "")
with self.assertRaises(subprocess.CalledProcessError):
turn_down_nm_connections()
self.assertEqual(get_connections_mock.call_count, 1)
sp_check_call_mock.assert_called_once_with(
"nmcli c down uuid1".split()
)

@patch(
"wifi_nmcli_test.sp.check_output",
return_value="GENERAL.STATE:activated",
)
@patch("wifi_nmcli_test.sp.check_call")
@patch(
"wifi_nmcli_test._get_nm_wireless_connections",
Expand All @@ -191,10 +227,11 @@ def test_turn_down_single_connection_with_exception(
},
)
def test_turn_down_multiple_connections(
self, get_connections_mock, sp_check_call_mock
self, get_connections_mock, sp_check_call_mock, sp_check_output_mock
):
turn_down_nm_connections()
self.assertEqual(get_connections_mock.call_count, 1)
# one UUID state check per activated connection
self.assertEqual(sp_check_output_mock.call_count, 2)
calls = [
call("nmcli c down uuid1".split()),
call("nmcli c down uuid2".split()),
Expand Down
Loading