Fix insertion ordering of repeat control

Signed-off-by: Sylvain Hellegouarch <[email protected]>

Author: Lawouach

CHANGELOG.md

@@ -7,6 +7,8 @@
 ### Fixed
 
 * Make sure the `repeat` control doesn't run when it count is less than 2
+* Prevent endless looping
+* Ensure insertion ordering is correct
 
 ### Changed
 

chaosaddons/controls/repeat.py

@@ -47,6 +47,11 @@ def after_activity_control(context: Activity, experiment: Experiment,
     Note, if `repeat_count` is less than 2, then this is a noop.
     """
     activity = context
+
+    # prevent endless looping
+    if "iteration_index" in activity:
+        return None
+
     activity_name = activity["name"]
     activity_type = activity["type"]
 
@@ -58,6 +63,9 @@ def after_activity_control(context: Activity, experiment: Experiment,
         )
         return None
 
+    logger.debug(
+        f"Repeat {activity_type} '{activity_name}' {repeat_count} more times"
+    )
     last_status = state.get("status")
 
     if break_if_previous_iteration_failed and last_status != "succeeded":
@@ -89,16 +97,12 @@ def repeat_activity(activity: Activity, activities: List[Activity],
         return
 
     activity_name = activity["name"]
+    copy_activities = activities[:]
 
-    for a in reversed(activities):
+    for pos, a in enumerate(copy_activities):
         if a["name"] == activity_name:
-            activity = deepcopy(activity)
-            if "iteration_index" not in activity:
-                activity["iteration_index"] = 1
-            else:
-                if activity["iteration_index"] == repeat_count:
-                    return
-                activity["iteration_index"] += 1
-
-            activities.append(activity)
+            for index in range(1, repeat_count+1):
+                new_activity = deepcopy(activity)
+                new_activity["iteration_index"] = index
+                activities.insert(pos+index, new_activity)
             break

tests/test_repeat.py

@@ -54,7 +54,7 @@ def test_repeat_n_times_in_hypothesis():
     assert len(x.get("steady-state-hypothesis").get("probes")) == 4
 
 
-def test_repeat_once_in_hypothesis():
+def test_repeat_once():
     a = {
         "name": "probe-B",
         "type": "probe",
@@ -103,7 +103,82 @@ def test_repeat_once_in_hypothesis():
 
     after_activity_control(
         context=a, experiment=x, state={},
-        repeat_count=1
+        repeat_count=2
     )
 
     assert len(x.get("method")) == 4
+
+
+def test_repeat_inserts():
+    a = {
+        "name": "probe-B",
+        "type": "probe",
+        "provider": {
+            "type": "python",
+            "module": "builtins",
+            "func": "sum",
+            "arguments": {
+                "iterable": [6, 7]
+            }
+        }
+    }
+    x = {
+        "title": "hello",
+        "description": "n/a",
+        "method": [
+                {
+                    "name": "probe-A",
+                    "type": "probe",
+                    "provider": {
+                        "type": "python",
+                        "module": "builtins",
+                        "func": "sum",
+                        "arguments": {
+                            "iterable": [2, 3]
+                        }
+                    }
+                },
+                a,
+                {
+                    "name": "probe-C",
+                    "type": "probe",
+                    "provider": {
+                        "type": "python",
+                        "module": "builtins",
+                        "func": "sum",
+                        "arguments": {
+                            "iterable": [2, 3]
+                        }
+                    }
+                },
+                {
+                    "name": "probe-D",
+                    "type": "probe",
+                    "provider": {
+                        "type": "python",
+                        "module": "builtins",
+                        "func": "sum",
+                        "arguments": {
+                            "iterable": [2, 3]
+                        }
+                    }
+                },
+            ]
+    }
+
+    assert len(x.get("method")) == 4
+    
+    after_activity_control(
+        context=a, experiment=x, state={},
+        repeat_count=3
+    )
+
+    assert len(x.get("method")) == 6
+
+    m = x.get("method")
+    assert m[0]["name"] == "probe-A"
+    assert m[1]["name"] == "probe-B"
+    assert m[2]["name"] == "probe-B"
+    assert m[3]["name"] == "probe-B"
+    assert m[4]["name"] == "probe-C"
+    assert m[5]["name"] == "probe-D"