rewriting this to work differently

Author: djdanielsson

roles/collect_async_status/README.md

@@ -8,66 +8,42 @@ This is an internal role that is not meant to be called directly by users of thi
 
 ## Task Files
 
-The role provides composable task files. `main.yml` loops over a configurable list of task files to include, so callers can control exactly which steps run and avoid unnecessary output.
-
-### Available task files
-
-|Task File|Description|Self-guarded|
-|:---|:---|:---:|
-|`collect_async_status.yml`|Polls `async_status` until the async job completes. Registers the result in `__cas_job_async_result`. Uses `failed_when: false` so subsequent task files can inspect the result.|no|
-|`register_value.yml`|Registers the async result into a caller-specified variable. Only runs when `aap_configuration_register` or the item's `register` field is defined.|yes|
-|`handle_error.yml`|Handles failed async results. Only runs when `__cas_job_async_result` is failed. In fail-fast mode (default), fails immediately with the error message and API response detail. In log-collection mode (`aap_configuration_collect_logs: true`), collects errors into `aap_configuration_role_errors` and continues.|yes|
-
-### Controlling which task files run
+|Task File|Description|
+|:---|:---|
+|`collect_async_status.yml`|Polls `async_status` until the async job completes. If `cas_collect_errors` is `true` and the result failed, automatically includes `handle_error.yml`.|
+|`handle_error.yml`|Handles failed async results. In fail-fast mode (default), fails immediately. In log-collection mode (`aap_configuration_collect_logs: true`), collects errors into `aap_configuration_role_errors` and continues.|
+|`register_value.yml`|Registers the async result into a caller-specified variable. Only runs when `aap_configuration_register` or the item's `register` field is defined.|
 
-`main.yml` iterates over the `cas_task_files` list variable. The default is:
+### Enabling error collection
 
-```yaml
-cas_task_files:
-  - collect_async_status.yml
-  - handle_error.yml
-```
+Error handling via `handle_error.yml` is only included when `cas_collect_errors` is `true`. Each calling role passes its own `<prefix>_collect_errors` variable, which defaults to the global `aap_configuration_collect_errors`:
 
-Files are included in list order. Each file is self-guarded (has its own `when` conditions), so it is safe to include files that may not apply — they will skip cleanly.
+- **Per-role**: Set `<prefix>_collect_errors: true` (e.g. `controller_configuration_applications_collect_errors: true`)
+- **Global**: Set `aap_configuration_collect_errors: true` to enable error handling for all roles
 
-To customize, pass `cas_task_files` in the caller's `vars`:
+When `cas_collect_errors` is `false` (default), the `handle_error.yml` include is skipped entirely, keeping output clean.
 
 ```yaml
-# Only poll, no error handling (caller handles errors itself)
-- ansible.builtin.include_role:
-    name: infra.aap_configuration.collect_async_status
-  vars:
-    cas_task_files:
-      - collect_async_status.yml
-
-# Poll + register + error handling
 - ansible.builtin.include_role:
     name: infra.aap_configuration.collect_async_status
+  loop: "{{ __job_async.results }}"
   vars:
-    cas_task_files:
-      - collect_async_status.yml
-      - register_value.yml
-      - handle_error.yml
-```
-
-Individual files can also be included directly using `tasks_from`:
-
-```yaml
-- ansible.builtin.include_role:
-    name: infra.aap_configuration.collect_async_status
-    tasks_from: collect_async_status.yml
+    cas_collect_errors: "{{ controller_configuration_applications_collect_errors }}"
+    cas_job_async_results_item: "{{ __job_async_results_item }}"
+    # ... other vars ...
 ```
 
 ## Variables
 
 |Variable Name|Default Value|Required|Description|
 |:---|:---:|:---:|:---|
 |`cas_job_async_results_item`||yes|The asynchronous item to check the status of. This must be from the registered `async` task|
-|`cas_task_files`|`[collect_async_status.yml, handle_error.yml]`|no|Ordered list of task files to include. Controls which steps run and their order.|
+|`cas_collect_errors`|`{{ aap_configuration_collect_errors \| default(false) }}`|no|When `true` and the async result has failed, `collect_async_status.yml` automatically includes `handle_error.yml`. Each calling role passes its own `<prefix>_collect_errors` variable.|
 |`cas_error_list_var_name`||yes|The name of the dictionary key to use when collecting errors|
 |`cas_register_subvar`||yes|The name of the dictionary key to use when registering values|
 |`cas_object_label`||no|Custom task label for the async_status polling task. When provided, replaces the default task name for better output readability.|
 |`cas_collect_logs`|`{{ aap_configuration_collect_logs \| default(false) }}`|no|When `true`, async task failures are suppressed (`failed_when: false`) so that `handle_error.yml` can collect error details and continue execution. Errors are collected in `aap_configuration_role_errors`. When `false` (default), the async task fails immediately on error.|
+|`aap_configuration_collect_errors`|`false`|no|Global toggle to enable error collection for all roles. Each role's `<prefix>_collect_errors` defaults to this value.|
 
 ### Error Output
 

roles/collect_async_status/defaults/main.yml

@@ -3,4 +3,5 @@ cas_async_retries: "{{ aap_configuration_async_retries | default(50) }}"
 cas_async_delay: "{{ aap_configuration_async_delay | default(1) }}"
 cas_secure_logging: "{{ aap_configuration_secure_logging | default('false') }}"
 cas_collect_logs: "{{ aap_configuration_collect_logs | default(false) }}"
+cas_collect_errors: "{{ aap_configuration_collect_errors | default(false) }}"
 ...

roles/collect_async_status/tasks/collect_async_status.yml

