qontract-reconcile 0.10.1rc708__py3-none-any.whl → 0.10.1rc709__py3-none-any.whl

{qontract_reconcile-0.10.1rc708.dist-info → qontract_reconcile-0.10.1rc709.dist-info}/METADATA

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

@@ -77,7 +77,7 @@ reconcile/openshift_routes.py,sha256=fXvuPSjcjVw1X3j2EQvUAdbOepmIFdKk-M3qP8QzPiw
 reconcile/openshift_saas_deploy.py,sha256=fmhopPEbyZsGQHRPzyzpKEvoBXEGN3aPxFi7Utq0emU,12788
 reconcile/openshift_saas_deploy_change_tester.py,sha256=fMmPDz-ZRO-WH8OIiDo4e4sBK4-zzpvFXmVCKGY1l-I,8837
 reconcile/openshift_saas_deploy_trigger_base.py,sha256=p1Mv7dbw_K7TVFv-M-DDq6r1ltuW9VAF6PCNnEng_zM,14291
-reconcile/openshift_saas_deploy_trigger_cleaner.py,sha256=aT8wqoXGyZEeXUA7Q6reaL9v5j5UnPLoYVe70D31HUg,2917
+reconcile/openshift_saas_deploy_trigger_cleaner.py,sha256=gU226N1JUvgEbTgDf7ouJ6QzZGMI_BLwXdS67UCukRk,3554
 reconcile/openshift_saas_deploy_trigger_configs.py,sha256=uWzUV5D5CW0frdi1ys7BObNg-rA-VZKlefd4TD_Z-pY,959
 reconcile/openshift_saas_deploy_trigger_images.py,sha256=Yl4lMtxqab-c04I2Ju8isAJuYuNTbHN01Bk3dF9nTos,967
 reconcile/openshift_saas_deploy_trigger_moving_commits.py,sha256=VqjwgRhA-yOSq0WFPqGIJVgYkdq_UrTHcVusBzOFgMY,973
@@ -234,7 +234,7 @@ reconcile/gql_definitions/common/ocm_env_telemeter.py,sha256=jW0Q9WazDQVOxh4u0LM
 reconcile/gql_definitions/common/ocm_environments.py,sha256=2Szg8VSIM4a9ZbjktDjSY6I1enih2Cx1tjYXoUFiZX0,2002
 reconcile/gql_definitions/common/pagerduty_instances.py,sha256=qcbOSUNwmeRcBetJ2FktUu6Mn4CPE2iNoevt3fY_xig,1988
 reconcile/gql_definitions/common/pgp_reencryption_settings.py,sha256=NPLmO6J-zSu5B9QiYbDezLHY3TuOO9ihRBV-Zr84R9w,2259
-reconcile/gql_definitions/common/pipeline_providers.py,sha256=AmEgemURPRQhsleaVbwxmEcbuymC6SH_3DO09sHl-b0,9115
+reconcile/gql_definitions/common/pipeline_providers.py,sha256=JJgmmghqLIwjKOdcWYHPnf4PDgAq4GF7046i0ozrqgI,9127
 reconcile/gql_definitions/common/saas_files.py,sha256=B7HE_jV5ky8AFxOCleSg2RYDrtUaV99DYa2If8wyvHs,15926
 reconcile/gql_definitions/common/saas_target_namespaces.py,sha256=gcTU9jrsNq9-HX-oOkj-nEZKYFTRytDHLs4SpEs93aw,2755
 reconcile/gql_definitions/common/saasherder_settings.py,sha256=nqQLcMwYxLseqq0BEcVvmrpIj2eQq0h8XDSpLN6GGCw,1793
@@ -262,7 +262,7 @@ reconcile/gql_definitions/fragments/membership_source.py,sha256=rVjAIAhhAoH0_fUf
 reconcile/gql_definitions/fragments/minimal_ocm_organization.py,sha256=G7uEwGR2qjtXl3yUUMWAzbihNKor0jj1_fcSd9qQOjw,731
 reconcile/gql_definitions/fragments/oc_connection_cluster.py,sha256=GO4v0q7urQt2G6fU6HJSgHmFOPxNCc3oO0zAwz9bU7o,1530
 reconcile/gql_definitions/fragments/ocm_environment.py,sha256=mEbBooD-SAxe7l73sja0ELiByGkTiqxuca9vmxfIISw,1075
-reconcile/gql_definitions/fragments/pipeline_provider_retention.py,sha256=hjqsTf95evcZn3BBKpF9dUJVBhpy2tq6r_rEbaF6cy4,757
+reconcile/gql_definitions/fragments/pipeline_provider_retention.py,sha256=nIGIaeuBDw5emBdDJvajl27pGULQ2fYG5SkQ0AYTr7E,814
 reconcile/gql_definitions/fragments/prometheus_instance.py,sha256=12ltnV9kdEw6LnHgevdM6Ms-lCPY802RC-CrYOoRRgY,1575
 reconcile/gql_definitions/fragments/resource_limits_requirements.py,sha256=ucskQ_a8RxvFl5-IWxz5kk3g4-5Pvh_W4N3nLmuKxi0,744
 reconcile/gql_definitions/fragments/resource_requests_requirements.py,sha256=TFKO4YALFPanSvZvIJFz0dCioBU7i73Q6hkDtGMvs9I,736
