TELCOV10N-452 ADD role junit2json

The role converts reports into json, optionally merging multiple fragments into 1 report in loadable json format
- added:
    - role code
    - initial tests
    - example playbook
    - role `README.md` using:

            docsible -g -nob -nop -r roles/junit2json -p roles/junit2json/examples/example_playbook.yml
- updated:
    - `galaxy.yml` - upd author
    - collection `README.md`
        - filter plugin `redhatci.ocp.junit2obj`
        - role `redhatci.ocp.junit2json`

Signed-off-by: Maxim Kovgan <makovgan@redhat.com>

README.md

@@ -81,6 +81,7 @@ Name | Description
 [redhatci.ocp.installer](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/installer/README.md) | [IPI installer](https://github.com/openshift-kni/baremetal-deploy)
 [redhatci.ocp.install_operator_gitops](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/install_operator_gitops/README.md) | Installs and configures the openshift-gitops-operator so it can be used for ZTP deployments. Installation is optional and may be skipped by setting the variable ```ioc_configure_only: true``
 [redhatci.ocp.jenkins_job_launcher](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/jenkins_job_launcher/README.md) | Launch Jenkins jobs
+[redhatci.ocp.junit2json](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/junit2json/README.md) | Convert JUnit XML files into JSON for reporting/observability role
 [redhatci.ocp.k8s_best_practices_certsuite](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/k8s_best_practices_certsuite/README.md) | Executes the [Red Hat Best Practices Test Suite for Kubernetes](https://github.com/redhat-best-practices-for-k8s/certsuite) tool.
 [redhatci.ocp.kvirt_vm](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/kvirt_vm/README.md) | Deployment of Kubevirt virtual machines.
 [redhatci.ocp.label_nodes](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/label_nodes/README.md) | Applies labels defined at inventory level to the OCP cluster nodes.
@@ -161,6 +162,7 @@ Name | Description
 Name | Type | Description
 --- | --- | ---
 [redhatci.ocp.junit2dict]() | Filter | Transforms a JUnit into a dictionary
+[redhatci.ocp.junit2obj]() | Filter | Transforms a JUnit into a corresponding JSON text (will replace `redhatci.ocp.junit2dict`)
 [redhatci.ocp.ocp_compatibility]() | Filter | Parse the deprecated and to-be-deprecated API after the workload installation
 [redhatci.ocp.regex_diff]() | Filter | Obtain differences between two lists
 [redhatci.ocp.get_compatible_rhocp_repo]() | Module | A module to find the latest available version of the RHOCP repository

galaxy.yml

@@ -54,6 +54,7 @@ authors:
   - "Keith Schincke <keith.schincke+github@gmail.com>"
   - "Manuel Rodriguez <manuel.rodriguez@redhat.com>"
   - "Marek Kochanowski <mkochanowski@redhat.com>"
+  - "Max Kovgan <makovgan@redhat.com>"
   - "mbpavan <pbheeman@redhat.com>"
   - "Michele Costa <micosta@redhat.com>"
   - "Murali Krishnasamy <70236227+mukrishn@users.noreply.gihub.com>"

roles/junit2json/README.md

@@ -0,0 +1,319 @@
+<!-- DOCSIBLE START -->
+
+# 📃 Role overview
+
+## junit2json
+
+
+
+Description: Converts XML junit reports passed or in passed directory into single or fragmented JSON report file(s)
+
+
+
+
+
+
+
+<details>
+<summary><b>🧩 Argument Specifications in meta/argument_specs</b></summary>
+
+#### Key: main 
+**Description**: The resulting JSON file(s) are of the same structure for all the teams' and CI systems and used later to be sent to the data collection system.
+This is the main entrypoint for the role `redhatci.ocp.junit2json`.
+Scans all the XML reports passed as `junit2json_input_reports_list`, scans folders for files matching `global_reports_path_patterns`.
+Converts XMLs into JSON, if variable `junit2json_do_merge` is `true` XMLs are merged into one.
+New filenames are based on the old ones and stored in `global_json_reports_list` global variable
+
+
+
+  - **junit2json_input_reports_list**
+    - **Required**: True
+    - **Type**: list
+    - **Default**: none
+    - **Description**: Mixed List files (and/or directories) containing the XML report(s) to convert
+
+
+
+
+
+  - **junit2json_output_dir**
+    - **Required**: True
+    - **Type**: str
+    - **Default**: none
+    - **Description**: Output directory for resulting report JSON file path(s)
+
+
+
+
+
+  - **junit2json_do_merge**
+    - **Required**: False
+    - **Type**: bool
+    - **Default**: True
+    - **Description**: Should we merge data of converted reports into 1 file or not.
+When `false`, each report `XML` file is converted to a corresponding json file appended `.json` extension
+Otherwise, resulting merged report is named as the directory, with `.report.json` extension.
+in both cases, the result is stored under `junit2json_output_dir`.
+
+
+
+
+
+  - **junit2json_input_merged_report**
+    - **Required**: False
+    - **Type**: str
+    - **Default**: none
+    - **Description**: Relative file name for the Merged XML report (relevant only when `junit2json_do_merge` is `true`),
+it is generated under `junit2json_output_dir`
+
+
+
+
+
+  - **junit2json_output_merged_report**
+    - **Required**: False
+    - **Type**: str
+    - **Default**: none
+    - **Description**: Relative file name for the JSON report (relevant only when `junit2json_do_merge` is `true`),
+it is generated under `junit2json_output_dir`
+
+
+
+
+
+
+
+</details>
+
+
+### Defaults
+
+**These are static variables with lower priority**
+
+#### File: defaults/main.yml
+
+| Var          | Type         | Value       |Required    | Title       |
+|--------------|--------------|-------------|-------------|-------------|
+| [junit2json_hash](defaults/main.yml#L5)   | str   | `sha256` |    n/a  |  n/a |
+| [junit2json_debug](defaults/main.yml#L6)   | bool   | `False` |    n/a  |  n/a |
+| [junit2json_do_merge](defaults/main.yml#L7)   | bool   | `True` |    n/a  |  n/a |
+
+
+
+
+
+### Tasks
+
+
+#### File: tasks/convert.yml
+
+| Name | Module | Has Conditions |
+| ---- | ------ | --------- |
+| Read file content | ansible.builtin.set_fact | False |
+| Generate content hash from the content | ansible.builtin.set_fact | False |
+| Print curr XML report filename | ansible.builtin.debug | True |
+| Obtain info on previous content checksum file | ansible.builtin.stat | False |
+| Update junit2json_result_data [junit2json_do_merge: true] | ansible.builtin.set_fact | True |
+| Convert junit XML to JSON and save in junit2json_result_data | ansible.builtin.set_fact | True |
+| Setup JSON report file name [xml_report.endswith('.xml'): true] | ansible.builtin.set_fact | True |
+| Setup JSON report file name [xml_report.endswith('.xml'): false] | ansible.builtin.set_fact | True |
+| Update junit2json_output_report_path [junit2json_do_merge: true] | ansible.builtin.set_fact | True |
+| Update junit2json_output_report_path [junit2json_do_merge: false] | ansible.builtin.set_fact | True |
+| Get xml_old_hash | ansible.builtin.set_fact | True |
+| Update global_json_reports_list | ansible.builtin.set_fact | False |
+| Ensure json data destination folder | ansible.builtin.file | True |
+| Write json data to destination | ansible.builtin.copy | True |
+| Write current hash to destination | ansible.builtin.copy | True |
+
+#### File: tasks/merge.yml
+
+| Name | Module | Has Conditions |
+| ---- | ------ | --------- |
+| Generate XML files list | ansible.builtin.set_fact | False |
+| Print XML reports' filenames data | ansible.builtin.debug | True |
+| Merge multiple JUnit XML files into single consolidated report | ansible.builtin.shell | False |
+| Write merge resulting file | ansible.builtin.copy | True |
+| Override the xml files list for conversion | ansible.builtin.set_fact | False |
+
+#### File: tasks/expand.yml
+
+| Name | Module | Has Conditions |
+| ---- | ------ | --------- |
+| Print path_item value | ansible.builtin.debug | False |
+| Setup helper variable | ansible.builtin.set_fact | False |
+| Check whether the path_item is a directory | ansible.builtin.stat | False |
+| Add path_item as a JUnit XML report [stat.isdir: false] | ansible.builtin.set_fact | True |
+| Find JUnit XML reports under path_item [stat.isdir: true] | ansible.builtin.find | True |
+| Setup the conversion list | ansible.builtin.set_fact | True |
+| Setup the default list for conversion | ansible.builtin.set_fact | True |
+
+#### File: tasks/main.yml
+
+| Name | Module | Has Conditions |
+| ---- | ------ | --------- |
+| Validate some variables | ansible.builtin.assert | False |
+| Initialize input reports variable | ansible.builtin.debug | False |
+| Initialize reports variable | ansible.builtin.set_fact | False |
+| Expand the input list to list of existing files | ansible.builtin.include_tasks | False |
+| Merge JUnit XML reports into single file [junit2json_do_merge: true] | ansible.builtin.include_tasks | True |
+| Convert XML to JSON | ansible.builtin.include_tasks | True |
+
+
+## Task Flow Graphs
+
+
+
+### Graph for convert.yml
+
+```mermaid
+flowchart TD
+Start
+classDef block stroke:#3498db,stroke-width:2px;
+classDef task stroke:#4b76bb,stroke-width:2px;
+classDef includeTasks stroke:#16a085,stroke-width:2px;
+classDef importTasks stroke:#34495e,stroke-width:2px;
+classDef includeRole stroke:#2980b9,stroke-width:2px;
+classDef importRole stroke:#699ba7,stroke-width:2px;
+classDef includeVars stroke:#8e44ad,stroke-width:2px;
+classDef rescue stroke:#665352,stroke-width:2px;
+
+  Start-->|Task| Read_file_content0[read file content]:::task
+  Read_file_content0-->|Task| Generate_content_hash_from_the_content1[generate content hash from the content]:::task
+  Generate_content_hash_from_the_content1-->|Task| Print_curr_XML_report_filename2[print curr xml report filename<br>When: **junit2json debug**]:::task
+  Print_curr_XML_report_filename2-->|Task| Obtain_info_on_previous_content_checksum_file3[obtain info on previous content checksum file]:::task
+  Obtain_info_on_previous_content_checksum_file3-->|Task| Update_junit2json_result_data__junit2json_do_merge__true_4[update junit2json result data  junit2json do merge<br> true <br>When: **junit2json do merge**]:::task
+  Update_junit2json_result_data__junit2json_do_merge__true_4-->|Task| Convert_junit_XML_to_JSON_and_save_in_junit2json_result_data5[convert junit xml to json and save in junit2json<br>result data<br>When: **not junit2json do merge**]:::task
+  Convert_junit_XML_to_JSON_and_save_in_junit2json_result_data5-->|Task| Setup_JSON_report_file_name__xml_report_endswith___xml____true_6[setup json report file name  xml report endswith  <br>xml    true <br>When: **not junit2json do merge  and xml report endswith  <br>xml**]:::task
+  Setup_JSON_report_file_name__xml_report_endswith___xml____true_6-->|Task| Setup_JSON_report_file_name__xml_report_endswith___xml____false_7[setup json report file name  xml report endswith  <br>xml    false <br>When: **not junit2json do merge  and not xml report<br>endswith   xml**]:::task
+  Setup_JSON_report_file_name__xml_report_endswith___xml____false_7-->|Task| Update_junit2json_output_report_path__junit2json_do_merge__true_8[update junit2json output report path  junit2json<br>do merge  true <br>When: **junit2json do merge**]:::task
+  Update_junit2json_output_report_path__junit2json_do_merge__true_8-->|Task| Update_junit2json_output_report_path__junit2json_do_merge__false_9[update junit2json output report path  junit2json<br>do merge  false <br>When: **not junit2json do merge**]:::task
+  Update_junit2json_output_report_path__junit2json_do_merge__false_9-->|Task| Get_xml_old_hash10[get xml old hash<br>When: **junit2json old hash stat stat exists**]:::task
+  Get_xml_old_hash10-->|Task| Update_global_json_reports_list11[update global json reports list]:::task
+  Update_global_json_reports_list11-->|Task| Ensure_json_data_destination_folder12[ensure json data destination folder<br>When: **junit2json xml report hash curr    junit2json xml<br>report hash old**]:::task
+  Ensure_json_data_destination_folder12-->|Task| Write_json_data_to_destination13[write json data to destination<br>When: **junit2json xml report hash curr    junit2json xml<br>report hash old**]:::task
+  Write_json_data_to_destination13-->|Task| Write_current_hash_to_destination14[write current hash to destination<br>When: **junit2json xml report hash curr    junit2json xml<br>report hash old**]:::task
+  Write_current_hash_to_destination14-->End
+```
+
+
+### Graph for merge.yml
+
+```mermaid
+flowchart TD
+Start
+classDef block stroke:#3498db,stroke-width:2px;
+classDef task stroke:#4b76bb,stroke-width:2px;
+classDef includeTasks stroke:#16a085,stroke-width:2px;
+classDef importTasks stroke:#34495e,stroke-width:2px;
+classDef includeRole stroke:#2980b9,stroke-width:2px;
+classDef importRole stroke:#699ba7,stroke-width:2px;
+classDef includeVars stroke:#8e44ad,stroke-width:2px;
+classDef rescue stroke:#665352,stroke-width:2px;
+
+  Start-->|Task| Generate_XML_files_list0[generate xml files list]:::task
+  Generate_XML_files_list0-->|Task| Print_XML_reports__filenames_data1[print xml reports  filenames data<br>When: **junit2json debug is defined and junit2json debug**]:::task
+  Print_XML_reports__filenames_data1-->|Task| Merge_multiple_JUnit_XML_files_into_single_consolidated_report2[merge multiple junit xml files into single<br>consolidated report]:::task
+  Merge_multiple_JUnit_XML_files_into_single_consolidated_report2-->|Task| Write_merge_resulting_file3[write merge resulting file<br>When: **junit2json merged xml stdout   length   10**]:::task
+  Write_merge_resulting_file3-->|Task| Override_the_xml_files_list_for_conversion4[override the xml files list for conversion]:::task
+  Override_the_xml_files_list_for_conversion4-->End
+```
+
+
+### Graph for expand.yml
+
+```mermaid
+flowchart TD
+Start
+classDef block stroke:#3498db,stroke-width:2px;
+classDef task stroke:#4b76bb,stroke-width:2px;
+classDef includeTasks stroke:#16a085,stroke-width:2px;
+classDef importTasks stroke:#34495e,stroke-width:2px;
+classDef includeRole stroke:#2980b9,stroke-width:2px;
+classDef importRole stroke:#699ba7,stroke-width:2px;
+classDef includeVars stroke:#8e44ad,stroke-width:2px;
+classDef rescue stroke:#665352,stroke-width:2px;
+
+  Start-->|Task| Print_path_item_value0[print path item value]:::task
+  Print_path_item_value0-->|Task| Setup_helper_variable1[setup helper variable]:::task
+  Setup_helper_variable1-->|Task| Check_whether_the_path_item_is_a_directory2[check whether the path item is a directory]:::task
+  Check_whether_the_path_item_is_a_directory2-->|Task| Add_path_item_as_a_JUnit_XML_report__stat_isdir__false_3[add path item as a junit xml report  stat isdir <br>false <br>When: **not  junit2json path item stat stat isdir  <br>default false**]:::task
+  Add_path_item_as_a_JUnit_XML_report__stat_isdir__false_3-->|Task| Find_JUnit_XML_reports_under_path_item__stat_isdir__true_4[find junit xml reports under path item  stat isdir<br> true <br>When: **junit2json path item stat stat isdir   default<br>false**]:::task
+  Find_JUnit_XML_reports_under_path_item__stat_isdir__true_4-->|Task| Setup_the_conversion_list5[setup the conversion list<br>When: **junit2json path item stat stat isdir   default<br>false  and  junit2json xml reports find matched  <br>0**]:::task
+  Setup_the_conversion_list5-->|Task| Setup_the_default_list_for_conversion6[setup the default list for conversion<br>When: **junit2json path item stat stat isdir   default<br>false  and junit2json found xml reports   length  <br>0**]:::task
+  Setup_the_default_list_for_conversion6-->End
+```
+
+
+### Graph for main.yml
+
+```mermaid
+flowchart TD
+Start
+classDef block stroke:#3498db,stroke-width:2px;
+classDef task stroke:#4b76bb,stroke-width:2px;
+classDef includeTasks stroke:#16a085,stroke-width:2px;
+classDef importTasks stroke:#34495e,stroke-width:2px;
+classDef includeRole stroke:#2980b9,stroke-width:2px;
+classDef importRole stroke:#699ba7,stroke-width:2px;
+classDef includeVars stroke:#8e44ad,stroke-width:2px;
+classDef rescue stroke:#665352,stroke-width:2px;
+
+  Start-->|Task| Validate_some_variables0[validate some variables]:::task
+  Validate_some_variables0-->|Task| Initialize_input_reports_variable1[initialize input reports variable]:::task
+  Initialize_input_reports_variable1-->|Task| Initialize_reports_variable2[initialize reports variable]:::task
+  Initialize_reports_variable2-->|Include task| expand_yml3[expand the input list to list of existing files<br>include_task: expand yml]:::includeTasks
+  expand_yml3-->|Include task| merge_yml4[merge junit xml reports into single file <br>junit2json do merge  true <br>When: **junit2json do merge and  junit2json found xml<br>reports matched   0**<br>include_task: merge yml]:::includeTasks
+  merge_yml4-->|Include task| convert_yml5[convert xml to json<br>When: **junit2json reports list   length   0**<br>include_task: convert yml]:::includeTasks
+  convert_yml5-->End
+```
+
+
+## Playbook
+
+```yml
+---
+
+- name: "Example playbook to use the role redhatci.ocp.junit2json role"
+  hosts: localhost
+  vars:
+    global_reports_path_patterns: # this depends on your actual naming patterns
+      - '*junit.xml'
+    global_json_reports_list: []
+    input_reports:
+      - "/path/to/input1-junit.xml"
+      - "/path2/to/input-2-junit.xml"
+  tasks:
+    - name: Run the role
+      ansible.builtin.include_role:
+        name: redhatci.ocp.junit2json
+      vars:
+        junit2json_input_reports_list: "{{ input_reports | list }}"
+        junit2json_output_dir: "{{ playbook_dir }}/json_reports"
+        junit2json_do_merge: false
+    - name: Print the resulting list of JSON files
+      ansible.builtin.debug:
+        var: global_json_reports_list
+
+```
+## Playbook graph
+```mermaid
+flowchart TD
+  localhost-->|Include role| redhatci_ocp_junit2json0(run the role<br>include_role: redhatci ocp junit2json):::includeRole
+  redhatci_ocp_junit2json0-->|Task| Print_the_resulting_list_of_JSON_files1[print the resulting list of json files]:::task
+```
+
+## Author Information
+Max Kovgan
+
+#### License
+
+Apache-2.0
+
+#### Minimum Ansible Version
+
+2.9
+
+#### Platforms
+
+No platforms specified.
+<!-- DOCSIBLE END -->

roles/junit2json/defaults/main.yml

@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: Apache-2.0
+---
+# defaults file for role redhatci.ocp.junit2json
+
+junit2json_hash: sha256
+junit2json_debug: false
+junit2json_do_merge: true

roles/junit2json/examples/example_playbook.yml

@@ -0,0 +1,22 @@
+---
+
+- name: "Example playbook to use the role redhatci.ocp.junit2json role"
+  hosts: localhost
+  vars:
+    global_reports_path_patterns: # this depends on your actual naming patterns
+      - '*junit.xml'
+    global_json_reports_list: []
+    input_reports:
+      - "/path/to/input1-junit.xml"
+      - "/path2/to/input-2-junit.xml"
+  tasks:
+    - name: Run the role
+      ansible.builtin.include_role:
+        name: redhatci.ocp.junit2json
+      vars:
+        junit2json_input_reports_list: "{{ input_reports | list }}"
+        junit2json_output_dir: "{{ playbook_dir }}/json_reports"
+        junit2json_do_merge: false
+    - name: Print the resulting list of JSON files
+      ansible.builtin.debug:
+        var: global_json_reports_list