qontract-reconcile 0.10.0__py3-none-any.whl → 0.10.1.dev1203__py3-none-any.whl

reconcile/utils/saasherder/interfaces.py

@@ -1,13 +1,9 @@
 from __future__ import annotations
 
-from collections.abc import Sequence
+from collections.abc import Mapping, Sequence, Set
 from typing import (
-    AbstractSet,
     Any,
-    Mapping,
-    Optional,
     Protocol,
-    Union,
     runtime_checkable,
 )
 
@@ -15,33 +11,57 @@ from reconcile.utils import oc_connection_parameters
 from reconcile.utils.secret_reader import HasSecret
 
 
+@runtime_checkable
 class HasParameters(Protocol):
-    parameters: Optional[dict[str, Any]]
+    parameters: dict[str, Any] | None
 
 
 class SaasFileSecretParameters(Protocol):
     name: str
 
     @property
-    def secret(self) -> HasSecret:
-        ...
+    def secret(self) -> HasSecret: ...
+
+    def dict(
+        self,
+        *,
+        by_alias: bool = False,
+        include: AbstractSetIntStr | MappingIntStrAny | None = None,
+    ) -> dict[str, Any]: ...
 
 
-SaasSecretParameters = Optional[Sequence[SaasFileSecretParameters]]
+SaasSecretParameters = Sequence[SaasFileSecretParameters] | None
 # Taken from pydantic.typing
-AbstractSetIntStr = AbstractSet[Union[int, str]]
-MappingIntStrAny = Mapping[Union[int, str], Any]
+AbstractSetIntStr = Set[int | str]
+MappingIntStrAny = Mapping[int | str, Any]
 
 
+@runtime_checkable
 class HasSecretParameters(Protocol):
     @property
-    def secret_parameters(self) -> SaasSecretParameters:
-        ...
+    def secret_parameters(self) -> SaasSecretParameters: ...
+
+
+class SaasParentApp(Protocol):
+    name: str
 
 
+@runtime_checkable
 class SaasApp(Protocol):
     name: str
 
+    @property
+    def parent_app(self) -> SaasParentApp | None: ...
+
+    @property
+    def self_service_roles(self) -> Sequence[SaasRole] | None: ...
+
+    @property
+    def service_owners(self) -> Sequence[SaasServiceOwner] | None: ...
+
+    @property
+    def code_components(self) -> Sequence[AppCodeComponent] | None: ...
+
 
 class SaasPipelinesProvider(Protocol):
     name: str
@@ -58,8 +78,7 @@ class SaasPipelinesProviderTektonNamespace(Protocol):
     name: str
 
     @property
-    def cluster(self) -> SaasPipelinesProviderTektonNamespaceCluster:
-        ...
+    def cluster(self) -> SaasPipelinesProviderTektonNamespaceCluster: ...
 
 
 class SaasPipelinesProviderTektonObjectTemplate(Protocol):
@@ -68,14 +87,12 @@ class SaasPipelinesProviderTektonObjectTemplate(Protocol):
 
 class SaasPipelinesProviderPipelineTemplates(Protocol):
     @property
-    def openshift_saas_deploy(self) -> SaasPipelinesProviderTektonObjectTemplate:
-        ...
+    def openshift_saas_deploy(self) -> SaasPipelinesProviderTektonObjectTemplate: ...
 
 
 class SaasPipelinesProviderTektonProviderDefaults(Protocol):
     @property
-    def pipeline_templates(self) -> SaasPipelinesProviderPipelineTemplates:
-        ...
+    def pipeline_templates(self) -> SaasPipelinesProviderPipelineTemplates: ...
 
 
 class SaasPipelinesProviderTekton_PipelinesProviderPipelineTemplates_PipelinesProviderTektonObjectTemplate(
@@ -88,8 +105,7 @@ class SaasPipelinesProviderTekton_PipelinesProviderPipelineTemplates(Protocol):
     @property
     def openshift_saas_deploy(
         self,
-    ) -> SaasPipelinesProviderTekton_PipelinesProviderPipelineTemplates_PipelinesProviderTektonObjectTemplate:
-        ...
+    ) -> SaasPipelinesProviderTekton_PipelinesProviderPipelineTemplates_PipelinesProviderTektonObjectTemplate: ...
 
 
 @runtime_checkable
