extend substitution support

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

Author: Lawouach

CHANGELOG.md

@@ -2,7 +2,15 @@
 
 ## [Unreleased][]
 
-[Unreleased]: https://github.com/chaostoolkit/chaostoolkit-reporting/compare/0.15.0...HEAD
+[Unreleased]: https://github.com/chaostoolkit/chaostoolkit-reporting/compare/0.16.0...HEAD
+
+## [0.16.0][] - 2023-12-05
+
+[0.16.0]: https://github.com/chaostoolkit/chaostoolkit-reporting/compare/0.15.0...0.16.0
+
+### Added
+
+- Extended support for substituoon to tolerance and pauses properties
 
 ## [0.15.0][] - 2023-11-30
 

chaosreport/__init__.py

@@ -20,10 +20,8 @@
 import pygal
 import pypandoc
 import semver
-from chaoslib import merge_vars, substitute
+from chaoslib import substitute
 from chaoslib.caching import cache_activities, lookup_activity
-from chaoslib.configuration import load_configuration
-from chaoslib.secret import load_secrets
 from chaoslib.types import Configuration, Experiment, Journal, Run, Secrets
 from jinja2 import Environment, PackageLoader
 from logzero import logger
@@ -36,7 +34,7 @@
     "generate_report_header",
     "save_report",
 ]
-__version__ = "0.15.0"
+__version__ = "0.16.0"
 
 curdir = os.getcwd()
 basedir = os.path.dirname(__file__)
@@ -248,20 +246,17 @@ def generate_report_header(
 
 
 def generate_report(
-    journal_path: str,
+    journal: Dict[str, Any],
     export_format: str = "markdown",
-    var: Dict[str, Any] = None,
-    var_file: List[str] = None,
+    config: Configuration = None,
+    secrets: Secrets = None,
 ) -> str:
     """
     Generate a report document from a chaostoolkit journal.
 
     The report is first generated from the markdown template and converted to
     the desired format using Pandoc.
     """
-    with io.open(journal_path) as fp:
-        journal = json.load(fp)
-
     # inject some pre-processed values into the journal for rendering
     experiment = journal["experiment"]
     cache_activities(experiment)
@@ -275,11 +270,6 @@ def generate_report(
 
     generate_chart_from_metric_probes(journal, export_format)
     add_contribution_model(journal, export_format)
-    config_vars, secret_vars = merge_vars(var, var_file) or (None, None)
-    config = load_configuration(
-        experiment.get("configuration", {}), config_vars
-    )
-    secrets = load_secrets(experiment.get("secrets", {}), secret_vars)
     template = get_report_template(
         journal["chaoslib-version"], configuration=config, secrets=secrets
     )
@@ -364,13 +354,23 @@ def get_report_template(
     env.globals["pretty_duration"] = lambda d0, d1: date.delta(
         dateparser.parse(d0), dateparser.parse(d1), words=False
     )[0]
-    env.globals["substitute"] = (
-        lambda args: {
-            k: substitute(v, configuration, secrets) for k, v in args.items()
-        }
-        if isinstance(args, dict)
-        else args
-    )
+
+    def substitution(args, is_tolerance: bool = False) -> Any:
+        if is_tolerance:
+            if isinstance(args, dict):
+                if args.get("type") == "probe":
+                    args = args.get("provider", {}).get("arguments")
+                    args.pop("value", None)
+
+        if isinstance(args, dict):
+            return {
+                k: substitute(v, configuration, secrets)
+                for k, v in args.items()
+            }
+
+        return substitute(args, configuration, secrets)
+
+    env.globals["substitute"] = substitution
 
     if not report_version:
         return env.get_template(default_template)

chaosreport/cli.py

@@ -1,10 +1,14 @@
 # -*- coding: utf-8 -*-
+import io
+import json
 import os
 from glob import glob
 from typing import Any, Dict, List
 
 import click
-from chaoslib import convert_vars
+from chaoslib import convert_vars, merge_vars
+from chaoslib.configuration import load_configuration
+from chaoslib.secret import load_secrets
 
 from chaosreport import generate_report, generate_report_header, save_report
 
@@ -70,7 +74,18 @@ def report(
     if len(journal) == 1 and not os.path.isfile(journal[0]):
         journal = glob(journal)
 
-    for journal in journal:
-        reports.append(generate_report(journal, export_format, var, var_file))
+    for journal_path in journal:
+        with io.open(journal_path) as fp:
+            j = json.load(fp)
+
+        experiment = j["experiment"]
+        config_vars, secret_vars = merge_vars(var, var_file) or (None, None)
+        config = load_configuration(
+            experiment.get("configuration", {}), config_vars
+        )
+        secrets = load_secrets(experiment.get("secrets", {}), secret_vars)
+
+        reports.append(generate_report(j, export_format, config, secrets))
+
     save_report(header, reports, report_path, export_format)
     click.echo("Report generated as '{f}'".format(f=report))

chaosreport/template/index.md

@@ -68,15 +68,15 @@ The steady state was {%if steady_states.before.steady_state_met %} verified {% e
 
 |  Probe                                                         |  Tolerance                  | Verified |
 | -------------------------------------------------------------- | --------------------------- | ------ | {% for probe in steady_states.before.probes %}
-| {{probe.activity.name}}     | {{probe.activity.tolerance}}         | {{probe.tolerance_met}} | {% endfor %}
+| {{probe.activity.name}}     | {{substitute(probe.activity.tolerance, True)}}         | {{probe.tolerance_met}} | {% endfor %}
 
 ##### After Run
 
 The steady state was {%if steady_states.after.steady_state_met %} verified {% else %} not verified. {% endif %}
 
 |  Probe                                                         |  Tolerance                  | Verified |
 | -------------------------------------------------------------- | --------------------------- | ------ | {% for probe in steady_states.after.probes %}
-| {{probe.activity.name}}     | {{probe.activity.tolerance}}         | {{probe.tolerance_met}} | {% endfor %}
+| {{probe.activity.name}}     | {{substitute(probe.activity.tolerance, True)}}         | {{probe.tolerance_met}} | {% endfor %}
 
 {% endif %}
 
@@ -106,8 +106,8 @@ The experiment was conducted on {{start|pretty_date}} and lasted roughly
 | **Started**           | {{item.start | pretty_date}} | 
 | **Ended**             | {{item.end | pretty_date}} |
 | **Duration**          | {{pretty_duration(item.start, item.end)}} | {% if item.activity.get("pauses", {}).get("before") %}
-| **Paused Before**     | {{item.activity.pauses.before}}s | {% endif %} {% if item.activity.get("pauses", {}).get("after") %}
-| **Paused After**      | {{item.activity.pauses.after}}s | {% endif %}
+| **Paused Before**     | {{substitute(item.activity.pauses.before)}}s | {% endif %} {% if item.activity.get("pauses", {}).get("after") %}
+| **Paused After**      | {{substitute(item.activity.pauses.after)}}s | {% endif %}
 
 The {{item.activity.type}} provider that was executed: