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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
|
"""
Unit tests for config file and CLI argument parsing.
"""
import pathlib
from io import BytesIO
from textwrap import dedent
import pytest
from vulture.config import (
DEFAULTS,
InputError,
_check_input_config,
_parse_args,
_parse_toml,
make_config,
)
def get_toml_bytes(toml_str: str) -> BytesIO:
"""
Wrap a string in BytesIO to play the role of the incoming config stream.
"""
return BytesIO(bytes(toml_str, "utf-8"))
def test_cli_args():
"""
Ensure that CLI arguments are converted to a config object.
"""
expected = dict(
paths=["path1", "path2"],
exclude=["file*.py", "dir/"],
ignore_decorators=["deco1", "deco2"],
ignore_names=["name1", "name2"],
config="pyproject.toml",
make_whitelist=True,
min_confidence=10,
sort_by_size=True,
verbose=True,
)
result = _parse_args(
[
"--exclude=file*.py,dir/",
"--ignore-decorators=deco1,deco2",
"--ignore-names=name1,name2",
"--make-whitelist",
"--min-confidence=10",
"--sort-by-size",
"--verbose",
"path1",
"path2",
]
)
assert isinstance(result, dict)
assert result == expected
def test_toml_config():
"""
Ensure parsing of TOML files results in a valid config object.
"""
expected = dict(
paths=["path1", "path2"],
exclude=["file*.py", "dir/"],
ignore_decorators=["deco1", "deco2"],
ignore_names=["name1", "name2"],
make_whitelist=True,
min_confidence=10,
sort_by_size=True,
verbose=True,
)
data = get_toml_bytes(
dedent(
"""\
[tool.vulture]
exclude = ["file*.py", "dir/"]
ignore_decorators = ["deco1", "deco2"]
ignore_names = ["name1", "name2"]
make_whitelist = true
min_confidence = 10
sort_by_size = true
verbose = true
paths = ["path1", "path2"]
"""
)
)
result = _parse_toml(data)
assert isinstance(result, dict)
assert result == expected
def test_toml_config_with_heterogenous_array():
"""
Ensure parsing of TOML files results in a valid config object, even if some
other part of the file contains an array of mixed types.
"""
expected = dict(
paths=["path1", "path2"],
exclude=["file*.py", "dir/"],
ignore_decorators=["deco1", "deco2"],
ignore_names=["name1", "name2"],
make_whitelist=True,
min_confidence=10,
sort_by_size=True,
verbose=True,
)
data = get_toml_bytes(
dedent(
"""\
[tool.foo]
# comment for good measure
problem_array = [{a = 1}, [2,3,4], "foo"]
[tool.vulture]
exclude = ["file*.py", "dir/"]
ignore_decorators = ["deco1", "deco2"]
ignore_names = ["name1", "name2"]
make_whitelist = true
min_confidence = 10
sort_by_size = true
verbose = true
paths = ["path1", "path2"]
"""
)
)
result = _parse_toml(data)
assert isinstance(result, dict)
assert result == expected
def test_config_merging():
"""
If we have both CLI args and a ``pyproject.toml`` file, the CLI args should
have precedence.
"""
toml = get_toml_bytes(
dedent(
"""\
[tool.vulture]
exclude = ["toml_exclude"]
ignore_decorators = ["toml_deco"]
ignore_names = ["toml_name"]
make_whitelist = false
min_confidence = 10
sort_by_size = false
verbose = false
paths = ["toml_path"]
"""
)
)
cliargs = [
"--exclude=cli_exclude",
"--ignore-decorators=cli_deco",
"--ignore-names=cli_name",
"--make-whitelist",
"--min-confidence=20",
"--sort-by-size",
"--verbose",
"cli_path",
]
result = make_config(cliargs, toml)
expected = dict(
paths=["cli_path"],
exclude=["cli_exclude"],
ignore_decorators=["cli_deco"],
ignore_names=["cli_name"],
config="pyproject.toml",
make_whitelist=True,
min_confidence=20,
sort_by_size=True,
verbose=True,
)
assert result == expected
def test_toml_config_custom_path():
"""
Ensure that TOML pyproject.toml files can be read from a custom path,
other than the current working directory.
Test file is in tests/toml/mock_pyproject.toml
"""
here = pathlib.Path(__file__).parent
tomlfile_path = here.joinpath("toml", "mock_pyproject.toml")
cliargs = [
f"--config={tomlfile_path}",
"cli_path",
]
result = make_config(cliargs)
assert result["ignore_names"] == ["name_from_toml_file"]
def test_config_merging_missing():
"""
If we have set a boolean value in the TOML file, but not on the CLI, we
want the TOML value to be taken.
"""
toml = get_toml_bytes(
dedent(
"""\
[tool.vulture]
verbose = true
ignore_names = ["name1"]
"""
)
)
cliargs = [
"cli_path",
]
result = make_config(cliargs, toml)
assert result["verbose"] is True
assert result["ignore_names"] == ["name1"]
def test_config_merging_toml_paths_only():
"""
If we have paths in the TOML but not on the CLI, the TOML paths should be
used.
"""
toml = get_toml_bytes(
dedent(
"""\
[tool.vulture]
paths = ["path1", "path2"]
"""
)
)
cliargs = [
"--exclude=test_*.py",
]
result = make_config(cliargs, toml)
assert result["paths"] == ["path1", "path2"]
assert result["exclude"] == ["test_*.py"]
def test_invalid_config_options_output():
"""
If the config file contains unknown options we want to abort.
"""
with pytest.raises(InputError):
_check_input_config({"unknown_key_1": 1})
@pytest.mark.parametrize("key, value", list(DEFAULTS.items()))
def test_incompatible_option_type(key, value):
"""
If a config value has a different type from the default value we abort.
"""
wrong_types = {int, str, list, bool} - {type(value)}
for wrong_type in wrong_types:
test_value = wrong_type()
with pytest.raises(InputError):
_check_input_config({key: test_value})
def test_missing_paths():
"""
If the script is run without any paths, we want to abort.
"""
with pytest.raises(InputError):
make_config([])
|