"""Automatic LVM readers must not bypass disk exclusions/idle policy.""" import ast import json from pathlib import Path import subprocess import sys import tempfile import types import unittest from unittest.mock import Mock, patch SCRIPTS = Path(__file__).resolve().parents[1] / "AppImage/scripts" sys.path.insert(0, str(SCRIPTS)) import lvm_device_scope as scope def lsblk(*devices): """lsblk -J -l output from (kname, type, pkname, fstype) rows.""" return json.dumps({"blockdevices": [dict(zip(("kname", "type", "pkname", "fstype"), row)) for row in devices]}) INVENTORY = lsblk(("nvme0n1", "disk", None, None), ("nvme0n1p1", "part", "nvme0n1", "LVM2_member"), ("sda", "disk", None, None), ("sda1", "part", "sda", "LVM2_member"), ("sdb", "disk", None, None), ("sdb1", "part", "sdb", "LVM2_member")) class LvmScopeTests(unittest.TestCase): def setUp(self): self.policy = Mock(side_effect=lambda disk, excluded: "excluded" if disk in excluded else "read") self.standby = Mock(return_value=False) self.excluded = {"sda"} self.disk_module = types.ModuleType("disk_temperature_history") self.disk_module.disk_read_policy = self.policy self.disk_module.excluded_disk_names = lambda: self.excluded self.modules = patch.dict(sys.modules, disk_temperature_history=self.disk_module) self.modules.start() self.addCleanup(self.modules.stop) lvmconfig = types.SimpleNamespace(returncode=0, stdout='global_filter=["r|/dev/zd.*|","r|/dev/rbd.*|"]\nfilter="a|.*|"\n') def args(self, inventory=INVENTORY, code=0): def run(command, **_): if command[0] == "lvmconfig": return self.lvmconfig return types.SimpleNamespace(returncode=code, stdout=inventory) with patch.object(scope.subprocess, "run", side_effect=run) as mocked: args = scope.lvm_device_args(self.standby) self.assertEqual(mocked.call_args_list[0].args[0], ["lsblk", "-J", "-l", "-o", "KNAME,TYPE,PKNAME,FSTYPE"]) return args def test_volumes_lvm_filters_reject_are_not_named(self): # A guest's volume group on a zvol is hidden by the Proxmox # global_filter, which an explicit --devices list would bypass. inventory = lsblk(("nvme0n1", "disk", None, None), ("nvme0n1p1", "part", "nvme0n1", "LVM2_member"), ("sda", "disk", None, None), ("sda1", "part", "sda", "LVM2_member"), ("zd48", "disk", None, None), ("zd48p3", "part", "zd48", "LVM2_member"), ("rbd0", "disk", None, None), ("rbd0p1", "part", "rbd0", "LVM2_member")) self.assertEqual(self.args(inventory), ["--devices", "/dev/nvme0n1p1"]) self.excluded = {"sda", "nvme0n1"} self.assertIsNone(self.args(inventory)) def test_an_unreadable_lvm_filter_skips_the_restricted_scan(self): for output in (types.SimpleNamespace(returncode=5, stdout=""), types.SimpleNamespace(returncode=0, stdout='global_filter=["x|/dev/zd.*|"]\n'), types.SimpleNamespace(returncode=0, stdout='filter=["r|[|"]\n')): self.lvmconfig = output self.assertIsNone(self.args()) self.excluded = set() self.assertEqual(self.args(), []) def test_excluded_disks_and_their_partitions_are_not_in_the_scan(self): self.assertEqual(self.args(), ["--devices", "/dev/nvme0n1p1,/dev/sdb1"]) self.assertNotIn((("sda",), {}), self.standby.call_args_list) self.assertEqual({call.args[0] for call in self.standby.call_args_list}, {"nvme0n1", "sdb"}) def test_idle_disks_receive_no_power_query(self): self.excluded = set() self.policy.side_effect = lambda disk, excluded: "idle" if disk == "sda" else "read" self.assertNotIn("/dev/sda1", self.args()[1]) self.assertEqual({call.args[0] for call in self.standby.call_args_list}, {"nvme0n1", "sdb"}) def test_a_standby_disk_is_excluded_even_when_its_io_changed(self): self.excluded = set() self.standby.side_effect = lambda disk: disk == "sdb" self.assertEqual(self.args(), ["--devices", "/dev/nvme0n1p1,/dev/sda1"]) def test_all_allowed_disks_keep_existing_scan_behaviour(self): self.excluded = set() self.assertEqual(self.args(), []) def test_all_blocked_disks_skip_instead_of_falling_back_to_full_scan(self): self.excluded = {"nvme0n1", "sda", "sdb"} self.assertIsNone(self.args()) self.standby.assert_not_called() def test_all_standby_disks_skip(self): self.excluded = set() self.standby.return_value = True self.assertIsNone(self.args()) def test_bad_inventory_or_policy_never_authorizes_an_unrestricted_scan(self): for inventory, code in (("", 0), (INVENTORY, 1), ("sda1 part sda", 0), (lsblk(("sda1", "part", "sda", None)), 0), (lsblk(("../sda", "disk", None, None)), 0)): self.assertIsNone(self.args(inventory, code)) for error in (FileNotFoundError(), subprocess.TimeoutExpired("lsblk", 5)): with patch.object(scope.subprocess, "run", side_effect=error): self.assertIsNone(scope.lvm_device_args(self.standby)) self.policy.side_effect = RuntimeError("policy unavailable") self.assertIsNone(self.args()) def test_raid_multipath_and_encrypted_devices_follow_their_disks(self): inventory = lsblk( ("sda", "disk", None, None), ("sda1", "part", "sda", "linux_raid_member"), ("sdb", "disk", None, None), ("sdb1", "part", "sdb", "linux_raid_member"), ("md0", "raid1", "sda1", "LVM2_member"), ("md0", "raid1", "sdb1", "LVM2_member"), ("sdc", "disk", None, None), ("sdc1", "part", "sdc", "crypto_LUKS"), ("dm-0", "crypt", "sdc1", "LVM2_member"), ("dm-1", "lvm", "dm-0", "ext4"), ("sdd", "disk", None, None), ("sde", "disk", None, None), ("dm-2", "mpath", "sdd", None), ("dm-2", "mpath", "sde", None), ("dm-3", "part", "dm-2", "LVM2_member")) self.excluded = {"sdb"} # md0 reads sdb as well, so it stays out; the LUKS volume and the # multipath partition are built only on readable disks. Disks that # hold no physical volume are never named, so LVM does not open them. self.assertEqual(self.args(inventory), ["--devices", "/dev/dm-0,/dev/dm-3"]) self.excluded = set() self.assertEqual(self.args(inventory), []) class LvmReaderTests(unittest.TestCase): def extract(self, file, name, owner=None, namespace=None): tree = ast.parse((SCRIPTS / file).read_text()) body = tree.body if owner is None else next(n.body for n in tree.body if isinstance(n, ast.ClassDef) and n.name == owner) node = next(n for n in body if isinstance(n, ast.FunctionDef) and n.name == name) namespace = dict(namespace or {}) exec(compile(ast.Module(body=[node], type_ignores=[]), file, "exec"), namespace) return namespace[name] def test_both_helpers_delegate_to_the_same_policy(self): for file in ("flask_server.py", "health_monitor.py"): standby = Mock() function = self.extract(file, "_lvm_device_args", namespace={"_hdd_in_standby": standby}) with patch.object(scope, "lvm_device_args", return_value=None) as shared: self.assertIsNone(function()) shared.assert_called_once_with(standby) def test_health_skips_lvs_and_vgs_when_no_scan_is_permitted(self): run = Mock(return_value=types.SimpleNamespace(returncode=0)) function = self.extract("health_monitor.py", "_check_lvm", "HealthMonitor", { "Dict": dict, "Any": object, "subprocess": types.SimpleNamespace(run=run), "_lvm_device_args": lambda: None, }) result = function(None) self.assertEqual(result["status"], "INFO") self.assertTrue(result["skipped"]) self.assertEqual([call.args[0] for call in run.call_args_list], [["which", "lvs"]]) def test_storage_skips_pvs_when_no_scan_is_permitted(self): tree = ast.parse((SCRIPTS / "flask_server.py").read_text()) function = next(n for n in tree.body if isinstance(n, ast.FunctionDef) and n.name == "get_system_disks") block = next(node for node in function.body if isinstance(node, ast.Try) and "'pvs'" in ast.unparse(node)) run = Mock(side_effect=AssertionError("pvs must not run")) namespace = {"subprocess": types.SimpleNamespace(run=run), "_lvm_device_args": lambda: None} exec(compile(ast.Module(body=[block], type_ignores=[]), "flask_server.py", "exec"), namespace) run.assert_not_called() def test_module_is_shipped(self): self.assertIn('cp "$SCRIPT_DIR/lvm_device_scope.py" "$APP_DIR/usr/bin/"', (SCRIPTS / "build_appimage.sh").read_text()) class DiskReadPolicyTests(unittest.TestCase): """Only the exclusions in Settings keep a disk from being read.""" def test_a_disk_without_activity_is_still_read_unless_excluded(self): import disk_temperature_history as dth with patch.object(dth, "_excluded_disk_names", return_value={"sdc"}): self.assertEqual(dth.disk_read_policy("sdb"), dth.READ) self.assertEqual(dth.disk_read_policy("sdb"), dth.READ) self.assertEqual(dth.disk_read_policy("sdc"), dth.EXCLUDED) class QuietDiskIdentityTests(unittest.TestCase): """A rotational disk is read on schedule; a parked one is not woken and is still shown by its model, serial and type.""" def setUp(self): folder = tempfile.TemporaryDirectory() self.addCleanup(folder.cleanup) root = Path(folder.name) for name, value in (("sys/block/sdb/device/model", "WDC WD40EFRX-68N\n"), ("sys/block/sdb/dev", "8:16\n"), ("sys/block/sdb/queue/rotational", "1\n"), ("run/udev/data/b8:16", "E:ID_MODEL=WDC_WD40EFRX-68N32N0\nE:ID_SERIAL_SHORT=WD-WCC7K4FV37J0\n")): (root / name).parent.mkdir(parents=True, exist_ok=True) (root / name).write_text(value) self.policy = "read" self.disk_module = types.ModuleType("disk_temperature_history") self.disk_module.disk_read_policy = lambda disk: self.policy modules = patch.dict(sys.modules, disk_temperature_history=self.disk_module) modules.start() self.addCleanup(modules.stop) self.standby = Mock(return_value=False) self.read = Mock(return_value={"model": "WDC WD40EFRX-68N32N0", "serial": "WD-WCC7K4FV37J0", "rotation_rate": 5400, "health": "healthy", "temperature": 31}) self.cache = {} namespace = {"Path": lambda path: root / path.lstrip("/"), "time": __import__("time"), "_smart_result_cache": self.cache, "_SMART_RESULT_TTL": 30, "_hdd_in_standby": self.standby, "_get_smart_data_uncached": self.read, "_smart_data_useful": lambda data: data.get("model") != "Unknown", "_smart_fail_backoff": {}, "_smart_fail_counts": {}, "_smart_probe_cache": {}, "_SMART_FAIL_THRESHOLD": 3, "_SMART_FAIL_BACKOFF_SEC": 3600} tree = ast.parse((SCRIPTS / "flask_server.py").read_text()) nodes = [n for n in tree.body if isinstance(n, ast.FunctionDef) and n.name in ("_smart_default_payload", "_smart_identity_payload", "get_smart_data")] exec(compile(ast.Module(body=nodes, type_ignores=[]), "flask_server.py", "exec"), namespace) self.get = namespace["get_smart_data"] def test_a_spinning_disk_is_read(self): data = self.get("sdb") self.assertEqual((data["model"], data["rotation_rate"], data["health"], data["temperature"]), ("WDC WD40EFRX-68N32N0", 5400, "healthy", 31)) self.read.assert_called_once() def test_a_parked_disk_is_not_woken_and_keeps_its_identity(self): self.standby.return_value = True data = self.get("sdb") self.read.assert_not_called() self.assertEqual((data["model"], data["serial"], data["rotation_rate"], data["standby"]), ("WDC WD40EFRX-68N32N0", "WD-WCC7K4FV37J0", -1, True)) def test_an_excluded_disk_receives_no_command(self): self.policy = "excluded" data = self.get("sdb") self.standby.assert_not_called() self.read.assert_not_called() self.assertEqual((data["model"], data["rotation_rate"], data["excluded"]), ("WDC WD40EFRX-68N32N0", -1, True)) if __name__ == "__main__": unittest.main()