Merge pull request #5830 from opsmill/lgu-migrate-check-repo-check-def

Migrate run repository user checks tasks

Author: LucasG0

backend/infrahub/git/models.py

@@ -1,6 +1,8 @@
 from typing import Optional
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
+
+from infrahub.message_bus.types import ProposedChangeBranchDiff
 
 
 class RequestArtifactDefinitionGenerate(BaseModel):
@@ -110,3 +112,77 @@ class GitDiffNamesOnlyResponse(BaseModel):
     files_added: list[str] = Field(..., description="Files added")
     files_changed: list[str] = Field(..., description="Files changed")
     files_removed: list[str] = Field(..., description="Files removed")
+
+
+class UserCheckDefinitionData(BaseModel):
+    """Triggers user defined checks to run based on a Check Definition."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    check_definition_id: str = Field(..., description="The unique ID of the check definition")
+    commit: str = Field(..., description="The commit to target")
+    repository_id: str = Field(..., description="The unique ID of the Repository")
+    repository_name: str = Field(..., description="The name of the Repository")
+    branch_name: str = Field(..., description="The branch where the check is run")
+    file_path: str = Field(..., description="The path and filename of the check")
+    class_name: str = Field(..., description="The name of the class containing the check")
+    proposed_change: str = Field(..., description="The unique ID of the Proposed Change")
+    branch_diff: ProposedChangeBranchDiff = Field(..., description="The calculated diff between the two branches")
+
+
+class UserCheckData(BaseModel):
+    """Runs a check as defined within a CoreCheckDefinition within a repository."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    validator_id: str = Field(..., description="The id of the validator associated with this check")
+    validator_execution_id: str = Field(..., description="The id of current execution of the associated validator")
+    check_execution_id: str = Field(..., description="The unique ID for the current execution of this check")
+    check_definition_id: str = Field(..., description="The unique ID of the check definition")
+    commit: str = Field(..., description="The commit to target")
+    repository_id: str = Field(..., description="The unique ID of the Repository")
+    repository_name: str = Field(..., description="The name of the Repository")
+    branch_name: str = Field(..., description="The branch where the check is run")
+    file_path: str = Field(..., description="The path and filename of the check")
+    class_name: str = Field(..., description="The name of the class containing the check")
+    proposed_change: str = Field(..., description="The unique ID of the Proposed Change")
+    variables: dict = Field(default_factory=dict, description="Input variables when running the check")
+    name: str = Field(..., description="The name of the check")
+    branch_diff: ProposedChangeBranchDiff = Field(..., description="The calculated diff between the two branches")
+    timeout: int = Field(..., description="The timeout for the check")
+
+
+class TriggerRepositoryUserChecks(BaseModel):
+    """Sent to trigger the user defined checks on a repository."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    proposed_change: str = Field(..., description="The unique ID of the Proposed Change")
+    repository_id: str = Field(..., description="The unique ID of the Repository")
+    repository_name: str = Field(..., description="The name of the Repository")
+    source_branch: str = Field(..., description="The source branch")
+    source_branch_sync_with_git: bool = Field(..., description="Indicates if the source branch should sync with git")
+    target_branch: str = Field(..., description="The target branch")
+    branch_diff: ProposedChangeBranchDiff = Field(..., description="The calculated diff between the two branches")
+
+
+class TriggerRepositoryInternalChecks(BaseModel):
+    """Sent to trigger the checks for a repository to be executed."""
+
+    proposed_change: str = Field(..., description="The unique ID of the Proposed Change")
+    repository: str = Field(..., description="The unique ID of the Repository")
+    source_branch: str = Field(..., description="The source branch")
+    target_branch: str = Field(..., description="The target branch")
+
+
+class CheckRepositoryMergeConflicts(BaseModel):
+    """Runs a check to validate if there are merge conflicts for a proposed change between two branches."""
+
+    validator_id: str = Field(..., description="The id of the validator associated with this check")
+    validator_execution_id: str = Field(..., description="The id of current execution of the associated validator")
+    check_execution_id: str = Field(..., description="The unique ID for the current execution of this check")
+    proposed_change: str = Field(..., description="The unique ID of the Proposed Change")
+    repository_id: str = Field(..., description="The unique ID of the Repository")
+    repository_name: str = Field(..., description="The name of the Repository")
+    source_branch: str = Field(..., description="The source branch")
+    target_branch: str = Field(..., description="The target branch")