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 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
|
"""Tests for file utility functions."""
from __future__ import annotations
import copy
import logging
import os
import time
from pathlib import Path
from typing import TYPE_CHECKING, Any
import pytest
from ansiblelint import cli, file_utils
from ansiblelint.file_utils import (
Lintable,
cwd,
expand_path_vars,
expand_paths_vars,
find_project_root,
normpath,
normpath_path,
)
from ansiblelint.runner import Runner
if TYPE_CHECKING:
from _pytest.capture import CaptureFixture
from _pytest.logging import LogCaptureFixture
from _pytest.monkeypatch import MonkeyPatch
from ansiblelint.constants import FileType
from ansiblelint.rules import RulesCollection
@pytest.mark.parametrize(
("path", "expected"),
(
pytest.param(Path("a/b/../"), "a", id="pathlib.Path"),
pytest.param("a/b/../", "a", id="str"),
pytest.param("", ".", id="empty"),
pytest.param(".", ".", id="empty"),
),
)
def test_normpath(path: str, expected: str) -> None:
"""Ensure that relative parent dirs are normalized in paths."""
assert normpath(path) == expected
def test_expand_path_vars(monkeypatch: MonkeyPatch) -> None:
"""Ensure that tilde and env vars are expanded in paths."""
test_path = "/test/path"
monkeypatch.setenv("TEST_PATH", test_path)
assert expand_path_vars("~") == os.path.expanduser("~") # noqa: PTH111
assert expand_path_vars("$TEST_PATH") == test_path
@pytest.mark.parametrize(
("test_path", "expected"),
(
pytest.param(Path("$TEST_PATH"), "/test/path", id="pathlib.Path"),
pytest.param("$TEST_PATH", "/test/path", id="str"),
pytest.param(" $TEST_PATH ", "/test/path", id="stripped-str"),
pytest.param("~", os.path.expanduser("~"), id="home"), # noqa: PTH111
),
)
def test_expand_paths_vars(
test_path: str | Path,
expected: str,
monkeypatch: MonkeyPatch,
) -> None:
"""Ensure that tilde and env vars are expanded in paths lists."""
monkeypatch.setenv("TEST_PATH", "/test/path")
assert expand_paths_vars([test_path]) == [expected] # type: ignore[list-item]
def test_discover_lintables_silent(
monkeypatch: MonkeyPatch,
capsys: CaptureFixture[str],
caplog: LogCaptureFixture,
) -> None:
"""Verify that no stderr output is displayed while discovering yaml files.
(when the verbosity is off, regardless of the Git or Git-repo presence)
Also checks expected number of files are detected.
"""
caplog.set_level(logging.FATAL)
options = cli.get_config([])
test_dir = Path(__file__).resolve().parent
lint_path = (test_dir / ".." / "examples" / "roles" / "test-role").resolve()
yaml_count = len(list(lint_path.glob("**/*.yml"))) + len(
list(lint_path.glob("**/*.yaml")),
)
monkeypatch.chdir(str(lint_path))
my_options = copy.deepcopy(options)
my_options.lintables = [str(lint_path)]
files = file_utils.discover_lintables(my_options)
stderr = capsys.readouterr().err
assert not stderr, (
f"No stderr output is expected when the verbosity is off, got: {stderr}"
)
assert len(files) == yaml_count, (
"Expected to find {yaml_count} yaml files in {lint_path}".format_map(
locals(),
)
)
def test_discover_lintables_umlaut(monkeypatch: MonkeyPatch) -> None:
"""Verify that filenames containing German umlauts are not garbled by the discover_lintables."""
options = cli.get_config([])
test_dir = Path(__file__).resolve().parent
lint_path = (test_dir / ".." / "examples" / "playbooks").resolve()
monkeypatch.chdir(str(lint_path))
files = file_utils.discover_lintables(options)
assert '"with-umlaut-\\303\\244.yml"' not in files
assert "with-umlaut-รค.yml" in files
@pytest.mark.parametrize(
("path", "kind"),
(
pytest.param("tasks/run_test_playbook.yml", "tasks", id="0"),
pytest.param("foo/playbook.yml", "playbook", id="1"),
pytest.param("playbooks/foo.yml", "playbook", id="2"),
pytest.param("examples/roles/foo.yml", "yaml", id="3"),
# the only yml file that is not a playbook inside molecule/ folders
pytest.param(
"examples/.config/molecule/config.yml",
"yaml",
id="4",
), # molecule shared config
pytest.param(
"test/schemas/test/molecule/cluster/base.yml",
"yaml",
id="5",
), # molecule scenario base config
pytest.param(
"test/schemas/test/molecule/cluster/molecule.yml",
"yaml",
id="6",
), # molecule scenario config
pytest.param(
"test/schemas/test/molecule/cluster/foobar.yml",
"playbook",
id="7",
), # custom playbook name
pytest.param(
"test/schemas/test/molecule/cluster/converge.yml",
"playbook",
id="8",
), # common playbook name
pytest.param(
"roles/foo/molecule/scenario3/requirements.yml",
"requirements",
id="9",
), # requirements
pytest.param(
"roles/foo/molecule/scenario3/collections.yml",
"requirements",
id="10",
), # requirements
pytest.param(
"roles/foo/meta/argument_specs.yml",
"role-arg-spec",
id="11",
), # role argument specs
# tasks files:
pytest.param("tasks/directory with spaces/main.yml", "tasks", id="12"), # tasks
pytest.param("tasks/requirements.yml", "tasks", id="13"), # tasks
# requirements (we do not support includes yet)
pytest.param(
"requirements.yml",
"requirements",
id="14",
), # collection requirements
pytest.param(
"roles/foo/meta/requirements.yml",
"requirements",
id="15",
), # inside role requirements
# Undeterminable files:
pytest.param("test/fixtures/unknown-type.yml", "yaml", id="16"),
pytest.param(
"releasenotes/notes/run-playbooks-refactor.yaml",
"reno",
id="17",
), # reno
pytest.param("examples/host_vars/localhost.yml", "vars", id="18"),
pytest.param("examples/group_vars/all.yml", "vars", id="19"),
pytest.param("examples/playbooks/vars/other.yml", "vars", id="20"),
pytest.param(
"examples/playbooks/vars/subfolder/settings.yml",
"vars",
id="21",
), # deep vars
pytest.param(
"molecule/scenario/collections.yml",
"requirements",
id="22",
), # deprecated 2.8 format
pytest.param(
"../roles/geerlingguy.mysql/tasks/configure.yml",
"tasks",
id="23",
), # relative path involved
pytest.param("galaxy.yml", "galaxy", id="24"),
pytest.param("foo.j2.yml", "jinja2", id="25"),
pytest.param("foo.yml.j2", "jinja2", id="26"),
pytest.param("foo.j2.yaml", "jinja2", id="27"),
pytest.param("foo.yaml.j2", "jinja2", id="28"),
pytest.param(
"examples/playbooks/rulebook.yml",
"playbook",
id="29",
), # playbooks folder should determine kind
pytest.param(
"examples/rulebooks/rulebook-pass.yml",
"rulebook",
id="30",
), # content should determine it as a rulebook
pytest.param(
"examples/yamllint/valid.yml",
"yaml",
id="31",
), # empty yaml is valid yaml, not assuming anything else
pytest.param(
"examples/other/guess-1.yml",
"playbook",
id="32",
), # content should determine is as a play
pytest.param(
"examples/playbooks/tasks/passing_task.yml",
"tasks",
id="33",
), # content should determine is tasks
pytest.param("examples/.collection/galaxy.yml", "galaxy", id="34"),
pytest.param("examples/meta/runtime.yml", "meta-runtime", id="35"),
pytest.param("examples/meta/changelogs/changelog.yaml", "changelog", id="36"),
pytest.param("examples/inventory/inventory.yml", "inventory", id="37"),
pytest.param("examples/inventory/production.yml", "inventory", id="38"),
pytest.param("examples/playbooks/vars/empty_vars.yml", "vars", id="39"),
pytest.param(
"examples/playbooks/vars/subfolder/settings.yaml",
"vars",
id="40",
),
pytest.param(
"examples/sanity_ignores/tests/sanity/ignore-2.14.txt",
"sanity-ignore-file",
id="41",
),
pytest.param("examples/playbooks/tasks/vars/bug-3289.yml", "vars", id="42"),
pytest.param(
"examples/site.yml",
"playbook",
id="43",
), # content should determine it as a play
pytest.param(
"plugins/modules/fake_module.py",
"plugin",
id="44",
),
pytest.param("examples/meta/changelogs/changelog.yml", "changelog", id="45"),
),
)
def test_kinds(path: str, kind: FileType) -> None:
"""Verify auto-detection logic based on DEFAULT_KINDS."""
# assert Lintable is able to determine file type
lintable_detected = Lintable(path)
lintable_expected = Lintable(path, kind=kind)
assert lintable_detected == lintable_expected
def test_find_project_root_1(tmp_path: Path) -> None:
"""Verify find_project_root()."""
# this matches black behavior in absence of any config files or .git/.hg folders.
with cwd(tmp_path):
path, method = find_project_root([])
assert str(path) == "/"
assert method == "file system root"
def test_find_project_root_dotconfig() -> None:
"""Verify find_project_root()."""
# this expects to return examples folder as project root because this
# folder already has an .config/ansible-lint.yml file inside, which should
# be enough.
with cwd(Path("examples")):
assert Path(
".config/ansible-lint.yml",
).exists(), "Test requires config file inside .config folder."
path, method = find_project_root([])
assert str(path) == str(Path.cwd())
assert ".config/ansible-lint.yml" in method
BASIC_PLAYBOOK = """
- name: "playbook"
tasks:
- name: Hello
debug:
msg: 'world'
"""
@pytest.fixture(name="tmp_updated_lintable")
def fixture_tmp_updated_lintable(
tmp_path: Path,
path: str,
content: str,
updated_content: str,
) -> Lintable:
"""Create a temp file Lintable with a content update that is not on disk."""
lintable = Lintable(tmp_path / path, content)
with lintable.path.open("w", encoding="utf-8") as f:
f.write(content)
# move mtime to a time in the past to avoid race conditions in the test
mtime = time.time() - 60 * 60 # 1hr ago
os.utime(str(lintable.path), (mtime, mtime))
lintable.content = updated_content
return lintable
@pytest.mark.parametrize(
("path", "content", "updated_content", "updated"),
(
pytest.param(
"no_change.yaml",
BASIC_PLAYBOOK,
BASIC_PLAYBOOK,
False,
id="no_change",
),
pytest.param(
"quotes.yaml",
BASIC_PLAYBOOK,
BASIC_PLAYBOOK.replace('"', "'"),
True,
id="updated_quotes",
),
pytest.param(
"shorten.yaml",
BASIC_PLAYBOOK,
"# short file\n",
True,
id="shorten_file",
),
),
)
def test_lintable_updated(
path: str,
content: str,
updated_content: str,
updated: bool,
) -> None:
"""Validate ``Lintable.updated`` when setting ``Lintable.content``."""
lintable = Lintable(path, content)
assert lintable.content == content
lintable.content = updated_content
assert lintable.content == updated_content
assert lintable.updated is updated
@pytest.mark.parametrize(
"updated_content",
((None,), (b"bytes",)),
ids=("none", "bytes"),
)
def test_lintable_content_setter_with_bad_types(updated_content: Any) -> None:
"""Validate ``Lintable.updated`` when setting ``Lintable.content``."""
lintable = Lintable("bad_type.yaml", BASIC_PLAYBOOK)
assert lintable.content == BASIC_PLAYBOOK
with pytest.raises(TypeError):
lintable.content = updated_content
assert not lintable.updated
def test_lintable_with_new_file(tmp_path: Path) -> None:
"""Validate ``Lintable.updated`` for a new file."""
lintable = Lintable(tmp_path / "new.yaml")
lintable.content = BASIC_PLAYBOOK
lintable.content = BASIC_PLAYBOOK
assert lintable.content == BASIC_PLAYBOOK
assert lintable.updated
assert not lintable.path.exists()
lintable.write()
assert lintable.path.exists()
assert lintable.path.read_text(encoding="utf-8") == BASIC_PLAYBOOK
@pytest.mark.parametrize(
("path", "force", "content", "updated_content", "updated"),
(
pytest.param(
"no_change.yaml",
False,
BASIC_PLAYBOOK,
BASIC_PLAYBOOK,
False,
id="no_change",
),
pytest.param(
"forced.yaml",
True,
BASIC_PLAYBOOK,
BASIC_PLAYBOOK,
False,
id="forced_rewrite",
),
pytest.param(
"quotes.yaml",
False,
BASIC_PLAYBOOK,
BASIC_PLAYBOOK.replace('"', "'"),
True,
id="updated_quotes",
),
pytest.param(
"shorten.yaml",
False,
BASIC_PLAYBOOK,
"# short file\n",
True,
id="shorten_file",
),
pytest.param(
"forced.yaml",
True,
BASIC_PLAYBOOK,
BASIC_PLAYBOOK.replace('"', "'"),
True,
id="forced_and_updated",
),
),
)
def test_lintable_write(
tmp_updated_lintable: Lintable,
force: bool,
content: str,
updated_content: str,
updated: bool,
) -> None:
"""Validate ``Lintable.write`` writes when it should."""
pre_updated = tmp_updated_lintable.updated
pre_stat = tmp_updated_lintable.path.stat()
tmp_updated_lintable.write(force=force)
post_stat = tmp_updated_lintable.path.stat()
post_updated = tmp_updated_lintable.updated
# write() should not hide that an update happened
assert pre_updated == post_updated == updated
if force or updated:
assert pre_stat.st_mtime < post_stat.st_mtime
else:
assert pre_stat.st_mtime == post_stat.st_mtime
with tmp_updated_lintable.path.open("r", encoding="utf-8") as f:
post_content = f.read()
if updated:
assert content != post_content
else:
assert content == post_content
assert post_content == updated_content
@pytest.mark.parametrize(
("path", "content", "updated_content"),
(
pytest.param(
"quotes.yaml",
BASIC_PLAYBOOK,
BASIC_PLAYBOOK.replace('"', "'"),
id="updated_quotes",
),
),
)
def test_lintable_content_deleter(
tmp_updated_lintable: Lintable,
content: str,
updated_content: str,
) -> None:
"""Ensure that resetting content cache triggers re-reading file."""
assert content != updated_content
assert tmp_updated_lintable.content == updated_content
del tmp_updated_lintable.content
assert tmp_updated_lintable.content == content
@pytest.mark.parametrize(
("path", "result"),
(
pytest.param("foo", "foo", id="rel"),
pytest.param(
os.path.expanduser("~/xxx"), # noqa: PTH111
"~/xxx",
id="rel-to-home",
),
pytest.param("/a/b/c", "/a/b/c", id="absolute"),
pytest.param(
"examples/playbooks/roles",
"examples/roles",
id="resolve-symlink",
),
),
)
def test_normpath_path(path: str, result: str) -> None:
"""Tests behavior of normpath."""
assert normpath_path(path) == Path(result)
def test_bug_2513(
tmp_path: Path,
default_rules_collection: RulesCollection,
) -> None:
"""Regression test for bug 2513.
Test that when CWD is outside ~, and argument is like ~/playbook.yml
we will still be able to process the files.
See: https://github.com/ansible/ansible-lint/issues/2513
"""
filename = Path("~/.cache/ansible-lint/playbook.yml").expanduser()
filename.parent.mkdir(parents=True, exist_ok=True)
lintable = Lintable(filename, content="---\n- hosts: all\n")
lintable.write(force=True)
with cwd(tmp_path):
results = Runner(filename, rules=default_rules_collection).run()
assert len(results) == 1
assert results[0].rule.id == "name"
|