tests/pytests/unit/utils/test_args.py - master - githubmirror/salt

tests/pytests/unit/utils/test_args.py
415 строк13 KB
Pedro Algarvio
Update to isort 5.10.1
01 авг 2022, 21:49
01 авг 2022, 21:494d49013
import logging
from collections import namedtuple

import pytest

import salt.utils.args
from salt.exceptions import SaltInvocationError
from tests.support.mock import DEFAULT, patch

log = logging.getLogger(__name__)


def test_condition_input_string():
    """
    Test passing a jid on the command line
    """
    cmd = salt.utils.args.condition_input(["*", "foo.bar", 20141020201325675584], None)
    assert isinstance(cmd[2], str)


def test_clean_kwargs():
    assert salt.utils.args.clean_kwargs(foo="bar") == {"foo": "bar"}
    assert salt.utils.args.clean_kwargs(__pub_foo="bar") == {}
    assert salt.utils.args.clean_kwargs(__foo_bar="gwar") == {}
    assert salt.utils.args.clean_kwargs(foo_bar="gwar") == {"foo_bar": "gwar"}


def test_get_function_argspec():
    class DummyClass:
        def __init__(self, first):
            pass

        def __call__(self, first):
            pass

    dummy_class = DummyClass("foo")

    def dummy_func_nodefault(first, second, third):
        pass

    def dummy_func_default(first, second, third="fourth"):
        pass

    def dummy_func_varargs_keywords(*args, **kwargs):
        pass

    def dummy_func_annotations(first: int, second: str) -> bool:
        pass

    _ArgSpec = namedtuple("ArgSpec", "args varargs keywords defaults")

    # Callable class instance
    expected_argspec = _ArgSpec(
        args=["first"],
        varargs=None,
        keywords=None,
        defaults=None,
    )
    ret = salt.utils.args.get_function_argspec(dummy_class)
    assert ret == expected_argspec

    # Function with no varargs, no keywords, and no defaults
    expected_argspec = _ArgSpec(
        args=["first", "second", "third"],
        varargs=None,
        keywords=None,
        defaults=None,
    )
    ret = salt.utils.args.get_function_argspec(dummy_func_nodefault)
    assert ret == expected_argspec

    # Function with no varargs, no keywords, and one default
    expected_argspec = _ArgSpec(
        args=["first", "second", "third"],
        varargs=None,
        keywords=None,
        defaults=("fourth",),
    )
    ret = salt.utils.args.get_function_argspec(dummy_func_default)
    assert ret == expected_argspec

    # Function with annotations
    expected_argspec = _ArgSpec(
        args=["first", "second"],
        varargs=None,
        keywords=None,
        defaults=None,
    )
    ret = salt.utils.args.get_function_argspec(dummy_func_annotations)
    assert ret == expected_argspec

    # Function with both varargs and keywords
    expected_argspec = _ArgSpec(
        args=[],
        varargs="args",
        keywords="kwargs",
        defaults=None,
    )
    ret = salt.utils.args.get_function_argspec(dummy_func_varargs_keywords)
    assert ret == expected_argspec

    # Test that is_class_method=True is respected. Note that we don't
    # actually have a decorated function from rest_tornado here to test
    # this case, but we're testing for the behavior we expect, which is
    # that the first argument is popped off of the args.
    expected_argspec = _ArgSpec(
        args=["second", "third"],
        varargs=None,
        keywords=None,
        defaults=None,
    )
    ret = salt.utils.args.get_function_argspec(
        dummy_func_nodefault, is_class_method=True
    )
    assert ret == expected_argspec


def test_parse_kwarg():
    ret = salt.utils.args.parse_kwarg("foo=bar")
    assert ret == ("foo", "bar")

    ret = salt.utils.args.parse_kwarg("foobar")
    assert ret == (None, None)


def test_arg_lookup():
    def dummy_func(first, second, third, fourth="fifth"):
        pass

    expected_dict = {
        "args": ["first", "second", "third"],
        "kwargs": {"fourth": "fifth"},
    }
    ret = salt.utils.args.arg_lookup(dummy_func)
    assert ret == expected_dict


