Merge pull request #62994 from twangboy/win_wua

Allow win_wua to load if CryptSvc set to Manual Start

changelog/62993.fixed

@@ -0,0 +1 @@
+Fixed issue with win_wua module where it wouldn't load if the CryptSvc was set to Manual start

salt/modules/win_wua.py

@@ -108,7 +108,7 @@ def __virtual__():
             "be disabled",
         )
 
-    if not salt.utils.win_service.info("CryptSvc")["StartType"] == "Auto":
+    if salt.utils.win_service.info("CryptSvc")["StartType"] == "Disabled":
         return (
             False,
             "WUA: The Cryptographic Services service (CryptSvc) must not be disabled",

tests/pytests/unit/modules/test_win_wua.py

@@ -0,0 +1,280 @@
+"""
+Test the win_wua execution module
+"""
+import pytest
+
+import salt.modules.win_wua as win_wua
+import salt.utils.platform
+import salt.utils.win_update
+from tests.support.mock import MagicMock, patch
+
+pytestmark = [
+    pytest.mark.windows_whitelisted,
+    pytest.mark.skip_unless_on_windows,
+]
+
+
+@pytest.fixture
+def updates_list():
+    return {
+        "ca3bb521-a8ea-4e26-a563-2ad6e3108b9a": {"KBs": ["KB4481252"]},
+        "07609d43-d518-4e77-856e-d1b316d1b8a8": {"KBs": ["KB925673"]},
+        "fbaa5360-a440-49d8-a3b6-0c4fc7ecaa19": {"KBs": ["KB4481252"]},
+        "a873372b-7a5c-443c-8022-cd59a550bef4": {"KBs": ["KB3193497"]},
+        "14075cbe-822e-4004-963b-f50e08d45563": {"KBs": ["KB4540723"]},
+        "d931e99c-4dda-4d39-9905-0f6a73f7195f": {"KBs": ["KB3193497"]},
+        "afda9e11-44a0-4602-9e9b-423af11ecaed": {"KBs": ["KB4541329"]},
+        "a0f997b1-1abe-4a46-941f-b37f732f9fbd": {"KBs": ["KB3193497"]},
+        "eac02b09-d745-4891-b80f-400e0e5e4b6d": {"KBs": ["KB4052623"]},
+        "0689e74b-54d1-4f55-a916-96e3c737db90": {"KBs": ["KB890830"]},
+    }
+
+
+@pytest.fixture
+def updates_summary():
+    return {"Installed": 10}
+
+
+class Updates:
+    @staticmethod
+    def list():
+        return {
+            "ca3bb521-a8ea-4e26-a563-2ad6e3108b9a": {"KBs": ["KB4481252"]},
+            "07609d43-d518-4e77-856e-d1b316d1b8a8": {"KBs": ["KB925673"]},
+            "fbaa5360-a440-49d8-a3b6-0c4fc7ecaa19": {"KBs": ["KB4481252"]},
+            "a873372b-7a5c-443c-8022-cd59a550bef4": {"KBs": ["KB3193497"]},
+            "14075cbe-822e-4004-963b-f50e08d45563": {"KBs": ["KB4540723"]},
+            "d931e99c-4dda-4d39-9905-0f6a73f7195f": {"KBs": ["KB3193497"]},
+            "afda9e11-44a0-4602-9e9b-423af11ecaed": {"KBs": ["KB4541329"]},
+            "a0f997b1-1abe-4a46-941f-b37f732f9fbd": {"KBs": ["KB3193497"]},
+            "eac02b09-d745-4891-b80f-400e0e5e4b6d": {"KBs": ["KB4052623"]},
+            "0689e74b-54d1-4f55-a916-96e3c737db90": {"KBs": ["KB890830"]},
+        }
+
+    @staticmethod
+    def summary():
+        return {"Installed": 10}
+
+
+def test__virtual__not_windows():
+    """
+    Test __virtual__ function on Non-Windows
+    """
+    with patch("salt.utils.platform.is_windows", autospec=True, return_value=False):
+        expected = (False, "WUA: Only available on Windows systems")
+        result = win_wua.__virtual__()
+        assert result == expected
+
+
+def test__virtual__missing_pywin32():
+    """
+    Test __virtual__ function when pywin32 is not installed
+    """
+    with patch("salt.modules.win_wua.HAS_PYWIN32", False):
+        expected = (False, "WUA: Requires PyWin32 libraries")
+        result = win_wua.__virtual__()
+        assert result == expected
+
+
+def test__virtual__wuauserv_disabled():
+    """
+    Test __virtual__ function when the wuauserv service is disabled
+    """
+    mock_service_info = MagicMock(
+        side_effect=[
+            {"StartType": "Disabled"},  # wuauserv
+            {"StartType": "Auto"},  # msiserver
+            {"StartType": "Auto"},  # BITS
+            {"StartType": "Auto"},  # CryptSvc
+            {"StartType": "Auto"},  # TrustedInstaller
+        ]
+    )
+    with patch("salt.utils.win_service.info", mock_service_info):
+        expected = (
+            False,
+            "WUA: The Windows Update service (wuauserv) must not be disabled",
+        )
+        result = win_wua.__virtual__()
+        assert result == expected
+
+
+def test__virtual__msiserver_disabled():
+    """
+    Test __virtual__ function when the msiserver service is disabled
+    """
+    mock_service_info = MagicMock(
+        side_effect=[
+            {"StartType": "Auto"},  # wuauserv
+            {"StartType": "Disabled"},  # msiserver
+            {"StartType": "Auto"},  # BITS
+            {"StartType": "Auto"},  # CryptSvc
+            {"StartType": "Auto"},  # TrustedInstaller
+        ]
+    )
+    with patch("salt.utils.win_service.info", mock_service_info):
+        expected = (
+            False,
+            "WUA: The Windows Installer service (msiserver) must not be disabled",
+        )
+        result = win_wua.__virtual__()
+        assert result == expected
+
+
+def test__virtual__BITS_disabled():
+    """
+    Test __virtual__ function when the BITS service is disabled
+    """
+    mock_service_info = MagicMock(
+        side_effect=[
+            {"StartType": "Auto"},  # wuauserv
+            {"StartType": "Auto"},  # msiserver
+            {"StartType": "Disabled"},  # BITS
+            {"StartType": "Auto"},  # CryptSvc
+            {"StartType": "Auto"},  # TrustedInstaller
+        ]
+    )
+    with patch("salt.utils.win_service.info", mock_service_info):
+        expected = (
+            False,
+            "WUA: The Background Intelligent Transfer service (bits) must not be"
+            " disabled",
+        )
+        result = win_wua.__virtual__()
+        assert result == expected
+
+
+def test__virtual__BITS_manual():
+    """
+    Test __virtual__ function when the BITS service is set to manual
+    Should not disable the module (__virtual__ should return True)
+    """
+    mock_service_info = MagicMock(
+        side_effect=[
+            {"StartType": "Auto"},  # wuauserv
+            {"StartType": "Auto"},  # msiserver
+            {"StartType": "Manual"},  # BITS
+            {"StartType": "Auto"},  # CryptSvc
+            {"StartType": "Auto"},  # TrustedInstaller
+        ]
+    )
+    with patch("salt.utils.win_service.info", mock_service_info):
+        expected = True
+        result = win_wua.__virtual__()
+        assert result == expected
+
+
+def test__virtual__CryptSvc_disabled():
+    """
+    Test __virtual__ function when the CryptSvc service is disabled
+    """
+    mock_service_info = MagicMock(
+        side_effect=[
+            {"StartType": "Auto"},  # wuauserv
+            {"StartType": "Auto"},  # msiserver
+            {"StartType": "Auto"},  # BITS
+            {"StartType": "Disabled"},  # CryptSvc
+            {"StartType": "Auto"},  # TrustedInstaller
+        ]
+    )
+    with patch("salt.utils.win_service.info", mock_service_info):
+        expected = (
+            False,
+            "WUA: The Cryptographic Services service (CryptSvc) must not be"
+            " disabled",
+        )
+        result = win_wua.__virtual__()
+        assert result == expected
+
+
+def test__virtual__CryptSvc_manual():
+    """
+    Test __virtual__ function when the CryptSvc service is disabled
+    """
+    mock_service_info = MagicMock(
+        side_effect=[
+            {"StartType": "Auto"},  # wuauserv
+            {"StartType": "Auto"},  # msiserver
+            {"StartType": "Auto"},  # BITS
+            {"StartType": "Manual"},  # CryptSvc
+            {"StartType": "Auto"},  # TrustedInstaller
+        ]
+    )
+    with patch("salt.utils.win_service.info", mock_service_info):
+        result = win_wua.__virtual__()
+        assert result is True
+
+
+def test__virtual__TrustedInstaller_disabled():
+    """
+    Test __virtual__ function when the TrustedInstaller service is disabled
+    """
+    mock_service_info = MagicMock(
+        side_effect=[
+            {"StartType": "Auto"},  # wuauserv
+            {"StartType": "Auto"},  # msiserver
+            {"StartType": "Auto"},  # BITS
+            {"StartType": "Auto"},  # CryptSvc
+            {"StartType": "Disabled"},  # TrustedInstaller
+        ]
+    )
+    with patch("salt.utils.win_service.info", mock_service_info):
+        expected = (
+            False,
+            "WUA: The Windows Module Installer service (TrustedInstaller) must not"
+            " be disabled",
+        )
+        result = win_wua.__virtual__()
+        assert result == expected
+
+
+def test_installed(updates_list):
+    """
+    Test installed function default
+    """
+    expected = updates_list
+    with patch("salt.utils.winapi.Com", autospec=True), patch(
+        "win32com.client.Dispatch", autospec=True
+    ), patch.object(
+        salt.utils.win_update.WindowsUpdateAgent, "refresh", autospec=True
+    ), patch.object(
+        salt.utils.win_update, "Updates", autospec=True, return_value=Updates()
+    ):
+        result = win_wua.installed()
+        assert result == expected
+
+
+def test_installed_summary(updates_summary):
+    """
+    Test installed function with summary=True
+    """
+    expected = updates_summary
+    # Remove all updates that are not installed
+    with patch("salt.utils.winapi.Com", autospec=True), patch(
+        "win32com.client.Dispatch", autospec=True
+    ), patch.object(
+        salt.utils.win_update.WindowsUpdateAgent, "refresh", autospec=True
+    ), patch.object(
+        salt.utils.win_update, "Updates", autospec=True, return_value=Updates()
+    ):
+        result = win_wua.installed(summary=True)
+        assert result == expected
+
+
+def test_installed_kbs_only(updates_list):
+    """
+    Test installed function with kbs_only=True
+    """
+    expected = set()
+    for update in updates_list:
+        expected.update(updates_list[update]["KBs"])
+    expected = sorted(expected)
+    # Remove all updates that are not installed
+    with patch("salt.utils.winapi.Com", autospec=True), patch(
+        "win32com.client.Dispatch", autospec=True
+    ), patch.object(
+        salt.utils.win_update.WindowsUpdateAgent, "refresh", autospec=True
+    ), patch.object(
+        salt.utils.win_update, "Updates", autospec=True, return_value=Updates()
+    ):
+        result = win_wua.installed(kbs_only=True)
+        assert result == expected