qontract-reconcile 0.10.1rc885__py3-none-any.whl → 0.10.1rc887__py3-none-any.whl

{qontract_reconcile-0.10.1rc885.dist-info → qontract_reconcile-0.10.1rc887.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qontract-reconcile
-Version: 0.10.1rc885
+Version: 0.10.1rc887
 Summary: Collection of tools to reconcile services with their desired state as defined in the app-interface DB.
 Home-page: https://github.com/app-sre/qontract-reconcile
 Author: Red Hat App-SRE Team

{qontract_reconcile-0.10.1rc885.dist-info → qontract_reconcile-0.10.1rc887.dist-info}/RECORD

@@ -428,7 +428,7 @@ reconcile/saas_auto_promotions_manager/integration.py,sha256=haXTpwi0rEQtN9-MadB
 reconcile/saas_auto_promotions_manager/meta.py,sha256=76Jp50r6Y_KyJoXFfSjrt5YrCtXyg_A4FXXxHYiS3TE,161
 reconcile/saas_auto_promotions_manager/publisher.py,sha256=IZGu-PMffyk3fNL8QcZ2VBmYTZ5zigoCwNJ4_Ak6-C8,2966
 reconcile/saas_auto_promotions_manager/s3_exporter.py,sha256=IKlVWZmiPnvl7sKeF6JgAlhXZe5CovKTxQc0SNkNSx4,2583
-reconcile/saas_auto_promotions_manager/subscriber.py,sha256=YPzlv8jptvvWgMIoXn4Jtk7-LST8grrVyi0-qTpqWQQ,8474
+reconcile/saas_auto_promotions_manager/subscriber.py,sha256=A-d_qIUo5jbseEaAN3YlVU46MQAVCw28j5HvORgaGtw,9149
 reconcile/saas_auto_promotions_manager/merge_request_manager/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/saas_auto_promotions_manager/merge_request_manager/batcher.py,sha256=CP392gq0yntzEkqpMJl2j-N4CGfFDFbBfK77J7Oo5Pg,7817
 reconcile/saas_auto_promotions_manager/merge_request_manager/desired_state.py,sha256=isY8frVsL3PlcdZmdZ4O0qyp76oczl4DUMX9uMArs5Y,1222
@@ -439,7 +439,7 @@ reconcile/saas_auto_promotions_manager/merge_request_manager/mr_parser.py,sha256
 reconcile/saas_auto_promotions_manager/merge_request_manager/open_merge_requests.py,sha256=-qGQOh6Jdp4lomNDij3zWVC0pl6uPHFWS5Woqcp5HQk,410
 reconcile/saas_auto_promotions_manager/merge_request_manager/renderer.py,sha256=IZ7cuH6uOi7f0aIPVi1irBmP0CIK5vmEuhKBJz4YA1s,7235
 reconcile/saas_auto_promotions_manager/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reconcile/saas_auto_promotions_manager/utils/saas_files_inventory.py,sha256=ZZ7JL6VPfKasq-XXi6CL2UZ89jOcC9uwLW1e8LMvgws,8187
+reconcile/saas_auto_promotions_manager/utils/saas_files_inventory.py,sha256=rGvBWGcpryM-W3nasBET-PHAXY2ZZL9ihcTe70qoQEA,8660
 reconcile/skupper_network/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/skupper_network/integration.py,sha256=GEFlQTjK4DYXnvrQtsvFdZlYsbiFabM7IdBX69ZXWcY,10757
 reconcile/skupper_network/models.py,sha256=HEwlVKsbmMaKaaBGvITIiSYNEVdjwXVhLaOJgLSZ2xQ,6604
@@ -560,7 +560,7 @@ reconcile/test/test_version_bump.py,sha256=q6-3Y1roriI6YWpFwaHOMN7emEP3yL33sh_0V
 reconcile/test/test_vpc_peerings_validator.py,sha256=dFSmjc_dMN2GqMbntCFpa7PUZmyYuQ9DKffh-T5wmxM,6639
 reconcile/test/test_wrong_region.py,sha256=7KzL7OaICQ9Z3DW27zt_ykMN7_87owAFC-2CYjvGoyA,2138
 reconcile/test/saas_auto_promotions_manager/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reconcile/test/saas_auto_promotions_manager/conftest.py,sha256=WqTFZAqCtWBCl8vdY1xGXpxLTMxXDAaZJ65UmaMSs1Y,5966
+reconcile/test/saas_auto_promotions_manager/conftest.py,sha256=tF6YMgeh9PHxlKsihL8qdLEgixk_k6mOGV1qS7ukHYI,6029
 reconcile/test/saas_auto_promotions_manager/test_integration_test.py,sha256=S30eXJSy2Vc3YLbCP7AfLkOiFGUVoKhEvEBL5vwnbfg,1848
 reconcile/test/saas_auto_promotions_manager/merge_request_manager/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/test/saas_auto_promotions_manager/merge_request_manager/merge_request_manager/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -810,7 +810,7 @@ tools/app_interface_metrics_exporter.py,sha256=zkwkxdAUAxjdc-pzx2_oJXG25fo0Fnyd5
 tools/app_interface_reporter.py,sha256=uy9eRHf6EdvD8ZY2WYdroGXm18DOdnqVZyxaWN3Bm_0,17724
 tools/glitchtip_access_reporter.py,sha256=oPBnk_YoDuljU3v0FaChzOwwnk4vap1xEE67QEjzdqs,2948
 tools/glitchtip_access_revalidation.py,sha256=8kbBJk04mkq28kWoRDDkfCGIF3GRg3pJrFAh1sW0dbk,2821
-tools/qontract_cli.py,sha256=xl_264MCbBAV-_YgZeBTVHnWPSagIzgbHNoQYEKWcFg,120361
+tools/qontract_cli.py,sha256=PYFiVIc37qFOl3UxXt04o-V50Leu37pAFndTRMu_WBs,121059
 tools/sd_app_sre_alert_report.py,sha256=e9vAdyenUz2f5c8-z-5WY0wv-SJ9aePKDH2r4IwB6pc,5063
 tools/template_validation.py,sha256=qpKYaTgk0GOPGa2Ct5_5sKdwIHtCAKIBGzsMPuJU5fw,3371
 tools/cli_commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -830,16 +830,19 @@ tools/saas_metrics_exporter/commit_distance/__init__.py,sha256=47DEQpj8HBSa-_TIm
 tools/saas_metrics_exporter/commit_distance/channel.py,sha256=XEAh3eL8TmgMe7V2BsyxuXYWgvBBVdSJETd6Ec7cI04,2171
 tools/saas_metrics_exporter/commit_distance/commit_distance.py,sha256=pUWaZfZf0TYOwAW0gDdU8cYgTR586J_8S_DWxqHMWNA,3116
 tools/saas_metrics_exporter/commit_distance/metrics.py,sha256=5-y6n-sGACAS3eJ5ndY-2BFxcd0fxLfhvZmmBHu4JuA,426
+tools/saas_promotion_state/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tools/saas_promotion_state/saas_promotion_state.py,sha256=_jP9E8-VcWho6FIOGdcjNN6uvMVhpdXOMHw59qNnEmE,2855
 tools/sre_checkpoints/__init__.py,sha256=CDaDaywJnmRCLyl_NCcvxi-Zc0hTi_3OdwKiFOyS39I,145
 tools/sre_checkpoints/util.py,sha256=zEDbGr18ZeHNQwW8pUsr2JRjuXIPz--WAGJxZo9sv_Y,894
 tools/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tools/test/conftest.py,sha256=YD8rdUD3XJAV_TvdzlhXkImaMQ3CU6m-8eYRkbc9qpg,993
+tools/test/conftest.py,sha256=YLtiauk_StNFE-lirLnfG_BpJmlB2NGMZISE9A4zwvk,2421
 tools/test/test_app_interface_metrics_exporter.py,sha256=SX7qL3D1SIRKFo95FoQztvftCWEEf-g1mfXOtgCog-g,1271
 tools/test/test_qontract_cli.py,sha256=_D61RFGAN5x44CY1tYbouhlGXXABwYfxKSWSQx3Jrss,4941
+tools/test/test_saas_promotion_state.py,sha256=48Qe5UA5WTI5NVgL7Nz0TSS77osetcijfHNCNdsHfSI,2726
 tools/test/test_sd_app_sre_alert_report.py,sha256=v363r9zM7__0kR5K6mvJoGFcM9BvE33fWAayrqkpojA,2116
 tools/test/test_sre_checkpoints.py,sha256=SKqPPTl9ua0RFdSSofnoQX-JZE6dFLO3LRhfQzqtfh8,2607
-qontract_reconcile-0.10.1rc885.dist-info/METADATA,sha256=nIpGToZHpAippnwf9bsAGA-Yr4rK5f_Cy_dpDPR8Ook,2273
-qontract_reconcile-0.10.1rc885.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-qontract_reconcile-0.10.1rc885.dist-info/entry_points.txt,sha256=GKQqCl2j2X1BJQ69een6rHcR26PmnxnONLNOQB-nRjY,491
-qontract_reconcile-0.10.1rc885.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
-qontract_reconcile-0.10.1rc885.dist-info/RECORD,,
+qontract_reconcile-0.10.1rc887.dist-info/METADATA,sha256=hsI7-7-pLKcnuPvfEEaiX0kI_9dg2RVn3ADXezJXa1Q,2273
+qontract_reconcile-0.10.1rc887.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+qontract_reconcile-0.10.1rc887.dist-info/entry_points.txt,sha256=GKQqCl2j2X1BJQ69een6rHcR26PmnxnONLNOQB-nRjY,491
+qontract_reconcile-0.10.1rc887.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
+qontract_reconcile-0.10.1rc887.dist-info/RECORD,,

reconcile/saas_auto_promotions_manager/subscriber.py

@@ -44,6 +44,7 @@ class Subscriber:
         use_target_config_hash: bool,
         uid: str,
         soak_days: int,
+        blocked_versions: set[str],
     ):
         self.saas_name = saas_name
         self.template_name = template_name
