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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
|
"""Tests for argparse_roles docutils extension."""
from __future__ import annotations
import typing as t
import pytest
from argparse_roles import (
cli_choice_role,
cli_command_role,
cli_default_role,
cli_metavar_role,
cli_option_role,
normalize_options,
register_roles,
)
from docutils import nodes
# --- normalize_options tests ---
def test_normalize_options_none() -> None:
"""Test normalize_options with None input."""
assert normalize_options(None) == {}
def test_normalize_options_dict() -> None:
"""Test normalize_options with dict input."""
opts = {"class": "custom"}
assert normalize_options(opts) == {"class": "custom"}
def test_normalize_options_empty_dict() -> None:
"""Test normalize_options with empty dict input."""
assert normalize_options({}) == {}
# --- CLI Option Role Tests ---
class OptionRoleFixture(t.NamedTuple):
"""Test fixture for CLI option role."""
test_id: str
text: str
expected_classes: list[str]
OPTION_ROLE_FIXTURES: list[OptionRoleFixture] = [
OptionRoleFixture(
test_id="long_option",
text="--verbose",
expected_classes=["cli-option", "cli-option-long"],
),
OptionRoleFixture(
test_id="long_option_with_dash",
text="--no-color",
expected_classes=["cli-option", "cli-option-long"],
),
OptionRoleFixture(
test_id="short_option",
text="-h",
expected_classes=["cli-option", "cli-option-short"],
),
OptionRoleFixture(
test_id="short_option_v",
text="-v",
expected_classes=["cli-option", "cli-option-short"],
),
OptionRoleFixture(
test_id="no_dash_prefix",
text="option",
expected_classes=["cli-option"],
),
]
@pytest.mark.parametrize(
list(OptionRoleFixture._fields),
OPTION_ROLE_FIXTURES,
ids=[f.test_id for f in OPTION_ROLE_FIXTURES],
)
def test_cli_option_role(
test_id: str,
text: str,
expected_classes: list[str],
) -> None:
"""Test CLI option role generates correct node classes."""
node_list, messages = cli_option_role(
"cli-option",
f":cli-option:`{text}`",
text,
1,
None,
)
assert len(node_list) == 1
assert len(messages) == 0
node = node_list[0]
assert isinstance(node, nodes.literal)
assert node.astext() == text
assert node["classes"] == expected_classes
def test_cli_option_role_with_options() -> None:
"""Test CLI option role accepts options parameter."""
node_list, _messages = cli_option_role(
"cli-option",
":cli-option:`--test`",
"--test",
1,
None,
options={"class": "extra"},
)
assert len(node_list) == 1
# Options are normalized but classes come from role logic
assert "cli-option" in node_list[0]["classes"]
# --- CLI Metavar Role Tests ---
class MetavarRoleFixture(t.NamedTuple):
"""Test fixture for CLI metavar role."""
test_id: str
text: str
METAVAR_ROLE_FIXTURES: list[MetavarRoleFixture] = [
MetavarRoleFixture(test_id="file", text="FILE"),
MetavarRoleFixture(test_id="path", text="PATH"),
MetavarRoleFixture(test_id="directory", text="DIRECTORY"),
MetavarRoleFixture(test_id="config", text="CONFIG"),
MetavarRoleFixture(test_id="lowercase", text="value"),
]
@pytest.mark.parametrize(
list(MetavarRoleFixture._fields),
METAVAR_ROLE_FIXTURES,
ids=[f.test_id for f in METAVAR_ROLE_FIXTURES],
)
def test_cli_metavar_role(
test_id: str,
text: str,
) -> None:
"""Test CLI metavar role generates correct node."""
node_list, messages = cli_metavar_role(
"cli-metavar",
f":cli-metavar:`{text}`",
text,
1,
None,
)
assert len(node_list) == 1
assert len(messages) == 0
node = node_list[0]
assert isinstance(node, nodes.literal)
assert node.astext() == text
assert node["classes"] == ["cli-metavar"]
# --- CLI Command Role Tests ---
class CommandRoleFixture(t.NamedTuple):
"""Test fixture for CLI command role."""
test_id: str
text: str
COMMAND_ROLE_FIXTURES: list[CommandRoleFixture] = [
CommandRoleFixture(test_id="sync", text="sync"),
CommandRoleFixture(test_id="add", text="add"),
CommandRoleFixture(test_id="vcspull", text="vcspull"),
CommandRoleFixture(test_id="list", text="list"),
CommandRoleFixture(test_id="with_dash", text="repo-add"),
]
@pytest.mark.parametrize(
list(CommandRoleFixture._fields),
COMMAND_ROLE_FIXTURES,
ids=[f.test_id for f in COMMAND_ROLE_FIXTURES],
)
def test_cli_command_role(
test_id: str,
text: str,
) -> None:
"""Test CLI command role generates correct node."""
node_list, messages = cli_command_role(
"cli-command",
f":cli-command:`{text}`",
text,
1,
None,
)
assert len(node_list) == 1
assert len(messages) == 0
node = node_list[0]
assert isinstance(node, nodes.literal)
assert node.astext() == text
assert node["classes"] == ["cli-command"]
# --- CLI Default Role Tests ---
class DefaultRoleFixture(t.NamedTuple):
"""Test fixture for CLI default role."""
test_id: str
text: str
DEFAULT_ROLE_FIXTURES: list[DefaultRoleFixture] = [
DefaultRoleFixture(test_id="none", text="None"),
DefaultRoleFixture(test_id="quoted_auto", text='"auto"'),
DefaultRoleFixture(test_id="number", text="0"),
DefaultRoleFixture(test_id="empty_string", text='""'),
DefaultRoleFixture(test_id="true", text="True"),
DefaultRoleFixture(test_id="false", text="False"),
]
@pytest.mark.parametrize(
list(DefaultRoleFixture._fields),
DEFAULT_ROLE_FIXTURES,
ids=[f.test_id for f in DEFAULT_ROLE_FIXTURES],
)
def test_cli_default_role(
test_id: str,
text: str,
) -> None:
"""Test CLI default role generates correct node."""
node_list, messages = cli_default_role(
"cli-default",
f":cli-default:`{text}`",
text,
1,
None,
)
assert len(node_list) == 1
assert len(messages) == 0
node = node_list[0]
assert isinstance(node, nodes.literal)
assert node.astext() == text
assert node["classes"] == ["cli-default"]
# --- CLI Choice Role Tests ---
class ChoiceRoleFixture(t.NamedTuple):
"""Test fixture for CLI choice role."""
test_id: str
text: str
CHOICE_ROLE_FIXTURES: list[ChoiceRoleFixture] = [
ChoiceRoleFixture(test_id="json", text="json"),
ChoiceRoleFixture(test_id="yaml", text="yaml"),
ChoiceRoleFixture(test_id="table", text="table"),
ChoiceRoleFixture(test_id="auto", text="auto"),
ChoiceRoleFixture(test_id="always", text="always"),
ChoiceRoleFixture(test_id="never", text="never"),
]
@pytest.mark.parametrize(
list(ChoiceRoleFixture._fields),
CHOICE_ROLE_FIXTURES,
ids=[f.test_id for f in CHOICE_ROLE_FIXTURES],
)
def test_cli_choice_role(
test_id: str,
text: str,
) -> None:
"""Test CLI choice role generates correct node."""
node_list, messages = cli_choice_role(
"cli-choice",
f":cli-choice:`{text}`",
text,
1,
None,
)
assert len(node_list) == 1
assert len(messages) == 0
node = node_list[0]
assert isinstance(node, nodes.literal)
assert node.astext() == text
assert node["classes"] == ["cli-choice"]
# --- Register Roles Test ---
def test_register_roles() -> None:
"""Test register_roles doesn't raise errors."""
# This should not raise any exceptions
register_roles()
# --- Role Return Type Tests ---
def test_all_roles_return_correct_types() -> None:
"""Test all roles return proper tuple of (nodes, messages)."""
role_functions = [
cli_option_role,
cli_metavar_role,
cli_command_role,
cli_default_role,
cli_choice_role,
]
for role_func in role_functions:
result = role_func("test", ":test:`value`", "value", 1, None)
assert isinstance(result, tuple), f"{role_func.__name__} should return tuple"
assert len(result) == 2, f"{role_func.__name__} should return 2-tuple"
node_list, messages = result
assert isinstance(node_list, list), (
f"{role_func.__name__} first element should be list"
)
assert isinstance(messages, list), (
f"{role_func.__name__} second element should be list"
)
assert len(node_list) == 1, f"{role_func.__name__} should return one node"
assert len(messages) == 0, (
f"{role_func.__name__} should return no error messages"
)
# --- Node Structure Tests ---
def test_cli_option_node_structure() -> None:
"""Test CLI option node has expected structure."""
node_list, _ = cli_option_role(
"cli-option",
":cli-option:`--test`",
"--test",
1,
None,
)
node = node_list[0]
# Check node type
assert isinstance(node, nodes.literal)
# Check rawsource is preserved
assert node.rawsource == ":cli-option:`--test`"
# Check text content
assert len(node.children) == 1
assert isinstance(node.children[0], nodes.Text)
assert str(node.children[0]) == "--test"
def test_roles_with_none_content_parameter() -> None:
"""Test roles handle None content parameter correctly."""
node_list, messages = cli_option_role(
"cli-option",
":cli-option:`--test`",
"--test",
1,
None,
options=None,
content=None,
)
assert len(node_list) == 1
assert len(messages) == 0
def test_roles_with_empty_content_parameter() -> None:
"""Test roles handle empty content parameter correctly."""
node_list, messages = cli_option_role(
"cli-option",
":cli-option:`--test`",
"--test",
1,
None,
options={},
content=[],
)
assert len(node_list) == 1
assert len(messages) == 0
# --- Edge Case Tests ---
def test_cli_option_role_empty_text() -> None:
"""Test CLI option role with empty text."""
node_list, _messages = cli_option_role(
"cli-option",
":cli-option:``",
"",
1,
None,
)
assert len(node_list) == 1
assert node_list[0].astext() == ""
# No dash prefix, so only base class
assert node_list[0]["classes"] == ["cli-option"]
def test_cli_option_role_special_characters() -> None:
"""Test CLI option role with special characters in text."""
node_list, _messages = cli_option_role(
"cli-option",
":cli-option:`--foo-bar_baz`",
"--foo-bar_baz",
1,
None,
)
assert len(node_list) == 1
assert node_list[0].astext() == "--foo-bar_baz"
assert "cli-option-long" in node_list[0]["classes"]
|