Function test

salt/modules/win_dsc_resource.py:188–247

r""" Test whether a DSC resource is in the desired state by calling ``Invoke-DscResource -Method Test``. Args: name (str): The name of the DSC resource to test. Required. module_name (str): The name of the PowerShell module that contains the res

(name, module_name, properties)

def test(name, module_name, properties):
    r"""
    Test whether a DSC resource is in the desired state by calling
    ``Invoke-DscResource -Method Test``.

    Args:

        name (str):
            The name of the DSC resource to test. Required.

        module_name (str):
            The name of the PowerShell module that contains the resource.
            Required.

        properties (dict):
            A dictionary of the desired resource properties. Required.

    Returns:
        bool: ``True`` if the resource is already in the desired state,
        ``False`` if changes are needed.

    Raises:
        CommandExecutionError: If the PowerShell call fails.
        SaltInvocationError: If required arguments are missing or invalid.

    CLI Example:

    .. code-block:: bash

        salt '*' dsc_resource.test File PSDesiredStateConfiguration \
            properties="{'DestinationPath': 'C:\\Temp\\test.txt', 'Ensure': 'Present'}"

    .. code-block:: bash

        salt '*' dsc_resource.test WindowsFeature PSDesiredStateConfiguration \
            properties="{'Name': 'Web-Server', 'Ensure': 'Present'}"

    .. versionadded:: 3008.1
    """
    if not name:
        raise SaltInvocationError("name is required")
    if not module_name:
        raise SaltInvocationError("module_name is required")
    if not isinstance(properties, dict):
        raise SaltInvocationError("properties must be a dict")

    ps_prop = _dict_to_ps_hashtable(properties)
    cmd = (
        f"(Invoke-DscResource"
        f" -Name '{_ps_quote(name)}'"
        f" -ModuleName '{_ps_quote(module_name)}'"
        f" -Method Test"
        f" -Property {ps_prop}).InDesiredState"
    )
    log.debug("DSC Resource test: %s", cmd)
    with PowerShellSession() as session:
        result = session.run(cmd)
    if isinstance(result, bool):