Files
schedls/tests/integration/test_cron_lifecycle.py
T

141 lines
4.8 KiB
Python

from __future__ import annotations
import os
import pytest
from schedls.backends.cron import CronBackend
from schedls.models import Backend, Command, JobSpec, Scope
from schedls.runner import CommandRunner
pytestmark = pytest.mark.integration
NAME = "schedls-it-cron"
SYSTEM_NAME = "schedls-it-system"
def _backend_or_skip() -> CronBackend:
backend = CronBackend(CommandRunner())
if not backend.available():
pytest.skip("crontab not available")
if os.environ.get("SCHEDLS_RUN_CRON_TESTS") != "1":
pytest.skip("set SCHEDLS_RUN_CRON_TESTS=1 to allow crontab mutation")
return backend
def _restore(backend: CronBackend, original: str) -> None:
backend.runner.run(["crontab", "-"], env_policy="identity", input_text=original, check=False)
def test_cron_lifecycle_preserves_content() -> None:
backend = _backend_or_skip()
original_document = backend.read()
original = original_document.text
# Add an unrelated line first so we can prove preservation.
seeded = original + ("\n" if original and not original.endswith("\n") else "")
seeded += "# unrelated comment\n"
backend.runner.run(["crontab", "-"], env_policy="identity", input_text=seeded)
try:
spec = JobSpec(
name=NAME,
backend=Backend.CRON,
scope=Scope.USER,
command=Command(argv=("/usr/bin/true", "a b", "50%")),
cron_expression="15 2 * * *",
)
plan = backend.plan_create(spec)
result = backend.apply(plan)
assert result.changed
jobs = [job for job in backend.discover([Scope.USER]) if job.name == NAME]
assert len(jobs) == 1
assert jobs[0].managed is True
assert jobs[0].schedule.expression == "15 2 * * *"
raw = backend.read().text
assert "# unrelated comment" in raw
assert "a\\%b" not in raw # sanity: percent is escaped, not raw in a bad way
job = backend.find(NAME)
assert job is not None
update = JobSpec(
name=NAME,
backend=Backend.CRON,
scope=Scope.USER,
command=Command(argv=("/usr/bin/true", "updated")),
cron_expression="30 3 * * *",
)
backend.apply(backend.plan_update(job, update))
updated = backend.find(NAME)
assert updated is not None
assert updated.schedule.expression == "30 3 * * *"
assert updated.command.raw == "/usr/bin/true updated"
backend.apply(backend.plan_remove(updated))
assert "# unrelated comment" in backend.read().text
assert backend.find(NAME) is None
finally:
_restore(backend, original)
def test_system_cron_discovery_never_executes() -> None:
if not os.path.isdir("/etc/cron.d"):
pytest.skip("/etc/cron.d not present")
backend = CronBackend(CommandRunner())
jobs = backend.discover([Scope.SYSTEM])
for job in jobs:
assert job.backend is Backend.CRON
assert job.scope is Scope.SYSTEM
assert not job.command.argv
assert job.cron is not None
def test_system_cron_lifecycle() -> None:
if os.geteuid() != 0:
pytest.skip("system cron mutation requires root")
if os.environ.get("SCHEDLS_RUN_CRON_TESTS") != "1":
pytest.skip("set SCHEDLS_RUN_CRON_TESTS=1 to allow cron.d mutation")
if not os.path.isdir("/etc/cron.d"):
pytest.skip("/etc/cron.d not present")
backend = CronBackend(CommandRunner())
path = f"/etc/cron.d/schedls-{SYSTEM_NAME}"
spec = JobSpec(
name=SYSTEM_NAME,
backend=Backend.CRON,
scope=Scope.SYSTEM,
command=Command(argv=("/usr/bin/true",)),
cron_expression="15 2 * * *",
run_as="root",
)
try:
plan = backend.plan_create(spec)
assert path in [change.path for change in plan.files]
backend.apply(plan)
job = backend.find(SYSTEM_NAME)
assert job is not None
assert job.managed is True
assert job.cron is not None and job.cron.user == "root"
update = JobSpec(
name=SYSTEM_NAME,
backend=Backend.CRON,
scope=Scope.SYSTEM,
command=Command(argv=("/usr/bin/true", "updated")),
cron_expression="30 3 * * *",
run_as="root",
)
backend.apply(backend.plan_update(job, update))
updated = backend.find(SYSTEM_NAME)
assert updated is not None
assert updated.schedule.expression == "30 3 * * *"
assert updated.cron is not None and updated.cron.user == "root"
assert updated.command.raw == "/usr/bin/true updated"
backend.apply(backend.plan_remove(updated))
assert not os.path.exists(path)
assert backend.find(SYSTEM_NAME) is None
finally:
if os.path.exists(path):
os.unlink(path)