Use FQCN for roles where available (#1021)

* Use FQCN for roles where available

* Consistently apply resolved_role similar to resolved_action

* Change fallback value to normal task_action

* Fix issue where resolved_ vars were there on stats event

Author: AlanCoding

ansible_runner/display_callback/callback/awx_display.py

@@ -409,6 +409,7 @@ def set_task(self, task, local=False):
             task=(task.name or task.action),
             task_uuid=str(task._uuid),
             task_action=task.action,
+            resolved_action=getattr(task, 'resolved_action', task.action),
             task_args='',
         )
         try:
@@ -423,6 +424,10 @@ def set_task(self, task, local=False):
                 task_ctx['task_args'] = task_args
         if getattr(task, '_role', None):
             task_role = task._role._role_name
+            if hasattr(task._role, 'get_name'):
+                resolved_role = task._role.get_name()
+                if resolved_role != task_role:
+                    task_ctx['resolved_role'] = resolved_role
         else:
             task_role = getattr(task, 'role_name', '')
         if task_role:
@@ -433,7 +438,10 @@ def set_task(self, task, local=False):
             event_context.add_global(**task_ctx)
 
     def clear_task(self, local=False):
-        task_ctx = dict(task=None, task_path=None, task_uuid=None, task_action=None, task_args=None, role=None)
+        task_ctx = dict(
+            task=None, task_path=None, task_uuid=None, task_action=None, task_args=None, resolved_action=None,
+            role=None, resolved_role=None
+        )
         if local:
             event_context.remove_local(**task_ctx)
         else:
@@ -554,7 +562,6 @@ def v2_playbook_on_task_start(self, task, is_conditional):
             name=task.get_name(),
             is_conditional=is_conditional,
             uuid=task_uuid,
-            resolved_action=getattr(task, 'resolved_action', '')
         )
         with self.capture_event_data('playbook_on_task_start', **event_data):
             super(CallbackModule, self).v2_playbook_on_task_start(task, is_conditional)

test/fixtures/projects/collection_role/collections/ansible_collections/groovy/peanuts/README.md

@@ -0,0 +1,14 @@
+---
+authors:
+  - The pytest tmp_path
+dependencies: {}
+description: A collection for ansible-runner test test_include_role_from_collection_events.
+license:
+  - GPL-3.0-only
+name: peanuts
+namespace: groovy
+readme: README.md
+repository: https://peanuts.invalid
+tags:
+  - legume
+version: 1.0.0

test/fixtures/projects/collection_role/collections/ansible_collections/groovy/peanuts/galaxy.yml

@@ -0,0 +1,2 @@
+---
+- debug: msg="Hello peanuts!"

test/fixtures/projects/collection_role/collections/ansible_collections/groovy/peanuts/roles/hello/tasks/main.yml

@@ -0,0 +1 @@
+ANSIBLE_DEVEL_WARNING: no

test/fixtures/projects/collection_role/env/envvars

@@ -0,0 +1,5 @@
+all:
+  hosts:
+    testhost:
+      ansible_connection: local
+      ansible_python_interpreter: "{{ ansible_playbook_python }}"

test/fixtures/projects/collection_role/inventory/hosts

@@ -0,0 +1,4 @@
+- hosts: all
+  gather_facts: no
+  roles:
+    - name: groovy.peanuts.hello

test/fixtures/projects/collection_role/use_role.yml

@@ -137,5 +137,28 @@ def test_include_role_events(project_fixtures):
     for event in role_events:
         event_data = event['event_data']
         assert not event_data.get('warning', False)  # role use should not contain warnings
+        assert 'resolved_role' not in event_data  # should not specify FQCN name if not from collection
         if event['event'] == 'runner_on_ok':
             assert event_data['res']['msg'] == 'Hello world!'
+        if event['event'] == 'playbook_on_task_start':
+            assert event_data['resolved_action'] == 'ansible.builtin.debug'
+
+
+def test_include_role_from_collection_events(project_fixtures):
+    r = run(
+        private_data_dir=str(project_fixtures / 'collection_role'),
+        playbook='use_role.yml'
+    )
+    for event in r.events:
+        event_data = event['event_data']
+        assert not event_data.get('warning', False)  # role use should not contain warnings
+        if event['event'] in ('runner_on_ok', 'playbook_on_task_start', 'runner_on_start'):
+            assert event_data['role'] == 'hello'
+            assert event_data['resolved_role'] == 'groovy.peanuts.hello'
+        if event['event'] == 'runner_on_ok':
+            assert event_data['res']['msg'] == 'Hello peanuts!'
+        if event['event'] == 'playbook_on_task_start':
+            assert event_data['resolved_action'] == 'ansible.builtin.debug'
+        if event['event'] == 'playbook_on_stats':
+            assert 'resolved_role' not in event_data
+            assert 'resolved_action' not in event_data

test/integration/test_events.py

@@ -42,11 +42,11 @@ def test_run_async(tmp_path):
 def get_env_data(res):
     for event in res.events:
         found = bool(
-            event['event'] == 'runner_on_ok' and event.get(
+            event['event'] in ('runner_on_ok', 'runner_on_start', 'playbook_on_task_start') and event.get(
                 'event_data', {}
             ).get('task_action', None) == 'look_at_environment'
         )
-        if found:
+        if found and 'res' in event['event_data']:
             return event['event_data']['res']
     else:
         print('output:')