amd-debug-tools 0.2.2__py3-none-any.whl → 0.2.12__py3-none-any.whl

test_s2idle.py

@@ -117,9 +117,9 @@ class TestParseArgs(unittest.TestCase):
 
     def test_version_command(self):
         """Test parse_args with version command"""
-        sys.argv = ["s2idle.py", "version"]
+        sys.argv = ["s2idle.py", "--version"]
         args = parse_args()
-        self.assertEqual(args.action, "version")
+        self.assertTrue(args.version)
 
 
 class TestMainFunction(unittest.TestCase):
@@ -180,7 +180,7 @@ class TestMainFunction(unittest.TestCase):
             mock_report.assert_called_once_with(
                 "2023-01-01", "2023-02-01", None, "html", False, False
             )
-            self.assertTrue(result)
+            self.assertIsNone(result)
 
     @patch("amd_debug.s2idle.relaunch_sudo")
     @patch("amd_debug.s2idle.run_test_cycle")
@@ -207,26 +207,28 @@ class TestMainFunction(unittest.TestCase):
             mock_test.assert_called_once_with(
                 None, None, "5", "txt", None, False, False, False, False, False
             )
-            self.assertTrue(result)
+            self.assertIsNone(result)
 
     @patch("amd_debug.s2idle.version")
     def test_main_version(self, mock_version):
         """Test main function with version action"""
         sys.argv = ["s2idle.py", "version"]
         with patch("amd_debug.s2idle.parse_args") as mock_parse_args:
-            mock_parse_args.return_value = argparse.Namespace(action="version")
+            mock_parse_args.return_value = argparse.Namespace(version=True, action=None)
             mock_version.return_value = "1.0.0"
             with patch("builtins.print") as mock_print:
                 result = main()
                 mock_version.assert_called_once()
                 mock_print.assert_called_once_with("1.0.0")
-                self.assertTrue(result)
+                self.assertIsNone(result)
 
     def test_main_no_action(self):
         """Test main function with no action specified"""
         sys.argv = ["s2idle.py"]
         with patch("amd_debug.s2idle.parse_args") as mock_parse_args:
-            mock_parse_args.return_value = argparse.Namespace(action=None)
+            mock_parse_args.return_value = argparse.Namespace(
+                version=False, action=None
+            )
             with self.assertRaises(SystemExit) as cm:
                 main()
             self.assertEqual(cm.exception.code, "no action specified")
@@ -358,8 +360,10 @@ class TestTestFunction(unittest.TestCase):
     @patch("amd_debug.s2idle.prompt_test_arguments")
     @patch("amd_debug.s2idle.prompt_report_arguments")
     @patch("amd_debug.s2idle.display_report_file")
+    @patch("amd_debug.s2idle.datetime")
     def test_test_success(
         self,
+        mock_datetime,
         mock_display_report_file,
         mock_prompt_report_arguments,
         mock_prompt_test_arguments,
@@ -369,6 +373,11 @@ class TestTestFunction(unittest.TestCase):
         mock_installer,
     ):
         """Test the test function when everything succeeds"""
+        from datetime import datetime
+
+        mock_datetime.now.return_value = datetime(2023, 2, 1, 0, 0, 0)
+        mock_datetime.side_effect = lambda *args, **kwargs: datetime(*args, **kwargs)
+
         mock_installer_instance = mock_installer.return_value
         mock_installer_instance.install_dependencies.return_value = True
 
@@ -414,9 +423,11 @@ class TestTestFunction(unittest.TestCase):
         mock_sleep_validator_instance.run.assert_called_once_with(
             duration=10, wait=5, count=3, rand=False, logind=False
         )
