qontract-reconcile 0.9.1rc162__py3-none-any.whl → 0.9.1rc164__py3-none-any.whl

reconcile/test/test_saasherder_allowed_secret_paths.py

@@ -1,10 +1,6 @@
-from collections.abc import Callable
-
 import pytest
 
-from reconcile.gql_definitions.common.saas_files import SaasFileV2
 from reconcile.utils.saasherder import SaasHerder
-from reconcile.utils.secret_reader import SecretReader
 
 
 @pytest.mark.parametrize(
@@ -24,103 +20,56 @@ def test_saasherder_allowed_secret_paths(
     allowed_secret_parameter_path: str,
     referenced_secret_path: str,
     expected_valid: bool,
-    secret_reader: SecretReader,
-    gql_class_factory: Callable[
-        ...,
-        SaasFileV2,
-    ],
 ):
     """
     ensure a parent directory in allowed_secret_parameter_paths matches correctly
     """
     saas_files = [
-        gql_class_factory(
-            SaasFileV2,
-            {
-                "path": "path1",
-                "name": "a1",
-                "managedResourceTypes": [],
-                "allowedSecretParameterPaths": [allowed_secret_parameter_path],
-                "app": {"name": "app1"},
-                "pipelinesProvider": {
-                    "name": "tekton-app-sre-pipelines-appsres03ue1",
-                    "provider": "tekton",
-                    "namespace": {
-                        "name": "app-sre-pipelines",
-                        "cluster": {
-                            "name": "appsres03ue1",
-                            "serverUrl": "https://api.appsres03ue1.5nvu.p1.openshiftapps.com:6443",
-                            "consoleUrl": "https://console.appsres03ue1.5nvu.p1.openshiftapps.com:6443",
-                            "internal": True,
-                        },
-                    },
-                    "defaults": {
-                        "pipelineTemplates": {
-                            "openshiftSaasDeploy": {"name": "openshift-saas-deploy"}
-                        }
-                    },
-                    "pipelineTemplates": {
-                        "openshiftSaasDeploy": {"name": "openshift-saas-deploy"}
-                    },
-                },
-                "imagePatterns": [],
-                "resourceTemplates": [
-                    {
-                        "path": "path1",
-                        "name": "test",
-                        "url": "url",
-                        "targets": [
-                            {
-                                "namespace": {
-                                    "name": "test-ns-subscriber",
-                                    "environment": {
-                                        "name": "App-SRE",
-                                        "parameters": "{}",
-                                    },
-                                    "app": {"name": "test-saas-deployments"},
-                                    "cluster": {
-                                        "name": "appsres03ue1",
-                                        "serverUrl": "https://api.appsres03ue1.5nvu.p1.openshiftapps.com:6443",
-                                        "internal": True,
-                                    },
-                                },
-                                "ref": "main",
-                                "upstream": {
-                                    "instance": {
-                                        "name": "ci",
-                                        "serverUrl": "https://jenkins.com",
+        {
+            "path": "path1",
+            "name": "a1",
+            "managedResourceTypes": [],
+            "allowedSecretParameterPaths": [allowed_secret_parameter_path],
+            "resourceTemplates": [
+                {
+                    "name": "test",
+                    "url": "url",
+                    "targets": [
+                        {
+                            "namespace": {
+                                "name": "ns",
+                                "environment": {"name": "env1", "parameters": "{}"},
+                                "cluster": {"name": "cluster"},
+                            },
+                            "ref": "main",
+                            "upstream": {"instance": {"name": "ci"}, "name": "job"},
+                            "parameters": {},
+                            "secretParameters": [
+                                {
+                                    "name": "secret",
+                                    "secret": {
+                                        "path": referenced_secret_path,
+                                        "field": "db.endpoint",
                                     },
-                                    "name": "job",
                                 },
-                                "parameters": "{}",
-                                "secretParameters": [
-                                    {
-                                        "name": "secret",
-                                        "secret": {
-                                            "path": referenced_secret_path,
-                                            "field": "db.endpoint",
-                                        },
-                                    },
-                                ],
-                            },
-                        ],
-                    },
-                ],
-                "selfServiceRoles": [
-                    {"users": [{"org_username": "theirname"}], "bots": []}
-                ],
-            },
-        )
+                            ],
+                        },
+                    ],
+                },
+            ],
+            "selfServiceRoles": [
+                {"users": [{"org_username": "theirname"}], "bots": []}
+            ],
+        },
     ]
 
     saasherder = SaasHerder(
         saas_files,
-        secret_reader=secret_reader,
         thread_pool_size=1,
+        gitlab=None,
         integration="",
         integration_version="",
-        hash_length=7,
-        repo_url="https://repo-url.com",
+        settings={},
         validate=True,
     )
 

reconcile/utils/mr/auto_promoter.py

@@ -2,29 +2,24 @@ import hashlib
 import json
 import logging
 from collections.abc import (
-    Iterable,
+    Mapping,
     MutableMapping,
 )
 from dataclasses import (
     asdict,
     dataclass,
 )
-from typing import (
-    Any,
-    Sequence,
-    Union,
-)
+from typing import Any
 
 from ruamel import yaml
 
-from reconcile.utils.gitlab_api import GitLabApi
 from reconcile.utils.mr.base import MergeRequestBase
 from reconcile.utils.mr.labels import AUTO_MERGE
-from reconcile.utils.saasherder.interfaces import SaasPromotion
-from reconcile.utils.saasherder.models import Promotion
 
 LOG = logging.getLogger(__name__)
 
+TARGET_CONFIG_HASH = "target_config_hash"
+
 
 @dataclass
 class ParentSaasConfigPromotion:
@@ -37,21 +32,10 @@ class ParentSaasConfigPromotion:
 class AutoPromoter(MergeRequestBase):
     name = "auto_promoter"
 
-    def __init__(
-        self, promotions: Union[Sequence[SaasPromotion], Sequence[dict[str, Any]]]
-    ):
-        # !!! Attention !!!
-        # AutoPromoter is also initialized with promitions as dict by 'gitlab_mr_sqs_consumer'
-        # loaded from SQS message body, therefore self.promotions must be json serializable
-        self.promotions = [
-            p.dict(by_alias=True) if isinstance(p, SaasPromotion) else p
-            for p in promotions
-        ]
-
-        # the parent class stores self.promotions (the json serializable one) in self.sqs_msg_data
+    def __init__(self, promotions):
+        self.promotions = [p for p in promotions if p]
         super().__init__()
-        # create an internal list with Promotion objects out of self.promotions
-        self._promotions = [Promotion(**p) for p in self.promotions]
+
         self.labels = [AUTO_MERGE]
 
     @property
@@ -71,19 +55,18 @@ class AutoPromoter(MergeRequestBase):
         return "openshift-saas-deploy automated promotion"
 
     @staticmethod
-    def init_promotion_data(channel: str, promotion: SaasPromotion) -> dict[str, Any]:
+    def init_promotion_data(
+        channel: str, promotion: Mapping[str, Any]
+    ) -> dict[str, Any]:
         psc = ParentSaasConfigPromotion(
-            parent_saas=promotion.saas_file_name,
-            target_config_hash=promotion.target_config_hash,
+            parent_saas=promotion["saas_file"],
+            target_config_hash=promotion[TARGET_CONFIG_HASH],
         )
         return {"channel": channel, "data": [asdict(psc)]}
 
     @staticmethod
-    def process_promotion(
-        promotion: SaasPromotion,
-        target_promotion: MutableMapping[str, Any],
-        target_channels: Iterable[str],
-    ) -> bool:
+    def process_promotion(promotion, target_promotion, target_channels):
+
         # Existent subscribe data channel data
         promotion_data = {
             v["channel"]: v["data"]
@@ -106,17 +89,20 @@ class AutoPromoter(MergeRequestBase):
                     if item["type"] == ParentSaasConfigPromotion.TYPE:
                         target_psc = ParentSaasConfigPromotion(**item)
                         promotion_psc = ParentSaasConfigPromotion(
-                            parent_saas=promotion.saas_file_name,
-                            target_config_hash=promotion.target_config_hash,
+                            parent_saas=promotion["saas_file"],
+                            target_config_hash=promotion[TARGET_CONFIG_HASH],
                         )
                         if target_psc != promotion_psc:
                             channel_data[i] = asdict(promotion_psc)
                             modified = True
 
-        return modified
+            return modified
 
     def process_target(
-        self, target: MutableMapping[str, Any], promotion: SaasPromotion
+        self,
+        target: MutableMapping[str, Any],
+        promotion_item: Mapping[str, Any],
+        commit_sha: str,
     ) -> bool:
         target_updated = False
         target_promotion = target.get("promotion")
@@ -128,31 +114,37 @@ class AutoPromoter(MergeRequestBase):
         subscribe = target_promotion.get("subscribe")
         if not subscribe:
             return target_updated
-        if not promotion.publish:
-            return target_updated
 
-        channels = [c for c in subscribe if c in promotion.publish]
-        if channels:
+        channels = [c for c in subscribe if c in promotion_item["publish"]]
+        if len(channels) > 0:
             # Update REF on target if differs.
-            if target["ref"] != promotion.commit_sha:
-                target["ref"] = promotion.commit_sha
+            if target["ref"] != commit_sha:
+                target["ref"] = commit_sha
                 target_updated = True
 
             # Update Promotion data
-            modified = self.process_promotion(promotion, target_promotion, channels)
+            modified = self.process_promotion(
+                promotion_item, target_promotion, channels
+            )
 
             if modified:
                 target_updated = True
 
         return target_updated
 
-    def process(self, gitlab_cli: GitLabApi) -> None:
-        for promotion in self._promotions:
-            if not promotion.publish:
+    def process(self, gitlab_cli):
+        for item in self.promotions:
+            saas_file_paths = item.get("saas_file_paths") or []
+            target_paths = item.get("target_paths") or []
+            if not (saas_file_paths or target_paths):
+                continue
+            publish = item.get("publish")
+            if not publish:
                 continue
-            if not promotion.commit_sha:
+            commit_sha = item.get("commit_sha")
+            if not commit_sha:
                 continue
-            for saas_file_path in promotion.saas_file_paths or []:
+            for saas_file_path in saas_file_paths:
                 saas_file_updated = False
                 try:
                     # This will only work with gitlab cli, not with SQS
@@ -168,13 +160,13 @@ class AutoPromoter(MergeRequestBase):
 
                 for rt in content["resourceTemplates"]:
                     for target in rt["targets"]:
-                        if self.process_target(target, promotion):
+                        if self.process_target(target, item, commit_sha):
                             saas_file_updated = True
 
                 if saas_file_updated:
                     new_content = "---\n"
-                    new_content += yaml.dump(content, Dumper=yaml.RoundTripDumper) or ""
-                    msg = f"auto promote {promotion.commit_sha} in {saas_file_path}"
+                    new_content += yaml.dump(content, Dumper=yaml.RoundTripDumper)
+                    msg = f"auto promote {commit_sha} in {saas_file_path}"
                     gitlab_cli.update_file(
                         branch_name=self.branch,
                         file_path=saas_file_path,
@@ -183,12 +175,12 @@ class AutoPromoter(MergeRequestBase):
                     )
                 else:
                     LOG.info(
-                        f"commit sha {promotion.commit_sha} has already been "
+                        f"commit sha {commit_sha} has already been "
                         f"promoted to all targets in {content['name']} "
-                        f"subscribing to {','.join(promotion.publish)}"
+                        f"subscribing to {','.join(item['publish'])}"
                     )
 
-            for target_path in promotion.target_paths or []:
+            for target_path in target_paths:
                 try:
                     # This will only work with gitlab cli, not with SQS
                     # this method is only triggered by gitlab_sqs_consumer
@@ -200,10 +192,10 @@ class AutoPromoter(MergeRequestBase):
                     logging.error(e)
 
                 content = yaml.load(raw_file.decode(), Loader=yaml.RoundTripLoader)
-                if self.process_target(content, promotion):
+                if self.process_target(content, item, commit_sha):
                     new_content = "---\n"
-                    new_content += yaml.dump(content, Dumper=yaml.RoundTripDumper)  # type: ignore
-                    msg = f"auto promote {promotion.commit_sha} in {target_path}"
+                    new_content += yaml.dump(content, Dumper=yaml.RoundTripDumper)
+                    msg = f"auto promote {commit_sha} in {target_path}"
                     gitlab_cli.update_file(
                         branch_name=self.branch,
                         file_path=target_path,
@@ -212,7 +204,7 @@ class AutoPromoter(MergeRequestBase):
                     )
                 else:
                     LOG.info(
-                        f"commit sha {promotion.commit_sha} has already been "
+                        f"commit sha {commit_sha} has already been "
                         f"promoted to all targets in {content['name']} "
-                        f"subscribing to {','.join(promotion.publish)}"
+                        f"subscribing to {','.join(item['publish'])}"
                     )

reconcile/utils/mr/base.py

@@ -4,7 +4,6 @@ from abc import (
     ABCMeta,
     abstractmethod,
 )
-from typing import Union
 from uuid import uuid4
 
 from gitlab.exceptions import GitlabError
@@ -28,9 +27,6 @@ class MergeRequestProcessingError(Exception):
     """
 
 
-MRClient = Union[GitLabApi, SQSGateway]
-
-
 class MergeRequestBase(metaclass=ABCMeta):
     """
     Base abstract class for all merge request types.
@@ -106,7 +102,7 @@ class MergeRequestBase(metaclass=ABCMeta):
             **self.sqs_msg_data,
         }
 
-    def submit_to_sqs(self, sqs_cli) -> None:
+    def submit_to_sqs(self, sqs_cli):
         """
         Sends the MR message to SQS.
 
@@ -204,7 +200,7 @@ class MergeRequestBase(metaclass=ABCMeta):
             from_=self.main_branch, to=self.branch
         )["diffs"]
 
-    def submit(self, cli: MRClient):
+    def submit(self, cli):
         if isinstance(cli, GitLabApi):
             return self.submit_to_gitlab(gitlab_cli=cli)