chore: add common action models to shared models folder

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
     -   id: check-yaml
     -   id: check-added-large-files
 -   repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.1.1
+    rev: 24.2.0
     hooks:
     -   id: black
 -   repo: https://github.com/yelp/detect-secrets

secureli/actions/action.py

@@ -1,7 +1,5 @@
 from abc import ABC
-from enum import Enum
 from pathlib import Path
-from typing import Optional
 from secureli.abstractions.echo import EchoAbstraction
 from secureli.consts.logging import TELEMETRY_DEFAULT_ENDPOINT
 from secureli.models.echo import Color
@@ -11,7 +9,7 @@
     VerifyConfigOutcome,
 )
 from secureli.repositories.settings import SecureliRepository, TelemetrySettings
-from secureli.services.language_analyzer import LanguageAnalyzerService, AnalyzeResult
+from secureli.services.language_analyzer import LanguageAnalyzerService
 from secureli.services.language_config import LanguageNotSupportedError
 from secureli.services.language_support import (
     LanguageMetadata,
@@ -20,31 +18,10 @@
 from secureli.services.scanner import ScannerService, ScanMode
 from secureli.services.updater import UpdaterService
 
-import pydantic
+from secureli.shared.models.actions import VerifyOutcome, VerifyResult
 from secureli.utilities.formatter import format_sentence_list
 
 
-class VerifyOutcome(str, Enum):
-    INSTALL_CANCELED = "install-canceled"
-    INSTALL_FAILED = "install-failed"
-    INSTALL_SUCCEEDED = "install-succeeded"
-    UPDATE_CANCELED = "update-canceled"
-    UPDATE_SUCCEEDED = "update-succeeded"
-    UPDATE_FAILED = "update-failed"
-    UP_TO_DATE = "up-to-date"
-
-
-class VerifyResult(pydantic.BaseModel):
-    """
-    The outcomes of performing verification. Actions can use these results
-    to decide whether to proceed with their post-initialization actions or not.
-    """
-
-    outcome: VerifyOutcome
-    config: Optional[SecureliConfig] = None
-    analyze_result: Optional[AnalyzeResult] = None
-
-
 class ActionDependencies:
     """
     Consolidates a growing set of common dependencies so Action adopters can

secureli/actions/scan.py

@@ -6,10 +6,8 @@
 
 from secureli.abstractions.echo import EchoAbstraction
 from secureli.actions.action import (
-    VerifyOutcome,
     Action,
     ActionDependencies,
-    VerifyResult,
 )
 from secureli.models.exit_codes import ExitCode
 from secureli.models.publish_results import PublishResultsOption
@@ -20,6 +18,7 @@
     ScannerService,
 )
 from secureli.settings import Settings
+from secureli.shared.models.actions import VerifyOutcome, VerifyResult
 from secureli.utilities.usage_stats import post_log, convert_failures_to_failure_count
 
 ONE_WEEK_IN_SECONDS: int = 7 * 24 * 60 * 60

secureli/shared/models/actions.py

@@ -0,0 +1,28 @@
+from enum import Enum
+from typing import Optional
+
+import pydantic
+
+from secureli.repositories.secureli_config import SecureliConfig
+from secureli.services.language_analyzer import AnalyzeResult
+
+
+class VerifyOutcome(str, Enum):
+    INSTALL_CANCELED = "install-canceled"
+    INSTALL_FAILED = "install-failed"
+    INSTALL_SUCCEEDED = "install-succeeded"
+    UPDATE_CANCELED = "update-canceled"
+    UPDATE_SUCCEEDED = "update-succeeded"
+    UPDATE_FAILED = "update-failed"
+    UP_TO_DATE = "up-to-date"
+
+
+class VerifyResult(pydantic.BaseModel):
+    """
+    The outcomes of performing verification. Actions can use these results
+    to decide whether to proceed with their post-initialization actions or not.
+    """
+
+    outcome: VerifyOutcome
+    config: Optional[SecureliConfig] = None
+    analyze_result: Optional[AnalyzeResult] = None

tests/actions/test_action.py

@@ -4,7 +4,7 @@
 import pytest
 from secureli.abstractions.pre_commit import InstallResult
 
-from secureli.actions.action import Action, ActionDependencies, VerifyOutcome
+from secureli.actions.action import Action, ActionDependencies
 from secureli.consts.logging import TELEMETRY_DEFAULT_ENDPOINT
 from secureli.models.echo import Color
 from secureli.repositories.secureli_config import SecureliConfig, VerifyConfigOutcome
@@ -13,6 +13,7 @@
 from secureli.services.scanner import ScanResult, Failure
 from secureli.services.updater import UpdateResult
 from secureli.settings import Settings
+from secureli.shared.models.actions import VerifyOutcome
 
 test_folder_path = Path("does-not-matter")
 

tests/actions/test_scan_action.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 from secureli.abstractions.pre_commit import RevisionPair
-from secureli.actions.action import ActionDependencies, VerifyOutcome
+from secureli.actions.action import ActionDependencies
 from secureli.actions.scan import ScanAction
 from secureli.models.exit_codes import ExitCode
 from secureli.models.publish_results import PublishResultsOption
@@ -25,6 +25,7 @@
 import pytest
 
 from secureli.settings import Settings
+from secureli.shared.models.actions import VerifyOutcome
 
 test_folder_path = Path("does-not-matter")
 

tests/application/test_main.py

@@ -4,12 +4,12 @@
 
 import pytest
 from pytest_mock import MockerFixture
-from secureli.actions.action import VerifyOutcome, VerifyResult
 
 import secureli.container
 import secureli.main
 from secureli.models.publish_results import PublishResultsOption
 from secureli.services.scanner import ScanMode
+from secureli.shared.models.actions import VerifyOutcome, VerifyResult
 from secureli.utilities.secureli_meta import secureli_version