frostfs-testlib/tests/test_local_shell.py

from unittest import TestCase

from frostfs_testlib.shell.interfaces import CommandOptions, InteractiveInput
from frostfs_testlib.shell.local_shell import LocalShell
from helpers import format_error_details, get_output_lines


class TestLocalShellInteractive(TestCase):
    @classmethod
    def setUpClass(cls):
        cls.shell = LocalShell()

    def test_command_with_one_prompt(self):
        script = "password = input('Password: '); print(password)"

        inputs = [InteractiveInput(prompt_pattern="Password", input="test")]
        result = self.shell.exec(
            f'python3 -c "{script}"', CommandOptions(interactive_inputs=inputs)
        )

        self.assertEqual(0, result.return_code)
        self.assertEqual(["Password: test", "test"], get_output_lines(result))
        self.assertEqual("", result.stderr)

    def test_command_with_several_prompts(self):
        script = (
            "input1 = input('Input1: '); print(input1); "
            "input2 = input('Input2: '); print(input2)"
        )
        inputs = [
            InteractiveInput(prompt_pattern="Input1", input="test1"),
            InteractiveInput(prompt_pattern="Input2", input="test2"),
        ]

        result = self.shell.exec(
            f'python3 -c "{script}"', CommandOptions(interactive_inputs=inputs)
        )

        self.assertEqual(0, result.return_code)
        self.assertEqual(
            ["Input1: test1", "test1", "Input2: test2", "test2"], get_output_lines(result)
        )
        self.assertEqual("", result.stderr)

    def test_failed_command_with_check(self):
        script = "invalid script"
        inputs = [InteractiveInput(prompt_pattern=".*", input="test")]

        with self.assertRaises(RuntimeError) as exc:
            self.shell.exec(f'python3 -c "{script}"', CommandOptions(interactive_inputs=inputs))

        error = format_error_details(exc.exception)
        self.assertIn("Error", error)
        # TODO: it would be nice to have return code as well
        # self.assertIn("return code: 1", error)

    def test_failed_command_without_check(self):
        script = "invalid script"
        inputs = [InteractiveInput(prompt_pattern=".*", input="test")]

        result = self.shell.exec(
            f'python3 -c "{script}"',
            CommandOptions(interactive_inputs=inputs, check=False),
        )
        self.assertEqual(1, result.return_code)

    def test_non_existing_binary(self):
        inputs = [InteractiveInput(prompt_pattern=".*", input="test")]

        with self.assertRaises(RuntimeError) as exc:
            self.shell.exec("not-a-command", CommandOptions(interactive_inputs=inputs))

        error = format_error_details(exc.exception)
        self.assertIn("The command was not found", error)


class TestLocalShellNonInteractive(TestCase):
    @classmethod
    def setUpClass(cls):
        cls.shell = LocalShell()

    def test_successful_command(self):
        script = "print('test')"

        result = self.shell.exec(f'python3 -c "{script}"')

        self.assertEqual(0, result.return_code)
        self.assertEqual("test", result.stdout.strip())
        self.assertEqual("", result.stderr)

    def test_invalid_command_with_check(self):
        script = "invalid script"

        with self.assertRaises(RuntimeError) as exc:
            self.shell.exec(f'python3 -c "{script}"')

        error = format_error_details(exc.exception)
        self.assertIn("Error", error)
        self.assertIn("return code: 1", error)

    def test_invalid_command_without_check(self):
        script = "invalid script"

        result = self.shell.exec(f'python3 -c "{script}"', CommandOptions(check=False))

        self.assertEqual(1, result.return_code)
        self.assertIn("Error", result.stdout)

    def test_non_existing_binary(self):
        with self.assertRaises(RuntimeError) as exc:
            self.shell.exec("not-a-command")

        error = format_error_details(exc.exception)
        self.assertIn("return code: 127", error)