+        from datetime import datetime
+
         mock_sleep_report.assert_called_once_with(
             since="2023-01-01",
-            until="2023-02-01",
+            until=datetime(2023, 2, 1, 0, 0, 0),
             fname="report.html",
             fmt="html",
             tool_debug=True,
@@ -455,12 +466,18 @@ class TestTestFunction(unittest.TestCase):
 
     @patch("amd_debug.s2idle.Installer")
     @patch("amd_debug.s2idle.PrerequisiteValidator")
-    @patch("amd_debug.prerequisites.SleepDatabase")
-    @patch("amd_debug.validator.SleepDatabase")
+    @patch("amd_debug.s2idle.SleepValidator")
+    @patch("amd_debug.s2idle.SleepReport")
+    @patch("amd_debug.s2idle.prompt_test_arguments")
+    @patch("amd_debug.s2idle.prompt_report_arguments")
+    @patch("amd_debug.s2idle.display_report_file")
     def test_test_prerequisite_failure(
         self,
-        _mock_sleep_db,
-        _mock_sleep_db_prerequisite,
+        mock_display_report_file,
+        mock_prompt_report_arguments,
+        mock_prompt_test_arguments,
+        mock_sleep_report,
+        mock_sleep_validator,
         mock_prerequisite_validator,
         mock_installer,
     ):
@@ -471,6 +488,17 @@ class TestTestFunction(unittest.TestCase):
         mock_prerequisite_instance = mock_prerequisite_validator.return_value
         mock_prerequisite_instance.run.return_value = False
 
+        mock_prompt_test_arguments.return_value = (10, 5, 3)
+        mock_prompt_report_arguments.return_value = (
+            "2023-01-01",
+            "2023-02-01",
+            "report.html",
+            "html",
+            True,
+        )
+        mock_sleep_validator_instance = mock_sleep_validator.return_value
+        mock_sleep_report_instance = mock_sleep_report.return_value
+
         result = run_test_cycle(
             duration=None,
             wait=None,
@@ -492,7 +520,20 @@ class TestTestFunction(unittest.TestCase):
         mock_prerequisite_validator.assert_called_once_with(True)
         mock_prerequisite_instance.run.assert_called_once()
         mock_prerequisite_instance.report.assert_called_once()
-        self.assertFalse(result)
+        mock_prompt_test_arguments.assert_called_once_with(None, None, None, False)
+        mock_prompt_report_arguments.assert_called_once()
+        mock_sleep_validator_instance.assert_not_called()
+        mock_sleep_report.assert_called_once_with(
+            since=None,
+            until=None,
+            fname="report.html",
+            fmt="html",
+            tool_debug=True,
+            report_debug=True,
+        )
+        mock_sleep_report_instance.run.assert_called_once()
+        mock_display_report_file.assert_called_once_with("report.html", "html")
+        self.assertTrue(result)
 
     @patch("amd_debug.s2idle.Installer")
     @patch("amd_debug.s2idle.PrerequisiteValidator")
@@ -533,9 +574,9 @@ class TestTestFunction(unittest.TestCase):
             "iasl", "ethtool", "edid-decode"
         )
         mock_installer_instance.install_dependencies.assert_called_once()
-        mock_prerequisite_validator.assert_called_once_with(True)
-        mock_prerequisite_instance.run.assert_called_once()
-        mock_prerequisite_instance.report.assert_called_once()
+        mock_prerequisite_validator.assert_not_called()
+        mock_prerequisite_instance.run.assert_not_called()
+        mock_prerequisite_instance.report.assert_not_called()
         mock_prompt_test_arguments.assert_called_once_with(None, None, None, False)
 
 
@@ -570,12 +611,18 @@ class TestDisplayReportFile(unittest.TestCase):
         self, mock_subprocess_call, mock_env_get, mock_is_root
     ):
         """Test display_report_file when format is html, user is root, and SUDO_USER is set"""
-        display_report_file("report.html", "html")
+        with self.assertRaises(SystemExit):
+            display_report_file("/tmp/report.html", "html")
         mock_is_root.assert_called_once()
         mock_env_get.assert_any_call("SUDO_USER")
-        mock_env_get.assert_any_call("XDG_SESSION_TYPE")
         mock_subprocess_call.assert_called_once_with(
-            ["sudo", "-E", "-u", "testuser", "xdg-open", "report.html"]
+            [
+                "systemd-run",
+                "--user",
+                "--machine=testuser@.host",
+                "xdg-open",
+                "/tmp/report.html",
+            ]
         )
 
     @patch("amd_debug.s2idle.is_root", return_value=True)

test_sleep_report.py