@@ -58,6 +59,7 @@ class Subscriber:
         self.soak_days = soak_days
         self._content_hash = ""
         self._use_target_config_hash = use_target_config_hash
+        self._blocked_versions = blocked_versions
 
     def has_diff(self) -> bool:
         current_hashes = {
@@ -141,22 +143,42 @@ class Subscriber:
                     break
                 publisher_refs.add(publisher.commit_sha)
 
-        if len(publisher_refs) > 1:
+        # By default we keep current state
+        self.desired_ref = self.ref
+
+        if any_bad_deployment:
+            logging.info(
+                "Subscriber at path %s promotion stopped because of bad publisher deployment",
+                self.target_file_path,
+            )
+            return
+
+        if len(publisher_refs) != 1:
             logging.info(
                 "Publishers for subscriber at path %s have mismatching refs: %s",
                 self.target_file_path,
                 publisher_refs,
             )
-        if (
-            len(publisher_refs) != 1
-            or any_bad_deployment
-            or not self._passed_accumulated_soak_days()
-        ):
-            # We keep current state
-            self.desired_ref = self.ref
-        else:
-            # We have a common single publisher ref w/o any deployment issues
-            self.desired_ref = next(iter(publisher_refs))
+            return
+
+        if not self._passed_accumulated_soak_days():
+            logging.debug(
+                "Subscriber at path %s promotion stopped because of soak days",
+                self.target_file_path,
+            )
+            return
+
+        desired_ref = next(iter(publisher_refs))
+        if desired_ref in self._blocked_versions:
+            logging.info(
+                "Subscriber at path %s promotion stopped because of blocked ref: %s",
+                self.target_file_path,
+                desired_ref,
+            )
+            return
+
+        # Passed all gates -> lets promote desired ref
+        self.desired_ref = desired_ref
 
     def _compute_desired_config_hashes(self) -> None:
         """

reconcile/saas_auto_promotions_manager/utils/saas_files_inventory.py

@@ -86,6 +86,10 @@ class SaasFilesInventory:
 
     def _assemble_subscribers_with_auto_promotions(self) -> None:
         for saas_file in self._saas_files:
+            blocked_versions: dict[str, set[str]] = {}
+            for code_component in saas_file.app.code_components or []:
+                for version in code_component.blocked_versions or []:
+                    blocked_versions.setdefault(code_component.url, set()).add(version)
             for resource_template in saas_file.resource_templates:
                 for target in resource_template.targets:
                     file_path = target.path if target.path else saas_file.path
@@ -98,6 +102,7 @@ class SaasFilesInventory:
                     soak_days = (
                         target.promotion.soak_days if target.promotion.soak_days else 0
                     )
+                    resource_template.url
                     subscriber = Subscriber(
                         uid=target.uid(
                             parent_saas_file_name=saas_file.name,
@@ -109,6 +114,9 @@ class SaasFilesInventory:
                         ref=target.ref,
                         target_namespace=target.namespace,
                         soak_days=soak_days,
+                        blocked_versions=blocked_versions.get(
+                            resource_template.url, set()
+                        ),
                         # Note: this will be refactored at a later point.
                         # https://issues.redhat.com/browse/APPSRE-7516
                         use_target_config_hash=bool(saas_file.publish_job_logs),

reconcile/test/saas_auto_promotions_manager/conftest.py

@@ -158,6 +158,7 @@ def subscriber_builder(
             template_name="",
             use_target_config_hash=data.get("USE_TARGET_CONFIG_HASH", True),
             soak_days=data.get("SOAK_DAYS", 0),
+            blocked_versions=data.get("BLOCKED_VERSIONS", {}),
         )
         subscriber.channels = channels
         subscriber.config_hashes_by_channel_name = cur_config_hashes_by_channel

tools/qontract_cli.py

@@ -3658,6 +3658,25 @@ def gpg_encrypt(
     ).execute()
 
 
+@root.command()
+@click.option("--channel", help="the channel that state is part of")
+@click.option("--sha", help="the commit sha we want state for")
+@environ(["APP_INTERFACE_STATE_BUCKET"])
+def get_promotion_state(channel: str, sha: str):
+    from tools.saas_promotion_state.saas_promotion_state import (
+        SaasPromotionState,
+    )
+
+    promotion_state = SaasPromotionState.create(promotion_state=None, saas_files=None)
+    for publisher_id, state in promotion_state.get(channel=channel, sha=sha).items():
+        print()
+        if not state:
+            print(f"No state found for {publisher_id=}")
+        else:
+            print(f"State for {publisher_id=}:")
+            print(state)
+
+
 @root.command()
 @click.option("--change-type-name")
 @click.option("--role-name")

tools/saas_promotion_state/saas_promotion_state.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from collections.abc import Iterable
+
+from reconcile.openshift_saas_deploy import (
+    QONTRACT_INTEGRATION as OPENSHIFT_SAAS_DEPLOY,
+)
+from reconcile.typed_queries.app_interface_vault_settings import (
+    get_app_interface_vault_settings,
+)
+from reconcile.typed_queries.saas_files import SaasFile, get_saas_files
+from reconcile.utils.promotion_state import PromotionData, PromotionState
+from reconcile.utils.secret_reader import create_secret_reader
+from reconcile.utils.state import init_state
+
+
+class SaasPromotionState:
+    def __init__(
+        self, promotion_state: PromotionState, saas_files: Iterable[SaasFile]
+    ) -> None:
+        self._promotion_state = promotion_state
+        self._saas_files = saas_files
+
+    def _publisher_ids_for_channel(
+        self, channel: str, saas_files: Iterable[SaasFile]
+    ) -> list[str]:
+        publisher_uids: list[str] = []
+        for saas_file in saas_files:
+            for resource_template in saas_file.resource_templates:
+                for target in resource_template.targets:
+                    if not target.promotion:
+                        continue
+                    for publish_channel in target.promotion.publish or []:
+                        if publish_channel == channel:
+                            publisher_uids.append(
+                                target.uid(
+                                    parent_saas_file_name=saas_file.name,
+                                    parent_resource_template_name=resource_template.name,
+                                )
+                            )
+        return publisher_uids
+
+    def get(self, channel: str, sha: str) -> dict[str, PromotionData | None]:
+        return {
+            publisher_id: self._promotion_state.get_promotion_data(
+                sha=sha,
+                channel=channel,
+                use_cache=False,
+                target_uid=publisher_id,
+                pre_check_sha_exists=False,
+            )
+            for publisher_id in self._publisher_ids_for_channel(
+                channel=channel, saas_files=self._saas_files
+            )
+        }
+
+    @staticmethod
+    def create(
+        promotion_state: PromotionState | None, saas_files: Iterable[SaasFile] | None
+    ) -> SaasPromotionState:
+        if not promotion_state:
+            vault_settings = get_app_interface_vault_settings()
+            secret_reader = create_secret_reader(use_vault=vault_settings.vault)
+            saas_deploy_state = init_state(
+                integration=OPENSHIFT_SAAS_DEPLOY, secret_reader=secret_reader
+            )
+            promotion_state = PromotionState(state=saas_deploy_state)
+        if not saas_files:
+            saas_files = get_saas_files()
+        return SaasPromotionState(
+            promotion_state=promotion_state, saas_files=saas_files
+        )

tools/test/conftest.py

@@ -1,13 +1,17 @@
 from collections.abc import (
     Callable,
+    Iterable,
+    Mapping,
     MutableMapping,
 )
+from pathlib import Path
 from typing import Any
 
 import pytest
 from pydantic import BaseModel
 from pydantic.error_wrappers import ValidationError
 
+from reconcile.typed_queries.saas_files import SaasFile
 from reconcile.utils.models import data_default_none
 
 
@@ -15,6 +19,44 @@ class GQLClassFactoryError(Exception):
     pass
 
 
+@pytest.fixture
+def saas_files_builder(
+    gql_class_factory: Callable[[type[SaasFile], Mapping], SaasFile],
+) -> Callable[[Iterable[MutableMapping]], list[SaasFile]]:
+    def builder(data: Iterable[MutableMapping]) -> list[SaasFile]:
+        for d in data:
+            if "app" not in d:
+                d["app"] = {}
+            if "pipelinesProvider" not in d:
+                d["pipelinesProvider"] = {}
+            if "managedResourceTypes" not in d:
+                d["managedResourceTypes"] = []
+            if "imagePatterns" not in d:
+                d["imagePatterns"] = []
+            for rt in d.get("resourceTemplates", []):
+                for t in rt.get("targets", []):
+                    ns = t["namespace"]
+                    if "name" not in ns:
+                        ns["name"] = "some_name"
+                    if "environment" not in ns:
+                        ns["environment"] = {}
+                    if "app" not in ns:
+                        ns["app"] = {}
+                    if "cluster" not in ns:
+                        ns["cluster"] = {}
+        return [gql_class_factory(SaasFile, d) for d in data]
+
+    return builder
+
+
+@pytest.fixture
+def fx() -> Callable:
+    def _fx(name: str) -> str:
+        return (Path(__file__).parent / "fixtures" / name).read_text()
+
+    return _fx
+
+
 @pytest.fixture
 def gql_class_factory() -> (
     Callable[

tools/test/test_saas_promotion_state.py

@@ -0,0 +1,86 @@
+from collections.abc import (
+    Callable,
+    Iterable,
+    Mapping,
+)
+from unittest.mock import (
+    create_autospec,
+)
+
+from reconcile.typed_queries.saas_files import SaasFile
+from reconcile.utils.promotion_state import PromotionData, PromotionState
+from tools.saas_promotion_state.saas_promotion_state import (
+    SaasPromotionState,
+)
+
+
+def test_saas_promotion_state(
+    saas_files_builder: Callable[[Iterable[Mapping]], list[SaasFile]],
+) -> None:
+    saas_files = saas_files_builder([
+        {
+            "path": "/saas1.yml",
+            "name": "saas_1",
+            "resourceTemplates": [
+                {
+                    "name": "template_1",
+                    "url": "repo1/url",
+                    "targets": [
+                        {
+                            "ref": "main",
+                            "namespace": {"path": "/namespace1.yml"},
+                            "promotion": {
+                                "publish": ["channel-a"],
+                            },
+                        }
+                    ],
+                }
+            ],
+        },
+        {
+            "path": "/saas2.yml",
+            "name": "saas_2",
+            "resourceTemplates": [
+                {
+                    "name": "template_2",
+                    "url": "repo2/url",
+                    "targets": [
+                        {
+                            "ref": "main",
+                            "namespace": {"path": "/namespace2.yml"},
+                            "promotion": {
+                                "publish": ["channel-b"],
+                                "subscribe": ["channel-a"],
+                            },
+                        },
+                        {
+                            "ref": "main",
+                            "namespace": {"path": "/namespace3.yml"},
+                        },
+                    ],
+                }
+            ],
+        },
+    ])
+
+    expected = PromotionData(
+        check_in="test1",
+        saas_file="test2",
+        success=True,
+        target_config_hash="test3",
+    )
+    promotion_state = create_autospec(spec=PromotionState)
+    promotion_state.get_promotion_data.return_value = expected
+    saas_promotion_state = SaasPromotionState.create(
+        promotion_state=promotion_state, saas_files=saas_files
+    )
+    result = saas_promotion_state.get(channel="channel-a", sha="main")
+
+    assert result == {"616af45d7fad7f4eea8d52b8b5e8a058cef82ab0": expected}
+    promotion_state.get_promotion_data.assert_called_once_with(
+        sha="main",
+        channel="channel-a",
+        use_cache=False,
+        target_uid="616af45d7fad7f4eea8d52b8b5e8a058cef82ab0",
+        pre_check_sha_exists=False,
+    )