feat: implement banner output (ansible#625)

Adds banner-type output to ansible-rulebook in the manner previously
demonstrated.

There's an open question as to how we want to handle outputting events
in rule_set_runner.py.
The previous code disabled args.print_events if verbosity was 2+ as the
logging would output the event.
We shouldn't have two different forms of output for the same data and
I'd opt for only the args.print_event form in all cases for consistency
unless there's specific, great enough value in using the logger when
verbosity is 2+.
At present, this code forcibly enables args.print_events when verbosity
is 2+ so both forms are output.

---------

Signed-off-by: Joe Shimkus <[email protected]>

CHANGELOG.md

@@ -8,6 +8,9 @@
 - Support for standalone boolean in conditions
 - Add basic auth to controller
 
+### Changed
+- Generic print as well as printing of events use new banner style
+
 ### Fixed
 
 ## [1.0.4] - 2023-10-30

ansible_rulebook/action/debug.py

@@ -15,12 +15,11 @@
 import logging
 import sys
 from dataclasses import asdict
-from pprint import pprint
 
 import dpath
 from drools import ruleset as lang
 
-from ansible_rulebook.util import get_horizontal_rule
+from ansible_rulebook import terminal
 
 from .control import Control
 from .helper import Helper
@@ -41,28 +40,26 @@ class Debug:
     def __init__(self, metadata: Metadata, control: Control, **action_args):
         self.helper = Helper(metadata, control, "debug")
         self.action_args = action_args
+        self.display = terminal.Display()
 
     async def __call__(self):
         if "msg" in self.action_args:
             messages = self.action_args.get("msg")
             if not isinstance(messages, list):
                 messages = [messages]
             for msg in messages:
-                print(msg)
+                self.display.banner("debug", msg)
         elif "var" in self.action_args:
             key = self.action_args.get("var")
             try:
-                print(
-                    dpath.get(
-                        self.helper.control.variables, key, separator="."
-                    )
+                value = dpath.get(
+                    self.helper.control.variables, key, separator="."
                 )
+                self.display.banner("debug", f"{key}: {value}")
             except KeyError:
                 logger.error("Key %s not found in variable pool", key)
                 raise
         else:
-            print(get_horizontal_rule("="))
-            print("kwargs:")
             args = asdict(self.helper.metadata)
             project_data_file = self.helper.control.project_data_file
             args.update(
@@ -73,11 +70,12 @@ async def __call__(self):
                     "project_data_file": project_data_file,
                 }
             )
-            pprint(args)
-            print(get_horizontal_rule("="))
-            print("facts:")
-            pprint(lang.get_facts(self.helper.metadata.rule_set))
-            print(get_horizontal_rule("="))
+            self.display.banner("debug: kwargs", args, pretty=True)
+            self.display.banner(
+                "debug: facts",
+                lang.get_facts(self.helper.metadata.rule_set),
+                pretty=True,
+            )
 
         sys.stdout.flush()
         await self.helper.send_default_status()

ansible_rulebook/action/print_event.py

@@ -13,8 +13,8 @@
 #  limitations under the License.
 
 import sys
-from pprint import pprint
-from typing import Callable
+
+from ansible_rulebook import terminal
 
 from .control import Control
 from .helper import Helper
@@ -30,16 +30,17 @@ class PrintEvent:
     def __init__(self, metadata: Metadata, control: Control, **action_args):
         self.helper = Helper(metadata, control, "print_event")
         self.action_args = action_args
+        self.display = terminal.Display()
 
     async def __call__(self):
-        print_fn: Callable = print
-        if self.action_args.get("pretty", False):
-            print_fn = pprint
-
         var_name = (
             "events" if "events" in self.helper.control.variables else "event"
         )
 
-        print_fn(self.helper.control.variables[var_name])
+        self.display.banner(
+            "event",
+            self.helper.control.variables[var_name],
+            pretty=self.action_args.get("pretty", False),
+        )
         sys.stdout.flush()
         await self.helper.send_default_status()

ansible_rulebook/action/shutdown.py

@@ -14,6 +14,7 @@
 
 from ansible_rulebook.exception import ShutdownException
 from ansible_rulebook.messages import Shutdown as ShutdownMessage
+from ansible_rulebook.terminal import Display
 from ansible_rulebook.util import run_at
 
 from .control import Control
@@ -43,16 +44,12 @@ async def __call__(self):
                 "kind": kind,
             }
         )