@@ -468,6 +468,7 @@ reconcile/test/test_openshift_resource.py,sha256=lbTf48jX1q6rGnRiA5pPvfU0uPfY8zh
 reconcile/test/test_openshift_resources_base.py,sha256=LtlR9x3o7KkSEw0JN0fZhinFeAAxBAQlB_9PpBnKwOM,14353
 reconcile/test/test_openshift_saas_deploy.py,sha256=YLJGkc--u5aP0UkQ-b9ZGEFGS2gw25jjcSgknQdI3Ic,5892
 reconcile/test/test_openshift_saas_deploy_change_tester.py,sha256=1yVe54Hx9YdVjn6qdnKge5Sa_s732c-8uZqCnuT1gGI,12871
+reconcile/test/test_openshift_saas_deploy_trigger_cleaner.py,sha256=cha3bUiXAWPCwrp8XwVC3RNJtJHLcsGTE-F8Zn6XxsU,2852
 reconcile/test/test_openshift_tekton_resources.py,sha256=RtRWsdm51S13OSkENC9nY_rOH0QELSCaO5tjF0XqIDI,11222
 reconcile/test/test_openshift_upgrade_watcher.py,sha256=0GDQ_YFHIX8DbkbDYSuLv9uZeeg4NwP1vlOqvSaZvN4,7183
 reconcile/test/test_prometheus_rules_tester.py,sha256=Qc9J4k0lSVie361lGr_cOy0EaBTD5LDqGZf7CYVFKr8,5677
@@ -761,8 +762,8 @@ tools/test/test_app_interface_metrics_exporter.py,sha256=SX7qL3D1SIRKFo95FoQztvf
 tools/test/test_qontract_cli.py,sha256=UEwAW7PA_GIrbqzaLxpkCxbuVjEFLNvnVG-6VyoCGIc,4147
 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.1rc708.dist-info/METADATA,sha256=jj1NGE9JNFWbhjQyp5dY0QHogw8JrqpK0_hKDkxtbUU,2382
-qontract_reconcile-0.10.1rc708.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-qontract_reconcile-0.10.1rc708.dist-info/entry_points.txt,sha256=rIxI5zWtHNlfpDeq1a7pZXAPoqf7HG32KMTN3MeWK_8,429
-qontract_reconcile-0.10.1rc708.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
-qontract_reconcile-0.10.1rc708.dist-info/RECORD,,
+qontract_reconcile-0.10.1rc709.dist-info/METADATA,sha256=LWgfuyiC1vMk_M3JnVI9i54gC6OTe2glD6StNzN4X5s,2382
+qontract_reconcile-0.10.1rc709.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+qontract_reconcile-0.10.1rc709.dist-info/entry_points.txt,sha256=rIxI5zWtHNlfpDeq1a7pZXAPoqf7HG32KMTN3MeWK_8,429
+qontract_reconcile-0.10.1rc709.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
+qontract_reconcile-0.10.1rc709.dist-info/RECORD,,

reconcile/gql_definitions/common/pipeline_providers.py