@@ -98,33 +114,33 @@ class SaasPipelinesProviderTekton(Protocol):
     provider: str
 
     @property
-    def namespace(self) -> SaasPipelinesProviderTektonNamespace:
-        ...
+    def namespace(self) -> SaasPipelinesProviderTektonNamespace: ...
 
     @property
-    def defaults(self) -> SaasPipelinesProviderTektonProviderDefaults:
-        ...
+    def defaults(self) -> SaasPipelinesProviderTektonProviderDefaults: ...
 
     @property
     def pipeline_templates(
         self,
-    ) -> Optional[SaasPipelinesProviderTekton_PipelinesProviderPipelineTemplates]:
-        ...
+    ) -> SaasPipelinesProviderTekton_PipelinesProviderPipelineTemplates | None: ...
 
 
-class SaasResourceRequirements(Protocol):
+class SaasResourceRequestsRequirements(Protocol):
     cpu: str
     memory: str
 
 
+class SaasResourceLimitsRequirements(Protocol):
+    cpu: str | None
+    memory: str
+
+
 class SaasDeployResources(Protocol):
     @property
-    def requests(self) -> SaasResourceRequirements:
-        ...
+    def requests(self) -> SaasResourceRequestsRequirements: ...
 
     @property
-    def limits(self) -> SaasResourceRequirements:
-        ...
+    def limits(self) -> SaasResourceLimitsRequirements: ...
 
 
 class SaasSlackWorkspaceIntegration(Protocol):
@@ -134,53 +150,47 @@ class SaasSlackWorkspaceIntegration(Protocol):
     username: str
 
     @property
-    def token(self) -> HasSecret:
-        ...
+    def token(self) -> HasSecret: ...
 
 
 class SaasSlackWorkspace(Protocol):
     name: str
 
     @property
-    def integrations(self) -> Optional[Sequence[SaasSlackWorkspaceIntegration]]:
-        ...
+    def integrations(self) -> Sequence[SaasSlackWorkspaceIntegration] | None: ...
 
 
 class SaasSlackOutputNotifications(Protocol):
-    start: Optional[bool]
+    start: bool | None
 
 
 class SaasSlackOutput(Protocol):
-    output: Optional[str]
-    channel: Optional[str]
+    output: str | None
+    channel: str | None
 
     @property
-    def workspace(self) -> SaasSlackWorkspace:
-        ...
+    def workspace(self) -> SaasSlackWorkspace: ...
 
     @property
-    def notifications(self) -> Optional[SaasSlackOutputNotifications]:
-        ...
+    def notifications(self) -> SaasSlackOutputNotifications | None: ...
 
 
 class SaasFileAuthentication(Protocol):
     @property
-    def code(self) -> Optional[HasSecret]:
-        ...
+    def code(self) -> HasSecret | None: ...
 
     @property
-    def image(self) -> Optional[HasSecret]:
-        ...
+    def image(self) -> HasSecret | None: ...
 
 
 class SaasEnvironment_SaasSecretParameters(Protocol):
     name: str
 
     @property
-    def secret(self) -> HasSecret:
-        ...
+    def secret(self) -> HasSecret: ...
 
 
+@runtime_checkable
 class SaasEnvironment(HasParameters, HasSecretParameters, Protocol):
     name: str
 
@@ -189,24 +199,20 @@ class SaasResourceTemplateTargetNamespace(Protocol):
     name: str
 
     @property
-    def environment(self) -> SaasEnvironment:
-        ...
+    def environment(self) -> SaasEnvironment: ...
 
     @property
-    def app(self) -> SaasApp:
-        ...
+    def app(self) -> SaasApp: ...
 
     @property
-    def cluster(self) -> oc_connection_parameters.Cluster:
-        ...
+    def cluster(self) -> oc_connection_parameters.Cluster: ...
 
     def dict(
         self,
         *,
         by_alias: bool = False,
-        include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None,
-    ) -> dict[str, Any]:
-        ...
+        include: AbstractSetIntStr | MappingIntStrAny | None = None,
+    ) -> dict[str, Any]: ...
 
 
 class SaasPromotionChannelData(Protocol):
