Play controls once only after experiment

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

Author: Lawouach

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 [Unreleased]: https://github.com/chaostoolkit/chaostoolkit-lib/compare/1.27.2...HEAD
 
+### Changed
+
+- Ensure experiment level controls are only played once
+
 ## [1.27.2][] - 2022-03-23
 
 [1.27.2]: https://github.com/chaostoolkit/chaostoolkit-lib/compare/1.27.1...1.27.2

chaoslib/control/__init__.py

@@ -369,7 +369,7 @@ def get_context_controls(
             for tc in reversed(top_level_controls):
                 if c.get("name") == tc.get("name"):
                     continue
-                if tc.get("automatic", True):
+                if (level != "experiment") and tc.get("automatic", True):
                     controls.insert(0, deepcopy(tc))
 
     return controls

tests/fixtures/controls/dummy_sums.py

@@ -0,0 +1,13 @@
+from typing import Sequence
+
+from chaoslib.types import Experiment, Journal
+
+
+def before_experiment_control(context: Experiment,
+                              values: Sequence[int]) -> None:
+    context["result_after"] = 0
+
+
+def after_experiment_control(context: Experiment, state: Journal,
+                             values: Sequence[int]) -> None:
+    context["result_after"] += sum(values)

tests/fixtures/experiments.py

@@ -864,28 +864,25 @@
             "name": "tc1",
             "provider": {
                 "type": "python",
-                "module": "builtins",
-                "func": "sum",
-                "arguments": {"iterable": [4, 5]},
+                "module": "fixtures.controls.dummy_sums",
+                "arguments": {"values": [4, 5]},
             },
         },
         {
             "name": "tc2",
             "automatic": False,
             "provider": {
                 "type": "python",
-                "module": "builtins",
-                "func": "sum",
-                "arguments": {"iterable": [6, 7]},
+                "module": "fixtures.controls.dummy_sums",
+                "arguments": {"values": [6, 7]},
             },
         },
         {
             "name": "tc3",
             "provider": {
                 "type": "python",
-                "module": "builtins",
-                "func": "sum",
-                "arguments": {"iterable": [6, 7]},
+                "module": "fixtures.controls.dummy_sums",
+                "arguments": {"values": [6, 7]},
             },
         },
     ],
@@ -905,12 +902,41 @@
                     "name": "lc1",
                     "provider": {
                         "type": "python",
-                        "module": "builtins",
-                        "func": "sum",
-                        "arguments": {"iterable": [2, 3]},
+                    "module": "fixtures.controls.dummy_sums",
+                        "arguments": {"values": [2, 3]},
                     },
                 }
             ],
         },
     ],
 }
+
+
+ExperimentWithOnlyTopLevelControls = deepcopy(ExperimentNoControls)
+ExperimentWithOnlyTopLevelControls["controls"] = [
+    {
+        "name": "tc1",
+        "provider": {
+            "type": "python",
+                "module": "fixtures.controls.dummy_sums",
+            "arguments": {"values": [1, 2]},
+        },
+    },
+    {
+        "name": "tc2",
+        "automatic": False,
+        "provider": {
+            "type": "python",
+                "module": "fixtures.controls.dummy_sums",
+            "arguments": {"values": [3, 4]},
+        },
+    },
+    {
+        "name": "tc3",
+        "provider": {
+            "type": "python",
+                "module": "fixtures.controls.dummy_sums",
+            "arguments": {"values": [5, 6]},
+        },
+    },
+]

tests/test_control.py

@@ -593,3 +593,9 @@ def test_activity_level_controls_are_merged_to_top_level_controls():
     assert controls[0]["name"] == "tc1"
     assert controls[1]["name"] == "tc3"
     assert controls[2]["name"] == "lc1"
+
+
+def test_experiment_level_controls_played_only_one_each_in_the_after_phase():
+    x = deepcopy(experiments.ExperimentWithOnlyTopLevelControls)
+    run_experiment(x)
+    assert x["result_after"] == 21