Fix formatting and bug in purge rule from GC

Author: amanda11

CHANGELOG.rst

@@ -152,7 +152,7 @@ Added
 
   Contributed by @Kami.
 
-* Added garbage collection for rule_enforcement and trace models
+* Added garbage collection for rule_enforcement and trace models #5596
   Contributed by Amanda McGuinness (@amanda11 intive)
 
 

conf/st2.conf.sample

@@ -177,14 +177,14 @@ collection_interval = 600
 logging = /etc/st2/logging.garbagecollector.conf
 # Set to True to perform garbage collection on Inquiries (based on the TTL value per Inquiry)
 purge_inquiries = False
+# Rule enforcements older than this value (days) will be automatically deleted.
+rule_enforcement_ttl = None
 # How long to wait / sleep (in seconds) between collection of different object types.
 sleep_delay = 2
+# Trace objects older than this value (days) will be automatically deleted.
+trace_ttl = None
 # Trigger instances older than this value (days) will be automatically deleted.
 trigger_instances_ttl = None
-# Rule enforcement instances older than this value (days) will be automatically deleted.
-rule_enforcement_ttl = None
-# Trace instances older than this value (days) will be automatically deleted.
-trace_ttl = None
 
 [keyvalue]
 # Allow encryption of values in key value stored qualified as "secret".

st2common/tests/unit/test_purge_rule_enforcement.py

@@ -37,7 +37,7 @@ def setUp(self):
 
     def test_no_timestamp_doesnt_delete(self):
         now = date_utils.get_datetime_utc_now()
-        saved = TestPurgeRuleEnforcement._create_save_rule_enforcement(
+        TestPurgeRuleEnforcement._create_save_rule_enforcement(
             enforced_at=now - timedelta(days=20),
         )
 
@@ -54,11 +54,11 @@ def test_no_timestamp_doesnt_delete(self):
 
     def test_purge(self):
         now = date_utils.get_datetime_utc_now()
-        saved = TestPurgeRuleEnforcement._create_save_rule_enforcement(
+        TestPurgeRuleEnforcement._create_save_rule_enforcement(
             enforced_at=now - timedelta(days=20),
         )
 
-        saved = TestPurgeRuleEnforcement._create_save_rule_enforcement(
+        TestPurgeRuleEnforcement._create_save_rule_enforcement(
             enforced_at=now - timedelta(days=5),
         )
 

st2common/tests/unit/test_purge_trace.py

@@ -37,7 +37,7 @@ def setUp(self):
 
     def test_no_timestamp_doesnt_delete(self):
         now = date_utils.get_datetime_utc_now()
-        saved = TestPurgeTrace._create_save_trace(
+        TestPurgeTrace._create_save_trace(
             trace_tag="test_trace",
             action_executions=[str(bson.ObjectId()) for _ in range(4)],
             rules=[str(bson.ObjectId()) for _ in range(4)],
@@ -58,15 +58,15 @@ def test_no_timestamp_doesnt_delete(self):
 
     def test_purge(self):
         now = date_utils.get_datetime_utc_now()
-        saved = TestPurgeTrace._create_save_trace(
+        TestPurgeTrace._create_save_trace(
             trace_tag="test_trace",
             action_executions=[str(bson.ObjectId()) for _ in range(4)],
             rules=[str(bson.ObjectId()) for _ in range(4)],
             trigger_instances=[str(bson.ObjectId()) for _ in range(5)],
             start_timestamp=now - timedelta(days=20),
         )
 
-        saved = TestPurgeTrace._create_save_trace(
+        TestPurgeTrace._create_save_trace(
             trace_tag="test_trace",
             action_executions=[str(bson.ObjectId()) for _ in range(4)],
             rules=[str(bson.ObjectId()) for _ in range(4)],

st2reactor/st2reactor/garbage_collector/base.py

@@ -349,7 +349,7 @@ def _purge_trace(self):
         utc_now = get_datetime_utc_now()
         timestamp = utc_now - datetime.timedelta(days=self._trace_ttl)
 
-        # Another sanity check to make sure we don't delete new executions
+        # Another sanity check to make sure we don't delete new objects
         if timestamp > (utc_now - datetime.timedelta(days=MINIMUM_TTL_DAYS)):
             raise ValueError(
                 "Calculated timestamp would violate the minimum TTL constraint"
@@ -378,7 +378,7 @@ def _purge_rule_enforcement(self):
         utc_now = get_datetime_utc_now()
         timestamp = utc_now - datetime.timedelta(days=self._rule_enforcement_ttl)
 
-        # Another sanity check to make sure we don't delete new executions
+        # Another sanity check to make sure we don't delete new objects
         if timestamp > (utc_now - datetime.timedelta(days=MINIMUM_TTL_DAYS)):
             raise ValueError(
                 "Calculated timestamp would violate the minimum TTL constraint"
@@ -394,7 +394,7 @@ def _purge_rule_enforcement(self):
             )
 
         try:
-            purge_executions(logger=LOG, timestamp=timestamp)
+            purge_rule_enforcement(logger=LOG, timestamp=timestamp)
         except Exception as e:
             LOG.exception("Failed to delete rule enforcements: %s" % (six.text_type(e)))
 

st2tests/st2tests/config.py

@@ -484,6 +484,16 @@ def _register_garbage_collector_opts():
             default=None,
             help="Trigger instances older than this value (days) will be automatically deleted.",
         ),
+        cfg.IntOpt(
+            "rule_enforcement_ttl",
+            default=None,
+            help="Rule enforcements older than this value (days) will be automatically deleted.",
+        ),
+        cfg.IntOpt(
+            "trace_ttl",
+            default=None,
+            help="Trace objects older than this value (days) will be automatically deleted.",
+        ),
     ]
 
     _register_opts(ttl_opts, group="garbagecollector")