@@ -39,6 +39,7 @@ fragment CommonJumphostFields on ClusterJumpHost_v1 {
 fragment PipelineProviderRetention on PipelinesProviderRetention_v1 {
     days
     minimum
+    maximum
 }
 
 fragment ResourceLimitsRequirements on ResourceLimitsRequirements_v1 {

reconcile/gql_definitions/fragments/pipeline_provider_retention.py

@@ -27,3 +27,4 @@ class ConfiguredBaseModel(BaseModel):
 class PipelineProviderRetention(ConfiguredBaseModel):
     days: Optional[int] = Field(..., alias="days")
     minimum: Optional[int] = Field(..., alias="minimum")
+    maximum: Optional[int] = Field(..., alias="maximum")

reconcile/openshift_saas_deploy_trigger_cleaner.py

@@ -12,6 +12,9 @@ from typing import (
 
 from dateutil import parser
 
+from reconcile.gql_definitions.fragments.pipeline_provider_retention import (
+    PipelineProviderRetention,
+)
 from reconcile.typed_queries.app_interface_vault_settings import (
     get_app_interface_vault_settings,
 )
@@ -30,15 +33,36 @@ QONTRACT_INTEGRATION = "openshift-saas-deploy-trigger-cleaner"
 QONTRACT_INTEGRATION_VERSION = make_semver(0, 1, 0)
 
 
-def within_retention_days(resource: dict[str, Any], days: int) -> bool:
+def within_retention_days(
+    resource: dict[str, Any], days: int, now_date: datetime
+) -> bool:
     metadata = resource["metadata"]
     creation_date = parser.parse(metadata["creationTimestamp"])
-    now_date = datetime.now(timezone.utc)
     interval = now_date.timestamp() - creation_date.timestamp()
 
     return interval < timedelta(days=days).total_seconds()
 
 
+def get_pipeline_runs_to_delete(
+    pipeline_runs: list[dict[str, Any]],
+    retention: PipelineProviderRetention,
+    now_date: datetime,
+) -> list[dict[str, Any]]:
+    pipeline_runs_to_delete = []
+    if retention.minimum:
+        pipeline_runs = pipeline_runs[retention.minimum :]
+    elif retention.maximum:
+        pipeline_runs_to_delete = pipeline_runs[retention.maximum :]
+        pipeline_runs = pipeline_runs[: retention.maximum]
+
+    for pr in pipeline_runs:
+        if retention.days and within_retention_days(pr, retention.days, now_date):
+            continue
+        pipeline_runs_to_delete.append(pr)
+
+    return pipeline_runs_to_delete
+
+
 @defer
 def run(
     dry_run: bool,
@@ -47,6 +71,7 @@ def run(
     use_jump_host: bool = True,
     defer: Optional[Callable] = None,
 ) -> None:
+    now_date = datetime.now(timezone.utc)
     vault_settings = get_app_interface_vault_settings()
     secret_reader = create_secret_reader(use_vault=vault_settings.vault)
     pipeline_providers = get_tekton_pipeline_providers()
@@ -77,14 +102,8 @@ def run(
             reverse=True,
         )
 
-        if pp.retention.minimum:
-            pipeline_runs = pipeline_runs[pp.retention.minimum :]
-
-        for pr in pipeline_runs:
+        for pr in get_pipeline_runs_to_delete(pipeline_runs, pp.retention, now_date):
             name = pr["metadata"]["name"]
-            if pp.retention.days and within_retention_days(pr, pp.retention.days):
-                continue
-
             logging.info([
                 "delete_trigger",
                 pp.namespace.cluster.name,

reconcile/test/test_openshift_saas_deploy_trigger_cleaner.py

@@ -0,0 +1,65 @@
+from datetime import datetime, timezone
+from typing import Any
+
+import pytest
+
+from reconcile.gql_definitions.fragments.pipeline_provider_retention import (
+    PipelineProviderRetention,
+)
+from reconcile.openshift_saas_deploy_trigger_cleaner import get_pipeline_runs_to_delete
+
+from .fixtures import Fixtures
+
+fxt = Fixtures("openshift_saas_deploy_trigger_cleaner")
+
+
+@pytest.fixture
+def now() -> datetime:
+    return datetime(2024, 4, 4, 0, 0, 0, 0, tzinfo=timezone.utc)
+
+
+# A fixture simulating the output of getting PipelineRuns from a namespace, simplified
+# as it contains only the fields relevant for get_pipeline_runs_to_delete, reversed
+# sorted by creationTimestamp
+@pytest.fixture
+def pipeline_runs() -> list[dict[str, Any]]:
+    return fxt.get_anymarkup("pipeline_runs.yaml")
+
+
+# No min/max settings, we go with whatever "days" says
+def test_days(now: datetime, pipeline_runs: list[dict[str, Any]]) -> None:
+    retention = PipelineProviderRetention(days=1, minimum=None, maximum=None)
+    assert len(get_pipeline_runs_to_delete(pipeline_runs, retention, now)) == 4
+
+    retention = PipelineProviderRetention(days=2, minimum=None, maximum=None)
+    assert len(get_pipeline_runs_to_delete(pipeline_runs, retention, now)) == 2
+
+
+# Minimum set, it takes precedence over "days"
+def test_days_and_minimum(now: datetime, pipeline_runs: list[dict[str, Any]]) -> None:
+    retention = PipelineProviderRetention(days=1, minimum=5, maximum=None)
+    assert len(get_pipeline_runs_to_delete(pipeline_runs, retention, now)) == 1
+    # We would have removed four from the "days" setting, we can only remove one
+
+    retention = PipelineProviderRetention(days=1, minimum=3, maximum=None)
+    assert len(get_pipeline_runs_to_delete(pipeline_runs, retention, now)) == 3
+    # We would have removed four from the "days" setting, we can only remove three
+
+    retention = PipelineProviderRetention(days=1, minimum=1, maximum=None)
+    assert len(get_pipeline_runs_to_delete(pipeline_runs, retention, now)) == 4
+    # Removing 4 we still have two, we're fine.
+
+
+# Maximum set, it takes precedence over "days"
+def test_days_and_maximum(now: datetime, pipeline_runs: list[dict[str, Any]]) -> None:
+    retention = PipelineProviderRetention(days=1, minimum=None, maximum=1)
+    assert len(get_pipeline_runs_to_delete(pipeline_runs, retention, now)) == 5
+    # we have a max of 1, no matter what "days" says.
+
+    retention = PipelineProviderRetention(days=1, minimum=None, maximum=3)
+    assert len(get_pipeline_runs_to_delete(pipeline_runs, retention, now)) == 4
+    # by removing 4 we comply with the max setting of three.
+
+    retention = PipelineProviderRetention(days=2, minimum=None, maximum=3)
+    assert len(get_pipeline_runs_to_delete(pipeline_runs, retention, now)) == 3
+    # We would have remove only two following "days", but max tells us otherwise.