def test_format_call():
    with patch("salt.utils.args.arg_lookup") as arg_lookup:

        def dummy_func(first=None, second=None, third=None):
            pass

        arg_lookup.return_value = {
            "args": ["first", "second", "third"],
            "kwargs": {},
        }
        get_function_argspec = DEFAULT
        get_function_argspec.return_value = namedtuple(
            "ArgSpec", "args varargs keywords defaults"
        )(
            args=["first", "second", "third", "fourth"],
            varargs=None,
            keywords=None,
            defaults=("fifth",),
        )

        # Make sure we raise an error if we don't pass in the requisite number of arguments
        with pytest.raises(SaltInvocationError):
            salt.utils.args.format_call(dummy_func, {"1": 2})

        # Make sure we warn on invalid kwargs
        with pytest.raises(SaltInvocationError):
            salt.utils.args.format_call(
                dummy_func, {"first": 2, "seconds": 2, "third": 3}
            )

        ret = salt.utils.args.format_call(
            dummy_func,
            {"first": 2, "second": 2, "third": 3},
            expected_extra_kws=("first", "second", "third"),
        )
        assert ret == {"args": [], "kwargs": {}}


def test_format_call_simple_args():
    def foo(one, two=2, three=3):
        pass

    assert salt.utils.args.format_call(foo, dict(one=10, two=20, three=30)) == {
        "args": [10],
        "kwargs": dict(two=20, three=30),
    }
    assert salt.utils.args.format_call(foo, dict(one=10, two=20)) == {
        "args": [10],
        "kwargs": dict(two=20, three=3),
    }
    assert salt.utils.args.format_call(foo, dict(one=2)) == {
        "args": [2],
        "kwargs": dict(two=2, three=3),
    }


def test_format_call_mimic_typeerror_exceptions():
    def foo(one, two=2, three=3):
        pass

    def foo2(one, two, three=3):
        pass

    with pytest.raises(SaltInvocationError) as exc:
        salt.utils.args.format_call(foo, dict(two=3))
    assert "foo takes at least 1 argument (0 given)" in str(exc)

    with pytest.raises(SaltInvocationError) as exc:
        salt.utils.args.format_call(foo2, dict(one=1))
    assert "foo2 takes at least 2 arguments (1 given)" in str(exc)


def test_argspec_report():
    def _test_spec(arg1, arg2, kwarg1=None):
        pass

    test_functions = {"test_module.test_spec": _test_spec}
    ret = salt.utils.args.argspec_report(test_functions, "test_module.test_spec")
    assert ret == {
        "test_module.test_spec": {
            "kwargs": None,
            "args": ["arg1", "arg2", "kwarg1"],
            "defaults": (None,),
            "varargs": None,
        }
    }


def test_test_mode():
    assert salt.utils.args.test_mode(test=True)
    assert salt.utils.args.test_mode(Test=True)
    assert salt.utils.args.test_mode(tEsT=True)


def test_parse_function_no_args():
    fun, args, kwargs = salt.utils.args.parse_function("amod.afunc()")
    assert fun == "amod.afunc"
    assert args == []
    assert kwargs == {}


def test_parse_function_args_only():
    fun, args, kwargs = salt.utils.args.parse_function("amod.afunc(str1, str2)")
    assert fun == "amod.afunc"
    assert args == ["str1", "str2"]
    assert kwargs == {}


def test_parse_function_kwargs_only():
    fun, args, kwargs = salt.utils.args.parse_function("amod.afunc(kw1=val1, kw2=val2)")
    assert fun == "amod.afunc"
    assert args == []
    assert kwargs == {"kw1": "val1", "kw2": "val2"}


def test_parse_function_args_kwargs():
    fun, args, kwargs = salt.utils.args.parse_function(
        "amod.afunc(str1, str2, kw1=val1, kw2=val2)"
    )
    assert fun == "amod.afunc"
    assert args == ["str1", "str2"]
    assert kwargs == {"kw1": "val1", "kw2": "val2"}


def test_parse_function_malformed_no_name():
    fun, args, kwargs = salt.utils.args.parse_function(
        "(str1, str2, kw1=val1, kw2=val2)"
    )
    assert fun is None
    assert args is None
    assert kwargs is None


def test_parse_function_malformed_not_fun_def():
    fun, args, kwargs = salt.utils.args.parse_function("foo bar, some=text")
    assert fun is None
    assert args is None
    assert kwargs is None


def test_parse_function_wrong_bracket_style():
    fun, args, kwargs = salt.utils.args.parse_function(
        "amod.afunc[str1, str2, kw1=val1, kw2=val2]"
    )
    assert fun is None
    assert args is None
    assert kwargs is None


