qontract-reconcile 0.10.1rc440__py3-none-any.whl → 0.10.1rc442__py3-none-any.whl

{qontract_reconcile-0.10.1rc440.dist-info → qontract_reconcile-0.10.1rc442.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qontract-reconcile
-Version: 0.10.1rc440
+Version: 0.10.1rc442
 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.1rc440.dist-info → qontract_reconcile-0.10.1rc442.dist-info}/RECORD

@@ -71,7 +71,7 @@ reconcile/openshift_resources.py,sha256=kwsY5cko7udEKNlhL2oKiKv_5wzEw9wmmwROE016
 reconcile/openshift_resources_base.py,sha256=iKS8mpKnJca6MO5dl1a1az2YdEa_6zDRNf_XS_i9FBA,44936
 reconcile/openshift_rolebindings.py,sha256=K6alhxtnxifnytQKMqIGdVkqGEa28AVwFv4B7SjbgIk,6628
 reconcile/openshift_routes.py,sha256=fXvuPSjcjVw1X3j2EQvUAdbOepmIFdKk-M3qP8QzPiw,1075
-reconcile/openshift_saas_deploy.py,sha256=QpQAQTeDZPOtgxV9RoAyu2NeX4Jlc4xAslVdgwD0sgQ,10811
+reconcile/openshift_saas_deploy.py,sha256=JkMv21u6JImrNSnKgfseXbg7GrIk9v2zmW1p7WfF9-w,11889
 reconcile/openshift_saas_deploy_change_tester.py,sha256=spWjxapC-u4TrCAsz1Q6_297QwfrIRx19oqz2bRPQn0,8907
 reconcile/openshift_saas_deploy_trigger_base.py,sha256=UEKWAJo6cN3Nml89tzJzbnpkJ7efOnFDf9Wfz9_tBdg,14325
 reconcile/openshift_saas_deploy_trigger_cleaner.py,sha256=tcvziJdw5lgJbbogk0-wKT2aYCFP99sL4qTSfau4otY,2971
@@ -131,7 +131,7 @@ reconcile/aws_ami_cleanup/integration.py,sha256=IW95cpMj2P5ffs-AxsR_TDQCJnYFBhLI
 reconcile/aws_cloudwatch_log_retention/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/aws_cloudwatch_log_retention/integration.py,sha256=0UcSZIrGvnGY4m9fj87oejIolIP_qTxtJInpmW9jrQ0,7772
 reconcile/aws_version_sync/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reconcile/aws_version_sync/integration.py,sha256=sddkW_XcHF8KMeqE23Mxl3yLrpUkqzv_ArP-EVXcwIU,11432
+reconcile/aws_version_sync/integration.py,sha256=fCDtfI3Lpz1l5l6AwC9tTnoiMeY7yvFLR6l7twixFlE,12248
 reconcile/aws_version_sync/utils.py,sha256=sVv-48PKi2VITlqqvmpbjnFDOPeGqfKzgkpIszlmjL0,1708
 reconcile/aws_version_sync/merge_request_manager/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/aws_version_sync/merge_request_manager/merge_request.py,sha256=FeNcQaory5AXNVuVk-jJxPwtI4uSoURgkTH3rXAb2cc,6198
@@ -202,7 +202,7 @@ reconcile/gql_definitions/common/ocm_environments.py,sha256=yV4UVjdnNmqbR5trQCOA
 reconcile/gql_definitions/common/pagerduty_instances.py,sha256=8NBHKRXg_OKG9NsJv6FOj8UVFcjkdJg-9E16ZqZIRPQ,2006
 reconcile/gql_definitions/common/pgp_reencryption_settings.py,sha256=tS68-tBBd7BJYmfTjtdTlxpABF3f_z9eJdtaKnyZc0Q,2305
 reconcile/gql_definitions/common/pipeline_providers.py,sha256=5N61ONUkwpytVsrl9icmNfa4M6yR1WXeTQAqvFE7c6c,9421
-reconcile/gql_definitions/common/saas_files.py,sha256=tw5iT4xqtM7kRaxYnbaB7bBem8uAr3AiRLEXQ8GAaZw,16089
+reconcile/gql_definitions/common/saas_files.py,sha256=tGLkM7ss_V8fCzEGXaDCm3HgKmuL7_xOxUDwllRukWE,16254
 reconcile/gql_definitions/common/saas_target_namespaces.py,sha256=ENKqwgZ_jvvmtrN0tWRnUt3k5qgdJBLsPnQPeaZATbs,2768
 reconcile/gql_definitions/common/saasherder_settings.py,sha256=jxrFr03NmiwV3uegKCxQgB5iveC2IaGZIoguXoiNMgs,1797
 reconcile/gql_definitions/common/smtp_client_settings.py,sha256=Pb8VgTGFqCh4_rI0BOHoXuicfdNyol1kIN8NLONHaxI,2252
