tests/pytests/functional/modules/cmd/test_run_win.py - master - githubmirror/salt

tests/pytests/functional/modules/cmd/test_run_win.py
175 строк5 KB
twangboy
Fix failing command quoting tests
07 май 2026, 00:37
07 май 2026, 00:3791714b1
import pytest

pytestmark = [
    pytest.mark.core_test,
    pytest.mark.windows_whitelisted,
    pytest.mark.skip_unless_on_windows,
]


@pytest.fixture(scope="module")
def account():
    with pytest.helpers.create_account() as _account:
        yield _account


@pytest.mark.parametrize(
    "exit_code, return_code, result",
    [
        (300, 0, True),
        (299, 299, False),
    ],
)
def test_cmd_exitcode(modules, state_tree, exit_code, return_code, result):
    """
    Test receiving an exit code with cmd.run
    """
    ret = modules.state.single(
        "cmd.run",
        name=f"exit {exit_code}",
        shell="cmd",
        success_retcodes=[2, 44, 300],
    )
    assert ret.result is result
    assert ret.filtered["changes"]["retcode"] == return_code


@pytest.mark.parametrize(
    "exit_code, return_code, result",
    [
        (300, 0, True),
        (299, 299, False),
    ],
)
def test_cmd_exitcode_runas(
    modules, state_tree, exit_code, return_code, result, account
):
    ret = modules.state.single(
        "cmd.run",
        name=f"exit {exit_code}",
        shell="cmd",
        success_retcodes=[2, 44, 300],
        runas=account.username,
        password=account.password,
    )
    assert ret.result is result
    assert ret.filtered["changes"]["retcode"] == return_code


_CMD_BUILTINS_CORE = [
    ("echo foo", "foo"),
    ("cmd /c echo foo", "foo"),
    ("whoami && echo foo", "foo"),
    ("echo \"foo 'bar'\"", "\"foo 'bar'\""),
]

# ``set /p`` / special-char cases need unquoted ``cmd /c`` + payload. ``win_runas``
# uses a single quoted ``/c`` argument; those cases are covered in ``test_cmd_builtins``
# only. See ``salt.platform.win.prepend_cmd`` (``quote_c_payload``).
_CMD_BUILTINS_EDGE = [
    ('echo|set /p="foo" & echo|set /p="bar"', "foobar"),
    ('''echo "&<>[]|{}^=;!'+,`~ "''', '''"&<>[]|{}^=;!'+,`~ "'''),
]


@pytest.mark.parametrize(
    "command, expected",
    _CMD_BUILTINS_CORE + _CMD_BUILTINS_EDGE,
)
def test_cmd_builtins(modules, command, expected):
    """
    Test builtin cmd.exe commands
    """
    result = modules.cmd.run(command, python_shell=True)
    assert expected in result


@pytest.mark.parametrize("command, expected", _CMD_BUILTINS_CORE)
def test_cmd_builtins_runas(modules, account, command, expected):
    """
    Test builtin cmd.exe commands with runas
    """
    result = modules.cmd.run(
        cmd=command,
        python_shell=True,
        runas=account.username,
        password=account.password,
    )
    assert expected in result


@pytest.mark.parametrize(
    "command, expected",
    [
        (["whoami.exe", "/?"], 0),
        (["whoami.exe", "/foo"], 1),
        ("whoami.exe /?", 0),
        ("whoami.exe /foo", 1),
    ],
)
def test_binary(modules, command, expected):
    """
    Test running a binary with cmd.run_all
    """
    result = modules.cmd.run_all(cmd=command)
    assert isinstance(result["pid"], int)
    assert result["retcode"] == expected


@pytest.mark.parametrize(
    "command, expected",
    [
        (["whoami.exe", "/?"], 0),
        (["whoami.exe", "/foo"], 1),
        ("whoami.exe /?", 0),
        ("whoami.exe /foo", 1),
    ],
)
def test_binary_runas(modules, account, command, expected):
    """
    Test running a binary with cmd.run_all and runas
    """
    result = modules.cmd.run_all(
        cmd=command, runas=account.username, password=account.password
    )
    assert isinstance(result["pid"], int)
    assert result["retcode"] == expected


@pytest.mark.parametrize(
    "command, env, expected",
    [
        ("echo %a%%b%", {"a": "foo", "b": "bar"}, "foobar"),
    ],
)
def test_cmd_env(modules, command, env, expected):
    """
    Test cmd.run with environment variables
    """
    result = modules.cmd.run_all(command, python_shell=True, env=env)
    assert isinstance(result["pid"], int)
    assert result["retcode"] == 0
    assert result["stdout"] == expected
    assert result["stderr"] == ""


@pytest.mark.parametrize(
    "command, expected, redirect_stderr",
    [
        (["whoami.exe", "/foo"], "/foo", True),
        (["whoami.exe", "/foo"], "/foo", False),
    ],
)
def test_redirect_stderr(modules, command, expected, redirect_stderr):
    """
    Test redirection of stderr to stdout by running cmd.run_all with invalid commands
    """
    result = modules.cmd.run_all(command, redirect_stderr=redirect_stderr)
    assert isinstance(result["pid"], int)
    assert result["retcode"] == 1
    if redirect_stderr:
        assert expected in result["stdout"]
        assert result["stderr"] == ""
    else:
        assert result["stdout"] == ""
        assert expected in result["stderr"]