test_maintenance_log_actor.py 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. """Who a maintenance reset is logged as (#3557).
  2. The user, an API key's owner, or, for a legacy key without an owner, the key
  3. by its name. Nobody when authentication is off.
  4. """
  5. from __future__ import annotations
  6. from types import SimpleNamespace
  7. from backend.app.api.routes.maintenance import _actor_identity
  8. from backend.app.core.auth import ApiKeyActor
  9. def _key_actor(name: str, owner: SimpleNamespace | None) -> ApiKeyActor:
  10. actor = ApiKeyActor.__new__(ApiKeyActor)
  11. actor.api_key = SimpleNamespace(name=name)
  12. actor.owner = owner
  13. actor.id = owner.id if owner else None
  14. actor.username = owner.username if owner else None
  15. return actor
  16. def test_auth_off_logs_nobody():
  17. assert _actor_identity(None) == (None, None)
  18. def test_a_user_is_logged_by_id_and_name():
  19. assert _actor_identity(SimpleNamespace(id=7, username="mechanic")) == (7, "mechanic")
  20. def test_a_key_is_logged_as_its_owner():
  21. owner = SimpleNamespace(id=3, username="farm-admin")
  22. assert _actor_identity(_key_actor("Home Assistant", owner)) == (3, "farm-admin")
  23. def test_a_legacy_key_without_an_owner_is_logged_by_its_name():
  24. assert _actor_identity(_key_actor("Home Assistant", None)) == (None, "API key: Home Assistant")
  25. def test_a_long_key_name_fits_the_column():
  26. _, name = _actor_identity(_key_actor("x" * 200, None))
  27. assert name is not None and len(name) == 100