mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-08 11:46:35 +00:00
Adds ``[tool.ruff.lint]`` with ``select = ["E", "F", "I", "B", "UP"]``
and ``target-version = "py311"``. ``E501`` is ignored because
``ruff format`` already reflows what it can; the remaining long lines
are unsplittable string literals / URLs.
Auto-fixed (2753 issues, behavior-preserving):
- UP006/UP035: ``List[X]`` → ``list[X]``, ``Dict[X]`` → ``dict[X]``,
``from typing import …`` redirected where superseded by builtins.
- UP045: ``Optional[X]`` → ``X | None``.
- UP010/UP009/UP015: dropped Python-2-era pragmas (``from __future__
import absolute_import, division, print_function``,
``# -*- coding: utf-8 -*-``), redundant ``open(..., "r")`` mode.
- UP004: dropped implicit ``class X(object):``.
- UP022/UP008/UP032: stdlib idiom modernization (``capture_output``,
super-call simplification, etc.).
- B905: ``zip(...)`` → ``zip(..., strict=False)`` (preserves prior
behavior; switching to ``strict=True`` is a separate semantic
choice not made here).
- I001: import-block ordering.
Hand-fixed (66 issues):
- B904 × 54: appended ``from <bound>`` (when the enclosing ``except``
binds a name) or ``from None`` (when it doesn't) so chained
exceptions stay distinguishable from errors-during-exception-
handling. Applied via a small AST-aware script that walked back to
the enclosing ``except`` clause and matched the binding.
- B017 × 4: narrowed broad ``assertRaises(Exception)`` to the actual
``AnsibleError`` / ``AnsibleFilterError`` raised by the code under
test.
- B023 × 2: bound captured loop variables via default args
(``def _record(name, *, _path_real=path_real, ...)``) so each
closure gets its own snapshot.
- B007 × 2: unused loop control variables renamed to ``_`` /
rewritten to ``.values()``.
- UP007 × 2: ``Union[X, Y]`` → ``X | Y`` (plus dropping the now-unused
``from typing import Union``).
- B018 × 1: Odoo addon manifests are bare dict expressions at module
level by design — suppressed with an inline ``# noqa: B018`` and
rationale comment.
- UP031 × 1: printf-style format → f-string.
The 65 ``# noqa: …`` markers introduced by the auto-fixer all carry
real ruff codes (``B018``, ``E402``, ``F401``, etc.), so
``test_noqa_only_ruff_codes`` stays green.
Verification
============
- ``ruff check .`` → All checks passed
- ``ruff format --check .`` → 894 files already formatted
- ``tests.lint.repository.{test_project_root_import,
test_no_direct_yaml_calls, test_noqa_only_ruff_codes}`` and
``tests.unit.utils.annotations.test_suppress`` → 20 tests OK
- 1621 unit tests → all pass
- Integration suite: 44 failures (pre-existing baseline, none from
this change), 1 skipped.
Going forward, the new rules block regressions on E (style), F
(pyflakes), I (import order), B (likely-bug patterns), and UP
(modernization to py311) for any new code.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
117 lines
4.5 KiB
Python
117 lines
4.5 KiB
Python
import importlib.util
|
|
import unittest
|
|
from unittest.mock import patch
|
|
|
|
from ansible.errors import AnsibleError
|
|
|
|
from . import PROJECT_ROOT
|
|
|
|
|
|
def _load_module(rel_path: str, name: str):
|
|
path = PROJECT_ROOT / rel_path
|
|
spec = importlib.util.spec_from_file_location(name, str(path))
|
|
mod = importlib.util.module_from_spec(spec)
|
|
assert spec and spec.loader
|
|
spec.loader.exec_module(mod)
|
|
return mod
|
|
|
|
|
|
class TestLookupDocker(unittest.TestCase):
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
cls.mod = _load_module("plugins/lookup/container.py", "lookup_plugins_docker")
|
|
cls.LookupModule = cls.mod.LookupModule
|
|
|
|
def setUp(self):
|
|
self.lookup = self.LookupModule()
|
|
self.vars_ok = {"DIR_COMPOSITIONS": "/opt/compose/"}
|
|
|
|
self.fake_paths = {
|
|
"directories": {
|
|
"instance": "/opt/compose/app/",
|
|
"env": "/opt/compose/app/.env/",
|
|
"services": "/opt/compose/app/services/",
|
|
"volumes": "/opt/compose/app/volumes/",
|
|
"config": "/opt/compose/app/config/",
|
|
},
|
|
"files": {
|
|
"env": "/opt/compose/app/.env/app.env",
|
|
"compose": "/opt/compose/app/compose.yml",
|
|
"compose_override": "/opt/compose/app/compose.override.yml",
|
|
"dockerfile": "/opt/compose/app/Dockerfile",
|
|
},
|
|
}
|
|
|
|
def test_returns_full_dict_when_only_application_id(self):
|
|
with patch.object(
|
|
self.mod, "get_docker_paths", return_value=self.fake_paths
|
|
) as p:
|
|
out = self.lookup.run(["web-app-mailu"], variables=self.vars_ok)
|
|
self.assertEqual(out, [self.fake_paths])
|
|
p.assert_called_once_with("web-app-mailu", "/opt/compose/")
|
|
|
|
def test_returns_subdict_for_top_level_key(self):
|
|
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
|
|
out = self.lookup.run(
|
|
["web-app-mailu", "directories"], variables=self.vars_ok
|
|
)
|
|
self.assertEqual(out, [self.fake_paths["directories"]])
|
|
|
|
out = self.lookup.run(["web-app-mailu", "files"], variables=self.vars_ok)
|
|
self.assertEqual(out, [self.fake_paths["files"]])
|
|
|
|
def test_returns_deep_value_for_dotted_path(self):
|
|
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
|
|
out = self.lookup.run(
|
|
["web-app-mailu", "directories.instance"], variables=self.vars_ok
|
|
)
|
|
self.assertEqual(out, ["/opt/compose/app/"])
|
|
|
|
out = self.lookup.run(
|
|
["web-app-mailu", "files.env"], variables=self.vars_ok
|
|
)
|
|
self.assertEqual(out, ["/opt/compose/app/.env/app.env"])
|
|
|
|
def test_invalid_path_raises(self):
|
|
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
|
|
with self.assertRaises(AnsibleError):
|
|
self.lookup.run(
|
|
["web-app-mailu", "doesnotexist"], variables=self.vars_ok
|
|
)
|
|
|
|
with self.assertRaises(AnsibleError):
|
|
self.lookup.run(
|
|
["web-app-mailu", "directories.doesnotexist"],
|
|
variables=self.vars_ok,
|
|
)
|
|
|
|
with self.assertRaises(AnsibleError):
|
|
self.lookup.run(
|
|
["web-app-mailu", "directories.instance.foo"],
|
|
variables=self.vars_ok,
|
|
)
|
|
|
|
def test_missing_instances_base_var_raises(self):
|
|
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
|
|
with self.assertRaises(AnsibleError) as ctx:
|
|
self.lookup.run(["web-app-mailu"], variables={})
|
|
self.assertIn("DIR_COMPOSITIONS not set", str(ctx.exception))
|
|
|
|
def test_empty_application_id_raises(self):
|
|
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
|
|
with self.assertRaises(AnsibleError) as ctx:
|
|
self.lookup.run([" "], variables=self.vars_ok)
|
|
self.assertIn("application_id is empty", str(ctx.exception))
|
|
|
|
def test_wrong_arity_raises(self):
|
|
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
|
|
with self.assertRaises(AnsibleError):
|
|
self.lookup.run([], variables=self.vars_ok)
|
|
|
|
with self.assertRaises(AnsibleError):
|
|
self.lookup.run(["a", "b", "c"], variables=self.vars_ok)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|