test_api_command.py

from unittest import TestCase

try:
    from pathlib import PurePosixPath

    HAS_PATHLIB = True
except ImportError:
    HAS_PATHLIB = False

import pytest

from pyinfra.api import (
    FileDownloadCommand,
    FileUploadCommand,
    FunctionCommand,
    MaskString,
    QuoteString,
    RsyncCommand,
    StringCommand,
)
from pyinfra.api.command import PyinfraCommand


class TestBaseCommand(TestCase):
    def test_base_command_no_execute(self):
        cmd = PyinfraCommand()
        with self.assertRaises(NotImplementedError):
            cmd.execute(None, None, None)


class TestStringCommand(TestCase):
    def test_normal(self):
        cmd = StringCommand("hello", "world")
        assert str(cmd) == cmd.get_raw_value() == "hello world"

    def test_masked(self):
        cmd = StringCommand(MaskString("adsfg"))
        assert cmd.get_raw_value() == "adsfg"
        assert str(cmd) == "***"

    def test_mixed_masked(self):
        cmd = StringCommand("some", "stuff", MaskString("mask me"), "other", "stuff")
        assert cmd.get_raw_value() == "some stuff mask me other stuff"
        assert str(cmd) == "some stuff *** other stuff"

    def test_nested(self):
        nested_cmd = StringCommand("some", "stuff")
        cmd = StringCommand("hello", nested_cmd, "world")
        assert str(cmd) == cmd.get_raw_value() == "hello some stuff world"

    def test_quote(self):
        quoted_str = QuoteString("quote me!")
        cmd = StringCommand("hello", quoted_str)
        assert str(cmd) == cmd.get_raw_value() == "hello 'quote me!'"

    def test_eq(self):
        assert StringCommand("hello world") == StringCommand("hello world")
        with self.assertRaises(AssertionError):
            assert StringCommand("a") == StringCommand("b")

    def test_separator(self):
        cmd = StringCommand("hello world", "yes", _separator="")
        assert str(cmd) == "hello worldyes"

    def test_int(self):
        cmd = StringCommand("hello", "world", 4420)
        assert str(cmd) == "hello world 4420"

    def test_list(self):
        cmd = StringCommand("hello", "world", ["a", "b", "c"])
        assert str(cmd) == "hello world ['a', 'b', 'c']"

    @pytest.mark.skipif(
        not HAS_PATHLIB,
        reason="Requires Python 3.4+ (pathlib module)",
    )
    def test_path(self):
        cmd = StringCommand("hello", "world", PurePosixPath("/path/to/somewhere"))
        assert str(cmd) == "hello world /path/to/somewhere"


class TestFileCommands(TestCase):
    def test_file_upload_command_repr(self):
        cmd = FileUploadCommand("src", "dest")
        assert repr(cmd) == "FileUploadCommand(src, dest)"

    def test_file_download_command_repr(self):
        cmd = FileDownloadCommand("src", "dest")
        assert repr(cmd) == "FileDownloadCommand(src, dest)"

    def test_rsync_command_repr(self):
        cmd = RsyncCommand("src", "dest", ["-a"])
        assert repr(cmd) == "RsyncCommand(src, dest, ['-a'])"


class TestFunctionCommand(TestCase):
    def test_function_command_repr(self):
        def some_function():
            pass

        cmd = FunctionCommand(some_function, (), {})
        assert repr(cmd) == "FunctionCommand(some_function, (), {})"