Add custom tag to skip the default callback

Author: Arvind Jangir

src/ansible.cfg

@@ -4,4 +4,4 @@ roles_path = ./roles
 filter_plugins = ./filter_plugins
 callback_plugins = ./callback_plugins
 callback_result_format = yaml
-stdout_callback = foremanctl
+stdout_callback = foremanctl

src/callback_plugins/foremanctl.py

@@ -1,5 +1,4 @@
 from ansible.plugins.callback.default import CallbackModule as DefaultCallbackModule
-from os.path import basename
 
 DOCUMENTATION = """
     name: foremanctl
@@ -22,12 +21,11 @@ class CallbackModule(DefaultCallbackModule):
     CALLBACK_NAME = 'foremanctl'
 
     FALLBACK_TO_DEFAULT = True
-    PLAYBOOKS_TO_SKIP_DEFAULT = ['features.yaml']
 
     def v2_playbook_on_start(self, playbook):
-        playbook_filename = basename(playbook._file_name)
-
-        if playbook_filename in self.PLAYBOOKS_TO_SKIP_DEFAULT:
+        plays = playbook.get_plays()
+        tags = plays[0].tags
+        if 'foremanctl_suppress_default_output' in tags:
             self.FALLBACK_TO_DEFAULT = False
         if self.FALLBACK_TO_DEFAULT:
             super().v2_playbook_on_start(playbook)
@@ -49,4 +47,4 @@ def v2_runner_on_ok(self, result):
 
     def v2_playbook_on_stats(self, stats):
         if self.FALLBACK_TO_DEFAULT:
-            super().v2_playbook_on_stats(stats)
+            super().v2_playbook_on_stats(stats)

src/filter_plugins/foremanctl.py

@@ -30,14 +30,14 @@ def known_foreman_plugins(_value):
     plugins = [FEATURE_MAP.get(feature).get('foreman', {}).get('plugin_name') for feature in FEATURE_MAP.keys()]
     return compact_list(plugins)
 
-def feature_list(value):
+def list_all_features(enabled_features):
     enabled_list = []
     available_list = []
     for name, meta in FEATURE_MAP.items():
         if meta.get('internal', False):
             continue
         description = meta.get('description', '')
-        if name in value:
+        if name in enabled_features:
             enabled_list.append((name, 'enabled', description))
         else:
             available_list.append((name, 'available', description))
@@ -57,5 +57,5 @@ def filters(self):
         return {
             'features_to_foreman_plugins': foreman_plugins,
             'known_foreman_plugins': known_foreman_plugins,
-            'feature_list': feature_list,
+            'list_all_features': list_all_features,
         }

src/playbooks/features/features.yaml

@@ -2,11 +2,13 @@
 - name: List features
   hosts: quadlet
   gather_facts: false
+  tags:
+    - foremanctl_suppress_default_output
   vars_files:
     - "../../vars/defaults.yml"
     - "../../vars/flavors/{{ flavor }}.yml"
     - "../../vars/base.yaml"
   tasks:
     - name: Print features
       ansible.builtin.debug:
-        msg: "{{ enabled_features | feature_list }}"
+        msg: "{{ enabled_features | list_all_features }}"

tests/features_test.py

@@ -1,13 +1,13 @@
-import os
+import subprocess
 
-def test_foremanctl_features(capfd):
-    result = os.system('./foremanctl features')
+def test_foremanctl_features():
+    command = ['./foremanctl', 'features']
+    result = subprocess.run(command, capture_output=True, text=True)
 
-    captured = capfd.readouterr()
-    assert result == 0
+    assert result.returncode == 0
 
     for noise in ['PLAY [', 'TASK [', 'ok:', 'changed:', 'PLAY RECAP']:
-        assert noise not in captured.out, f"Ansible output not suppressed: found '{noise}'"
+        assert noise not in result.stdout, f"Ansible output not suppressed: found '{noise}'"
 
     for feature in ['foreman', 'foreman-proxy', 'azure_rm']:
-        assert feature in captured.out, f"Expected feature '{feature}' in output"
+        assert feature in result.stdout, f"Expected feature '{feature}' in output"