Demo of decorating controls

Closes #197

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

Author: Lawouach

CHANGELOG.md

@@ -9,6 +9,9 @@
 - Activities can be requested not to be executed on a per activity basis, not
   just as all or none. This can be used by a control to dynamically make
   a decision on what to run.
+- Test that demonstrate how to wrap controls into decorators [#197][197]
+
+[197]: https://github.com/chaostoolkit/chaostoolkit-lib/issues/197
 
 ## [1.16.0][] - 2020-12-02
 

tests/fixtures/controls/dummy_with_decorated_control.py

@@ -0,0 +1,40 @@
+from functools import wraps
+from itertools import count
+from typing import Callable
+
+from logzero import logger
+
+from chaoslib.types import Journal
+
+counter = None
+
+
+def initcounter(f: Callable) -> Callable:
+    @wraps(f)
+    def wrapped(*args, **kwargs) -> None:
+        global counter
+        counter = count()
+        f(*args, **kwargs)
+    return wrapped
+
+
+def keepcount(f: Callable) -> Callable:
+    @wraps(f)
+    def wrapped(*args, **kwargs) -> None:
+        next(counter)
+        f(*args, **kwargs)
+    return wrapped
+
+
+@keepcount
+def after_activity_control(**kwargs):
+    logger.info("Activity is called")
+
+
+@initcounter
+def configure_control(**kwargs):
+    logger.info("configure is called")
+
+
+def after_experiment_control(state: Journal, **kwargs):
+    state["counted_activities"] = next(counter)

tests/fixtures/experiments.py

@@ -310,6 +310,17 @@
     }
 ]
 
+ExperimentWithDecoratedControls = deepcopy(ExperimentNoControls)
+ExperimentWithDecoratedControls["controls"] = [
+    {
+        "name": "dummy",
+        "provider": {
+            "type": "python",
+            "module": "fixtures.controls.dummy_with_decorated_control"
+        }
+    }
+]
+
 ExperimentWithControlsRequiringSecrets = deepcopy(ExperimentWithControls)
 ExperimentWithControlsRequiringSecrets["secrets"] = {
     "mystuff": {

tests/test_control.py

@@ -580,3 +580,9 @@ def test_secrets_are_passed_to_all_control_hookpoints():
             "after_hypothesis_control", "before_activity_control",
             "after_activity_control"):
         assert exp["{}_secrets".format(hookpoint)] == secrets, "{} was not provided the secrets".format(hookpoint)
+
+
+def test_control_can_be_decorated_functions():
+    exp = deepcopy(experiments.ExperimentWithDecoratedControls)
+    state = run_experiment(exp)
+    assert state["counted_activities"] == 4