Use fixed list of bios data files and update unit tests

Author: pieqq

checkbox-ng/checkbox_ng/support/device_info.py

@@ -1,10 +1,10 @@
 #!/usr/bin/env python3
 import argparse
-import glob
 import json
-import os
+from pathlib import Path
 import platform
 import subprocess
+import sys
 
 from checkbox_ng.support.release_info import get_release_info
 from checkbox_ng.support.parsers.meminfo import MeminfoParser
@@ -44,20 +44,27 @@ def get_bios_info() -> dict:
     - bios_version
 
     This function extracts the content from these files and returns a dict,
-    using the filename as a key.
+    using the filename as a key, defaulting to `None` if it cannot find data.
     """
-    bios_data = {}
-    base_path = "/sys/class/dmi/id/bios_*"
-
-    for filepath in glob.glob(base_path):
-        key = os.path.basename(filepath)
+    bios_data = {
+        "date": None,
+        "release": None,
+        "vendor": None,
+        "version": None,
+    }
+    bios_root = Path("/sys/class/dmi/id/")
+    bios_data_name = "bios_{}"
+    for key in bios_data:
         try:
-            with open(filepath, "r") as f:
-                bios_data[key] = f.read().strip()
-        except (PermissionError, OSError):
-            # If a specific file is restricted or unreadable, skip it
-            continue
-
+            value = (
+                (bios_root / bios_data_name.format(key)).read_text().strip()
+            )
+            bios_data[key] = value
+        except (PermissionError, FileNotFoundError) as e:
+            print(
+                "Failed to read bios {}. Error: {}".format(key, e),
+                file=sys.stderr,
+            )
     return bios_data
 
 

checkbox-ng/checkbox_ng/support/tests/test_device_info.py

@@ -30,64 +30,64 @@ def test_get_debian_packages(self, mock_co):
         self.assertEqual(pkg[0]["version"], "23.01+dfsg-11")
         self.assertEqual(pkg[0]["architecture"], "amd64")
 
-    @patch("glob.glob")
-    def test_get_bios_info_success(self, mock_glob):
+    def test_get_bios_info_success(self):
         """Test successful retrieval of multiple BIOS files."""
-        # Setup mocks
-        mock_glob.return_items = [
-            "/sys/class/dmi/id/bios_vendor",
-            "/sys/class/dmi/id/bios_version",
-        ]
-        mock_glob.return_value = mock_glob.return_items
-
-        # Use a mapping for mock_open to return different data for different files
-        file_contents = {
-            "/sys/class/dmi/id/bios_vendor": "Dell Inc.",
-            "/sys/class/dmi/id/bios_version": "1.5.0",
-        }
 
-        def side_effect_open(filename, mode):
-            content = file_contents.get(filename, "")
-            return mock_open(read_data=content).return_value
+        file_contents = [
+            "2026/03/20",
+            "v1.0",
+            "Dell Inc.",
+            "1.5.0",
+        ]
 
-        with patch("builtins.open", side_effect=side_effect_open):
+        with patch(
+            "checkbox_ng.support.device_info.Path.read_text",
+            side_effect=file_contents,
+        ):
             result = device_info.get_bios_info()
 
-            self.assertEqual(result["bios_vendor"], "Dell Inc.")
-            self.assertEqual(result["bios_version"], "1.5.0")
-            self.assertEqual(len(result), 2)
+            self.assertEqual(result["vendor"], "Dell Inc.")
+            self.assertEqual(result["version"], "1.5.0")
+            self.assertEqual(len(result), 4)
 
-    @patch("glob.glob")
-    def test_get_bios_info_empty(self, mock_glob):
+    def test_get_bios_info_empty(self):
         """Test behavior when no bios_* files are found."""
-        mock_glob.return_value = []
-
-        result = device_info.get_bios_info()
+        with patch(
+            "checkbox_ng.support.device_info.Path.read_text",
+            side_effect=FileNotFoundError,
+        ):
+            result = device_info.get_bios_info()
 
-        self.assertEqual(result, {})
+        self.assertEqual(
+            result,
+            {"date": None, "release": None, "vendor": None, "version": None},
+        )
 
-    @patch("glob.glob")
-    @patch("os.path.basename")
-    def test_get_bios_info_permission_denied(self, mock_basename, mock_glob):
+    def test_get_bios_info_permission_denied(self):
         """Test behavior when a file exists but cannot be read."""
-        mock_glob.return_value = ["/sys/class/dmi/id/bios_version"]
-        mock_basename.return_value = "bios_version"
-
-        # Force a PermissionError when trying to open the file
-        with patch("builtins.open", side_effect=PermissionError):
+        with patch(
+            "checkbox_ng.support.device_info.Path.read_text",
+            side_effect=PermissionError,
+        ):
             result = device_info.get_bios_info()
-            self.assertEqual(result, {})
+
+        self.assertEqual(
+            result,
+            {"date": None, "release": None, "vendor": None, "version": None},
+        )
 
     @patch("checkbox_ng.support.device_info.get_debian_packages")
     @patch("checkbox_ng.support.device_info.get_devices")
     @patch("checkbox_ng.support.device_info.get_release_info")
     @patch("checkbox_ng.support.device_info.get_meminfo")
     @patch("checkbox_ng.support.device_info.get_snap_packages")
     @patch("checkbox_ng.support.device_info.get_uname")
+    @patch("checkbox_ng.support.device_info.get_bios_info")
     @patch("checkbox_ng.support.device_info.get_kernel_cmdline")
     def test_kernel_cmdline_subcommand_uses_only_kernel_getter(
         self,
         mock_kernel_cmdline,
+        mock_bios_info,
         mock_uname,
         mock_snap_packages,
         mock_meminfo,
@@ -105,6 +105,7 @@ def test_kernel_cmdline_subcommand_uses_only_kernel_getter(
         )
         mock_kernel_cmdline.assert_called_once_with()
         mock_uname.assert_not_called()
+        mock_bios_info.assert_not_called()
         mock_meminfo.assert_not_called()
         mock_release_info.assert_not_called()
         mock_devices.assert_not_called()