1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
|
import pytest
from clikit.api.args.format import Argument
def test_create():
arg = Argument("argument")
assert "argument" == arg.name
assert not arg.is_required()
assert arg.is_optional()
assert not arg.is_multi_valued()
assert arg.default is None
assert arg.description is None
def test_fail_if_name_is_null():
with pytest.raises(ValueError):
Argument(None)
def test_fail_if_name_is_empty():
with pytest.raises(ValueError):
Argument("")
def test_fail_if_name_is_not_a_string():
with pytest.raises(ValueError):
Argument(1234)
def test_fail_if_name_contains_spaces():
with pytest.raises(ValueError):
Argument("foo bar")
def test_fail_if_name_starts_with_hyphen():
with pytest.raises(ValueError):
Argument("-argument")
def test_fail_if_name_starts_with_number():
with pytest.raises(ValueError):
Argument("1argument")
@pytest.mark.parametrize(
"flags",
[
Argument.REQUIRED | Argument.OPTIONAL,
Argument.STRING | Argument.BOOLEAN,
Argument.STRING | Argument.INTEGER,
Argument.STRING | Argument.FLOAT,
Argument.BOOLEAN | Argument.INTEGER,
Argument.BOOLEAN | Argument.FLOAT,
Argument.INTEGER | Argument.FLOAT,
],
)
def test_fail_if_invalid_flags_combination(flags):
with pytest.raises(ValueError):
Argument("argument", flags)
def test_required_argument():
arg = Argument("argument", Argument.REQUIRED)
assert "argument" == arg.name
assert arg.is_required()
assert not arg.is_optional()
assert not arg.is_multi_valued()
assert arg.default is None
assert arg.description is None
def test_fail_if_required_argument_and_default_value():
with pytest.raises(ValueError):
Argument("argument", Argument.REQUIRED, default="Default")
def test_optional_argument():
arg = Argument("argument", Argument.OPTIONAL)
assert "argument" == arg.name
assert not arg.is_required()
assert arg.is_optional()
assert not arg.is_multi_valued()
assert arg.default is None
assert arg.description is None
def test_optional_argument_with_default_value():
arg = Argument("argument", Argument.OPTIONAL, default="Default")
assert "argument" == arg.name
assert not arg.is_required()
assert arg.is_optional()
assert not arg.is_multi_valued()
assert "Default" == arg.default
assert arg.description is None
def test_multi_valued_argument():
arg = Argument("argument", Argument.MULTI_VALUED)
assert "argument" == arg.name
assert not arg.is_required()
assert arg.is_optional()
assert arg.is_multi_valued()
assert arg.default == []
assert arg.description is None
def test_required_multi_valued_argument():
arg = Argument("argument", Argument.REQUIRED | Argument.MULTI_VALUED)
assert "argument" == arg.name
assert arg.is_required()
assert not arg.is_optional()
assert arg.is_multi_valued()
assert arg.default == []
assert arg.description is None
def test_optional_multi_valued_argument():
arg = Argument("argument", Argument.OPTIONAL | Argument.MULTI_VALUED)
assert "argument" == arg.name
assert not arg.is_required()
assert arg.is_optional()
assert arg.is_multi_valued()
assert arg.default == []
assert arg.description is None
def test_optional_multi_valued_argument_with_default():
arg = Argument(
"argument", Argument.OPTIONAL | Argument.MULTI_VALUED, default=["foo", "bar"]
)
assert "argument" == arg.name
assert not arg.is_required()
assert arg.is_optional()
assert arg.is_multi_valued()
assert ["foo", "bar"] == arg.default
assert arg.description is None
def test_fail_if_multi_values_argument_and_default_value_is_not_list():
with pytest.raises(ValueError):
Argument("argument", Argument.MULTI_VALUED, default="Default")
@pytest.mark.parametrize(
"flags, string, output",
[
(0, "", ""),
(0, "string", "string"),
(0, "1", "1"),
(0, "1.23", "1.23"),
(0, "null", "null"),
(Argument.NULLABLE, "null", None),
(0, "true", "true"),
(0, "false", "false"),
(Argument.STRING, "", ""),
(Argument.STRING, "string", "string"),
(Argument.STRING, "1", "1"),
(Argument.STRING, "1.23", "1.23"),
(Argument.STRING, "null", "null"),
(Argument.STRING | Argument.NULLABLE, "null", None),
(Argument.STRING, "true", "true"),
(Argument.STRING, "false", "false"),
(Argument.BOOLEAN, "true", True),
(Argument.BOOLEAN, "false", False),
(Argument.BOOLEAN | Argument.NULLABLE, "null", None),
(Argument.INTEGER, "1", 1),
(Argument.INTEGER, "0", 0),
(Argument.INTEGER | Argument.NULLABLE, "null", None),
(Argument.FLOAT, "1", 1.0),
(Argument.FLOAT, "1.23", 1.23),
(Argument.FLOAT, "0", 0.0),
(Argument.FLOAT | Argument.NULLABLE, "null", None),
],
)
def test_parse_value(flags, string, output):
arg = Argument("argument", flags)
assert output == arg.parse(string)
@pytest.mark.parametrize(
"flags, string",
[(Argument.BOOLEAN, "null"), (Argument.INTEGER, "null"), (Argument.FLOAT, "null")],
)
def test_parse_value_fails_if_invalid(flags, string):
arg = Argument("argument", flags)
with pytest.raises(ValueError):
arg.parse(string)
|