WindowsFeature tool for managing Windows features

lisa/tools/__init__.py

@@ -124,6 +124,7 @@
 from .virtualclient import VcRunner, VcTargetInfo, VirtualClientTool
 from .who import Who
 from .whoami import Whoami
+from .windows_feature import WindowsFeature
 from .wsl import Wsl
 
 __all__ = [
@@ -260,5 +261,6 @@
     "VirtualClientTool",
     "Who",
     "Whoami",
+    "WindowsFeature",
     "Wsl",
 ]

lisa/tools/windows_feature.py

@@ -0,0 +1,85 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT license.
+
+from typing import Any, List
+
+from lisa.executable import Tool
+from lisa.tools.powershell import PowerShell
+from lisa.util import LisaException
+
+
+# WindowsFeature management tool for Windows Servers.
+# It can install, uninstall, and check the status of Windows features.
+# Hyper-V, DHCP etc. are examples of Windows features.
+# This tool uses PowerShell to manage Windows features.
+# Not supported on PC versions like Windows 10, 11 etc.
+class WindowsFeature(Tool):
+    @property
+    def command(self) -> str:
+        return ""
+
+    @property
+    def can_install(self) -> bool:
+        return False
+
+    def _check_exists(self) -> bool:
+        try:
+            self.node.tools[PowerShell].run_cmdlet(
+                "Get-WindowsFeature",
+                force_run=True,
+            )
+            self._log.debug("'Get-WindowsFeature' is installed")
+            return True
+        except LisaException as e:
+            self._log.debug(f"'Get-WindowsFeature' is not available: {e}")
+            return False
+
+    def _initialize(self, *args: Any, **kwargs: Any) -> None:
+        self._powershell = self.node.tools[PowerShell]
+
+    def install_feature(self, name: str) -> None:
+        if self.is_installed(name):
+            self._log.debug(f"Feature {name} is already installed.")
+            return
+        self._powershell.run_cmdlet(
+            f"Install-WindowsFeature -Name {name} -IncludeManagementTools",
+            force_run=True,
+        )
+
+    def uninstall_feature(self, name: str) -> None:
+        if not self.is_installed(name):
+            self._log.debug(f"Feature {name} is not installed.")
+            return
+        self._powershell.run_cmdlet(
+            f"Uninstall-WindowsFeature -Name {name}",
+            force_run=True,
+        )
+
+    def is_installed(self, name: str) -> bool:
+        return (
+            self._powershell.run_cmdlet(
+                f"Get-WindowsFeature -Name {name} | Select-Object -ExpandProperty Installed",  # noqa: E501
+                force_run=True,
+            ).strip()
+            == "True"
+        )
+
+    def get_installed_features(self) -> List[str]:
+        return (
+            self._powershell.run_cmdlet(
+                "Get-WindowsFeature | Where-Object { $_.Installed -eq $true } | Select-Object -ExpandProperty Name",  # noqa: E501
+                force_run=True,
+            )
+            .strip()
+            .split("\n")
+        )
+
+    def get_available_features(self) -> List[str]:
+        return (
+            self._powershell.run_cmdlet(
+                "Get-WindowsFeature | Where-Object { $_.Installed -eq $false } | Select-Object -ExpandProperty Name",  # noqa: E501
+                force_run=True,
+            )
+            .strip()
+            .split("\n")
+        )