Files
computer-playbook/tests/unit/python/utils/packages/test_plan.py
T
kevinveenbirkenbachandClaude Opus 5.5 3dc35655a3 style: apply make autoformat to files committed unformatted
ruff format reflows the package batch, registry, plan and invocation code and tests and the Stalwart and Nextcloud tests, ansible-lint rewraps long Jinja lines in folded scalars of sys-service, Nextcloud and SeaweedFS, mbake restores the Makefile's final newline, and the Nextcloud OAuth test merges its nested with statements (SIM117).

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-10-29 01:17:22 +01:00

244 lines
9.3 KiB
Python

import re
import unittest
from utils.packages.calls import STATE_ABSENT, STATE_PRESENT
from utils.packages.plan import build_plan, merge_plans
from utils.packages.schema import SOURCE_AUR, SOURCE_BUILD, SOURCE_COPR, PackageSpec
from utils.packages.sources import AUR_BUILDER_USER, PACMAN_CONF
class TestExternalFetchRetries(unittest.TestCase):
"""Every call that fetches over the network carries a retry policy, the
distribution's own repositories included: their mirror pools degrade
independently of whatever retries the package manager does internally."""
def _retried(self, plan):
return {call.module for call in plan if call.retry is not None}
def test_the_aur_build_is_retried(self):
plan = build_plan(
PackageSpec(("nfs-ganesha",), source=SOURCE_AUR), STATE_PRESENT
)
self.assertEqual(
self._retried(plan), {"kewlfft.aur.aur", "ansible.builtin.package"}
)
def test_the_build_command_is_retried(self):
spec = PackageSpec(("tool",), source=SOURCE_BUILD, build={"command": "make"})
self.assertEqual(
self._retried(build_plan(spec, STATE_PRESENT)),
{"ansible.builtin.command", "ansible.builtin.package"},
)
def test_enabling_a_copr_is_retried(self):
spec = PackageSpec(("pkg",), source=SOURCE_COPR, repo={"copr": "user/proj"})
self.assertEqual(
self._retried(build_plan(spec, STATE_PRESENT)),
{"community.general.copr", "ansible.builtin.package"},
)
def test_adding_a_ppa_is_retried(self):
spec = PackageSpec(("pkg",), repo={"ppa": "ppa:x/y"})
self.assertEqual(
self._retried(build_plan(spec, STATE_PRESENT)),
{"ansible.builtin.apt_repository", "ansible.builtin.package"},
)
def test_a_plain_repository_install_is_retried(self):
plan = build_plan(PackageSpec(("git",)), STATE_PRESENT)
self.assertEqual(self._retried(plan), {"ansible.builtin.package"})
def _modules(plan):
return [call.module for call in plan]
class TestBuildPlan(unittest.TestCase):
def test_plain_repo_is_a_single_call(self):
plan = build_plan(PackageSpec(("git",)), STATE_PRESENT)
self.assertEqual(_modules(plan), ["ansible.builtin.package"])
self.assertEqual(plan[0].args["state"], STATE_PRESENT)
def test_empty_names_produce_no_calls(self):
self.assertEqual(build_plan(PackageSpec(()), STATE_PRESENT), [])
def test_absent_never_needs_the_source(self):
spec = PackageSpec(("nfs-ganesha",), source="aur")
plan = build_plan(spec, STATE_ABSENT)
self.assertEqual(_modules(plan), ["ansible.builtin.package"])
self.assertEqual(plan[0].args["state"], STATE_ABSENT)
def test_aur_bootstraps_a_build_user_then_builds(self):
plan = build_plan(PackageSpec(("nfs-ganesha",), source="aur"), STATE_PRESENT)
self.assertEqual(
_modules(plan),
[
"ansible.builtin.package",
"ansible.builtin.user",
"ansible.builtin.lineinfile",
"kewlfft.aur.aur",
],
)
self.assertEqual(plan[-1].become_user, AUR_BUILDER_USER)
def test_copr_enables_before_installing(self):
spec = PackageSpec(("foo",), source="copr", repo={"copr": "user/project"})
plan = build_plan(spec, STATE_PRESENT)
self.assertEqual(
_modules(plan), ["community.general.copr", "ansible.builtin.package"]
)
def test_ppa_adds_the_repository_before_installing(self):
spec = PackageSpec(("foo",), source="ppa", repo={"ppa": "ppa:user/foo"})
plan = build_plan(spec, STATE_PRESENT)
self.assertEqual(
_modules(plan),
["ansible.builtin.apt_repository", "ansible.builtin.package"],
)
def test_copr_without_repo_raises(self):
with self.assertRaises(ValueError):
build_plan(PackageSpec(("foo",), source="copr"), STATE_PRESENT)
def test_build_installs_depends_then_runs_the_command(self):
spec = PackageSpec(
("foo",),
source="build",
build={
"command": "make install",
"depends": ["gcc"],
"creates": "/usr/bin/foo",
},
)
plan = build_plan(spec, STATE_PRESENT)
self.assertEqual(
_modules(plan), ["ansible.builtin.package", "ansible.builtin.command"]
)
self.assertEqual(plan[1].args["cmd"], "make install")
def test_build_without_block_raises(self):
with self.assertRaises(ValueError):
build_plan(PackageSpec(("foo",), source="build"), STATE_PRESENT)
def test_bootstrap_package_repo_installs_the_enabler_first(self):
spec = PackageSpec(("micro",), repo={"bootstrap_package": "epel-release"})
plan = build_plan(spec, STATE_PRESENT)
self.assertEqual(plan[0].args["name"], ["epel-release"])
self.assertEqual(plan[1].args["name"], ["micro"])
def test_enable_existing_uses_dnf_with_the_repo(self):
spec = PackageSpec(
("libntirpc",),
repo={"enable_existing": "updates-testing", "state": "latest"},
)
plan = build_plan(spec, STATE_PRESENT)
self.assertEqual(_modules(plan), ["ansible.builtin.dnf"])
self.assertEqual(plan[0].args["enablerepo"], "updates-testing")
def test_pacman_section_is_uncommented_before_the_install(self):
spec = PackageSpec(("steam",), repo={"pacman_section": "multilib"})
plan = build_plan(spec, STATE_PRESENT)
self.assertEqual(
_modules(plan), ["ansible.builtin.replace", "community.general.pacman"]
)
self.assertEqual(plan[0].args["path"], PACMAN_CONF)
self.assertIn("multilib", plan[0].args["regexp"])
self.assertTrue(plan[1].args["update_cache"])
self.assertEqual(plan[1].args["name"], ["steam"])
def test_pacman_section_regex_matches_the_stock_pacman_conf(self):
spec = PackageSpec(("steam",), repo={"pacman_section": "multilib"})
call = build_plan(spec, STATE_PRESENT)[0]
stock = "#[multilib]\n#Include = /etc/pacman.d/mirrorlist\n"
enabled = re.sub(
call.args["regexp"],
call.args["replace"].replace("\\n", "\n"),
stock,
flags=re.MULTILINE,
)
self.assertEqual(enabled, "[multilib]\nInclude = /etc/pacman.d/mirrorlist\n")
self.assertEqual(
re.sub(
call.args["regexp"],
call.args["replace"].replace("\\n", "\n"),
enabled,
flags=re.MULTILINE,
),
enabled,
)
def test_externally_managed_repo_only_installs(self):
spec = PackageSpec(("docker-ce",), repo={"managed_externally": "role does it"})
plan = build_plan(spec, STATE_PRESENT)
self.assertEqual(_modules(plan), ["ansible.builtin.package"])
def test_full_repo_definition_is_rendered_first(self):
spec = PackageSpec(
("nfs-ganesha",),
repo={
"name": "sig",
"description": "SIG",
"baseurl": "https://example/",
"gpgkey": "https://example/key",
},
)
plan = build_plan(spec, STATE_PRESENT)
self.assertEqual(
_modules(plan),
["ansible.builtin.yum_repository", "ansible.builtin.package"],
)
def _plan(*names, **spec):
return build_plan(PackageSpec(tuple(names), **spec), STATE_PRESENT)
def _names(call):
return call.args["name"]
class TestMergePlans(unittest.TestCase):
def test_plain_plans_share_one_call(self):
merged = merge_plans([_plan("git"), _plan("curl", "jq")])
self.assertEqual(len(merged), 1)
self.assertEqual([_names(call) for call in merged[0]], [["git", "curl", "jq"]])
def test_a_name_requested_twice_is_installed_once(self):
merged = merge_plans([_plan("git"), _plan("git")])
self.assertEqual(_names(merged[0][0]), ["git"])
def test_bootstrap_packages_install_before_every_name(self):
epel = {"repo": {"bootstrap_package": "epel-release"}}
merged = merge_plans(
[_plan("git"), _plan("micro", **epel), _plan("jq", **epel)]
)
self.assertEqual(
[_names(call) for call in merged[0]],
[["epel-release"], ["git", "micro", "jq"]],
)
def test_a_plan_with_other_modules_runs_unchanged_after_the_merged_one(self):
aur = _plan("caffeine", source=SOURCE_AUR)
merged = merge_plans([aur, _plan("git")])
self.assertEqual([_names(call) for call in merged[0]], [["git"]])
self.assertEqual(merged[1], aur)
def test_plans_of_different_states_never_merge(self):
absent = build_plan(PackageSpec(("postfix",)), STATE_ABSENT)
merged = merge_plans([_plan("git"), absent])
self.assertEqual(
[(call.args["state"], _names(call)) for plan in merged for call in plan],
[(STATE_PRESENT, ["git"]), (STATE_ABSENT, ["postfix"])],
)
def test_no_plans_merge_to_nothing(self):
self.assertEqual(merge_plans([]), [])
def test_the_merged_call_keeps_the_retry_policy(self):
merged = merge_plans([_plan("git"), _plan("curl")])
self.assertIsNotNone(merged[0][0].retry)
if __name__ == "__main__":
unittest.main()