borgmatic/tests/unit/commands/test_completions.py

134 lines
4.6 KiB
Python
Raw Normal View History

from argparse import Action
2023-05-06 20:16:45 +02:00
from collections import namedtuple
from typing import Tuple
import pytest
2023-05-06 19:56:54 +02:00
from borgmatic.commands.completion import (
exact_options_completion,
2023-05-06 19:56:54 +02:00
has_choice_options,
has_exact_options,
has_file_options,
has_unknown_required_param_options,
)
2023-05-06 20:16:45 +02:00
OptionType = namedtuple('OptionType', ['file', 'choice', 'unknown_required'])
TestCase = Tuple[Action, OptionType]
test_data: list[TestCase] = [
(Action('--flag', 'flag'), OptionType(file=False, choice=False, unknown_required=False)),
*(
(
Action('--flag', 'flag', metavar=metavar),
OptionType(file=True, choice=False, unknown_required=False),
)
for metavar in ('FILENAME', 'PATH')
),
(
Action('--flag', dest='config_paths'),
OptionType(file=True, choice=False, unknown_required=False),
),
(
Action('--flag', 'flag', metavar='OTHER'),
OptionType(file=False, choice=False, unknown_required=False),
),
(
Action('--flag', 'flag', choices=['a', 'b']),
OptionType(file=False, choice=True, unknown_required=False),
),
(
Action('--flag', 'flag', choices=['a', 'b'], type=str),
OptionType(file=False, choice=True, unknown_required=True),
),
(
Action('--flag', 'flag', choices=None),
OptionType(file=False, choice=False, unknown_required=False),
),
(
Action('--flag', 'flag', required=True),
OptionType(file=False, choice=False, unknown_required=True),
),
*(
(
Action('--flag', 'flag', nargs=nargs),
OptionType(file=False, choice=False, unknown_required=True),
)
for nargs in ('+', '*')
),
*(
(
Action('--flag', 'flag', metavar=metavar),
OptionType(file=False, choice=False, unknown_required=True),
)
for metavar in ('PATTERN', 'KEYS', 'N')
),
*(
(
Action('--flag', 'flag', type=type, default=None),
OptionType(file=False, choice=False, unknown_required=True),
)
for type in (int, str)
),
(
Action('--flag', 'flag', type=int, default=1),
OptionType(file=False, choice=False, unknown_required=False),
),
(
Action('--flag', 'flag', type=str, required=True, metavar='PATH'),
OptionType(file=True, choice=False, unknown_required=True),
),
(
Action('--flag', 'flag', type=str, required=True, metavar='PATH', default='/dev/null'),
OptionType(file=True, choice=False, unknown_required=True),
),
(
Action('--flag', 'flag', type=str, required=False, metavar='PATH', default='/dev/null'),
OptionType(file=True, choice=False, unknown_required=False),
),
]
2023-05-06 20:16:45 +02:00
@pytest.mark.parametrize('action, option_type', test_data)
def test_has_file_options_detects_file_options(action: Action, option_type: OptionType):
assert (
has_file_options(action) == option_type.file
), f'Action: {action} should be file={option_type.file}'
2023-05-06 19:56:54 +02:00
2023-05-06 20:16:45 +02:00
@pytest.mark.parametrize('action, option_type', test_data)
def test_has_choice_options_detects_choice_options(action: Action, option_type: OptionType):
assert (
has_choice_options(action) == option_type.choice
), f'Action: {action} should be choice={option_type.choice}'
2023-05-06 19:56:54 +02:00
2023-05-06 20:16:45 +02:00
@pytest.mark.parametrize('action, option_type', test_data)
2023-05-06 19:56:54 +02:00
def test_has_unknown_required_param_options_detects_unknown_required_param_options(
2023-05-06 20:16:45 +02:00
action: Action, option_type: OptionType
2023-05-06 19:56:54 +02:00
):
assert (
has_unknown_required_param_options(action) == option_type.unknown_required
), f'Action: {action} should be unknown_required={option_type.unknown_required}'
2023-05-06 20:16:45 +02:00
@pytest.mark.parametrize('action, option_type', test_data)
def test_has_exact_options_detects_exact_options(action: Action, option_type: OptionType):
assert has_exact_options(action) == (
2023-05-06 20:29:14 +02:00
True in option_type
), f'Action: {action} should have exact options given {option_type}'
@pytest.mark.parametrize('action, option_type', test_data)
def test_produce_exact_options_completion(action: Action, option_type: OptionType):
try:
completion = exact_options_completion(action)
2023-05-06 20:29:14 +02:00
if True in option_type:
assert completion.startswith(
'\ncomplete -c borgmatic'
), f'Completion should start with "complete -c borgmatic", got {completion}'
else:
assert completion == '', f'Completion should be empty, got {completion}'
except ValueError as value_error:
assert False, f'exact_options_completion raised ValueError: {value_error}'