@@ -216,28 +222,32 @@ class SaasPromotionChannelData(Protocol):
 @runtime_checkable
 class SaasParentSaasPromotion(Protocol):
     q_type: str
-    parent_saas: Optional[str]
-    target_config_hash: Optional[str]
+    parent_saas: str | None
+    target_config_hash: str | None
 
 
 class SaasPromotionData(Protocol):
-    channel: Optional[str]
+    channel: str | None
 
     @property
     def data(
         self,
-    ) -> Optional[Sequence[Union[SaasParentSaasPromotion, SaasPromotionChannelData]]]:
-        ...
+    ) -> Sequence[SaasParentSaasPromotion | SaasPromotionChannelData] | None: ...
 
 
 class SaasResourceTemplateTargetPromotion(Protocol):
-    auto: Optional[bool]
-    publish: Optional[list[str]]
-    subscribe: Optional[list[str]]
+    auto: bool | None
+    publish: list[str] | None
+    subscribe: list[str] | None
+    soak_days: int | None
 
     @property
-    def promotion_data(self) -> Optional[Sequence[SaasPromotionData]]:
-        ...
+    def promotion_data(self) -> Sequence[SaasPromotionData] | None: ...
+
+
+class Channel(Protocol):
+    name: str
+    publisher_uids: list[str]
 
 
 @runtime_checkable
@@ -245,26 +255,26 @@ class SaasPromotion(Protocol):
     commit_sha: str
     saas_file: str
     target_config_hash: str
-    auto: Optional[bool] = None
-    publish: Optional[list[str]] = None
-    subscribe: Optional[list[str]] = None
-    saas_file_paths: Optional[list[str]] = None
-    target_paths: Optional[list[str]] = None
+    auto: bool | None = None
+    publish: list[str] | None = None
+    saas_file_paths: list[str] | None = None
+    target_paths: list[str] | None = None
+    soak_days: int | None = None
+
+    @property
+    def promotion_data(self) -> Sequence[SaasPromotionData] | None: ...
 
     @property
-    def promotion_data(self) -> Optional[Sequence[SaasPromotionData]]:
-        ...
+    def subscribe(self) -> list[Channel] | None: ...
 
-    def dict(self, *, by_alias: bool = False) -> dict[str, Any]:
-        ...
+    def dict(self, *, by_alias: bool = False) -> dict[str, Any]: ...
 
 
 class SaasResourceTemplateTarget_SaasSecretParameters(Protocol):
     name: str
 
     @property
-    def secret(self) -> HasSecret:
-        ...
+    def secret(self) -> HasSecret: ...
 
 
 class SaasJenkinsInstance(Protocol):
@@ -276,8 +286,7 @@ class SaasResourceTemplateTargetUpstream(Protocol):
     name: str
 
     @property
-    def instance(self) -> SaasJenkinsInstance:
-        ...
+    def instance(self) -> SaasJenkinsInstance: ...
 
 
 class SaasQuayInstance(Protocol):
@@ -288,117 +297,113 @@ class SaasQuayOrg(Protocol):
     name: str
 
     @property
-    def instance(self) -> SaasQuayInstance:
-        ...
+    def instance(self) -> SaasQuayInstance: ...
 
 
 class SaasResourceTemplateTargetImage(Protocol):
     name: str
 
     @property
-    def org(self) -> SaasQuayOrg:
-        ...
+    def org(self) -> SaasQuayOrg: ...
 
 
 class SaasResourceTemplateTarget(HasParameters, HasSecretParameters, Protocol):
-    path: Optional[str]
-    name: Optional[str]
-    disable: Optional[bool]
-    delete: Optional[bool]
+    path: str | None
+    name: str | None
+    disable: bool | None
+    delete: bool | None
     ref: str
 
     @property
-    def namespace(self) -> SaasResourceTemplateTargetNamespace:
-        ...
+    def namespace(self) -> SaasResourceTemplateTargetNamespace: ...
 
     @property
-    def promotion(self) -> Optional[SaasResourceTemplateTargetPromotion]:
-        ...
+    def promotion(self) -> SaasResourceTemplateTargetPromotion | None: ...
 
     @property