@@ -400,7 +400,7 @@ reconcile/test/test_openshift_namespace_labels.py,sha256=P1hqi6P88NijNrurdXG_QR2
 reconcile/test/test_openshift_namespaces.py,sha256=HmRnCE5EnFt3MYceVEFHmk8wWRtCrxu2AFGFkY9pdyA,9214
 reconcile/test/test_openshift_resource.py,sha256=FwU5xzrGyc1FHOL-HA3EH09iktCsdPaGv8HyKNwKit4,13037
 reconcile/test/test_openshift_resources_base.py,sha256=i4tk9knD5F1DppSsjBJ5pfrLSm1aP7lt--OSx3gmO9M,14058
-reconcile/test/test_openshift_saas_deploy.py,sha256=OoS8MNnkNQ6ZBkIgSdfEP3KSiiZeb92HAwXsQ2XnhwM,2713
+reconcile/test/test_openshift_saas_deploy.py,sha256=nbscib0QtIRpuRdgwFdiMpsW5k-ZjkENn40fKCbZg3Q,5891
 reconcile/test/test_openshift_saas_deploy_change_tester.py,sha256=5naL8Z1vq18CrlZHS_bfuxesUatKc4DXgsVvqBwqvmA,13201
 reconcile/test/test_openshift_tekton_resources.py,sha256=xkVgV_TGSHTaeTPgbdknWxmYVv8D3xCcXyK7CiMrXW8,11256
 reconcile/test/test_openshift_upgrade_watcher.py,sha256=na5Q5l88c0ZHMh82gvNpYheoMOAzEZRG0ZvzzDhafYE,7100
@@ -483,7 +483,7 @@ reconcile/typed_queries/namespaces.py,sha256=vItPrn7sfcHOix-VvkzQkf54_ljzI_ymyxh
 reconcile/typed_queries/namespaces_minimal.py,sha256=rUtqNQ0ORXXUTQfnpsMURymAJ4gYtE77V-Lb3LiJFEY,278
 reconcile/typed_queries/pagerduty_instances.py,sha256=QCHqEAakiH6eSob0Pnnn3IBd8Ga0zpEp1Z6Qu3v2uH4,733
 reconcile/typed_queries/repos.py,sha256=RKBsf7IDS6NsXTtXxJ9Ol9G3bxG9sr3vW9QQ2bahEHo,512
-reconcile/typed_queries/saas_files.py,sha256=BuDZf83hv6ItJMqBEWBOF14XNyeEwr4qMkEWsA1fTK8,13990
+reconcile/typed_queries/saas_files.py,sha256=tDZFCrTCaSUwB3aCS7AAQkbf1ueZ6koxiaMo-rChFDk,14117
 reconcile/typed_queries/slo_documents.py,sha256=x2dg0cnMET-ImARzhDg7Q81MA9Zlm9alH8Rp5XkVR6s,407
 reconcile/typed_queries/smtp.py,sha256=aSLglYa5bHKmlGwKkxq2RZqyMWuAf0a4S_mOuhDa084,542
 reconcile/typed_queries/status_board.py,sha256=-W_YwyASGCHo5Vs5eqych7sbdoKHznl57Dh4Vp_oOvI,1843
@@ -554,7 +554,7 @@ reconcile/utils/quay_api.py,sha256=EuOegpb-7ntEjkKLFwM2Oo4Nw7SyFtmyl3sQ9aXMtrM,8
 reconcile/utils/raw_github_api.py,sha256=ZHC-SZuAyRe1zaMoOU7Krt1-zecDxENd9c_NzQYqK9g,2968
 reconcile/utils/repo_owners.py,sha256=j-pUjc9PuDzq7KpjNLpnhqfU8tUG4nj2WMhFp4ick7g,6629
 reconcile/utils/secret_reader.py,sha256=2DeYAAQFjUULEKlLw3UDAUoND6gbqvCh9uKPtlc-0us,10403
