ansible.builtin.junit callback – write playbook output to a JUnit file.

Note

This callback plugin is part of ansible-core and included in all Ansible installations. In most cases, you can use the short plugin name junit even without specifying the collections: keyword. However, we recommend you use the FQCN for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same callback plugin name.

Synopsis

  • This callback writes playbook output to a JUnit formatted XML file.

  • Tasks show up in the report as follows: ‘ok’: pass ‘failed’ with ‘EXPECTED FAILURE’ in the task name: pass ‘failed’ with ‘TOGGLE RESULT’ in the task name: pass ‘ok’ with ‘TOGGLE RESULT’ in the task name: failure ‘failed’ due to an exception: error ‘failed’ for other reasons: failure ‘skipped’: skipped

Requirements

The below requirements are needed on the local controller node that executes this callback.

  • enable in configuration

Parameters

Parameter

Comments

fail_on_change

string

Consider any tasks reporting “changed” as a junit test failure

Default: “no”

Configuration:

  • Environment variable: JUNIT_FAIL_ON_CHANGE

fail_on_ignore

string

Consider failed tasks as a junit test failure even if ignore_on_error is set

Default: “no”

Configuration:

  • Environment variable: JUNIT_FAIL_ON_IGNORE

hide_task_arguments

string

added in 2.8 of ansible.builtin

Hide the arguments for a task

Default: “no”

Configuration:

  • Environment variable: JUNIT_HIDE_TASK_ARGUMENTS

include_setup_tasks_in_report

string

Should the setup tasks be included in the final report

Default: “yes”

Configuration:

  • Environment variable: JUNIT_INCLUDE_SETUP_TASKS_IN_REPORT

output_dir

string

Directory to write XML files to.

Default: “~/.ansible.log”

Configuration:

  • Environment variable: JUNIT_OUTPUT_DIR

replace_out_of_tree_path

string

added in 2.12.3 of ansible.builtin

Replace the directory portion of an out-of-tree relative task path with the given placeholder

Default: “none”

Configuration:

  • Environment variable: JUNIT_REPLACE_OUT_OF_TREE_PATH

task_class

string

Configure the output to be one class per yaml file

Default: “no”

Configuration:

  • Environment variable: JUNIT_TASK_CLASS

task_relative_path

string

added in 2.8 of ansible.builtin

Configure the output to use relative paths to given directory

Default: “none”

Configuration:

  • Environment variable: JUNIT_TASK_RELATIVE_PATH

test_case_prefix

string

added in 2.8 of ansible.builtin

Consider a task only as test case if it has this value as prefix. Additionally failing tasks are recorded as failed test cases.

Default: “\u003cempty\u003e”

Configuration:

  • Environment variable: JUNIT_TEST_CASE_PREFIX

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.