salt/tests/integration/shell/test_arguments.py

# -*- coding: utf-8 -*-
"""
    Test Salt's argument parser
"""

from __future__ import absolute_import

import pytest
import salt.utils.args
from tests.support.case import ModuleCase
from tests.support.helpers import requires_salt_modules, slowTest


@requires_salt_modules("test.ping", "test.arg")
@pytest.mark.windows_whitelisted
class ArgumentTestCase(ModuleCase):
    @slowTest
    def test_unsupported_kwarg(self):
        """
        Test passing a non-supported keyword argument. The relevant code that
        checks for invalid kwargs is located in salt/minion.py, within the
        'load_args_and_kwargs' function.
        """
        self.assertIn(
            ("ERROR executing 'test.ping': The following keyword arguments"),
            self.run_function("test.ping", foo="bar"),
        )

    @slowTest
    def test_kwarg_name_containing_dashes(self):
        """
        Tests the arg parser to ensure that kwargs with dashes in the arg name
        are properly identified as kwargs. If this fails, then the KWARG_REGEX
        variable in salt/utils/__init__.py needs to be fixed.
        """
        # We need to use parse_input here because run_function now requires
        # kwargs to be passed in as *actual* kwargs, and dashes are not valid
        # characters in Python kwargs.
        self.assertEqual(
            self.run_function("test.arg", salt.utils.args.parse_input(["foo-bar=baz"]))
            .get("kwargs", {})
            .get("foo-bar"),
            "baz",
        )

    @slowTest
    def test_argument_containing_pound_sign(self):
        """
        Tests the argument parsing to ensure that a CLI argument with a pound
        sign doesn't have the pound sign interpreted as a comment and removed.
        See https://github.com/saltstack/salt/issues/8585 for more info.
        """
        arg = "foo bar #baz"
        self.assertEqual(self.run_function("test.echo", [arg]), arg)