def test_parse_function_brackets_unbalanced():
    fun, args, kwargs = salt.utils.args.parse_function(
        "amod.afunc(str1, str2, kw1=val1, kw2=val2"
    )
    assert fun is None
    assert args is None
    assert kwargs is None
    fun, args, kwargs = salt.utils.args.parse_function(
        "amod.afunc(str1, str2, kw1=val1, kw2=val2]"
    )
    assert fun is None
    assert args is None
    assert kwargs is None
    fun, args, kwargs = salt.utils.args.parse_function(
        "amod.afunc(str1, str2, kw1=(val1[val2)], kw2=val2)"
    )
    assert fun is None
    assert args is None
    assert kwargs is None


def test_parse_function_brackets_in_quotes():
    fun, args, kwargs = salt.utils.args.parse_function(
        'amod.afunc(str1, str2, kw1="(val1[val2)]", kw2=val2)'
    )
    assert fun == "amod.afunc"
    assert args == ["str1", "str2"]
    assert kwargs == {"kw1": "(val1[val2)]", "kw2": "val2"}


def test_parse_function_quotes():
    fun, args, kwargs = salt.utils.args.parse_function(
        "amod.afunc(\"double \\\" single '\", 'double \" single \\'',"
        ' kw1="equal=equal", kw2=val2)'
    )
    assert fun == "amod.afunc"
    assert args == ["double \" single '", "double \" single '"]
    assert kwargs == {"kw1": "equal=equal", "kw2": "val2"}


def test_yamlify_arg():
    """
    Test that we properly yamlify CLI input. In several of the tests below `is`
    is used instead of ==. This is because we want to confirm that the return
    value is not a copy of the original, but the same instance as the original.
    """

    def _yamlify_arg(item):
        log.debug("Testing yamlify_arg with %r", item)
        return salt.utils.args.yamlify_arg(item)

    # Make sure non-strings are just returned back
    for item in (True, False, None, 123, 45.67, ["foo"], {"foo": "bar"}):
        assert _yamlify_arg(item) is item

    # Make sure whitespace-only isn't loaded as None
    for item in ("", "\t", " "):
        assert _yamlify_arg(item) is item

    # This value would be loaded as an int (123), the underscores would be
    # ignored. Test that we identify this case and return the original
    # value.
    item = "1_2_3"
    assert _yamlify_arg(item) is item

    # The '#' is treated as a comment when not part of a data structure, we
    # don't want that behavior
    for item in ("# hash at beginning", "Hello world! # hash elsewhere"):
        assert _yamlify_arg(item) is item

    # However we _do_ want the # to be intact if it _is_ within a data
    # structure.
    item = '["foo", "bar", "###"]'
    assert _yamlify_arg(item) == ["foo", "bar", "###"]
    item = '{"foo": "###"}'
    assert _yamlify_arg(item) == {"foo": "###"}

    # The string "None" should load _as_ None
    assert _yamlify_arg("None") is None

    # Leading dashes, or strings containing colons, will result in lists
    # and dicts, and we only want to load lists and dicts when the strings
    # look like data structures.
    for item in ("- foo", "foo: bar"):
        assert _yamlify_arg(item) is item

    # Make sure we don't load '|' as ''
    item = "|"
    assert _yamlify_arg(item) is item

    # Make sure we don't load '!' as something else (None in 2018.3, '' in newer)
    item = "!"
    assert _yamlify_arg(item) is item

    # Make sure we load ints, floats, and strings correctly
    assert _yamlify_arg("123") == 123
    assert _yamlify_arg("45.67") == 45.67
    assert _yamlify_arg("foo") == "foo"

    # We tested list/dict loading above, but there is separate logic when
    # the string contains a '#', so we need to test again here.
    assert _yamlify_arg('["foo", "bar"]') == ["foo", "bar"]
    assert _yamlify_arg('{"foo": "bar"}') == {"foo": "bar"}

    # Make sure that an empty string is loaded properly.
    assert _yamlify_arg("   ") == "   "

    # Make sure that we don't improperly load strings that would be
    # interpreted by PyYAML as YAML document start/end.
    assert _yamlify_arg("---") == "---"
    assert _yamlify_arg("--- ") == "--- "
    assert _yamlify_arg("...") == "..."
    assert _yamlify_arg(" ...") == " ..."

    # Make sure that non-printable whitespace is not YAML-loaded
    assert _yamlify_arg("foo\t\nbar") == "foo\t\nbar"


def test_arguments_regex():
    argument_matches = (
        ("pip=1.1", ("pip", "1.1")),
        ("pip==1.1", None),
        ("pip=1.2=1", ("pip", "1.2=1")),
    )
    for argument, match in argument_matches:
        if match is None:
            assert salt.utils.args.KWARG_REGEX.match(argument) is None
        else:
            assert salt.utils.args.KWARG_REGEX.match(argument).groups() == match