Fix #251

Signed-off-by: Sylvain Hellegouarch <sh@defuze.org>

Author: Lawouach

CHANGELOG.md

@@ -4,6 +4,13 @@
 
 [Unreleased]: https://github.com/chaostoolkit/chaostoolkit-lib/compare/1.27.1...HEAD
 
+### Changed
+
+- Ensure experiment level controls are applied to activity level controls
+  when activity declares a control too [#251][251]
+
+[251]: https://github.com/chaostoolkit/chaostoolkit-lib/issues/251
+
 ## [1.27.1][] - 2022-02-25
 
 [1.27.1]: https://github.com/chaostoolkit/chaostoolkit-lib/compare/1.27.0...1.27.1

chaoslib/control/__init__.py

@@ -359,19 +359,18 @@ def get_context_controls(
     if level in ["method", "rollback"]:
         return [deepcopy(c) for c in top_level_controls if c.get("automatic", True)]
 
-    for c in controls:
+    for c in controls[:]:
         if "ref" in c:
             for top_level_control in top_level_controls:
                 if c["ref"] == top_level_control["name"]:
                     controls.append(deepcopy(top_level_control))
                     break
         else:
-            for tc in top_level_controls:
+            for tc in reversed(top_level_controls):
                 if c.get("name") == tc.get("name"):
-                    break
-            else:
+                    continue
                 if tc.get("automatic", True):
-                    controls.append(deepcopy(tc))
+                    controls.insert(0, deepcopy(tc))
 
     return controls
 

tests/fixtures/experiments.py

@@ -854,3 +854,63 @@
         "provider": {"type": "python", "module": "fixtures.controls.dummy_validator"},
     }
 ]
+
+
+ExperimentWithTopLevelControlsAndActivityControl = {
+    "title": "Hello world!",
+    "description": "Say hello world.",
+    "controls": [
+        {
+            "name": "tc1",
+            "provider": {
+                "type": "python",
+                "module": "builtins",
+                "func": "sum",
+                "arguments": {"iterable": [4, 5]},
+            },
+        },
+        {
+            "name": "tc2",
+            "automatic": False,
+            "provider": {
+                "type": "python",
+                "module": "builtins",
+                "func": "sum",
+                "arguments": {"iterable": [6, 7]},
+            },
+        },
+        {
+            "name": "tc3",
+            "provider": {
+                "type": "python",
+                "module": "builtins",
+                "func": "sum",
+                "arguments": {"iterable": [6, 7]},
+            },
+        },
+    ],
+    "method": [
+        {
+            "type": "action",
+            "name": "pretend-we-do-stuff",
+            "background": True,
+            "provider": {
+                "type": "python",
+                "module": "builtins",
+                "func": "sum",
+                "arguments": {"iterable": [1, 2]},
+            },
+            "controls": [
+                {
+                    "name": "lc1",
+                    "provider": {
+                        "type": "python",
+                        "module": "builtins",
+                        "func": "sum",
+                        "arguments": {"iterable": [2, 3]},
+                    },
+                }
+            ],
+        },
+    ],
+}

tests/test_control.py

@@ -584,3 +584,12 @@ def test_control_can_validate_itself():
 
     with pytest.raises(InvalidActivity):
         ensure_experiment_is_valid(exp)
+
+
+def test_activity_level_controls_are_merged_to_top_level_controls():
+    x = deepcopy(experiments.ExperimentWithTopLevelControlsAndActivityControl)
+    a = x["method"][0]
+    controls = get_context_controls("activity", x, a)
+    assert controls[0]["name"] == "tc1"
+    assert controls[1]["name"] == "tc3"
+    assert controls[2]["name"] == "lc1"