chocolatey: add viruscheck as an optional cli argument to install

Author: Sxderp

changelog/68558.added.md

@@ -0,0 +1 @@
+Add an option in the chocolatey state and module so that the viruscheck flag can be controlled.

salt/modules/chocolatey.py

@@ -578,6 +578,7 @@ def install(
     package_args=None,
     allow_multiple=False,
     execution_timeout=None,
+    viruscheck=None,
 ):
     """
     Instructs Chocolatey to install a package.
@@ -642,6 +643,13 @@ def install(
 
             .. versionadded:: 2018.3.0
 
+        viruscheck (bool):
+            Enable or disable the chocolatey virus check extension (licensed
+            version only). If not provided then no arguments are added.
+            Default is ``None``.
+
+            .. versionadded:: 3006.18
+
     Returns:
         str: The output of the ``chocolatey`` command
 
@@ -683,6 +691,9 @@ def install(
         cmd.append("--allow-multiple")
     if execution_timeout:
         cmd.extend(["--execution-timeout", execution_timeout])
+    if viruscheck is not None:
+        virusarg = "--viruscheck" if viruscheck else "--skipviruscheck"
+        cmd.append(virusarg)
 
     # Salt doesn't need to see the progress
     cmd.extend(_no_progress())

salt/states/chocolatey.py

@@ -35,6 +35,7 @@ def installed(
     package_args=None,
     allow_multiple=False,
     execution_timeout=None,
+    viruscheck=None,
 ):
     """
     Installs a package if not already installed
@@ -89,6 +90,11 @@ def installed(
             Chocolatey execution timeout value you want to pass to the
             installation process. Default is ``None``.
 
+        viruscheck (bool):
+            Enable or disable the chocolatey virus check extension (licensed
+            version only). If not provided then no arguments are added.
+            Default is ``None``.
+
     Example:
 
     .. code-block:: yaml
@@ -170,6 +176,7 @@ def installed(
         package_args=package_args,
         allow_multiple=allow_multiple,
         execution_timeout=execution_timeout,
+        viruscheck=viruscheck,
     )
 
     if "Running chocolatey failed" not in result:

tests/pytests/unit/modules/test_chocolatey.py

@@ -277,6 +277,32 @@ def test_add_source(choco_path):
         cmd_run_all_mock.assert_called_with(expected_call, python_shell=False)
 
 
+def test_install_viruscheck_true():
+    mock_version = MagicMock(return_value="2.0.1")
+    mock_find = MagicMock(return_value=choco_path)
+    mock_run = MagicMock(return_value={"stdout": "No packages", "retcode": 0})
+    with patch.object(chocolatey, "chocolatey_version", mock_version), patch.object(
+        chocolatey, "_find_chocolatey", mock_find
+    ), patch.dict(chocolatey.__salt__, {"cmd.run_all": mock_run}):
+        chocolatey.install("busybox", viruscheck=True)
+        # --no-progress and --yes populated from separate functions within the module.
+        expected_call = [choco_path, "install", "busybox", "--viruscheck", "--no-progress", "--yes"]
+        mock_run.assert_called_with(expected_call, python_shell=False)
+
+
+def test_install_viruscheck_false():
+    mock_version = MagicMock(return_value="2.0.1")
+    mock_find = MagicMock(return_value=choco_path)
+    mock_run = MagicMock(return_value={"stdout": "No packages", "retcode": 0})
+    with patch.object(chocolatey, "chocolatey_version", mock_version), patch.object(
+        chocolatey, "_find_chocolatey", mock_find
+    ), patch.dict(chocolatey.__salt__, {"cmd.run_all": mock_run}):
+        chocolatey.install("busybox", viruscheck=False)
+        # --no-progress and --yes populated from separate functions within the module.
+        expected_call = [choco_path, "install", "busybox", "--skipviruscheck", "--no-progress", "--yes"]
+        mock_run.assert_called_with(expected_call, python_shell=False)
+
+
 def test_list_pre_2_0_0():
     mock_version = MagicMock(return_value="1.2.1")
     mock_find = MagicMock(return_value=choco_path)