If Koji session becomes invalid, open a new one and try again (packit#2478)

If Koji session becomes invalid, open a new one and try again

Fixes packit/packit-service#2608.

Reviewed-by: Maja Massarini
Reviewed-by: Nikola Forró
Reviewed-by: Laura Barcziová
Reviewed-by: Matej Focko

Author: softwarefactory-project-zuul[bot]

packit/utils/koji_helper.py

@@ -3,7 +3,7 @@
 
 import logging
 from datetime import date, datetime
-from typing import Optional, Union
+from typing import Callable, Optional, Union
 
 import koji
 from specfile.changelog import ChangelogEntry
@@ -14,18 +14,54 @@
 logger = logging.getLogger(__name__)
 
 
-class KojiHelper:
-    """
-    Class for querying Koji.
+class SessionWrapper:
+    def __init__(self) -> None:
+        self.session = self._open_session()
+
+    def __getattr__(self, name: str) -> Callable:
+        if name in self.__dict__:
+            return self.__dict__[name]
+        return self._wrap(getattr(self.session, name))
+
+    def _open_session(self) -> koji.ClientSession:
+        return koji.ClientSession(baseurl=KOJI_BASEURL)
+
+    def _wrap(self, call: Callable) -> Callable:
+        call_name = f"{call._VirtualMethod__name}()"  # type: ignore[attr-defined]
+
+        def wrapper(*args, **kwargs):
+            exceptions = []
+            while True:
+                try:
+                    return call(*args, **kwargs)
+                except koji.ActionNotAllowed as e:  # noqa: PERF203
+                    if (type(e), e.faultCode, e.args) in exceptions:
+                        # break the loop if the same exception has already occurred
+                        raise
+                    exceptions.append((type(e), e.faultCode, e.args))
+                    logger.debug(
+                        f"{call_name} requires authenticated Koji session, logging in",
+                    )
+                    self.session.gssapi_login()
+                    continue
+                except koji.AuthError as e:
+                    if (type(e), e.faultCode, e.args) in exceptions:
+                        # break the loop if the same exception has already occurred
+                        raise
+                    exceptions.append((type(e), e.faultCode, e.args))
+                    logger.debug(
+                        f"Koji session authentication error during {call_name}: {e};"
+                        "opening new session",
+                    )
+                    self.session = self._open_session()
+                    continue
+
+        return wrapper
 
-    Attributes:
-        session: Koji client session.
-    """
 
-    def __init__(self, session: Optional[koji.ClientSession] = None) -> None:
-        self.session = (
-            session if session is not None else koji.ClientSession(baseurl=KOJI_BASEURL)
-        )
+class KojiHelper:
+    def __init__(self) -> None:
+        self.session = SessionWrapper()
 
     def get_builds(self, package: str, since: datetime) -> list[dict]:
         """
@@ -306,12 +342,6 @@ def create_sidetag(self, dist_git_branch: str) -> Optional[dict]:
         if not (build_tag := target.get("build_tag_name")):
             logger.debug(f"Failed to get build tag for {dist_git_branch}")
             return None
-        if not self.session.logged_in:
-            try:
-                self.session.gssapi_login()
-            except Exception as e:
-                logger.debug(f"Authentication failed: {e}")
-                return None
         try:
             info = self.session.createSideTag(build_tag)
         except Exception as e:
@@ -328,12 +358,6 @@ def remove_sidetag(self, sidetag: str) -> None:
         Args:
             sidetag: Sidetag name.
         """
-        if not self.session.logged_in:
-            try:
-                self.session.gssapi_login()
-            except Exception as e:
-                logger.debug(f"Authentication failed: {e}")
-                return
         try:
             self.session.removeSideTag(sidetag)
         except Exception as e:
@@ -352,12 +376,6 @@ def tag_build(self, nvr: str, tag: str) -> Optional[str]:
         Returns:
             Task ID if tagging was successfully requested else None.
         """
-        if not self.session.logged_in:
-            try:
-                self.session.gssapi_login()
-            except Exception as e:
-                logger.debug(f"Authentication failed: {e}")
-                return None
         try:
             task_id = self.session.tagBuild(tag, nvr)
         except Exception as e:
@@ -375,12 +393,6 @@ def untag_build(self, nvr: str, tag: str) -> None:
             nvr: NVR of the build.
             tag: Tag name.
         """
-        if not self.session.logged_in:
-            try:
-                self.session.gssapi_login()
-            except Exception as e:
-                logger.debug(f"Authentication failed: {e}")
-                return
         try:
             self.session.untagBuild(tag, nvr, strict=True)
         except Exception as e:

tests/integration/test_create_update.py

@@ -8,7 +8,7 @@
 
 from packit import distgit
 from packit.exceptions import PackitBodhiException
-from packit.utils.koji_helper import KojiHelper
+from packit.utils.koji_helper import KojiHelper, SessionWrapper
 
 
 @pytest.fixture()
@@ -275,6 +275,8 @@ def test_basic_bodhi_update(
     u, d, api = api_instance
     flexmock(api).should_receive("init_kerberos_ticket").at_least().once()
 
+    flexmock(SessionWrapper).should_receive("_open_session").and_return()
+
     flexmock(KojiHelper).should_receive("get_candidate_tag").and_return(
         "f30-updates-candidate",
     )
@@ -329,6 +331,8 @@ def validate_save(kwargs, expected_kwargs):
     api.config.fas_user = "packit"
     flexmock(api).should_receive("init_kerberos_ticket").at_least().once()
 
+    flexmock(SessionWrapper).should_receive("_open_session").and_return()
+
     flexmock(KojiHelper).should_receive("get_candidate_tag").and_return(
         "f30-updates-candidate",
     )