-reconcile/utils/semver_helper.py,sha256=4Rrkz9Cj9A6oHPVgA-nGj6MBoxlFT4eyxTcslWqow3I,771
+reconcile/utils/semver_helper.py,sha256=dp86KxjlOc8LHzawMvbxRfZamv7KU7b2SVnZQL-Xg6U,1142
 reconcile/utils/sharding.py,sha256=gkYf0lD3IUKQPEmdRJZ70mdDT1c9qWjbdP7evRsUis4,839
 reconcile/utils/slack_api.py,sha256=fntPGTn4hHRiScEIZu9LDPwbKeNPe9bR2Rmef9c-GIM,15830
 reconcile/utils/smtp_client.py,sha256=gJNbBQJpAt5PX4t_TaeNHsXM8vt50bFgndml6yK2b5o,2800
@@ -646,8 +646,8 @@ tools/test/test_app_interface_metrics_exporter.py,sha256=dmEcNwZltP1rd_4DbxIYakO
 tools/test/test_qontract_cli.py,sha256=awwTHEc2DWlykuqGIYM0WOBoSL0KRnOraCLk3C7izis,1401
 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.1rc440.dist-info/METADATA,sha256=-uhvfCTgCWPyQyEqyH_cfVF32cjGY01lu5z6kSS0FOM,2348
-qontract_reconcile-0.10.1rc440.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-qontract_reconcile-0.10.1rc440.dist-info/entry_points.txt,sha256=rTjAv28I_CHLM8ID3OPqMI_suoQ9s7tFbim4aYjn9kk,376
-qontract_reconcile-0.10.1rc440.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
-qontract_reconcile-0.10.1rc440.dist-info/RECORD,,
+qontract_reconcile-0.10.1rc442.dist-info/METADATA,sha256=y-3WObgzBJvlIUo2w7yrbG2GOPcQ6FiJ7nLAJ7-dRPQ,2348
+qontract_reconcile-0.10.1rc442.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+qontract_reconcile-0.10.1rc442.dist-info/entry_points.txt,sha256=rTjAv28I_CHLM8ID3OPqMI_suoQ9s7tFbim4aYjn9kk,376
+qontract_reconcile-0.10.1rc442.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
+qontract_reconcile-0.10.1rc442.dist-info/RECORD,,

reconcile/aws_version_sync/integration.py

@@ -5,7 +5,11 @@ from collections.abc import (
 )
 from typing import Any
 
-from pydantic import BaseModel
+import semver
+from pydantic import (
+    BaseModel,
+    validator,
+)
 
 from reconcile.aws_version_sync.merge_request_manager.merge_request import (
     Parser,
@@ -42,6 +46,7 @@ from reconcile.utils.runtime.integration import (
     PydanticRunParams,
     QontractReconcileIntegration,
 )
+from reconcile.utils.semver_helper import parse_semver
 from reconcile.utils.unleash import get_feature_toggle_state
 from reconcile.utils.vcs import VCS
 
@@ -67,7 +72,10 @@ class ExternalResource(BaseModel):
     resource_provider: str
     resource_identifier: str
     resource_engine: str
-    resource_engine_version: str
+    resource_engine_version: semver.VersionInfo
+
+    class Config:
+        arbitrary_types_allowed = True
 
     @property
     def key(self) -> tuple:
@@ -79,6 +87,14 @@ class ExternalResource(BaseModel):
             self.resource_engine,
         )
 
+    @validator("resource_engine_version", pre=True)
+    def parse_resource_engine_version(  # pylint: disable=no-self-argument
+        cls, v: str | semver.VersionInfo
+    ) -> semver.VersionInfo:
+        if isinstance(v, semver.VersionInfo):
+            return v
+        return parse_semver(v, optional_minor_and_patch=True)
+
 
 AwsExternalResources = list[ExternalResource]
 AppInterfaceExternalResources = list[ExternalResource]
@@ -228,12 +244,18 @@ class AVSIntegration(QontractReconcileIntegration[AVSIntegrationParams]):
             current=external_resources_app_interface,
             desired=external_resources_aws,
             key=lambda r: r.key,
-            equal=lambda r1, r2: r1.resource_engine_version
-            == r2.resource_engine_version,
+            equal=lambda external_resources_app_interface, external_resources_aws: external_resources_app_interface.resource_engine_version
+            == external_resources_aws.resource_engine_version,
         )
         for diff_pair in diff.change.values():
             aws_resource = diff_pair.desired
             app_interface_resource = diff_pair.current