@@ -5,6 +5,7 @@
 This module contains unit tests for the s2idle tool in the amd-debug-tools package.
 """
 
+import math
 import unittest
 from datetime import datetime
 from unittest.mock import patch
@@ -165,3 +166,31 @@ class TestSleepReport(unittest.TestCase):
         self.report.build_hw_sleep_chart()
         self.assertIsNotNone(self.report.hwsleep_svg)
         mock_savefig.assert_called_once()
+
+    def test_pre_process_dataframe_zero_duration(self):
+        """Test the pre_process_dataframe method when t0 and t1 are the same."""
+        # Mock the dataframe with t0 and t1 being the same
+        self.report.df = pd.DataFrame(
+            {
+                "t0": [datetime(2023, 10, 10, 12, 0, 0).strftime("%Y%m%d%H%M%S")],
+                "t1": [datetime(2023, 10, 10, 12, 0, 0).strftime("%Y%m%d%H%M%S")],
+                "hw": [50],
+                "requested": [1],
+                "gpio": ["1, 2"],
+                "wake_irq": ["1"],
+                "b0": [90],
+                "b1": [85],
+                "full": [100],
+            }
+        )
+
+        # Call the method
+        self.report.pre_process_dataframe()
+
+        # Verify the dataframe was processed correctly
+        self.assertTrue(
+            self.report.df["Duration"].isna().iloc[0]
+        )  # Duration should be NaN
+        self.assertTrue(
+            math.isnan(self.report.df["Hardware Sleep"].iloc[0])
+        )  # Hardware Sleep should be NaN

test_ttm.py

@@ -0,0 +1,276 @@
+#!/usr/bin/python3
+# SPDX-License-Identifier: MIT
+
+"""
+This module contains unit tests for the ttm tool in the amd-debug-tools package.
+"""
+import unittest
+import sys
+import logging
+from unittest import mock
+
+from amd_debug.ttm import main, parse_args, AmdTtmTool, maybe_reboot
+
+
+class TestParseArgs(unittest.TestCase):
+    """Test parse_args function"""
+
+    @classmethod
+    def setUpClass(cls):
+        logging.basicConfig(filename="/dev/null", level=logging.DEBUG)
+
+    def setUp(self):
+        self.default_sys_argv = sys.argv
+
+    def tearDown(self):
+        sys.argv = self.default_sys_argv
+
+    @mock.patch.object(sys, "argv", new=["ttm", "--version"])
+    def test_parse_args_version(self):
+        """Test version argument"""
+        args = parse_args()
+        self.assertTrue(args.version)
+        self.assertFalse(args.set)
+        self.assertFalse(args.clear)
+
+    @mock.patch.object(sys, "argv", new=["ttm", "--clear"])
+    def test_parse_args_clear(self):
+        """Test clear argument"""
+        args = parse_args()
+        self.assertFalse(args.version)
+        self.assertFalse(args.set)
+        self.assertTrue(args.clear)
+
+
+class TestMainFunction(unittest.TestCase):
+    """Test main() function logic"""
+
+    @mock.patch("amd_debug.ttm.parse_args")
+    @mock.patch("amd_debug.ttm.version", return_value="1.2.3")
+    @mock.patch("builtins.print")
+    def test_main_version(self, mock_print, _mock_version, mock_parse_args):
+        """Test main function with version argument"""
+        mock_parse_args.return_value = mock.Mock(
+            version=True, set=None, clear=False, tool_debug=False
+        )
+        ret = main()
+        mock_print.assert_called_with("1.2.3")
+        self.assertIsNone(ret)
+
+    @mock.patch("amd_debug.ttm.parse_args")
+    @mock.patch("amd_debug.ttm.AmdTtmTool")
+    @mock.patch("builtins.print")
+    def test_main_set_invalid(self, mock_print, _mock_tool, mock_parse_args):
+        """Test main function with invalid set argument"""
+        mock_parse_args.return_value = mock.Mock(
+            version=False, set=0, clear=False, tool_debug=False
+        )
+        ret = main()
+        mock_print.assert_called_with("Error: GB value must be greater than 0")
+        self.assertEqual(ret, 1)
+
+    @mock.patch("amd_debug.ttm.parse_args")
+    @mock.patch("amd_debug.ttm.AmdTtmTool")
+    def test_main_set_valid(self, mock_tool, mock_parse_args):
+        """Test main function with set argument"""
+        instance = mock_tool.return_value
+        instance.set.return_value = True
+        mock_parse_args.return_value = mock.Mock(
+            version=False, set=2, clear=False, tool_debug=False
+        )
+        ret = main()
+        instance.set.assert_called_with(2)
+        self.assertIsNone(ret)
+
+    @mock.patch("amd_debug.ttm.parse_args")
+    @mock.patch("amd_debug.ttm.AmdTtmTool")
+    def test_main_set_failed(self, mock_tool, mock_parse_args):
+        instance = mock_tool.return_value
+        instance.set.return_value = False
+        mock_parse_args.return_value = mock.Mock(
+            version=False, set=2, clear=False, tool_debug=False
+        )
+        ret = main()
+        instance.set.assert_called_with(2)
+        self.assertEqual(ret, 1)
+
+    @mock.patch("amd_debug.ttm.parse_args")
+    @mock.patch("amd_debug.ttm.AmdTtmTool")
+    def test_main_clear_success(self, mock_tool, mock_parse_args):
+        """Test main function with clear argument"""
+        instance = mock_tool.return_value
+        instance.clear.return_value = True
+        mock_parse_args.return_value = mock.Mock(
+            version=False, set=None, clear=True, tool_debug=False
+        )
+        ret = main()
+        instance.clear.assert_called_once()
+        self.assertIsNone(ret)
+
+    @mock.patch("amd_debug.ttm.parse_args")
+    @mock.patch("amd_debug.ttm.AmdTtmTool")
+    def test_main_clear_failed(self, mock_tool, mock_parse_args):
+        """Test main function with clear argument failure"""
+        instance = mock_tool.return_value
+        instance.clear.return_value = False
+        mock_parse_args.return_value = mock.Mock(
+            version=False, set=None, clear=True, tool_debug=False
+        )
+        ret = main()
+        instance.clear.assert_called_once()
+        self.assertEqual(ret, 1)
+
+    @mock.patch("amd_debug.ttm.parse_args")
+    @mock.patch("amd_debug.ttm.AmdTtmTool")
+    def test_main_get_success(self, mock_tool, mock_parse_args):
+        """Test main function with get argument"""
+        instance = mock_tool.return_value
+        instance.get.return_value = True
+        mock_parse_args.return_value = mock.Mock(
+            version=False, set=None, clear=False, tool_debug=False
+        )
+        ret = main()
+        instance.get.assert_called_once()
+        self.assertIsNone(ret)
+
+    @mock.patch("amd_debug.ttm.parse_args")
+    @mock.patch("amd_debug.ttm.AmdTtmTool")
+    def test_main_get_failed(self, mock_tool, mock_parse_args):
+        """Test main function with get argument failure"""
+        instance = mock_tool.return_value
+        instance.get.return_value = False
+        mock_parse_args.return_value = mock.Mock(
+            version=False, set=None, clear=False, tool_debug=False
+        )
+        ret = main()
+        instance.get.assert_called_once()
+        self.assertEqual(ret, 1)
+
+
+class TestMaybeReboot(unittest.TestCase):
+    """Test maybe_reboot function"""
+
+    @mock.patch("builtins.input", return_value="y")
+    @mock.patch("amd_debug.ttm.reboot", return_value=True)
+    def test_maybe_reboot_yes(self, mock_reboot, _mock_input):
+        """Test reboot confirmation and execution"""
+        result = maybe_reboot()
+        mock_reboot.assert_called_once()
+        self.assertTrue(result)
+
+    @mock.patch("builtins.input", return_value="n")
+    @mock.patch("amd_debug.ttm.reboot", return_value=True)
+    def test_maybe_reboot_no(self, mock_reboot, _mock_input):
+        """Test reboot confirmation without execution"""
+        result = maybe_reboot()
+        mock_reboot.assert_not_called()
+        self.assertTrue(result)
+
+
+class TestAmdTtmTool(unittest.TestCase):
+    """Unit tests for AmdTtmTool class"""
+
+    def setUp(self):
+        self.tool = AmdTtmTool(logging=False)
+
+    @mock.patch("builtins.open", new_callable=mock.mock_open, read_data="4096")
+    @mock.patch("amd_debug.ttm.bytes_to_gb", return_value=4.0)
+    @mock.patch("amd_debug.ttm.print_color")
+    @mock.patch("amd_debug.ttm.get_system_mem", return_value=16.0)
+    def test_get_success(self, _mock_mem, mock_print, _mock_bytes_to_gb, mock_open):
+        """Test get() when TTM_PARAM_PATH exists"""
+        result = self.tool.get()
+        mock_open.assert_called_once_with(
+            "/sys/module/ttm/parameters/pages_limit", "r", encoding="utf-8"
+        )
+        mock_print.assert_any_call(
+            "Current TTM pages limit: 4096 pages (4.00 GB)", "💻"
+        )
+        mock_print.assert_any_call("Total system memory: 16.00 GB", "💻")
+        self.assertTrue(result)
+
+    @mock.patch("builtins.open", side_effect=FileNotFoundError)
+    @mock.patch("amd_debug.ttm.print_color")
+    def test_get_file_not_found(self, mock_print, _mock_open):
+        """Test get() when TTM_PARAM_PATH does not exist"""
+        result = self.tool.get()
+        mock_print.assert_called_with(
+            "Error: Could not find /sys/module/ttm/parameters/pages_limit", "❌"
+        )
+        self.assertFalse(result)
+
+    @mock.patch("amd_debug.ttm.relaunch_sudo", return_value=True)
+    @mock.patch("amd_debug.ttm.get_system_mem", return_value=8.0)
+    @mock.patch("amd_debug.ttm.print_color")
+    def test_set_gb_greater_than_total(
+        self, mock_print, _mock_mem, _mock_relaunch_sudo
+    ):
+        """Test set() when gb_value > total system memory"""
+        result = self.tool.set(16)
+        mock_print.assert_any_call(
+            "16.00 GB is greater than total system memory (8.00 GB)", "❌"
+        )
+        self.assertFalse(result)
+
+    @mock.patch("amd_debug.ttm.relaunch_sudo", return_value=True)
+    @mock.patch("amd_debug.ttm.get_system_mem", return_value=10.0)
+    @mock.patch("amd_debug.ttm.print_color")
+    @mock.patch("builtins.input", return_value="n")
+    def test_set_gb_exceeds_max_percentage_cancel(
+        self, _mock_input, mock_print, _mock_mem, mock_relaunch_sudo
+    ):
+        """Test set() when gb_value exceeds max percentage and user cancels"""
+        result = self.tool.set(9.5)
+        self.assertFalse(result)
+        mock_print.assert_any_call("Operation cancelled.", "🚦")
+
+    @mock.patch("amd_debug.ttm.relaunch_sudo", return_value=True)
+    @mock.patch("amd_debug.ttm.get_system_mem", return_value=10.0)
+    @mock.patch("amd_debug.ttm.gb_to_pages", return_value=20480)
+    @mock.patch("amd_debug.ttm.print_color")
+    @mock.patch("builtins.open", new_callable=mock.mock_open)
+    @mock.patch("builtins.input", return_value="y")
+    @mock.patch("amd_debug.ttm.maybe_reboot", return_value=True)
+    def test_set_success(
+        self,
+        _mock_reboot,
+        _mock_input,
+        mock_open,
+        mock_print,
+        _mock_gb_to_pages,
+        _mock_mem,
+        _relaunch_sudo,
+    ):
+        """Test set() success path"""
+        result = self.tool.set(5)
+        mock_open.assert_called_once_with(
+            "/etc/modprobe.d/ttm.conf", "w", encoding="utf-8"
+        )
+        mock_print.assert_any_call(
+            "Successfully set TTM pages limit to 20480 pages (5.00 GB)", "🐧"
+        )
+        self.assertTrue(result)
+
+    @mock.patch("os.path.exists", return_value=False)
+    @mock.patch("amd_debug.ttm.print_color")
+    def test_clear_file_not_exists(self, mock_print, _mock_exists):
+        """Test clear() when config file does not exist"""
+        result = self.tool.clear()
+        mock_print.assert_called_with("/etc/modprobe.d/ttm.conf doesn't exist", "❌")
+        self.assertFalse(result)
+
+    @mock.patch("os.path.exists", return_value=True)
+    @mock.patch("amd_debug.ttm.relaunch_sudo", return_value=True)
+    @mock.patch("os.remove")
+    @mock.patch("amd_debug.ttm.print_color")
+    @mock.patch("amd_debug.ttm.maybe_reboot", return_value=True)
+    def test_clear_success(
+        self, _mock_reboot, mock_print, mock_remove, _mock_relaunch_sudo, _mock_exists
+    ):
+        """Test clear() success path"""
+        result = self.tool.clear()
+        mock_remove.assert_called_once_with("/etc/modprobe.d/ttm.conf")
+        mock_print.assert_any_call(
+            "Configuration /etc/modprobe.d/ttm.conf removed", "🐧"
+        )
+        self.assertTrue(result)