fix(events): refactor abstract classes

Signed-off-by: Matej Focko <mfocko@redhat.com>

packit_service/worker/allowlist.py

@@ -47,7 +47,7 @@
     TestingFarmResultsEvent,
     github,
 )
-from packit_service.worker.events.comment import CommitCommentEvent
+from packit_service.worker.events.abstract.comment import Commit as CommitCommentEvent
 from packit_service.worker.events.koji.base import Build as KojiBuildEvent
 from packit_service.worker.events.koji.base import BuildTag as KojiBuildTagEvent
 from packit_service.worker.helpers.build import CoprBuildJobHelper

packit_service/worker/events/__init__.py

@@ -1,23 +1,27 @@
 # Copyright Contributors to the Packit project.
 # SPDX-License-Identifier: MIT
 
-from packit_service.worker.events.abstract import (
+from packit_service.worker.events.abstract.base import (
     ForgeIndependent as AbstractForgeIndependentEvent,
 )
-from packit_service.worker.events.abstract import (
+from packit_service.worker.events.abstract.base import (
     Result as AbstractResultEvent,
 )
+from packit_service.worker.events.abstract.comment import (
+    Comment as AbstractCommentEvent,
+)
+from packit_service.worker.events.abstract.comment import (
+    Issue as AbstractIssueCommentEvent,
+)
+from packit_service.worker.events.abstract.comment import (
+    PullRequest as AbstractPRCommentEvent,
+)
 from packit_service.worker.events.anitya.base import (
     NewHotness as NewHotnessUpdateEvent,
 )
 from packit_service.worker.events.anitya.base import (
     VersionUpdate as AnityaVersionUpdateEvent,
 )
-from packit_service.worker.events.comment import (
-    AbstractCommentEvent,
-    AbstractIssueCommentEvent,
-    AbstractPRCommentEvent,
-)
 from packit_service.worker.events.copr import (
     CoprBuild as AbstractCoprBuildEvent,
 )

packit_service/worker/events/abstract/__init__.py

@@ -0,0 +1,2 @@
+# Copyright Contributors to the Packit project.
+# SPDX-License-Identifier: MIT

packit_service/worker/events/comment.py → packit_service/worker/events/abstract/comment.py

@@ -9,7 +9,8 @@
 from logging import getLogger
 from typing import Optional, Union
 
-from ogr.abstract import Comment, Issue
+from ogr.abstract import Comment
+from ogr.abstract import Issue as OgrIssue
 
 from packit_service.models import (
     BuildStatus,
@@ -22,12 +23,12 @@
     AddIssueEventToDb,
     AddPullRequestEventToDb,
 )
-from packit_service.worker.events.abstract import ForgeIndependent
+from packit_service.worker.events.abstract.base import ForgeIndependent
 
 logger = getLogger(__name__)
 
 
-class AbstractCommentEvent(ForgeIndependent):
+class CommentEvent(ForgeIndependent):
     def __init__(
         self,
         project_url: str,
@@ -53,7 +54,7 @@ def get_dict(self, default_dict: Optional[dict] = None) -> dict:
         return result
 
 
-class AbstractPRCommentEvent(AddPullRequestEventToDb, AbstractCommentEvent):
+class PullRequest(AddPullRequestEventToDb, CommentEvent):
     def __init__(
         self,
         pr_id: int,
@@ -132,7 +133,7 @@ def get_dict(self, default_dict: Optional[dict] = None) -> dict:
         return result
 
 
-class AbstractIssueCommentEvent(AddIssueEventToDb, AbstractCommentEvent):
+class Issue(AddIssueEventToDb, CommentEvent):
     def __init__(
         self,
         issue_id: int,
@@ -162,7 +163,7 @@ def __init__(
         self._tag_name = tag_name
         self._commit_sha: Optional[str] = None
         self._comment_object = comment_object
-        self._issue_object: Optional[Issue] = None
+        self._issue_object: Optional[OgrIssue] = None
 
     @property
     def tag_name(self):
@@ -180,7 +181,7 @@ def commit_sha(self) -> Optional[str]:  # type:ignore
         return self._commit_sha
 
     @property
-    def issue_object(self) -> Optional[Issue]:
+    def issue_object(self) -> Optional[OgrIssue]:
         if not self._issue_object:
             self._issue_object = self.project.get_issue(self.issue_id)
         return self._issue_object
@@ -200,7 +201,7 @@ def get_dict(self, default_dict: Optional[dict] = None) -> dict:
         return result
 
 
-class CommitCommentEvent(AbstractCommentEvent):
+class Commit(CommentEvent):
     _trigger: Union[GitBranchModel, ProjectReleaseModel] = None
     _event: ProjectEventModel = None
 

packit_service/worker/events/copr.py

@@ -15,7 +15,7 @@
     ProjectEventModelType,
     SRPMBuildModel,
 )
-from packit_service.worker.events.abstract import Result
+from packit_service.worker.events.abstract.base import Result
 from packit_service.worker.events.enums import FedmsgTopic
 
 logger = getLogger(__name__)

packit_service/worker/events/github/abstract.py

@@ -3,7 +3,7 @@
 
 from typing import Optional
 
-from packit_service.worker.events.abstract import ForgeIndependent
+from packit_service.worker.events.abstract.base import ForgeIndependent
 
 
 class GithubEvent(ForgeIndependent):

packit_service/worker/events/github/commit.py

@@ -1,8 +1,8 @@
 # Copyright Contributors to the Packit project.
 # SPDX-License-Identifier: MIT
 
-from packit_service.worker.events.comment import CommitCommentEvent
+from packit_service.worker.events.abstract.comment import Commit
 
 
-class Comment(CommitCommentEvent):
+class Comment(Commit):
     pass

packit_service/worker/events/github/issue.py

@@ -5,7 +5,7 @@
 
 from ogr.abstract import Comment as OgrComment
 
-from packit_service.worker.events.comment import AbstractIssueCommentEvent
+from packit_service.worker.events.abstract.comment import Issue as AbstractIssueCommentEvent
 from packit_service.worker.events.enums import IssueCommentAction
 from packit_service.worker.events.github.abstract import GithubEvent
 

packit_service/worker/events/github/pr.py

@@ -7,7 +7,7 @@
 from ogr.abstract import GitProject
 
 from packit_service.service.db_project_events import AddPullRequestEventToDb
-from packit_service.worker.events.comment import AbstractPRCommentEvent
+from packit_service.worker.events.abstract.comment import PullRequest as AbstractPRCommentEvent
 from packit_service.worker.events.enums import (
     PullRequestAction,
     PullRequestCommentAction,

packit_service/worker/events/gitlab/abstract.py

@@ -3,7 +3,7 @@
 
 from typing import Optional
 
-from packit_service.worker.events.abstract import ForgeIndependent
+from packit_service.worker.events.abstract.base import ForgeIndependent
 
 
 class GitlabEvent(ForgeIndependent):

packit_service/worker/events/gitlab/commit.py

@@ -1,8 +1,8 @@
 # Copyright Contributors to the Packit project.
 # SPDX-License-Identifier: MIT
 
-from packit_service.worker.events.comment import CommitCommentEvent
+from packit_service.worker.events.abstract.comment import Commit
 
 
-class Comment(CommitCommentEvent):
+class Comment(Commit):
     pass

packit_service/worker/events/gitlab/issue.py

@@ -4,8 +4,8 @@
 
 from ogr.abstract import Comment as OgrComment
 
-from packit_service.worker.events.comment import (
-    AbstractIssueCommentEvent,
+from packit_service.worker.events.abstract.comment import (
+    Issue as AbstractIssueCommentEvent,
 )
 from packit_service.worker.events.enums import GitlabEventAction
 from packit_service.worker.events.gitlab.abstract import GitlabEvent

packit_service/worker/events/gitlab/mr.py

@@ -9,8 +9,8 @@
 from packit_service.service.db_project_events import (
     AddPullRequestEventToDb,
 )
-from packit_service.worker.events.comment import (
-    AbstractPRCommentEvent,
+from packit_service.worker.events.abstract.comment import (
+    PullRequest as AbstractPRCommentEvent,
 )
 from packit_service.worker.events.enums import GitlabEventAction
 from packit_service.worker.events.gitlab.abstract import GitlabEvent

packit_service/worker/events/koji/abstract.py

@@ -9,7 +9,7 @@
     KojiBuildTargetModel,
     ProjectEventModel,
 )
-from packit_service.worker.events.abstract import Result
+from packit_service.worker.events.abstract.base import Result
 
 logger = logging.getLogger(__name__)
 

packit_service/worker/events/openscanhub/abstract.py

@@ -13,7 +13,7 @@
     OSHScanModel,
     ProjectEventModel,
 )
-from packit_service.worker.events.abstract import Result
+from packit_service.worker.events.abstract.base import Result
 
 logger = getLogger(__name__)
 

packit_service/worker/events/pagure/abstract.py

@@ -7,7 +7,7 @@
 from packit.config import PackageConfig
 
 from packit_service.config import PackageConfigGetter
-from packit_service.worker.events.abstract import ForgeIndependent
+from packit_service.worker.events.abstract.base import ForgeIndependent
 
 logger = getLogger(__name__)
 

packit_service/worker/events/pagure/pr.py

@@ -14,7 +14,7 @@
     AddPullRequestEventToDb,
 )
 from packit_service.utils import get_packit_commands_from_comment
-from packit_service.worker.events.comment import AbstractPRCommentEvent
+from packit_service.worker.events.abstract.comment import PullRequest as AbstractPRCommentEvent
 from packit_service.worker.events.enums import (
     PullRequestAction,
     PullRequestCommentAction,

packit_service/worker/events/testing_farm.py

@@ -14,7 +14,7 @@
     TestingFarmResult,
     TFTTestRunTargetModel,
 )
-from packit_service.worker.events.abstract import Result as AbstractResult
+from packit_service.worker.events.abstract.base import Result as AbstractResult
 
 
 class Result(AbstractResult):

packit_service/worker/handlers/copr.py

@@ -55,7 +55,7 @@
     ReleaseEvent,
     ReleaseGitlabEvent,
 )
-from packit_service.worker.events.comment import CommitCommentEvent
+from packit_service.worker.events.abstract.comment import Commit as CommitCommentEvent
 from packit_service.worker.handlers.abstract import (
     JobHandler,
     RetriableJobHandler,

packit_service/worker/handlers/testing_farm.py

@@ -49,7 +49,7 @@
     ReleaseGitlabEvent,
     TestingFarmResultsEvent,
 )
-from packit_service.worker.events.comment import CommitCommentEvent
+from packit_service.worker.events.abstract.comment import Commit as CommitCommentEvent
 from packit_service.worker.handlers import JobHandler
 from packit_service.worker.handlers.abstract import (
     RetriableJobHandler,

packit_service/worker/jobs.py

@@ -39,11 +39,17 @@
     PullRequestPagureEvent,
     github,
 )
-from packit_service.worker.events.comment import (
-    AbstractCommentEvent,
-    AbstractIssueCommentEvent,
-    AbstractPRCommentEvent,
-    CommitCommentEvent,
+from packit_service.worker.events.abstract.comment import (
+    Comment as AbstractCommentEvent,
+)
+from packit_service.worker.events.abstract.comment import (
+    Commit as CommitCommentEvent,
+)
+from packit_service.worker.events.abstract.comment import (
+    Issue as AbstractIssueCommentEvent,
+)
+from packit_service.worker.events.abstract.comment import (
+    PullRequest as AbstractPRCommentEvent,
 )
 from packit_service.worker.events.koji.base import BuildTag as KojiBuildTagEvent
 from packit_service.worker.events.koji.base import Task as KojiTaskEvent

packit_service/worker/parser.py

@@ -62,7 +62,7 @@
     VMImageBuildResultEvent,
     github,
 )
-from packit_service.worker.events.comment import CommitCommentEvent
+from packit_service.worker.events.abstract.comment import Commit as CommitCommentEvent
 from packit_service.worker.events.enums import (
     GitlabEventAction,
     IssueCommentAction,

tests/integration/test_pr_comment.py

@@ -67,7 +67,7 @@
 from packit_service.worker.allowlist import Allowlist
 from packit_service.worker.celery_task import CeleryTask
 from packit_service.worker.events import PullRequestCommentPagureEvent
-from packit_service.worker.events.abstract import (
+from packit_service.worker.events.abstract.base import (
     ForgeIndependent as AbstractForgeIndependentEvent,
 )
 from packit_service.worker.handlers.bodhi import (

tests/unit/events/test_github.py

@@ -30,7 +30,7 @@
     ReleaseEvent,
     github,
 )
-from packit_service.worker.events.comment import CommitCommentEvent
+from packit_service.worker.events.abstract.comment import Commit as CommitCommentEvent
 from packit_service.worker.events.enums import (
     IssueCommentAction,
     PullRequestAction,

tests/unit/events/test_gitlab.py

@@ -18,7 +18,7 @@
     ReleaseGitlabEvent,
     TagPushGitlabEvent,
 )
-from packit_service.worker.events.comment import CommitCommentEvent
+from packit_service.worker.events.abstract.comment import Commit as CommitCommentEvent
 from packit_service.worker.events.enums import GitlabEventAction
 from packit_service.worker.parser import Parser
 from tests.spellbook import DATA_DIR

tests/unit/test_allowlist.py

@@ -36,7 +36,7 @@
     PullRequestGithubEvent,
     ReleaseEvent,
 )
-from packit_service.worker.events.comment import CommitCommentEvent
+from packit_service.worker.events.abstract.comment import Commit as CommitCommentEvent
 from packit_service.worker.events.enums import (
     IssueCommentAction,
     PullRequestAction,

tests/unit/test_mixin.py

@@ -10,7 +10,7 @@
 
 from packit_service.config import ServiceConfig
 from packit_service.worker.events import EventData
-from packit_service.worker.events.comment import AbstractIssueCommentEvent
+from packit_service.worker.events.abstract.comment import Issue as AbstractIssueCommentEvent
 from packit_service.worker.handlers.mixin import (
     GetCoprBuildJobHelperMixin,
     GetVMImageBuilderMixin,