@@ -1,10 +1,10 @@
 ---
 - name: handle_error | Handle Errors Block
-  when: __cas_job_async_result is defined and __cas_job_async_result is failed
-  no_log: "{{ cas_secure_logging }}"
+  when: __cas_job_async_result is defined and __cas_job_async_result.status is defined and __cas_job_async_result.status == 'failed'
   block:
     - name: handle_error | Show error and stop execution
-      when: not cas_collect_logs | bool
+      no_log: "{{ cas_secure_logging }}"
+      when: not (cas_collect_logs | bool or cas_collect_errors | bool)
       vars:
         __cas_response: "{{ __cas_job_async_result['response'] | default({}) }}"
         __cas_response_detail: >-
@@ -43,6 +43,7 @@
           }}
 
     - name: handle_error | Build consolidated list of failed objects and the error
+      no_log: "{{ cas_secure_logging }}"
       vars:
         __cas_response: "{{ __cas_job_async_result['response'] | default({}) }}"
         __new_error: >-

roles/collect_async_status/tasks/handle_error.yml

@@ -1,13 +1,16 @@
 ---
-- name: Include async status tasks
+- name: "{{ cas_object_label | default('collect_async_status | Wait for async job to complete') }}"
+  no_log: "{{ cas_secure_logging }}"
+  ansible.builtin.async_status:
+    jid: "{{ cas_job_async_results_item.ansible_job_id }}"
+  register: __cas_job_async_result
+  until: __cas_job_async_result.finished
+  retries: "{{ cas_async_retries }}"
+  delay: "{{ cas_async_delay }}"
+  failed_when: __cas_job_async_result is failed and not (cas_collect_logs | bool or cas_collect_errors | bool)
+
+- name: "Handle errors"
+  when: cas_collect_errors | bool and __cas_job_async_result is defined and __cas_job_async_result.status is defined and __cas_job_async_result.status == 'failed'
   ansible.builtin.include_tasks:
-    file: "{{ __cas_task_file }}"
-  loop: "{{ cas_task_files | default(__cas_default_task_files) }}"
-  loop_control:
-    loop_var: __cas_task_file
-    label: "{{ __cas_task_file }}"
-  vars:
-    __cas_default_task_files:
-      - collect_async_status.yml
-      - handle_error.yml
+    file: handle_error.yml
 ...

roles/collect_async_status/tasks/main.yml

@@ -7,4 +7,5 @@ controller_configuration_applications_async_delay: "{{ aap_configuration_async_d
 controller_configuration_applications_loop_delay: "{{ aap_configuration_loop_delay | default(0) }}"
 aap_configuration_async_dir:
 controller_configuration_applications_enforce_defaults: "{{ aap_configuration_enforce_defaults | default(false) }}"
+controller_configuration_applications_collect_errors: "{{ aap_configuration_collect_errors | default(false) }}"
 ...

roles/collect_async_status/tasks/register_value.yml

@@ -3,9 +3,9 @@
 - name: Manage Controller Applications Block
   vars:
     ansible_async_dir: "{{ aap_configuration_async_dir }}"
-  no_log: "{{ controller_configuration_applications_secure_logging }}"
   block:
     - name: Managing Controller Applications
+      no_log: "{{ controller_configuration_applications_secure_logging }}"
       ansible.controller.application:
         name: "{{ __application_item.name | mandatory }}"
         new_name: "{{ __application_item.new_name | default(omit, true) }}"
@@ -53,6 +53,7 @@
         label: "{{ __operation.verb }} Controller Application {{ __applications_job_async_results_item.__application_item.name }} | Wait for finish the Application {{
           __operation.action }}"
       vars:
+        cas_collect_errors: "{{ controller_configuration_applications_collect_errors }}"
         cas_secure_logging: "{{ controller_configuration_applications_secure_logging }}"
         cas_async_delay: "{{ controller_configuration_applications_async_delay }}"
         cas_async_retries: "{{ controller_configuration_applications_async_retries }}"

roles/controller_applications/defaults/main.yml

@@ -4,4 +4,5 @@ controller_configuration_bulk_hosts_async_retries: "{{ aap_configuration_async_r
 controller_configuration_bulk_hosts_async_delay: "{{ aap_configuration_async_delay | default(1) }}"
 controller_configuration_bulk_hosts_loop_delay: "{{ aap_configuration_loop_delay | default(0) }}"
 aap_configuration_async_dir:
+controller_configuration_bulk_hosts_collect_errors: "{{ aap_configuration_collect_errors | default(false) }}"
 ...

roles/controller_applications/tasks/main.yml

@@ -2,10 +2,10 @@
 - name: Manage Controller hosts in bulk Block
   vars:
     ansible_async_dir: "{{ aap_configuration_async_dir }}"
-  no_log: "{{ controller_configuration_bulk_hosts_secure_logging }}"
   block:
     # Create controller hosts
     - name: Add Controller hosts in bulk
+      no_log: "{{ controller_configuration_bulk_hosts_secure_logging }}"
       ansible.controller.bulk_host_create:
         hosts: "{{ __controller_bulk_hosts_item.hosts }}"
         inventory: "{{ __controller_bulk_hosts_item.inventory }}"
@@ -41,6 +41,7 @@
       loop_control:
         loop_var: __controller_bulk_hosts_job_async_results_item
       vars:
+        cas_collect_errors: "{{ controller_configuration_bulk_hosts_collect_errors }}"
         cas_secure_logging: "{{ controller_configuration_bulk_hosts_secure_logging }}"
         cas_async_delay: "{{ controller_configuration_bulk_hosts_async_delay }}"
         cas_async_retries: "{{ controller_configuration_bulk_hosts_async_retries }}"