-        print(
-            "Ruleset: %s rule: %s has initiated shutdown of type: %s. "
-            "Delay: %.3f seconds, Message: %s"
-            % (
-                self.helper.metadata.rule_set,
-                self.helper.metadata.rule,
-                kind,
-                delay,
-                message,
-            )
+        Display.instance().banner(
+            "ruleset",
+            f"{self.helper.metadata.rule_set}"
+            f" rule: {self.helper.metadata.rule}"
+            f" has initiated shutdown of type: {kind}."
+            f" Delay: {delay:.3f} seconds, Message: {message}",
         )
         raise ShutdownException(
             ShutdownMessage(message=message, delay=delay, kind=kind)

ansible_rulebook/cli.py

@@ -33,11 +33,14 @@
 
 import ansible_rulebook  # noqa: E402
 from ansible_rulebook import app  # noqa: E402
+from ansible_rulebook import terminal  # noqa: E402
 from ansible_rulebook.conf import settings  # noqa: E402
 from ansible_rulebook.job_template_runner import (  # noqa: E402
     job_template_runner,
 )
 
+display = terminal.Display()
+
 DEFAULT_VERBOSITY = 0
 
 logger = logging.getLogger(__name__)
@@ -227,11 +230,15 @@ def setup_logging(args: argparse.Namespace) -> None:
     if args.verbosity >= 2:
         level = logging.DEBUG
         stream = sys.stdout
-        args.print_events = False
     elif args.verbosity == 1:
         level = logging.INFO
         stream = sys.stdout
 
+    # As Display is a singleton if it was created elsewhere we may need to
+    # adjust the level.
+    if display.level > level:
+        display.level = level
+
     logging.basicConfig(stream=stream, level=level, format=LOG_FORMAT)
     logging.getLogger("drools.").setLevel(level)
 
@@ -244,6 +251,7 @@ def main(args: List[str] = None) -> int:
 
     args = parser.parse_args(args)
     validate_args(args)
+    setup_logging(args)
 
     if args.controller_url:
         job_template_runner.host = args.controller_url
@@ -271,8 +279,6 @@ def main(args: List[str] = None) -> int:
     if args.execution_strategy:
         settings.default_execution_strategy = args.execution_strategy
 
-    setup_logging(args)
-
     try:
         asyncio.run(app.run(args))
     except KeyboardInterrupt:

ansible_rulebook/collection.py

@@ -20,6 +20,8 @@
 
 import yaml
 
+from ansible_rulebook import terminal
+
 ANSIBLE_GALAXY = shutil.which("ansible-galaxy")
 EDA_PATH_PREFIX = "extensions/eda"
 
@@ -130,7 +132,9 @@ def load_rulebook(collection, rulebook):
     if not location:
         return False
     with open(location) as f:
-        print(f"Loading rulebook from {location}")
+        terminal.Display.instance().banner(
+            "collection", f"Loading rulebook from {location}"
+        )
         return yaml.safe_load(f.read())
 
 

ansible_rulebook/rule_set_runner.py

@@ -16,7 +16,7 @@
 import gc
 import logging
 import uuid
-from pprint import PrettyPrinter, pformat
+from pprint import pformat
 from types import MappingProxyType
 from typing import Dict, List, Optional, Union, cast
 
@@ -28,6 +28,7 @@
 )
 from drools.ruleset import session_stats
 
+from ansible_rulebook import terminal
 from ansible_rulebook.action.control import Control
 from ansible_rulebook.action.debug import Debug
 from ansible_rulebook.action.metadata import Metadata
@@ -102,6 +103,7 @@ def __init__(
         self.active_actions = set()
         self.broadcast_method = broadcast_method
         self.event_counter = 0
+        self.display = terminal.Display()
 
     async def run_ruleset(self):
         tasks = []
@@ -203,12 +205,20 @@ async def _drain_source_queue(self):
         try:
             while True:
                 data = await self.ruleset_queue_plan.source_queue.get()
+                # Default to output events at debug level.
+                level = logging.DEBUG
+
+                # If print_events is specified adjust the level to the
+                # display's current level to guarantee output.
                 if self.parsed_args and self.parsed_args.print_events:
-                    PrettyPrinter(indent=4).pprint(data)
+                    level = self.display.level
+
+                self.display.banner("received event", level=level)
+                self.display.output(f"Ruleset: {self.name}", level=level)
+                self.display.output("Event:", level=level)
+                self.display.output(data, pretty=True, level=level)
+                self.display.banner(level=level)
 
-                logger.debug(
-                    "Ruleset: %s, received event: %s ", self.name, str(data)
-                )
                 if isinstance(data, Shutdown):
                     self.shutdown = data
                     return await self._handle_shutdown()