-    def upstream(self) -> Optional[SaasResourceTemplateTargetUpstream]:
-        ...
+    def upstream(self) -> SaasResourceTemplateTargetUpstream | None: ...
 
     @property
-    def image(self) -> Optional[SaasResourceTemplateTargetImage]:
-        ...
+    def image(self) -> SaasResourceTemplateTargetImage | None: ...
 
-    def dict(self, *, by_alias: bool = False) -> dict[str, Any]:
-        ...
+    def uid(
+        self, parent_saas_file_name: str, parent_resource_template_name: str
+    ) -> str: ...
+
+    def dict(self, *, by_alias: bool = False) -> dict[str, Any]: ...
 
 
 class SaasResourceTemplate(HasParameters, HasSecretParameters, Protocol):
     name: str
     url: str
     path: str
-    provider: Optional[str]
-    hash_length: Optional[int]
+    provider: str | None
+    hash_length: int | None
 
     @property
-    def targets(self) -> Sequence[SaasResourceTemplateTarget]:
-        ...
+    def targets(self) -> Sequence[SaasResourceTemplateTarget]: ...
+
 
+class SaasRole(Protocol):
+    name: str
 
-class SaasUser(Protocol):
-    org_username: str
-    tag_on_merge_requests: Optional[bool]
 
+class SaasServiceOwner(Protocol):
+    name: str
+    email: str
 
-class SaasBot(Protocol):
-    org_username: Optional[str]
 
+class AppCodeComponent(Protocol):
+    url: str
+    blocked_versions: list[str] | None
+    hotfix_versions: list[str] | None
 
-class SaasRole(Protocol):
-    @property
-    def users(self) -> Sequence[SaasUser]:
-        ...
 
-    @property
-    def bots(self) -> Sequence[SaasBot]:
-        ...
+SaasPipelinesProviders = SaasPipelinesProviderTekton | SaasPipelinesProvider
 
 
-SaasPipelinesProviders = Union[SaasPipelinesProviderTekton, SaasPipelinesProvider]
+@runtime_checkable
+class ManagedResourceName(Protocol):
+    resource: str
+    resource_names: list[str]
 
 
 class SaasFile(HasParameters, HasSecretParameters, Protocol):
     path: str
     name: str
+    labels: dict[str, Any] | None
     managed_resource_types: list[str]
-    takeover: Optional[bool]
-    deprecated: Optional[bool]
-    compare: Optional[bool]
-    timeout: Optional[str]
-    publish_job_logs: Optional[bool]
-    cluster_admin: Optional[bool]
+    takeover: bool | None
+    deprecated: bool | None
+    compare: bool | None
+    timeout: str | None
+    publish_job_logs: bool | None
+    cluster_admin: bool | None
     image_patterns: list[str]
-    allowed_secret_parameter_paths: Optional[list[str]]
-    use_channel_in_image_tag: Optional[bool]
+    allowed_secret_parameter_paths: list[str] | None
+    use_channel_in_image_tag: bool | None
+    validate_targets_in_app: bool | None
+
+    @property
+    def app(self) -> SaasApp: ...
 
     @property
-    def app(self) -> SaasApp:
-        ...
+    def pipelines_provider(self) -> SaasPipelinesProviders: ...
 
     @property
-    def pipelines_provider(self) -> SaasPipelinesProviders:
-        ...
+    def deploy_resources(self) -> SaasDeployResources | None: ...
 
     @property
-    def deploy_resources(self) -> Optional[SaasDeployResources]:
-        ...
+    def slack(self) -> SaasSlackOutput | None: ...
 
     @property
-    def slack(self) -> Optional[SaasSlackOutput]:
-        ...
+    def authentication(self) -> SaasFileAuthentication | None: ...
 
     @property
-    def authentication(self) -> Optional[SaasFileAuthentication]:
-        ...
+    def resource_templates(self) -> Sequence[SaasResourceTemplate]: ...
 
     @property
-    def resource_templates(self) -> Sequence[SaasResourceTemplate]:
-        ...
+    def self_service_roles(self) -> Sequence[SaasRole] | None: ...
 
     @property
-    def self_service_roles(self) -> Optional[Sequence[SaasRole]]:
-        ...
+    def managed_resource_names(self) -> Sequence[ManagedResourceName] | None: ...