Skip to content

Fix: Add validations to suspend_trigger (BugFix) #2500

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

Open
EstebanVg15 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix: Add validations to suspend_trigger (BugFix) #2500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
220fc5a
Fix: Add validations to suspend_trigger (Bugfix)
EstebanVg15 Apr 24, 2026
427dd93
Fix: Update the test_suspend_trigger (Bugfix)
EstebanVg15 Apr 24, 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
18 changes: 18 additions & 0 deletions providers/base/bin/suspend_trigger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,22 @@ def main(args=sys.argv[1:]):
str(args.sleep_delay),
]
suspend_cmd = ["systemctl", "suspend"]
list_jobs_cmd = ["systemctl", "list-jobs", "*suspend*"]
timeout = 10
while timeout > 0:
output = subprocess.check_output(
list_jobs_cmd,
stderr=subprocess.STDOUT,
universal_newlines=True,
).strip()
if "No jobs running." in output or "No jobs listed." in output:
break
print("Suspend jobs ongoing, waiting...")
time.sleep(1)
timeout -= 1
else:
print("Timed out waiting for suspend jobs to finish")
return 1
print("Running: {}".format(" ".join(rtcwake_cmd)))
subprocess.check_call(rtcwake_cmd)
print(
Expand All @@ -80,6 +96,8 @@ def main(args=sys.argv[1:]):
print("Removing {}...".format(log_path))
os.remove(log_path)

return 0


if __name__ == "__main__":
sys.exit(main())
93 changes: 92 additions & 1 deletion providers/base/tests/test_suspend_trigger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ def test_fwts_path_on_i386_with_defaults(


@patch("suspend_trigger.fwts_test")
@patch("suspend_trigger.subprocess.check_output")
@patch("suspend_trigger.subprocess.check_call")
@patch("suspend_trigger.platform.machine")
@patch("os.remove")
Expand All @@ -85,12 +86,14 @@ def test_rtcwake_path_success_with_args(
mock_remove,
mock_machine,
mock_check_call,
mock_check_output,
mock_fwts_test,
):
"""
Tests the rtcwake/systemctl path on aarch64 with custom arguments.
"""
mock_machine.return_value = "aarch64"
mock_check_output.return_value = "No jobs listed."

suspend_trigger.main(
["--sleep-delay", "25", "--rtc-device", "/dev/my_rtc"]
Expand All @@ -108,25 +111,34 @@ def test_rtcwake_path_success_with_args(
"25",
]
expected_suspend_cmd = ["systemctl", "suspend"]
expected_list_cmd = ["systemctl", "list-jobs", "*suspend*"]
mock_check_output.assert_called_with(
expected_list_cmd,
stderr=subprocess.STDOUT,
universal_newlines=True,
)
subprocess_calls = [
call(expected_rtcwake_cmd),
call(expected_suspend_cmd),
]
mock_check_call.assert_has_calls(subprocess_calls)
self.assertEqual(mock_check_call.call_count, 2)
self.assertEqual(mock_check_output.call_count, 1)

def test_rtcwake_path_with_defaults(
self,
mock_exists,
mock_remove,
mock_machine,
mock_check_call,
mock_check_output,
mock_fwts_test,
):
"""
Tests the rtcwake/systemctl path without any argument.
"""
mock_machine.return_value = "riscv64"
mock_check_output.return_value = "No jobs listed."

suspend_trigger.main([])

Expand All @@ -141,24 +153,89 @@ def test_rtcwake_path_with_defaults(
"30",
]
expected_suspend_cmd = ["systemctl", "suspend"]
expected_list_cmd = ["systemctl", "list-jobs", "*suspend*"]
mock_check_output.assert_called_with(
expected_list_cmd,
stderr=subprocess.STDOUT,
universal_newlines=True,
)
subprocess_calls = [
call(expected_rtcwake_cmd),
call(expected_suspend_cmd),
]
mock_check_call.assert_has_calls(subprocess_calls)

def test_list_command_failure(
self,
mock_exists,
mock_remove,
mock_machine,
mock_check_call,
mock_check_output,
mock_fwts_test,
):
"""
Tests the case where the systemctl list-jobs *suspend* fails.
"""
mock_machine.return_value = "aarch64"
# Simulate a command failure
error = subprocess.CalledProcessError(
returncode=1,
cmd="systemctl list-jobs *suspend*",
output="Timed out waiting for suspend jobs to finish",
)
mock_check_output.side_effect = error

# The script should propagate the exception
with self.assertRaises(subprocess.CalledProcessError):
suspend_trigger.main([])

# Verify that only the first command was attempted
self.assertTrue(mock_check_output.called)
called_args = mock_check_output.call_args[0][0]
self.assertEqual(called_args[0], "systemctl")
self.assertEqual(called_args[1], "list-jobs")

def test_wait_for_jobs_timeout(
self,
mock_exists,
mock_remove,
mock_machine,
mock_check_call,
mock_check_output,
mock_fwts_test,
):
"""
Tests the case where systemctl list-jobs *suspend* times out.
"""
mock_machine.return_value = "aarch64"

mock_check_output.return_value = "1 jobs listed. (suspend ongoing)"

result = suspend_trigger.main([])

self.assertEqual(result, 1)

# Verify that check_output was called exactly 10 times (your loop limit).
self.assertEqual(mock_check_output.call_count, 10)

# Verify that rtcwake was NEVER called (because of the timeout).
self.assertFalse(mock_check_call.called)

def test_rtcwake_command_failure(
self,
mock_exists,
mock_remove,
mock_machine,
mock_check_call,
mock_check_output,
mock_fwts_test,
):
"""
Tests the case where the rtcwake command fails.
"""
mock_machine.return_value = "aarch64"
mock_check_output.return_value = "No jobs listed."
# Simulate a command failure
error = subprocess.CalledProcessError(
returncode=1, cmd="rtcwake", output="Error from rtcwake"
Expand All @@ -169,7 +246,8 @@ def test_rtcwake_command_failure(
with self.assertRaises(subprocess.CalledProcessError):
suspend_trigger.main([])

# Verify that only the first command (rtcwake) was attempted
# Verify that only the first 2 commands were attempted
self.assertTrue(mock_check_output.called)
self.assertTrue(mock_check_call.called)
self.assertIn("rtcwake", mock_check_call.call_args[0][0])

Expand All @@ -179,12 +257,14 @@ def test_suspend_command_failure(
mock_remove,
mock_machine,
mock_check_call,
mock_check_output,
mock_fwts_test,
):
"""
Tests the case where the systemctl suspend command fails.
"""
mock_machine.return_value = "aarch64"
mock_check_output.return_value = "No jobs listed."
suspend_error = subprocess.CalledProcessError(
returncode=1, cmd="systemctl suspend", output="Error from suspend"
)
Expand All @@ -195,6 +275,7 @@ def test_suspend_command_failure(
suspend_trigger.main([])

# Verify both commands were attempted
self.assertTrue(mock_check_output.called)
self.assertEqual(mock_check_call.call_count, 2)
self.assertIn("rtcwake", mock_check_call.call_args_list[0][0][0])
self.assertIn("systemctl", mock_check_call.call_args_list[1][0][0])
Expand All @@ -205,6 +286,7 @@ def test_log_file_removed_if_exists(
mock_remove,
mock_machine,
mock_check_call,
mock_check_output,
mock_fwts_test,
):
"""
Expand All @@ -214,10 +296,17 @@ def test_log_file_removed_if_exists(
mock_machine.return_value = "aarch64"
mock_exists.return_value = True # Simulate file exists
mock_check_call.side_effect = [None, None]
mock_check_output.return_value = "No jobs listed."

suspend_trigger.main([])

# Verify commands were called
expected_list_cmd = ["systemctl", "list-jobs", "*suspend*"]
mock_check_output.assert_called_with(
expected_list_cmd,
stderr=subprocess.STDOUT,
universal_newlines=True,
)
expected_rtcwake_cmd = [
"rtcwake",
"--verbose",
Expand Down Expand Up @@ -246,6 +335,7 @@ def test_log_file_not_removed_if_missing(
mock_remove,
mock_machine,
mock_check_call,
mock_check_output,
mock_fwts_test,
):
"""
Expand All @@ -254,6 +344,7 @@ def test_log_file_not_removed_if_missing(
mock_machine.return_value = "aarch64"
mock_exists.return_value = False # Simulate file missing
mock_check_call.side_effect = [None, None]
mock_check_output.return_value = "No jobs listed."

suspend_trigger.main([])
# Verify remove was never called
Expand Down
3 changes: 3 additions & 0 deletions providers/base/units/stress/suspend_cycles_reboot.pxu
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ estimated_duration: 75.0
environ: PLAINBOX_SESSION_SHARE STRESS_S3_INIT_DELAY STRESS_S3_SLEEP_DELAY STRESS_S3_WAIT_DELAY LD_LIBRARY_PATH RTC_DEVICE_FILE
user: root
command:
set -o pipefail
echo "Current boot ID is: $(tr -d - < /proc/sys/kernel/random/boot_id)"
suspend_trigger.py --wait "${STRESS_S3_INIT_DELAY:-120}" --check-delay "${STRESS_S3_WAIT_DELAY:-45}" --sleep-delay "${STRESS_S3_SLEEP_DELAY:-30}" --rtc-device "${RTC_DEVICE_FILE:-/dev/rtc0}" 2>&1 | tee -a "$PLAINBOX_SESSION_SHARE"/suspend_cycles_with_reboot_total.log
summary:
Expand All @@ -105,6 +106,7 @@ environ: PLAINBOX_SESSION_SHARE STRESS_S3_INIT_DELAY STRESS_S3_SLEEP_DELAY STRES
after: stress-tests/suspend_cycles_reboot{{suspend_reboot_previous}}
user: root
command:
set -o pipefail
echo "Current boot ID is: $(tr -d - < /proc/sys/kernel/random/boot_id)"
suspend_trigger.py --wait "${STRESS_S3_INIT_DELAY:-120}" --check-delay "${STRESS_S3_WAIT_DELAY:-45}" --sleep-delay "${STRESS_S3_SLEEP_DELAY:-30}" --rtc-device "${RTC_DEVICE_FILE:-/dev/rtc0}" 2>&1 | tee -a "$PLAINBOX_SESSION_SHARE"/suspend_cycles_with_reboot_total.log
summary:
Expand All @@ -129,6 +131,7 @@ environ: PLAINBOX_SESSION_SHARE STRESS_S3_INIT_DELAY STRESS_S3_SLEEP_DELAY STRES
after: stress-tests/suspend_cycles_{{suspend_id_previous}}_reboot{{suspend_reboot_id}}
user: root
command:
set -o pipefail
echo "Current boot ID is: $(tr -d - < /proc/sys/kernel/random/boot_id)"
suspend_trigger.py --check-delay "${STRESS_S3_WAIT_DELAY:-45}" --sleep-delay "${STRESS_S3_SLEEP_DELAY:-30}" --rtc-device "${RTC_DEVICE_FILE:-/dev/rtc0}" 2>&1 | tee -a "$PLAINBOX_SESSION_SHARE"/suspend_cycles_with_reboot_total.log
summary:
Expand Down
Loading