+            if (
+                aws_resource.resource_engine_version
+                <= app_interface_resource.resource_engine_version
+            ):
+                # do not downgrade the version
+                continue
             # make mypy happy
             assert app_interface_resource.namespace_file
             assert app_interface_resource.provisioner.path

reconcile/gql_definitions/common/saas_files.py

@@ -205,6 +205,7 @@ query SaasFiles {
     deprecated
     compare
     timeout
+    skipSuccessfulDeployNotifications
     publishJobLogs
     clusterAdmin
     imagePatterns
@@ -564,6 +565,9 @@ class SaasFileV2(ConfiguredBaseModel):
     deprecated: Optional[bool] = Field(..., alias="deprecated")
     compare: Optional[bool] = Field(..., alias="compare")
     timeout: Optional[str] = Field(..., alias="timeout")
+    skip_successful_deploy_notifications: Optional[bool] = Field(
+        ..., alias="skipSuccessfulDeployNotifications"
+    )
     publish_job_logs: Optional[bool] = Field(..., alias="publishJobLogs")
     cluster_admin: Optional[bool] = Field(..., alias="clusterAdmin")
     image_patterns: list[str] = Field(..., alias="imagePatterns")

reconcile/openshift_saas_deploy.py

@@ -67,8 +67,19 @@ def slack_notify(
     in_progress: bool,
     trigger_integration: Optional[str] = None,
     trigger_reason: Optional[str] = None,
+    skip_successful_notifications: Optional[bool] = False,
 ) -> None:
     success = not ri.has_error_registered()
+    # if the deployment doesn't want any notifications for successful
+    # deployments, then we should grant the wish. However, there's a user
+    # expereince concern where the deployment owners will receive a "in
+    # progress" notice but no subsequent notice. We handle this case by
+    # including an "fyi" message for in progress deployments down below.
+    if success and skip_successful_notifications and not in_progress:
+        logging.info(
+            f"Skipping Slack notification for {saas_file_name} to {env_name} because deploy was successful."
+        )
+        return
     if in_progress:
         icon = ":yellow_jenkins_circle:"
         description = "In Progress"
@@ -87,6 +98,8 @@ def slack_notify(
         message += f". Reason: {trigger_reason}"
     if trigger_integration:
         message += f" triggered by _{trigger_integration}_"
+    if in_progress and skip_successful_notifications:
+        message += ". There will not be a notice for success."
     slack.chat_post_message(message)
 
 
@@ -120,6 +133,9 @@ def run(
     # - this is not a dry run
     # - there is a single saas file deployed
     notify = not dry_run and len(saas_files) == 1
+    skip_successful_deploy_notifications = (
+        saas_files[0].skip_successful_deploy_notifications if saas_files else False
+    )
     slack = None
     if notify:
         saas_file = saas_files[0]
@@ -151,6 +167,7 @@ def run(
                         in_progress=False,
                         trigger_integration=trigger_integration,
                         trigger_reason=trigger_reason,
+                        skip_successful_notifications=skip_successful_deploy_notifications,
                     )
                 )
             # deployment start notification
@@ -164,6 +181,7 @@ def run(
                     in_progress=True,
                     trigger_integration=trigger_integration,
                     trigger_reason=trigger_reason,
+                    skip_successful_notifications=skip_successful_deploy_notifications,
                 )
 
     jenkins_map = jenkins_base.get_jenkins_map()

reconcile/test/test_openshift_saas_deploy.py

@@ -1,12 +1,20 @@
 from collections.abc import Callable
+from unittest.mock import create_autospec
 
 import pytest
 
-from reconcile.openshift_saas_deploy import compose_console_url
+from reconcile.openshift_saas_deploy import (
+    compose_console_url,
+    slack_notify,
+)
 from reconcile.openshift_tekton_resources import (
     OpenshiftTektonResourcesNameTooLongError,
 )
 from reconcile.typed_queries.saas_files import SaasFile
+from reconcile.utils import (
+    openshift_resource,
+    slack_api,
+)
 
 
 @pytest.fixture
@@ -86,3 +94,94 @@ def test_compose_console_url_with_long_saas_name(
         f"Pipeline name o-saas-deploy-{saas_name} is longer than 56 characters"
         == str(e.value)
     )
+
+
+def test_slack_notify_skipped_success():
+    api = create_autospec(slack_api.SlackApi)
+    slack_notify(
+        saas_file_name="test-slack_notify--skipped-success.yaml",
+        env_name="test",
+        slack=api,
+        ri=openshift_resource.ResourceInventory(),
+        console_url="https://test.local/console",
+        in_progress=False,
+        skip_successful_notifications=True,
+    )
+    api.chat_post_message.assert_not_called()
+
+
+def test_slack_notify_unskipped_success():
+    api = create_autospec(slack_api.SlackApi)
+    slack_notify(
+        saas_file_name="test-slack_notify--unskipped-success.yaml",
+        env_name="test",
+        slack=api,
+        ri=openshift_resource.ResourceInventory(),
+        console_url="https://test.local/console",
+        in_progress=False,
+        skip_successful_notifications=False,
+    )
+    api.chat_post_message.assert_called_once_with(
+        ":green_jenkins_circle: SaaS file *test-slack_notify--unskipped-success.yaml* "
+        "deployment to environment *test*: Success "
+        "(<https://test.local/console|Open>)"
+    )
+
+
+def test_slack_notify_unskipped_failure():
+    api = create_autospec(slack_api.SlackApi)
+    ri = openshift_resource.ResourceInventory()
+    ri.register_error()
+    slack_notify(
+        saas_file_name="test-saas-file-name.yaml",
+        env_name="test",
+        slack=api,
+        ri=ri,
+        console_url="https://test.local/console",
+        in_progress=False,
+        skip_successful_notifications=False,
+    )
+    api.chat_post_message.assert_called_once_with(
+        ":red_jenkins_circle: SaaS file *test-saas-file-name.yaml* "
+        "deployment to environment *test*: Failure "
+        "(<https://test.local/console|Open>)"
+    )
+
+
+def test_slack_notify_skipped_failure():
+    api = create_autospec(slack_api.SlackApi)
+    ri = openshift_resource.ResourceInventory()
+    ri.register_error()
+    slack_notify(
+        saas_file_name="test-saas-file-name.yaml",
+        env_name="test",
+        slack=api,
+        ri=ri,
+        console_url="https://test.local/console",
+        in_progress=False,
+        skip_successful_notifications=True,
+    )
+    api.chat_post_message.assert_called_once_with(
+        ":red_jenkins_circle: SaaS file *test-saas-file-name.yaml* "
+        "deployment to environment *test*: Failure "
+        "(<https://test.local/console|Open>)"
+    )
+
+
+def test_slack_notify_skipped_in_progress():
+    api = create_autospec(slack_api.SlackApi)
+    ri = openshift_resource.ResourceInventory()
+    slack_notify(
+        saas_file_name="test-saas-file-name.yaml",
+        env_name="test",
+        slack=api,
+        ri=ri,
+        console_url="https://test.local/console",
+        in_progress=True,
+        skip_successful_notifications=True,
+    )
+    api.chat_post_message.assert_called_once_with(
+        ":yellow_jenkins_circle: SaaS file *test-saas-file-name.yaml* "
+        "deployment to environment *test*: In Progress "
+        "(<https://test.local/console|Open>). There will not be a notice for success."
+    )

reconcile/typed_queries/saas_files.py

@@ -116,6 +116,9 @@ class SaasFile(ConfiguredBaseModel):
     deprecated: Optional[bool] = Field(..., alias="deprecated")
     compare: Optional[bool] = Field(..., alias="compare")
     timeout: Optional[str] = Field(..., alias="timeout")
+    skip_successful_deploy_notifications: Optional[bool] = Field(
+        ..., alias="skipSuccessfulDeployNotifications"
+    )
     publish_job_logs: Optional[bool] = Field(..., alias="publishJobLogs")
     cluster_admin: Optional[bool] = Field(..., alias="clusterAdmin")
     image_patterns: list[str] = Field(..., alias="imagePatterns")

reconcile/utils/semver_helper.py

@@ -7,7 +7,16 @@ def make_semver(major: int, minor: int, patch: int) -> str:
     return str(semver.VersionInfo(major=major, minor=minor, patch=patch))
 
 
-def parse_semver(version: str) -> semver.VersionInfo:
+def parse_semver(
+    version: str, optional_minor_and_patch: bool = False
+) -> semver.VersionInfo:
+    if optional_minor_and_patch:
+        # semver3 supports optional minor and patch.
+        # until we upgrade to semver3, we support this by adding a default minor and/or patch
+        if "." not in version:
+            version = f"{version}.0.0"
+        elif version.count(".") == 1:
+            version = f"{version}.0"
     return semver.VersionInfo.parse(version)