Add role test_report_send (obsolete, was split)
#712
Conversation
|
from change #712:
|
📝 WalkthroughWalkthroughThis update introduces a new Ansible role, Changes
Suggested reviewers
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
from change #712:
|
|
Build succeeded. ✔️ dci-rpm-build-el8 SUCCESS in 2m 49s |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 13
🔭 Outside diff range comments (1)
roles/test_report_send/vars/jenkins.yml (1)
1-4: Env-to-var mapping file is empty. This stub lacks the actual mappings and may break tasks expecting variables. Please populate with your Jenkins mappings or remove if unused.
🧹 Nitpick comments (47)
roles/test_report_send/tasks/ensure-file.yml (2)
5-8: Consider reducing debug verbosity. The debug task is useful for development, but may clutter logs in CI. You could guard it withwhen: ansible_verbosity > 1or remove in production.
16-26: Refactor repeated conditions into a block. Both stat and assert share the samewhen:check—consider wrapping these tasks in ablock:to DRY up the play. Also, you can simplify the assert by passing the loop variable directly without Jinja braces:assert: that: - conditionroles/test_report_send/doc/scripts/jenkins_node_labels.sh (1)
1-36: Add strict mode and error handling. To catch failures early, enable bash strictness at the top:#!/usr/bin/env bash +set -euo pipefailThis will ensure missing variables or command failures don’t silently pass.
roles/test_report_send/vars/main.yml (1)
1-3: Placeholder vars file without content.
This file only contains license info and a placeholder header; no role-specific variables are defined. Consider removing it or populating it with necessary variables, or rely solely ondefaults/main.ymlif no strict variables are needed.roles/test_report_send/tests/test.yml (2)
1-7: Basic test playbook is valid.
The playbook correctly invokesredhatci.ocp.test_report_sendon localhost. To improve coverage, consider adding idempotence checks or assertions on generated output (e.g., verifying JSON diffs).
1-8: Add newline at end of file.
Ensure the file ends with a single newline to conform to YAML best practices.roles/test_report_send/doc/main.md (1)
9-14: Fix trailing whitespace and numbering.
Line 14 has a trailing space and the “Reporting” section is numbered1.again—consider removing the trailing space, adding a newline at EOF, and renumbering to2.for clarity.roles/test_report_send/doc/reporting.md (1)
1-9: Documentation introduces high-level concepts clearly.The overview of reporting systems and observability goals is concise and well-structured. Consider adding cross-references to related docs (e.g., metadata.md or splunk.md) to improve discoverability.
roles/test_report_send/meta/main.yml (1)
1-11: Role metadata is properly defined.Authors, description, license, and min_ansible_version follow Ansible Galaxy conventions. You may want to populate
galaxy_tagsto improve role discoverability.roles/junit2json/tasks/ensure-dir.yml (1)
7-19: New directory-ensuring task is concise and effective.The
statcheck and conditional directory creation ensure idempotency. Optionally, consider exposingmode(and possiblyowner/group) as variables for increased flexibility in different environments.roles/test_report_send/tasks/metadata-detect/unknown.yml (1)
5-8: Use a dynamic debug message
Instead of a fixed string, include the CI system identifier for clarity:- name: Unsupported CI system ansible.builtin.debug: msg: "unsupported CI system" + name: Debug unsupported CI system + ansible.builtin.debug: + msg: "Unsupported CI system detected: {{ trs_ci_system }}"roles/junit2json/tasks/merge.yml (1)
20-27: Optional: simplify directory creation
You can replace theinclude_tasksloop with the built-infilemodule for a single directory:- name: Ensure junit2_output_dir is created - ansible.builtin.include_tasks: - file: ensure-dir.yml - loop: - - "{{ junit2_output_dir }}" - loop_control: - loop_var: folder_path + name: Ensure output directory exists + ansible.builtin.file: + path: "{{ junit2_output_dir }}" + state: directory + mode: '0755'roles/test_report_send/doc/metadata.md (2)
1-1: Use a top-level heading
Markdown linting expects the first line to be# Metadata structureinstead of##.
24-24: Ensure a single trailing newline
Add a newline at EOF to satisfy MD047.roles/test_report_send/tasks/env2vars-populate.yml (1)
8-16: Improve loop debugability
Add a label so failures reference the specific key, and considerwith_dictfor clarity:loop: "{{ env2vars }}" + loop_control: + label: "{{ item.key }}" when: - env2vars | default({}) | length > 0roles/test_report_send/doc/event.md (1)
14-15: Link to metadata docs
Consider hyperlinkingevent.metadatato the detailed metadata.md for easier navigation.roles/test_report_send/vars/env2vars/jenkins.yml (1)
49-56: Remove GitLab-specific variables
Entries forCI_PROJECT_NAMESPACE,CI_PROJECT_NAME, andCI_PROJECT_PATHdon’t exist in a vanilla Jenkins env. Unless you have a plugin setting those, please remove or document them under a conditional.roles/test_report_send/tasks/ci-detect.yml (1)
20-22: Simplify the assertion
Instead of looping, you can assert both conditions in one go for clarity:- name: Validate supported CI system ansible.builtin.assert: that: - trs_ci_system != 'unknown' - trs_ci_system in trs_ci_systems_supported fail_msg: "Unsupported CI system: {{ trs_ci_system }}"roles/test_report_send/doc/jenkins.md (1)
17-23: Improve Markdown formatting
Several long lines exceed 120 chars and nested lists underBUILD_CAUSEaren’t indented uniformly. Wrap descriptions into shorter lines and indent sub‐items by 4 spaces to satisfy markdown-lint rules.roles/test_report_send/doc/splunk.md (3)
5-7: Grammar: hyphenate “yq-like” and tighten punctuation.
Change “jqoryq-like manner” to “jq- or yq-like manner,” and add a comma after “monospace.”
104-112: Link to event schema fortrs_event.
Consider adding a pointer to the detailed schema indoc/event.md, e.g.:> See [Event Schema](../doc/event.md) for `trs_event` structure.
12-24: Consistent heading levels.
Under “## The event contains the following,” use uniform subheadings (e.g., H3) for each numbered section to improve readability.roles/test_report_send/tasks/metadata-detect/dci.yml (1)
28-36: Tighten merge conditions.
Includetrs_metadata_path is definedin thewhenclauses and verifytrs_meta_data.metadata is definedbefore squashing.roles/test_report_send/tasks/metadata-detect.yml (1)
16-21: Fix duplicate task names for clarity.Both tasks on lines 16 and 19 have the same name "Detect dynamic metadata" which makes debugging harder.
-- name: Detect dynamic metadata +- name: Populate environment variables to facts ansible.builtin.include_tasks: "env2vars-populate.yml" -- name: Detect dynamic metadata +- name: Detect CI-specific metadata ansible.builtin.include_tasks: "metadata-detect/{{ trs_ci_system }}.yml"roles/test_report_send/tasks/reporting/splunk.yml (2)
15-16: Clean up extra blank line.Remove the unnecessary blank line for consistency.
when: _trs_json_file_content.content | length > 0 -
48-68: Simplify status code configuration logic.The status codes are set twice with different conditions - this could be confusing. Consider consolidating the logic.
-- name: Set default allowed status codes - ansible.builtin.set_fact: - trs_http_status_codes: - # can be "forbidden" (403) for mock collector - HEAD: - - 200 - - 403 - POST: - - 200 - -- name: Set allowed status codes +- name: Set allowed status codes based on send mode ansible.builtin.set_fact: trs_http_status_codes: - # can be "forbidden" (403) for mock collector HEAD: - - 200 + - 200 + - "{{ 403 if not trs_do_send else omit }}" POST: - 200 - when: - - trs_do_sendroles/test_report_send/tasks/main.yml (5)
5-10: Validate collector URL explicitly
The current assert checks the collector type and auth but doesn’t ensuretrs_collector_urlis provided. Add a clause like- trs_collector_url | length > 0to fail early if the endpoint is missing.
29-35: Align task name with metadata variable
The task name references{{ trs_file_path }}, butslurpreads from{{ trs_metadata_path }}. Update the name to “Read content of JSON file {{ trs_metadata_path }}” for consistency.
36-43: Handle invalid JSON gracefully
Currently a malformed metadata file will breakfrom_json. Consider pre-validating or wrapping the filter to default egregious input to{}without failing the playbook.
44-47: Guard metadata detect include
You always includemetadata-detect.yml, even when autodetect is disabled. Addwhen: trs_ci_system_autodetectto skip this step if the user turns off CI autodetection.
48-53: Respect the send flag in main
The send task is only gated bytrs_report_path. Include- trs_do_sendin thewhen:sotrs_do_send: falsetruly disables report transmission.roles/test_report_send/doc/scripts/gen_dcirc.sh (2)
65-73: Quote and escape values robustly
Usingecho "${var_name}='${var_value}'"will break if${var_value}contains single quotes. Useprintf '%q'or similar to ensure values are safely escaped, for example:echo "${var_name}=$(printf '%q' "$var_value")"
5-7: Enable nounset for safer scripting
Addset -o nounsetalongsidepipefailanderrexitto catch unintended unset variables.roles/test_report_send/tasks/metadata-detect/jenkins.yml (3)
9-13: Duplicate task names reduce clarity
Two tasks share the name “Update helper variables for ci attributes.” Rename one to specify its purpose (e.g., initializingci.runnervs. settingci.type/ci.url) to improve log readability.Also applies to: 15-23
101-104: Clarify merge task name
The task “Update helper variables for source attributes” mergessource_changeintosource. Rename it to “Merge source_change into source” to reflect its real action.
105-113: Use recursive merge for nested metadata
The finalcombineontrs_ci_runtimeis shallow. To merge nested CI, pipeline, job, and source structures without overwriting, addrecursive=Trueto the filter.roles/test_report_send/README.md (2)
37-41: Fix relative link for event documentation
The link[doc/event.md](ocp/role/test_report_send/doc/event.md)points to an incorrect path. Update it todoc/event.mdorroles/test_report_send/doc/event.mdto correctly referenceevent.md.
18-23: Inline HTML may reduce compatibility
Using<details>/<summary>isn’t supported by all Markdown renderers. Consider replacing with pure Markdown sections or removing to ensure broader compatibility.roles/test_report_send/defaults/main.yml (2)
1-15:trs_collector_urlmissing in defaults
The role requirestrs_collector_url(per argument specs) but it’s absent here. Add a default entry liketrs_collector_url: ""or document that it must always be provided.
13-15: Quote string default values
Unquotedunknownandsplunkare valid strings, but quoting them (e.g.,"unknown","splunk") improves readability and consistency with other defaults.roles/test_report_send/doc/env2vars.md (7)
7-7: Fix singular/plural agreement
Change “Tests answers” to “Tests answer” for grammatical consistency.
55-55: Correct verb usage
Replace “We not have” with “We do not have” for proper English.
58-58: Clarify verb choice
“can't admin” → “can't administer” or “can't manage” to use the verb form.
59-59: Hyphenate modifier
Change “CI specific queries” to “CI-specific queries” for consistency.
69-70: Complete the sentence
“Event structure has” is incomplete—consider specifying what it has (e.g., “Event structure has the following sections:”).
106-106: Improve list formatting
The section uses repeated “1.” for each item—switch to hyphens or proper numbering to enhance readability.
124-124: Add missing article
Change “Assumes list of strings” to “Assumes a list of strings.”
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (41)
.github/CODEOWNERS(1 hunks).markdownlint.json(1 hunks)README.md(5 hunks)ansible-collection-redhatci-ocp.spec(2 hunks)galaxy.yml(1 hunks)roles/junit2json/tasks/convert.yml(1 hunks)roles/junit2json/tasks/ensure-dir.yml(1 hunks)roles/junit2json/tasks/merge.yml(1 hunks)roles/test_report_send/README.md(1 hunks)roles/test_report_send/defaults/main.yml(1 hunks)roles/test_report_send/doc/dci.md(1 hunks)roles/test_report_send/doc/env2vars.md(1 hunks)roles/test_report_send/doc/event.json(1 hunks)roles/test_report_send/doc/event.md(1 hunks)roles/test_report_send/doc/jenkins.md(1 hunks)roles/test_report_send/doc/main.md(1 hunks)roles/test_report_send/doc/metadata.md(1 hunks)roles/test_report_send/doc/reporting.md(1 hunks)roles/test_report_send/doc/scripts/gen_dcirc.sh(1 hunks)roles/test_report_send/doc/scripts/jenkins_node_labels.sh(1 hunks)roles/test_report_send/doc/splunk.md(1 hunks)roles/test_report_send/meta/argument_specs.yml(1 hunks)roles/test_report_send/meta/main.yml(1 hunks)roles/test_report_send/tasks/ci-detect.yml(1 hunks)roles/test_report_send/tasks/dump-file.yml(1 hunks)roles/test_report_send/tasks/empty.yml(1 hunks)roles/test_report_send/tasks/ensure-file.yml(1 hunks)roles/test_report_send/tasks/env2vars-populate.yml(1 hunks)roles/test_report_send/tasks/main.yml(1 hunks)roles/test_report_send/tasks/metadata-detect.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/dci.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/jenkins.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/unknown.yml(1 hunks)roles/test_report_send/tasks/reporting/splunk.yml(1 hunks)roles/test_report_send/tasks/reporting/validations.yml(1 hunks)roles/test_report_send/templates/env2vars.j2(1 hunks)roles/test_report_send/tests/test.yml(1 hunks)roles/test_report_send/vars/env2vars/example.yml(1 hunks)roles/test_report_send/vars/env2vars/jenkins.yml(1 hunks)roles/test_report_send/vars/jenkins.yml(1 hunks)roles/test_report_send/vars/main.yml(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
roles/test_report_send/doc/main.md
14-14: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
14-14: Files should end with a single newline character
null
(MD047, single-trailing-newline)
roles/test_report_send/doc/metadata.md
1-1: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)
24-24: Files should end with a single newline character
null
(MD047, single-trailing-newline)
roles/test_report_send/doc/jenkins.md
11-11: Line length
Expected: 120; Actual: 158
(MD013, line-length)
18-18: Line length
Expected: 120; Actual: 135
(MD013, line-length)
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
22-22: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
36-36: Line length
Expected: 120; Actual: 209
(MD013, line-length)
roles/test_report_send/README.md
7-7: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
8-8: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
11-11: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
12-12: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
13-13: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
14-14: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
15-15: Multiple consecutive blank lines
Expected: 1; Actual: 6
(MD012, no-multiple-blanks)
16-16: Multiple consecutive blank lines
Expected: 1; Actual: 7
(MD012, no-multiple-blanks)
17-17: Multiple consecutive blank lines
Expected: 1; Actual: 8
(MD012, no-multiple-blanks)
18-18: Inline HTML
Element: details
(MD033, no-inline-html)
19-19: Inline HTML
Element: summary
(MD033, no-inline-html)
19-19: Inline HTML
Element: b
(MD033, no-inline-html)
21-21: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
21-21: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
27-27: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
31-31: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
32-32: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
33-33: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
34-34: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
35-35: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
36-36: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
36-36: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
37-37: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
41-41: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
42-42: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
43-43: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
44-44: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
45-45: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
46-46: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
47-47: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
49-49: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
54-54: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
55-55: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
56-56: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
57-57: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
58-58: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
59-59: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
60-60: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
61-61: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
62-62: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
64-64: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
65-65: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
66-66: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
67-67: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
68-68: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
69-69: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
70-70: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
71-71: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
72-72: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
75-75: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
76-76: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
77-77: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
78-78: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
79-79: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
80-80: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
81-81: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
81-81: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
82-82: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
84-84: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
85-85: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
86-86: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
87-87: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
88-88: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
89-89: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
90-90: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
91-91: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
92-92: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
94-94: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
95-95: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
96-96: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
97-97: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
98-98: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
99-99: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
100-100: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
102-102: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
104-104: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
105-105: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
106-106: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
107-107: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
108-108: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
109-109: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
110-110: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
111-111: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
112-112: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
114-114: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
115-115: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
116-116: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
117-117: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
118-118: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
119-119: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
120-120: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
121-121: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
122-122: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
125-125: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
126-126: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
127-127: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
128-128: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
129-129: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
130-130: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
131-131: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
132-132: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
133-133: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
133-133: Line length
Expected: 120; Actual: 133
(MD013, line-length)
136-136: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
137-137: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
138-138: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
139-139: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
140-140: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
141-141: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
142-142: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
143-143: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
144-144: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
147-147: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
148-148: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
149-149: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
150-150: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
151-151: Multiple consecutive blank lines
Expected: 1; Actual: 6
(MD012, no-multiple-blanks)
152-152: Multiple consecutive blank lines
Expected: 1; Actual: 7
(MD012, no-multiple-blanks)
155-155: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
158-158: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
185-185: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
186-186: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
187-187: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
188-188: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
191-191: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
311-311: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
314-314: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
315-315: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
335-335: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
356-356: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
377-377: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
402-402: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
422-422: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
447-447: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
480-480: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
502-502: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
530-530: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
557-557: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
577-577: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
589-589: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
590-590: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
590-590: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
591-591: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
596-596: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
599-599: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🪛 LanguageTool
roles/test_report_send/doc/jenkins.md
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...nning in jenkins. ### CI * NODE_NAME: The name of the agent (or controller) w...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...here the build is running. * WORKSPACE: The absolute path to the directory wher...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ring the build process. * JENKINS_HOME: The directory where Jenkins stores its ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ory, and other data. * EXECUTOR_NUMBER: The unique number that identifies the c...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...r job's metadata. ### Job * JOB_NAME: The name of the Jenkins job. * `JOB_URL...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...The name of the Jenkins job. * JOB_URL: The URL of the Jenkins job. * `BUILD_NU...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...URL of the Jenkins job. * BUILD_NUMBER: The unique build number for the current...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ... current run (e.g., 153). * BUILD_ID: The current build ID, usually identical...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...r recent Jenkins versions. * BUILD_TAG: A unique tag combining the job name and...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...B_NAME}-${BUILD_NUMBER}). * BUILD_URL`: The URL where the results of this speci...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...an be found. ### Source * GIT_COMMIT: The full SHA-1 hash of the current Gi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...t Git commit being built. * GIT_BRANCH: The name of the Git branch being built ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: .../master, feature/my-branch). * GIT_URL: The URL of the remote Git repository. *...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...ote Git repository. * GIT_LOCAL_BRANCH: If a specific local branch is checked o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...ontain its name. * GIT_PREVIOUS_COMMIT: The SHA-1 hash of the previous commit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...anch. * GIT_PREVIOUS_SUCCESSFUL_COMMIT: The SHA-1 hash of the commit of the l...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...st/Merge Request/ChangeId * CHANGE_ID: for GitHub it is PR, for GitLab it is M...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~61-~61: Loose punctuation mark.
Context: ...rrit it is ChangeId. * PULL_REQUEST_ID: GitHub term * `GITLAB_MERGE_REQUEST_IID...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...tHub Change Info (PR) * CHANGE_BRANCH: source branch name of the PR * `CHANGE_...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...R ###### Author (PR) * CHANGE_AUTHOR: the author of the PR * `CHANGE_AUTHOR_D...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ... * GITLAB_MERGE_REQUEST_SOURCE_BRANCH: source branch of the MR * `GITLAB_MERGE...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~84-~84: Loose punctuation mark.
Context: ...###### Author (MR) * GITLAB_USER_NAME: The merge request author's name. * `GIT...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~85-~85: Loose punctuation mark.
Context: ...est author's name. * GITLAB_USER_EMAIL: The merge request author's email. ### ...
(UNLIKELY_OPENING_PUNCTUATION)
roles/test_report_send/doc/env2vars.md
[typographical] ~7-~7: Do not use a colon (:) before a series that is introduced by a preposition (‘as’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...nt: 1. Tests answers questions such as: 1. which test suite(s) ran, with whi...
(RP_COLON)
[grammar] ~55-~55: Did you mean “don't have”?
Context: ...nt variables. ## Solution overview We not have full control of our reporting systems, ...
(NOT_TO_DOES_NOT)
[grammar] ~58-~58: The word ‘admin’ is a noun or an adjective. A verb is missing or misspelled, or maybe a comma is missing.
Context: ...ost-ingest processing. In short, we 1. can't admin the reporting (regulation, policies) 2....
(PRP_MD_NN)
[uncategorized] ~59-~59: When ‘CI-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...policies) 2. we do not want to maintain CI specific queries => we want to query events from...
(SPECIFIC_HYPHEN)
[uncategorized] ~106-~106: Possible missing comma found.
Context: ...ng reported. 1. For every supported CI type we should have proper `vars/env2vars/{{...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~124-~124: Possible missing article found.
Context: ...g, default | ### (*) Assumes list of strings, given the data is formatted...
(AI_HYDRA_LEO_MISSING_A)
roles/test_report_send/README.md
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...under 'test' attribute. For full report syntax see [doc/event.md](ocp/role/test_report...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Checkov (3.2.334)
roles/test_report_send/tasks/reporting/validations.yml
[MEDIUM] 25-36: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 25-36: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
roles/test_report_send/tasks/reporting/splunk.yml
[MEDIUM] 109-125: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 109-125: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Sanity Check (stable-2.18)
- GitHub Check: Sanity Check (stable-2.9)
- GitHub Check: Ansible-lint Check
🔇 Additional comments (27)
roles/test_report_send/tasks/empty.yml (1)
1-2: Placeholder tasks file is valid. This empty stub prevents role-loading errors when no default tasks are needed.roles/test_report_send/tasks/ensure-file.yml (1)
9-15: Stat validation is correctly scoped. Usingwhen: trs_file_path | length > 0ensures we only run stat when a path is provided. Nice job handling defaults on stat lookups.galaxy.yml (1)
12-12: Version bump looks good. Updating to2.6.0aligns with the newtest_report_sendrole addition.ansible-collection-redhatci-ocp.spec (2)
6-6: Version bump looks correct.
Updated to2.6.EPOCHto reflect the newtest_report_sendrole and related updates.
57-60: Changelog entry is accurate.
The new changelog documents thejunit2jsonupdate and addition oftest_report_sendas expected..github/CODEOWNERS (1)
42-44: CODEOWNERS updated appropriately.
Assigning/roles/test_report_sendto@redhatci/verificationaligns with the new role ownership..markdownlint.json (1)
1-8: Configuration is valid and aligns with PR objectives.The custom MD013 settings (120-character limit, ignoring code blocks and tables) are well-defined and will enforce consistent Markdown styling across the collection.
roles/junit2json/tasks/convert.yml (1)
26-33: Modularized directory creation is a nice improvement.Including
ensure-dir.ymlcentralizes folder setup and maintains idempotency. Ensure the same pattern is applied inmerge.ymlfor consistency across tasks.roles/test_report_send/tasks/ci-detect.yml (1)
23-26: Verify default var definition
Ensuretrs_ci_systems_supportedis defined (e.g., indefaults/main.yml) so this assert won’t error out.roles/test_report_send/doc/dci.md (1)
1-84: Looks good overall
Comprehensive and clear DCI API documentation that aligns with the role’s workflow.roles/test_report_send/tasks/metadata-detect/dci.yml (1)
12-19: Inconsistent fact nesting for CI URL.
You setci.urlat top level instead of undertrs_ci_runtime. Confirm ifurlshould be combined intotrs_ci_runtimefor consistency withis_ci.README.md (2)
133-133: Verify new role entry link.
Ensureroles/test_report_send/README.mdexists at this path and correctly documents the role.
153-160: Confirm plugin additions.
Please verify that the new filter and module plugins (junit2dict,junit2obj,regex_diff,get_compatible_rhocp_repo,nmcli,packet_missing) exist underplugins/{filter,modules}/with matching filenames.roles/test_report_send/vars/env2vars/example.yml (1)
1-54: Looks good.
This example clearly illustrates dict, list, int, and bool mappings for environment variables and will aid users during integration.roles/test_report_send/tasks/reporting/validations.yml (3)
5-18: Solid validation logic for authentication headers!The comprehensive checks for Splunk auth headers ensure all required fields are present and properly formatted.
19-24: Good security practice enforcing HTTPS!Requiring HTTPS for the collector URL is the right approach for secure data transmission.
25-44: Proper certificate validation implementation!The URI task correctly configures certificate validation and the static analysis warnings are false positives - the code properly enforces both HTTPS and certificate validation.
roles/test_report_send/tasks/metadata-detect.yml (2)
5-9: Clean conditional CI auto-detection!The conditional include for CI system detection is well-structured.
28-37: Nice metadata merging and conditional source updates!The metadata combination and conditional collector source update logic is well-implemented.
roles/test_report_send/doc/event.json (1)
1-133: Excellent example event structure!This comprehensive JSON example provides clear documentation of the expected event format with realistic test data and metadata structures.
roles/test_report_send/tasks/reporting/splunk.yml (1)
109-123: Proper URI configuration with security measures!The POST request correctly configures certificate validation, follows redirects, and uses proper authentication. Static analysis warnings are false positives.
roles/test_report_send/templates/env2vars.j2 (3)
1-4: Clean list processing with proper defaults!The list type handling with configurable splitters and empty value fallback is well-implemented.
5-27: Sophisticated dictionary processing logic!The dict type conversion handles complex scenarios including duplicate keys and proper trimming. The logic for converting single values to lists when duplicates are encountered is particularly well-thought-out.
28-34: Comprehensive type conversion coverage!The int, bool, and default string handling covers all common use cases with proper defaults and trimming.
roles/test_report_send/tasks/main.yml (1)
12-21: Input file validation loop is clear
This include correctly verifies readability of both report and metadata when paths are set.roles/test_report_send/doc/env2vars.md (2)
1-2: The heading is clear and descriptive. No changes needed.
76-76: Verify link path
Confirm that[this file](event.md)correctly points to the event structure definition (e.g., adjust to the proper relative path).
Docstrings generation was requested by @mvk. * #712 (comment) The following files were modified: * `roles/test_report_send/doc/scripts/gen_dcirc.sh` * `roles/test_report_send/doc/scripts/jenkins_node_labels.sh`
|
Note Generated docstrings for this pull request at #713 |
mvk
force-pushed
the
mvk-role-test_report_send
branch
from
89962fa to
16059b8
Compare
|
from change #712:
|
1 similar comment
|
from change #712:
|
|
Build succeeded. ✔️ dci-rpm-build-el8 SUCCESS in 2m 49s |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (10)
roles/test_report_send/tasks/dump-file.yml (1)
27-27: Add trailing newlineYAML lint flagged a missing newline at end of file. Add an empty line after the last task.
roles/test_report_send/doc/env2vars.md (9)
5-7: Surround list with blank lines
Add a blank line before the numbered list starting at line 6 to separate it from the preceding paragraph.
31-35: Surround CI systems list with blank lines
Insert blank lines before and after the bullet list of CI systems (lines 31–35) for consistent markdown formatting.
55-61: Fix grammar and hyphenation
Rewrite to “We do not have full control of our reporting systems…” and “we can’t administer the reporting,” and hyphenate “CI-specific queries.”
59-59: Break up long line
The sentence on line 59 exceeds 120 characters; consider splitting it or simplifying for readability.
66-72: Remove extra blank lines
There are multiple consecutive blank lines between sections—reduce to a single blank line to maintain consistent spacing.
73-74: Use consistent list markers
Switch dashes to asterisks for unordered lists (lines 73–74) to align with the repository’s markdown style.
57-57: Trim trailing whitespace
Line 57 contains trailing spaces—please remove them.
69-70: Trim trailing whitespace
Lines 69–70 have trailing spaces—please trim them.
187-193: Differentiate repeated headings
The “YAML structure” subheading is reused for multiple types. Consider renaming to include the type (e.g., “String (str) – YAML structure”) to avoid duplication.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
README.md(5 hunks)ansible-collection-redhatci-ocp.spec(2 hunks)galaxy.yml(1 hunks)roles/test_report_send/doc/env2vars.md(1 hunks)roles/test_report_send/meta/argument_specs.yml(1 hunks)roles/test_report_send/tasks/dump-file.yml(1 hunks)roles/test_report_send/tasks/env2vars-populate.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/unknown.yml(1 hunks)roles/test_report_send/vars/env2vars/jenkins.yml(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- galaxy.yml
- roles/test_report_send/tasks/env2vars-populate.yml
🚧 Files skipped from review as they are similar to previous changes (5)
- ansible-collection-redhatci-ocp.spec
- roles/test_report_send/vars/env2vars/jenkins.yml
- roles/test_report_send/tasks/metadata-detect/unknown.yml
- roles/test_report_send/meta/argument_specs.yml
- README.md
🧰 Additional context used
🪛 LanguageTool
roles/test_report_send/doc/env2vars.md
[typographical] ~7-~7: Do not use a colon (:) before a series that is introduced by a preposition (‘as’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...nt: 1. Tests answers questions such as: 1. which test suite(s) ran, with whi...
(RP_COLON)
[grammar] ~55-~55: Did you mean “don't have”?
Context: ...nt variables. ## Solution overview We not have full control of our reporting systems, ...
(NOT_TO_DOES_NOT)
[grammar] ~58-~58: The word ‘admin’ is a noun or an adjective. A verb is missing or misspelled, or maybe a comma is missing.
Context: ...ost-ingest processing. In short, we 1. can't admin the reporting (regulation, policies) 2....
(PRP_MD_NN)
[uncategorized] ~59-~59: When ‘CI-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...policies) 2. we do not want to maintain CI specific queries => we want to query events from...
(SPECIFIC_HYPHEN)
[uncategorized] ~94-~94: You might be missing the article “a” here.
Context: ...development, env2vars is populated by list of key -> var pairs to define keys from...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~106-~106: Possible missing comma found.
Context: ...ng reported. 1. For every supported CI type we should have proper `vars/env2vars/{{...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~124-~124: Possible missing article found.
Context: ...g, default | ### (*) Assumes list of strings, given the data is formatted...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~131-~131: A punctuation mark might be missing here.
Context: ... | | ---------- | ----------------- | | <elm> | element | | `<...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~135-~135: You might be missing the article “a” here.
Context: ...msep>` | element separator | Parsed as list of strings, into: ```yaml ${key}: ...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
🪛 markdownlint-cli2 (0.17.2)
roles/test_report_send/doc/env2vars.md
7-7: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
38-38: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
57-57: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
58-58: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
59-59: Line length
Expected: 120; Actual: 209
(MD013, line-length)
66-66: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
69-69: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
70-70: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
72-72: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
73-73: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
102-102: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
207-207: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
220-220: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
231-231: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
244-244: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
250-250: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
257-257: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
266-266: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
274-274: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
285-285: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
🪛 YAMLlint (1.37.1)
roles/test_report_send/tasks/dump-file.yml
[error] 27-27: no new line character at the end of file
(new-line-at-end-of-file)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Sanity Check (stable-2.18)
- GitHub Check: Sanity Check (stable-2.9)
- GitHub Check: Ansible-lint Check
🔇 Additional comments (3)
roles/test_report_send/tasks/dump-file.yml (3)
5-10: Guarding debug implementedThe debug task is now properly conditioned on
trs_event_saveandansible_verbosity.
12-18: Parent directory ensuredThe
filetask correctly creates the parent directory under thetrs_event_saveguard.
21-27: Event dump task guardedThe
copytask dumps the formatted JSON only whentrs_event_saveis true.
mvk
force-pushed
the
mvk-role-test_report_send
branch
from
16059b8 to
fb51772
Compare
|
from change #712:
|
1 similar comment
|
from change #712:
|
|
Build succeeded. ✔️ dci-rpm-build-el8 SUCCESS in 2m 50s |
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (4)
roles/test_report_send/tasks/dump-file.yml (1)
27-27: Add final newline.YAML files should end with a newline to satisfy linters.
when: - trs_event_save | default(false) +roles/test_report_send/doc/reporting.md (2)
6-9: Refine phrasing for clarity
Consider rephrasing “This in its turn enables:” to “In turn, this enables:” for more natural flow.
11-11: Add comma after linking adverb
Per style, add a comma after “Currently” to improve readability:- Currently supported reporting system: [splunk.md] + Currently, supported reporting system: [splunk.md]roles/test_report_send/doc/env2vars.md (1)
7-9: Avoid colon before “as”
The series introduced by “such as” shouldn’t end with a colon. For example:- 1. **Tests** answers questions such as: + 1. **Tests** answers questions such as
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
README.md(5 hunks)ansible-collection-redhatci-ocp.spec(2 hunks)galaxy.yml(1 hunks)roles/test_report_send/doc/env2vars.md(1 hunks)roles/test_report_send/doc/main.md(1 hunks)roles/test_report_send/doc/reporting.md(1 hunks)roles/test_report_send/doc/scripts/jenkins_node_labels.sh(1 hunks)roles/test_report_send/meta/argument_specs.yml(1 hunks)roles/test_report_send/tasks/dump-file.yml(1 hunks)roles/test_report_send/tasks/ensure-file.yml(1 hunks)roles/test_report_send/tasks/env2vars-populate.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/unknown.yml(1 hunks)roles/test_report_send/vars/env2vars/jenkins.yml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- roles/test_report_send/tasks/env2vars-populate.yml
🚧 Files skipped from review as they are similar to previous changes (8)
- galaxy.yml
- ansible-collection-redhatci-ocp.spec
- roles/test_report_send/meta/argument_specs.yml
- roles/test_report_send/tasks/ensure-file.yml
- README.md
- roles/test_report_send/tasks/metadata-detect/unknown.yml
- roles/test_report_send/doc/scripts/jenkins_node_labels.sh
- roles/test_report_send/vars/env2vars/jenkins.yml
🧰 Additional context used
🪛 LanguageTool
roles/test_report_send/doc/env2vars.md
[typographical] ~7-~7: Do not use a colon (:) before a series that is introduced by a preposition (‘as’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...nt: 1. Tests answers questions such as: 1. which test suite(s) ran, with whi...
(RP_COLON)
[grammar] ~55-~55: Did you mean “don't have”?
Context: ...nt variables. ## Solution overview We not have full control of our reporting systems, ...
(NOT_TO_DOES_NOT)
[grammar] ~58-~58: The word ‘admin’ is a noun or an adjective. A verb is missing or misspelled, or maybe a comma is missing.
Context: ...ost-ingest processing. In short, we 1. can't admin the reporting (regulation, policies) 2....
(PRP_MD_NN)
[uncategorized] ~59-~59: When ‘CI-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...policies) 2. we do not want to maintain CI specific queries => we want to query events from...
(SPECIFIC_HYPHEN)
[uncategorized] ~94-~94: You might be missing the article “a” here.
Context: ...development, env2vars is populated by list of key -> var pairs to define keys from...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~106-~106: Possible missing comma found.
Context: ...ng reported. 1. For every supported CI type we should have proper `vars/env2vars/{{...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~124-~124: Possible missing article found.
Context: ...g, default | ### (*) Assumes list of strings, given the data is formatted...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~131-~131: A punctuation mark might be missing here.
Context: ... | | ---------- | ----------------- | | <elm> | element | | `<...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~135-~135: You might be missing the article “a” here.
Context: ...msep>` | element separator | Parsed as list of strings, into: ```yaml ${key}: ...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
roles/test_report_send/doc/main.md
[uncategorized] ~13-~13: A punctuation mark might be missing here.
Context: ...d) 2. Jenkins 2. Reporting, per reporting system: 1. [Splunk]...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
roles/test_report_send/doc/reporting.md
[uncategorized] ~10-~10: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...s - Data-based decision-making process Currently supported reporting system: [splunk.md]...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
🪛 markdownlint-cli2 (0.17.2)
roles/test_report_send/doc/env2vars.md
7-7: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
38-38: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
57-57: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
58-58: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
59-59: Line length
Expected: 120; Actual: 209
(MD013, line-length)
66-66: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
69-69: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
70-70: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
72-72: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
73-73: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
102-102: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
207-207: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
220-220: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
231-231: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
244-244: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
250-250: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
257-257: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
266-266: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
274-274: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
285-285: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
🪛 YAMLlint (1.37.1)
roles/test_report_send/tasks/dump-file.yml
[error] 27-27: no new line character at the end of file
(new-line-at-end-of-file)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Sanity Check (stable-2.18)
- GitHub Check: Sanity Check (stable-2.9)
- GitHub Check: Ansible-lint Check
🔇 Additional comments (5)
roles/test_report_send/tasks/dump-file.yml (3)
5-10: Good use of conditionals on the debug task.The debug output is now gated by
trs_event_saveand verbosity, matching the intended feature flag behavior.
12-19: Directory creation is correctly guarded.Ensuring the parent directory exists under the same feature flag prevents potential write failures.
21-27: Event payload dump is properly formatted.Using
to_nice_jsonwith indentation and the copy module ensures a clean, permissioned dump.roles/test_report_send/doc/reporting.md (1)
1-5: Looks good overall
The introduction is clear and concise, and the overview of reporting systems aligns with the role’s purpose.roles/test_report_send/doc/main.md (1)
1-15: Documentation structure looks solid
The abstract and table of contents correctly reference all subdocuments, and the role’s scope is well laid out.
mvk
force-pushed
the
mvk-role-test_report_send
branch
from
fb51772 to
f0d2b9c
Compare
|
from change #712:
|
1 similar comment
|
from change #712:
|
|
Build succeeded. ✔️ dci-rpm-build-el8 SUCCESS in 2m 56s |
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (3)
roles/test_report_send/doc/env2vars.md (3)
55-55: Fix grammar in sentence.
Change “We not have full control of our reporting systems” to “We do not have full control of our reporting systems” for correct English.
58-58: Use correct verb.
Replace “can't admin the reporting” with “can't administer the reporting” (or “can’t manage the reporting”) to use a verb form.
59-59: Hyphenate adjective modifier.
Write “CI-specific queries” instead of “CI specific queries.”
🧹 Nitpick comments (4)
roles/test_report_send/doc/env2vars.md (1)
94-94: Add missing article.
Include “a” in “populated by list of key -> var pairs” to read “populated by a list of key -> var pairs.”roles/test_report_send/tasks/dump-file.yml (1)
27-27: Add newline at end of file.
Ensure the file ends with a newline to satisfy POSIX and YAML linting expectations.roles/test_report_send/tasks/reporting/splunk.yml (2)
5-9: Pre-validate the report file before slurpSlurping an undefined or non-existent
trs_report_pathwill fail the play. Consider adding a file-existence check (e.g., viastat) or including the role’sensure-file.ymltask before this step.
124-135: Use dynamic label in assertion messageThe failure message hardcodes "splunk". Replace with
{{ trs_collector }}for clarity:- fail_msg: >- - Variable splunk POST status {{ _trs_splunk_response.status }} + fail_msg: >- + Variable {{ trs_collector }} POST status {{ _trs_splunk_response.status }}This improves maintainability if multiple collectors are supported.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (15)
README.md(5 hunks)ansible-collection-redhatci-ocp.spec(2 hunks)galaxy.yml(1 hunks)roles/test_report_send/doc/env2vars.md(1 hunks)roles/test_report_send/doc/main.md(1 hunks)roles/test_report_send/doc/reporting.md(1 hunks)roles/test_report_send/doc/scripts/jenkins_node_labels.sh(1 hunks)roles/test_report_send/meta/argument_specs.yml(1 hunks)roles/test_report_send/tasks/dump-file.yml(1 hunks)roles/test_report_send/tasks/ensure-file.yml(1 hunks)roles/test_report_send/tasks/env2vars-populate.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/unknown.yml(1 hunks)roles/test_report_send/tasks/reporting/splunk.yml(1 hunks)roles/test_report_send/tasks/reporting/validations.yml(1 hunks)roles/test_report_send/vars/env2vars/jenkins.yml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- roles/test_report_send/tasks/env2vars-populate.yml
🚧 Files skipped from review as they are similar to previous changes (8)
- galaxy.yml
- ansible-collection-redhatci-ocp.spec
- roles/test_report_send/tasks/metadata-detect/unknown.yml
- roles/test_report_send/vars/env2vars/jenkins.yml
- roles/test_report_send/tasks/ensure-file.yml
- roles/test_report_send/meta/argument_specs.yml
- roles/test_report_send/doc/scripts/jenkins_node_labels.sh
- README.md
🧰 Additional context used
🪛 LanguageTool
roles/test_report_send/doc/env2vars.md
[typographical] ~7-~7: Do not use a colon (:) before a series that is introduced by a preposition (‘as’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...nt: 1. Tests answers questions such as: 1. which test suite(s) ran, with whi...
(RP_COLON)
[grammar] ~55-~55: Did you mean “don't have”?
Context: ...nt variables. ## Solution overview We not have full control of our reporting systems, ...
(NOT_TO_DOES_NOT)
[grammar] ~58-~58: The word ‘admin’ is a noun or an adjective. A verb is missing or misspelled, or maybe a comma is missing.
Context: ...ost-ingest processing. In short, we 1. can't admin the reporting (regulation, policies) 2....
(PRP_MD_NN)
[uncategorized] ~59-~59: When ‘CI-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...policies) 2. we do not want to maintain CI specific queries => we want to query events from...
(SPECIFIC_HYPHEN)
[uncategorized] ~94-~94: You might be missing the article “a” here.
Context: ...development, env2vars is populated by list of key -> var pairs to define keys from...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~106-~106: Possible missing comma found.
Context: ...ng reported. 1. For every supported CI type we should have proper `vars/env2vars/{{...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~124-~124: Possible missing article found.
Context: ...g, default | ### (*) Assumes list of strings, given the data is formatted...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~131-~131: A punctuation mark might be missing here.
Context: ... | | ---------- | ----------------- | | <elm> | element | | `<...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~135-~135: You might be missing the article “a” here.
Context: ...msep>` | element separator | Parsed as list of strings, into: ```yaml ${key}: ...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
roles/test_report_send/doc/main.md
[uncategorized] ~13-~13: A punctuation mark might be missing here.
Context: ...d) 2. Jenkins 2. Reporting, per reporting system: 1. [Splunk]...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
roles/test_report_send/doc/reporting.md
[uncategorized] ~10-~10: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...s - Data-based decision-making process Currently supported reporting system: [splunk.md]...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
🪛 markdownlint-cli2 (0.17.2)
roles/test_report_send/doc/env2vars.md
7-7: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
38-38: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
57-57: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
58-58: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
59-59: Line length
Expected: 120; Actual: 209
(MD013, line-length)
66-66: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
69-69: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
70-70: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
72-72: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
73-73: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
102-102: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
207-207: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
220-220: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
231-231: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
244-244: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
250-250: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
257-257: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
266-266: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
274-274: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
285-285: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
🪛 YAMLlint (1.37.1)
roles/test_report_send/tasks/dump-file.yml
[error] 27-27: no new line character at the end of file
(new-line-at-end-of-file)
🪛 Checkov (3.2.334)
roles/test_report_send/tasks/reporting/splunk.yml
[MEDIUM] 109-125: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 109-125: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
roles/test_report_send/tasks/reporting/validations.yml
[MEDIUM] 25-36: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 25-36: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Sanity Check (stable-2.18)
- GitHub Check: Ansible-lint Check
- GitHub Check: Sanity Check (stable-2.9)
🔇 Additional comments (14)
roles/test_report_send/doc/main.md (1)
1-15: Documentation is clear and comprehensive.
No changes needed here.roles/test_report_send/doc/reporting.md (1)
1-11: Reporting overview is well-written and informative.
No edits required.roles/test_report_send/tasks/reporting/splunk.yml (12)
10-15: Correctly handle empty JSON contentGood use of
default({})and conditional decoding to avoid errors when the file is empty.
17-21: Conditional debug output is informativeDebugging
trs_default_tsat higher verbosity helps troubleshooting without cluttering standard runs.
23-30: Robust timestamp parsingThe Jinja chain cleanly extracts integer and fractional parts. Consider catching parse errors if
trs_meta_data.job.created_atis malformed, but overall solid.
31-33: Aggregate timestamp as floatCombining integer and fraction is concise and clear.
35-41: Merge authorization header correctlyUsing
combinewith a default dict ensures headers include only provided values.
42-47: Add custom request channel headerAppending
X-Splunk-Request-Channelwhen provided is correct and follows Ansible best practices.
48-57: Define default HTTP status codesProviding a fallback including
403for mock collectors is thoughtful.
58-66: Override status codes when sendingRestricting to only
200on real sends is consistent; HEAD is unused in send, and POST check is strict.Also applies to: 67-68
69-72: Modular validation tasksIsolating Splunk validations in
validations.ymlkeeps this file focused.
73-78: Construct event dictionary correctlySeparating
testandmetadataundertrs_eventis clear and maintainable.
79-84: Verbose event previewConditional debug of
trs_eventaids troubleshooting at higher verbosity.
100-107: Conditional event dumpingIncluding
dump-file.ymlbased ontrs_event_saveis neat for optional local dumps.
mvk
force-pushed
the
mvk-role-test_report_send
branch
from
f0d2b9c to
ab2450d
Compare
|
from change #712:
|
1 similar comment
|
from change #712:
|
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (6)
roles/test_report_send/tasks/reporting/validations.yml (1)
11-15: Dictionary key lookup will raise beforeis definedhelpsIndexing a potentially-missing key (
['Authorization'],['X-Splunk-Request-Channel']) throws a fatal error before theis definedtest can be evaluated.
Switch to membership checks first, then safely inspect the value.- - trs_collector_auth_headers['Authorization'] is defined - - trs_collector_auth_headers['X-Splunk-Request-Channel'] is defined - - trs_collector_auth_headers['Authorization'] | regex_search('^Splunk ') - - trs_collector_auth_headers['Authorization'] | length > 10 - - trs_collector_auth_headers['X-Splunk-Request-Channel'] | length > 5 + - "'Authorization' in trs_collector_auth_headers" + - "'X-Splunk-Request-Channel' in trs_collector_auth_headers" + - trs_collector_auth_headers['Authorization'] | default('') | regex_search('^Splunk ') + - trs_collector_auth_headers['Authorization'] | default('') | length > 10 + - trs_collector_auth_headers['X-Splunk-Request-Channel'] | default('') | length > 5roles/test_report_send/tasks/reporting/splunk.yml (3)
130-134:hostfield still points at the collector URL
(This is the same concern raised previously.)Sending the target URL as
hostdrops useful provenance information and breaks host-based grouping in Splunk. Prefer the emitting host/source.
78-84: Guardwhen:clause against undefinedtrs_collectorand make it self-containedIf
trs_collectorisn’t set, the second condition explodes during evaluation.
Also keep the pattern consistent with the first condition.- when: - - trs_collector_auth_token | default('') | length > 0 - - trs_collector + when: + - trs_collector_auth_token | default('') | length > 0 + - trs_collector | default('') | length > 0
85-91:lengthon an undefined variable may fail
trs_collector_target | lengthraises when the variable is unset.
Provide a safe default first.- when: - - trs_collector_target | length > 0 + when: + - trs_collector_target | default('') | length > 0roles/test_report_send/doc/event.proto (2)
10-15: Remove illegal semicolon & spacing after message block
proto3does not allow a semicolon after a message definition. The extra;will makeprotoc/buf lintfail.- repeated CIRunnerProperty properties= 3; -}; + repeated CIRunnerProperty properties = 3; +}
3-3: Package-directory mismatch blocks Buf / ProtocPackage is declared as
test_report, but the file lives inroles/test_report_send/doc.
Either move the file totest_report/event.protoor change the package:-package test_report; +package roles.test_report_send.doc;Without this,
buf generateand CI linting will error out (PACKAGED_DIRECTORY_MATCH).
🧹 Nitpick comments (4)
roles/test_report_send/doc/splunk.md (1)
106-112: JSON example contains inline comments – not valid JSONReaders may copy/paste the snippet into validators that reject
//comments.
Consider moving the explanations outside of the fenced block or use/* */-style in a note.roles/test_report_send/doc/jenkins.md (1)
89-92: Comma splice after “{},”Minor grammar: insert a period or semicolon after the brace to avoid run-on.
roles/test_report_send/doc/comprehensive_guide.md (1)
490-496: Hyphenate “decision-making”Consistent technical writing: “decision-making” is normally hyphenated.
roles/test_report_send/doc/env2vars.md (1)
21-33: Tighten up Markdown heading hierarchy & excess blank lines
### Testsjumps directly from an H2 to an H3 and is followed by a run-on series of blank lines. Linting tools (markdownlintMD001/MD012) complain and some renderers collapse the whitespace unpredictably.-### Tests - - - - - - +### TestsSame applies to the block that starts with
## Solution Overview(around lines 59-67). A quick pass withmarkdownlint --fixorpre-commitwould normalise heading levels, bullet indentation and remove >150 superfluous blank lines.Also applies to: 59-67
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (42)
.github/CODEOWNERS(1 hunks).gitignore(1 hunks).markdownlint.json(1 hunks)README.md(5 hunks)ansible-collection-redhatci-ocp.spec(2 hunks)galaxy.yml(1 hunks)roles/junit2json/tasks/convert.yml(1 hunks)roles/junit2json/tasks/ensure-dir.yml(1 hunks)roles/junit2json/tasks/merge.yml(1 hunks)roles/test_report_send/README.md(1 hunks)roles/test_report_send/defaults/main.yml(1 hunks)roles/test_report_send/doc/comprehensive_guide.md(1 hunks)roles/test_report_send/doc/dci.md(1 hunks)roles/test_report_send/doc/env2vars.md(1 hunks)roles/test_report_send/doc/event.json(1 hunks)roles/test_report_send/doc/event.md(1 hunks)roles/test_report_send/doc/event.proto(1 hunks)roles/test_report_send/doc/jenkins.md(1 hunks)roles/test_report_send/doc/main.md(1 hunks)roles/test_report_send/doc/metadata.md(1 hunks)roles/test_report_send/doc/reporting.md(1 hunks)roles/test_report_send/doc/scripts/gen_dcirc.sh(1 hunks)roles/test_report_send/doc/scripts/jenkins_node_labels.sh(1 hunks)roles/test_report_send/doc/splunk.md(1 hunks)roles/test_report_send/meta/argument_specs.yml(1 hunks)roles/test_report_send/meta/main.yml(1 hunks)roles/test_report_send/tasks/ci-detect.yml(1 hunks)roles/test_report_send/tasks/dump-file.yml(1 hunks)roles/test_report_send/tasks/empty.yml(1 hunks)roles/test_report_send/tasks/ensure-file.yml(1 hunks)roles/test_report_send/tasks/env2vars-populate.yml(1 hunks)roles/test_report_send/tasks/main.yml(1 hunks)roles/test_report_send/tasks/metadata-detect.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/dci.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/jenkins.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/unknown.yml(1 hunks)roles/test_report_send/tasks/reporting/splunk.yml(1 hunks)roles/test_report_send/tasks/reporting/validations.yml(1 hunks)roles/test_report_send/templates/env2vars.j2(1 hunks)roles/test_report_send/tests/test.yml(1 hunks)roles/test_report_send/vars/env2vars/example.yml(1 hunks)roles/test_report_send/vars/env2vars/jenkins.yml(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- roles/test_report_send/tasks/env2vars-populate.yml
- roles/test_report_send/doc/metadata.md
🚧 Files skipped from review as they are similar to previous changes (32)
- galaxy.yml
- .gitignore
- .markdownlint.json
- roles/test_report_send/tests/test.yml
- roles/test_report_send/doc/main.md
- roles/test_report_send/doc/reporting.md
- roles/junit2json/tasks/ensure-dir.yml
- roles/test_report_send/tasks/metadata-detect.yml
- roles/test_report_send/doc/dci.md
- roles/test_report_send/tasks/metadata-detect/unknown.yml
- roles/test_report_send/tasks/empty.yml
- roles/test_report_send/doc/scripts/jenkins_node_labels.sh
- roles/test_report_send/vars/env2vars/jenkins.yml
- roles/junit2json/tasks/merge.yml
- .github/CODEOWNERS
- roles/test_report_send/tasks/metadata-detect/dci.yml
- roles/test_report_send/meta/argument_specs.yml
- roles/test_report_send/doc/event.md
- ansible-collection-redhatci-ocp.spec
- roles/test_report_send/tasks/ensure-file.yml
- roles/test_report_send/vars/env2vars/example.yml
- roles/test_report_send/tasks/main.yml
- roles/junit2json/tasks/convert.yml
- roles/test_report_send/tasks/ci-detect.yml
- README.md
- roles/test_report_send/doc/event.json
- roles/test_report_send/templates/env2vars.j2
- roles/test_report_send/tasks/metadata-detect/jenkins.yml
- roles/test_report_send/tasks/dump-file.yml
- roles/test_report_send/defaults/main.yml
- roles/test_report_send/doc/scripts/gen_dcirc.sh
- roles/test_report_send/meta/main.yml
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#715
File: roles/copy_and_render/tasks/main.yml:18-24
Timestamp: 2025-06-24T21:40:17.028Z
Learning: The copy_and_render role in the ansible-collection-redhatci-ocp repository is designed to work only with relative paths for car_source_dir, not absolute paths. This is an intentional design constraint.
roles/test_report_send/doc/comprehensive_guide.md (1)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
roles/test_report_send/doc/env2vars.md (1)
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/README.md (3)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#715
File: roles/copy_and_render/tasks/main.yml:18-24
Timestamp: 2025-06-24T21:40:17.028Z
Learning: The copy_and_render role in the ansible-collection-redhatci-ocp repository is designed to work only with relative paths for car_source_dir, not absolute paths. This is an intentional design constraint.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/tasks/reporting/splunk.yml (3)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#652
File: roles/example_cnf_deploy/scripts/get-example-cnf-status.sh:45-45
Timestamp: 2025-04-21T23:02:58.178Z
Learning: When deprecating components in the redhatci/ansible-collection-redhatci-ocp repository, references to the deprecated component in other roles (like references to `cnf-app-mac-operator` in `fbc_catalog`) may be left intact if they serve as examples rather than functional components. Deprecation scope should be limited to the directly affected role (in this case `example_cnf_deploy`).
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/tasks/reporting/validations.yml (2)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
🪛 LanguageTool
roles/test_report_send/doc/comprehensive_guide.md
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...I System Information:** - JENKINS_URL: Base URL of the Jenkins instance - `NOD...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~246-~246: Loose punctuation mark.
Context: ...gers Job Information: - JOB_NAME: Jenkins job name - JOB_URL: Job URL -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~255-~255: Loose punctuation mark.
Context: ...urce Code Information:** - GIT_COMMIT: Full SHA-1 hash of current commit - `GI...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~287-~287: Loose punctuation mark.
Context: ... Runner Information: - NODE_NAME: Runner name - NODE_LABELS: Space-sepa...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~300-~300: Possible missing comma found.
Context: ...des a different approach to CI metadata collection since it stores completed process infor...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~386-~386: You might be missing the article “the” here.
Context: ...ion**: Collects and formats values from environment 3. Event Metadata Generation: Trans...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~490-~490: The noun “decision-making” (= the process of deciding something) is spelled with a hyphen.
Context: ...to enable observability and data-driven decision making. ### Benefits - **Shared Visual Langu...
(DECISION_MAKING)
roles/test_report_send/doc/env2vars.md
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...s to allow quick reporting-side rollout cadence depending on organizational regulations...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~70-~70: It appears that a comma is missing.
Context: ...stion. ### Implementation For each CI system we create: * env2vars maps environme...
(DURING_THAT_TIME_COMMA)
roles/test_report_send/README.md
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...under 'test' attribute. For full report syntax see [doc/event.md](ocp/role/test_report...
(AI_HYDRA_LEO_MISSING_COMMA)
roles/test_report_send/doc/jenkins.md
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...nning in jenkins. ### CI * NODE_NAME: The name of the agent (or controller) w...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...here the build is running. * WORKSPACE: The absolute path to the directory wher...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ring the build process. * JENKINS_HOME: The directory where Jenkins stores its ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ory, and other data. * EXECUTOR_NUMBER: The unique number that identifies the c...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...r job's metadata. ### Job * JOB_NAME: The name of the Jenkins job. * `JOB_URL...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...The name of the Jenkins job. * JOB_URL: The URL of the Jenkins job. * `BUILD_NU...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...URL of the Jenkins job. * BUILD_NUMBER: The unique build number for the current...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ... current run (e.g., 153). * BUILD_ID: The current build ID, usually identical...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...r recent Jenkins versions. * BUILD_TAG: A unique tag combining the job name and...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...B_NAME}-${BUILD_NUMBER}). * BUILD_URL`: The URL where the results of this speci...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...an be found. ### Source * GIT_COMMIT: The full SHA-1 hash of the current Gi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...t Git commit being built. * GIT_BRANCH: The name of the Git branch being built ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: .../master, feature/my-branch). * GIT_URL: The URL of the remote Git repository. *...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...ote Git repository. * GIT_LOCAL_BRANCH: If a specific local branch is checked o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...ontain its name. * GIT_PREVIOUS_COMMIT: The SHA-1 hash of the previous commit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...anch. * GIT_PREVIOUS_SUCCESSFUL_COMMIT: The SHA-1 hash of the commit of the l...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...st/Merge Request/ChangeId * CHANGE_ID: for GitHub it is PR, for GitLab it is M...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~61-~61: Loose punctuation mark.
Context: ...rrit it is ChangeId. * PULL_REQUEST_ID: GitHub term * `GITLAB_MERGE_REQUEST_IID...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...tHub Change Info (PR) * CHANGE_BRANCH: source branch name of the PR * `CHANGE_...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...R ###### Author (PR) * CHANGE_AUTHOR: the author of the PR * `CHANGE_AUTHOR_D...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ... * GITLAB_MERGE_REQUEST_SOURCE_BRANCH: source branch of the MR * `GITLAB_MERGE...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~84-~84: Loose punctuation mark.
Context: ...###### Author (MR) * GITLAB_USER_NAME: The merge request author's name. * `GIT...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~85-~85: Loose punctuation mark.
Context: ...est author's name. * GITLAB_USER_EMAIL: The merge request author's email. ### ...
(UNLIKELY_OPENING_PUNCTUATION)
[typographical] ~89-~89: The word “However” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...the metadata we can assign product: {}, However similar functionality can refer to a jo...
(HOWEVER_SENTENCE)
roles/test_report_send/doc/splunk.md
[uncategorized] ~5-~5: You might be missing the article “a” here.
Context: ...ons - Example queries are presented in jq or yq -like manner. - The variable...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
🪛 markdownlint-cli2 (0.17.2)
roles/test_report_send/doc/env2vars.md
7-7: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
8-8: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
11-11: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
12-12: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
13-13: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
14-14: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
15-15: Multiple consecutive blank lines
Expected: 1; Actual: 6
(MD012, no-multiple-blanks)
16-16: Multiple consecutive blank lines
Expected: 1; Actual: 7
(MD012, no-multiple-blanks)
17-17: Multiple consecutive blank lines
Expected: 1; Actual: 8
(MD012, no-multiple-blanks)
18-18: Inline HTML
Element: details
(MD033, no-inline-html)
19-19: Inline HTML
Element: summary
(MD033, no-inline-html)
19-19: Inline HTML
Element: b
(MD033, no-inline-html)
21-21: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
21-21: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
27-27: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
31-31: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
32-32: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
33-33: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
34-34: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
35-35: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
36-36: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
36-36: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
37-37: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
41-41: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
42-42: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
43-43: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
44-44: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
45-45: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
46-46: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
47-47: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
49-49: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
54-54: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
55-55: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
56-56: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
57-57: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
58-58: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
59-59: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
60-60: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
61-61: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
62-62: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
64-64: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
65-65: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
66-66: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
67-67: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
68-68: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
69-69: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
70-70: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
71-71: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
72-72: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
75-75: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
76-76: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
77-77: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
78-78: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
79-79: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
80-80: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
81-81: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
81-81: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
82-82: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
84-84: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
85-85: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
86-86: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
87-87: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
88-88: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
89-89: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
90-90: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
91-91: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
92-92: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
94-94: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
95-95: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
96-96: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
97-97: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
98-98: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
99-99: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
100-100: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
102-102: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
104-104: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
105-105: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
106-106: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
107-107: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
108-108: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
109-109: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
110-110: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
111-111: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
112-112: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
114-114: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
115-115: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
116-116: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
117-117: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
118-118: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
119-119: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
120-120: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
121-121: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
122-122: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
125-125: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
126-126: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
127-127: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
128-128: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
129-129: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
130-130: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
131-131: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
132-132: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
133-133: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
133-133: Line length
Expected: 120; Actual: 133
(MD013, line-length)
136-136: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
137-137: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
138-138: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
139-139: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
140-140: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
141-141: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
142-142: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
143-143: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
144-144: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
147-147: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
148-148: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
149-149: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
150-150: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
151-151: Multiple consecutive blank lines
Expected: 1; Actual: 6
(MD012, no-multiple-blanks)
152-152: Multiple consecutive blank lines
Expected: 1; Actual: 7
(MD012, no-multiple-blanks)
155-155: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
158-158: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
185-185: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
186-186: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
187-187: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
188-188: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
191-191: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
roles/test_report_send/README.md
7-7: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
8-8: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
11-11: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
12-12: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
13-13: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
14-14: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
15-15: Multiple consecutive blank lines
Expected: 1; Actual: 6
(MD012, no-multiple-blanks)
16-16: Multiple consecutive blank lines
Expected: 1; Actual: 7
(MD012, no-multiple-blanks)
17-17: Multiple consecutive blank lines
Expected: 1; Actual: 8
(MD012, no-multiple-blanks)
18-18: Inline HTML
Element: details
(MD033, no-inline-html)
19-19: Inline HTML
Element: summary
(MD033, no-inline-html)
19-19: Inline HTML
Element: b
(MD033, no-inline-html)
21-21: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
21-21: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
27-27: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
31-31: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
32-32: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
33-33: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
34-34: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
35-35: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
36-36: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
36-36: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
37-37: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
41-41: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
42-42: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
43-43: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
44-44: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
45-45: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
46-46: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
47-47: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
49-49: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
54-54: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
55-55: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
56-56: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
57-57: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
58-58: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
59-59: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
60-60: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
61-61: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
62-62: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
64-64: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
65-65: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
66-66: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
67-67: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
68-68: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
69-69: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
70-70: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
71-71: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
72-72: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
75-75: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
76-76: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
77-77: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
78-78: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
79-79: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
80-80: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
81-81: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
81-81: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
82-82: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
84-84: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
85-85: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
86-86: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
87-87: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
88-88: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
89-89: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
90-90: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
91-91: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
92-92: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
94-94: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
95-95: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
96-96: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
97-97: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
98-98: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
99-99: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
100-100: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
102-102: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
104-104: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
105-105: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
106-106: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
107-107: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
108-108: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
109-109: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
110-110: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
111-111: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
112-112: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
114-114: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
115-115: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
116-116: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
117-117: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
118-118: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
119-119: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
120-120: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
121-121: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
122-122: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
125-125: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
126-126: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
127-127: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
128-128: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
129-129: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
130-130: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
131-131: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
132-132: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
133-133: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
133-133: Line length
Expected: 120; Actual: 133
(MD013, line-length)
136-136: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
137-137: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
138-138: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
139-139: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
140-140: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
141-141: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
142-142: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
143-143: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
144-144: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
147-147: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
148-148: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
149-149: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
150-150: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
151-151: Multiple consecutive blank lines
Expected: 1; Actual: 6
(MD012, no-multiple-blanks)
152-152: Multiple consecutive blank lines
Expected: 1; Actual: 7
(MD012, no-multiple-blanks)
155-155: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
158-158: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
185-185: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
186-186: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
187-187: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
188-188: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
191-191: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
311-311: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
314-314: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
315-315: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
335-335: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
356-356: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
377-377: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
402-402: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
422-422: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
447-447: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
480-480: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
502-502: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
530-530: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
557-557: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
577-577: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
589-589: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
590-590: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
590-590: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
591-591: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
596-596: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
599-599: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🪛 Buf (1.54.0)
roles/test_report_send/doc/event.proto
3-3: Files with package "test_report" must be within a directory "test_report" relative to root but were in directory "roles/test_report_send/doc".
(PACKAGE_DIRECTORY_MATCH)
🪛 Checkov (3.2.334)
roles/test_report_send/tasks/reporting/splunk.yml
[MEDIUM] 145-161: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 145-161: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
roles/test_report_send/tasks/reporting/validations.yml
[MEDIUM] 28-39: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 28-39: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Ansible-lint Check
- GitHub Check: Sanity Check (stable-2.18)
- GitHub Check: Sanity Check (stable-2.9)
| - **Description**: Test report JSON file to send. | ||
| Merged into the event under 'test' attribute. | ||
| For full report syntax see [doc/event.md](ocp/role/test_report_send/doc/event.md). | ||
|
|
||
|
|
There was a problem hiding this comment.
Broken relative link to event schema
[doc/event.md](ocp/role/test_report_send/doc/event.md) points to a path that does not exist in the repo.
Either use a relative link (../doc/event.md) or an absolute GitHub URL so users don’t get a 404.
-For full report syntax see [doc/event.md](ocp/role/test_report_send/doc/event.md).
+For full report syntax see [event schema](../doc/event.md).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Description**: Test report JSON file to send. | |
| Merged into the event under 'test' attribute. | |
| For full report syntax see [doc/event.md](ocp/role/test_report_send/doc/event.md). | |
| - **Description**: Test report JSON file to send. | |
| Merged into the event under 'test' attribute. | |
| For full report syntax see [event schema](../doc/event.md). |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...under 'test' attribute. For full report syntax see [doc/event.md](ocp/role/test_report...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
37-37: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
41-41: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
🤖 Prompt for AI Agents
In roles/test_report_send/README.md around lines 37 to 41, the link to the event
schema file uses a broken relative path 'ocp/role/test_report_send/doc/event.md'
that does not exist. Fix this by updating the link to a correct relative path
such as '../doc/event.md' or replace it with an absolute GitHub URL pointing to
the correct location of the event.md file to prevent 404 errors.
bf8366f to
055baee
Compare
|
from change #712:
|
1 similar comment
|
from change #712:
|
|
Build succeeded. ✔️ dci-rpm-build-el8 SUCCESS in 2m 55s |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (9)
roles/test_report_send/tasks/reporting/validations.yml (2)
11-15: Indexing dict keys directly can crash when they are absent
trs_collector_auth_headers['Authorization']and friends explode before theis definedtests kick in. Use membership checks +defaultto stay safe.- - trs_collector_auth_headers['Authorization'] is defined - - trs_collector_auth_headers['X-Splunk-Request-Channel'] is defined - - trs_collector_auth_headers['Authorization'] | regex_search('^Splunk ') - - trs_collector_auth_headers['Authorization'] | length > 10 - - trs_collector_auth_headers['X-Splunk-Request-Channel'] | length > 5 + - "'Authorization' in trs_collector_auth_headers" + - "'X-Splunk-Request-Channel' in trs_collector_auth_headers" + - trs_collector_auth_headers['Authorization'] | default('') | regex_search('^Splunk ') + - trs_collector_auth_headers['Authorization'] | default('') | length > 10 + - trs_collector_auth_headers['X-Splunk-Request-Channel'] | default('') | length > 5
21-24: Missingis definedguard for URL assertion
Iftrs_collector_urlis unset the play will fail during template evaluation. Add the guard that was discussed previously.- - trs_collector_url is match('^https://') + - trs_collector_url is defined + - trs_collector_url | regex_search('^https://')roles/test_report_send/tasks/reporting/splunk.yml (4)
49-60: Same undefined-key risk for the pipeline block – the earlier feedback still applies.
90-91: Undefined variable risk
Add a default to prevent| lengthon an undefined var:- - trs_collector_target | length > 0 + - trs_collector_target | default('') | length > 0
79-84: Guard thewhen:clause and avoid bare variable
trs_collectormay be undefined, causing an immediate failure.- when: - - trs_collector_auth_token | default('') | length > 0 - - trs_collector + when: + - trs_collector_auth_token | default('') | length > 0 + - trs_collector | default('') | length > 0
131-134:hostshould represent the sender, not the collector URL
Using the collector URL loses provenance and breaks host-based grouping in Splunk.- "host": "{{ trs_collector_url | default(ansible_hostname) }}" + host: "{{ trs_collector_source | default(ansible_hostname) }}"roles/test_report_send/README.md (1)
38-41: Fix broken relative link to event specification
The link[doc/event.md](ocp/role/test_report_send/doc/event.md)points to a non-existent path. Readers will get a 404.-For full report syntax see [doc/event.md](ocp/role/test_report_send/doc/event.md). +For full report syntax see [event.md](../doc/event.md).roles/test_report_send/doc/event.proto (2)
10-14: Remove illegal trailing semicolon after message block
proto3does not permit a semicolon after the closing brace; the file will fail to compile.- repeated CIRunnerProperty properties= 3; -}; + repeated CIRunnerProperty properties = 3; +}
3-3: Align proto package with directoryThe
package test_report;declaration doesn’t match the file’s path (roles/test_report_send/doc/event.proto). Please choose one of the following:• Change the package to reflect its directory:
-package test_report; +package roles.test_report_send.doc;• Or move
event.protounder atest_report/folder to matchpackage test_report;.After making your change, run
buf lintto confirm the error is resolved.
🧹 Nitpick comments (11)
roles/test_report_send/doc/main.md (1)
9-14: Fix list indentation for clean Markdown renderingThe ordered list is nested but the indentation is off, causing markdownlint (
MD005,MD029) warnings and broken rendering on most viewers.
Suggest normalising to 3-space indents per level or switching to a top-level ordered list with dashed sub-lists.-1. [Event Structure](event.md) - 1. [metadata generation](metadata.md), per CI: - 1. [DCI](dci.md) - 2. [Jenkins](jenkins.md) -2. [Reporting](reporting.md), per reporting system: - 1. [Splunk](splunk.md) +1. [Event Structure](event.md) + - Metadata generation: + - [DCI](dci.md) + - [Jenkins](jenkins.md) +2. [Reporting](reporting.md) + - [Splunk](splunk.md)This removes numbering jitter and satisfies
markdownlintdefaults.roles/test_report_send/doc/reporting.md (1)
6-10: Polish phrasing & bullet-styleSentence “This in its turn enables” is awkward, and list markers use
*whereas other docs prefer-, trippingMD004.-This in its turn enables: - -* Shared visual and data languages -* Data-based decision-making process +This, in turn, enables: + +- Shared visual and data languages +- Data-driven decision-makingTiny tweak for clarity & consistency.
roles/test_report_send/doc/metadata.md (1)
3-4: Tighten introduction grammarCurrent wording reads a bit clunky.
-The metadata resides in the event object under `.metadata[]` -When everything is properly done, it has the following sections +Metadata is stored in the event object under `.metadata[]`. +It is organised into the following sections:Adds period, eliminates filler, and converts to two crisp sentences.
roles/test_report_send/doc/event.md (1)
3-5: Add missing period and extra blank line for linterMarkdown-lint flags missing punctuation; adding a period and ensuring a blank line before the next heading silences
MD022.-Sample event data can be seen here [`event.json`](event.json) - -The event contains the following main sections: +Sample event data can be seen here [`event.json`](event.json). + +The event contains the following main sections:Minor, but keeps docs tidy.
roles/test_report_send/doc/dci.md (1)
24-30: Clarify “Dynamic environment to metadata conversion” noteThe paragraph mixes two ideas in one long sentence; splitting improves readability.
-In this DCI use case, we do not need to dynamically process the environment. -When data from DCI reaches us, we can get the metadata from its API as JSON. +In this DCI workflow no dynamic environment processing is required. +All necessary metadata can be fetched directly from the DCI REST API as JSON.Also aligns with the concise style used in sibling docs.
roles/test_report_send/doc/env2vars.md (2)
42-47: Add blank lines before list to satisfy Markdown MD032
The bullet list that begins with “* change over the time …” is not preceded by a blank line, tripping markdownlint and impairing readability.-Even though the intent is to reduce the number of CI system types, the tools tend to: -* change over the time without backward compatibility +Even though the intent is to reduce the number of CI system types, the tools tend to: + +* change over the time without backward compatibility
118-123: Duplicate heading text causes anchor collisions (MD024)
Headings “### (*)” and “### (**)” repeat across the doc. Give them unique names so autogenerated anchors differ.Example:
-### (*) +### (*) List splitter formatroles/test_report_send/doc/splunk.md (1)
105-112: JSON sample isn’t valid JSON – remove comments & trailing commaThe illustrative block embeds
//comments and leaves a trailing comma after the last field, so anyone copy-pasting it will hit a parser error.{ - "source": "<str>", // type of information signifying team/channel - "host": "<hostname>", // the host or container or service sending the data + "source": "<str>", + "host": "<hostname>", "sourcetype": "_json", - "_time": <timestamp>, // event emission time stamp, note it may happen AFTER event occurrence. - "event": <trs_event>, // event data dictionary -} + "_time": "<timestamp>", + "event": "<trs_event>" +}If you want to keep the explanations, move them to prose below the snippet or use a table.
roles/test_report_send/doc/jenkins.md (1)
35-37: Jenkins does have a “pipeline” object – wording may confuse readers
Jenkinsfilepipelines (both declarative & scripted) are first-class objects exposed viaJOB_NAME,BUILD_URL, Blue Ocean API, etc. Saying “Jenkins does not have an object of pipeline” can mislead users.Consider rephrasing:
“Classic freestyle jobs have no separate pipeline entity. When a declarative/ scripted pipeline is used, the job itself represents the pipeline; hence
pipelineis left empty unless parent/child relationships are detected.”roles/test_report_send/doc/comprehensive_guide.md (2)
60-70: JSON example contains comments – break strict JSON
//comments are not part of the JSON spec and will cause tooling to fail. Recommend either:
- Drop inline comments and document fields below, or
- Mark the block as
jsonc/json5and clarify it’s pseudo-JSON.- "source": "<str>", // Information source (team/channel identifier) + "source": "<str>", ... - "metadata": "<metadata_object>", // CI/CD and environment metadata - "test": "<test_data_object>" // Test execution data + "metadata": "<metadata_object>", + "test": "<test_data_object>"
389-393: Code fence missing language identifierMarkdown-lint (
MD040) flags the pipeline diagram fence. Adding a language (e.g.,text) avoids the warning and enables proper formatting.-``` -Environment Variables → env2vars → trs_vars_dict → event.metadata -``` +```text +Environment Variables → env2vars → trs_vars_dict → event.metadata +```
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (43)
.github/CODEOWNERS(1 hunks).gitignore(1 hunks).markdownlint.json(1 hunks)README.md(5 hunks)ansible-collection-redhatci-ocp.spec(2 hunks)galaxy.yml(3 hunks)roles/junit2json/tasks/convert.yml(1 hunks)roles/junit2json/tasks/ensure-dir.yml(1 hunks)roles/junit2json/tasks/merge.yml(1 hunks)roles/test_report_send/README.md(1 hunks)roles/test_report_send/defaults/main.yml(1 hunks)roles/test_report_send/doc/comprehensive_guide.md(1 hunks)roles/test_report_send/doc/dci.md(1 hunks)roles/test_report_send/doc/env2vars.md(1 hunks)roles/test_report_send/doc/event.json(1 hunks)roles/test_report_send/doc/event.md(1 hunks)roles/test_report_send/doc/event.mmd(1 hunks)roles/test_report_send/doc/event.proto(1 hunks)roles/test_report_send/doc/jenkins.md(1 hunks)roles/test_report_send/doc/main.md(1 hunks)roles/test_report_send/doc/metadata.md(1 hunks)roles/test_report_send/doc/reporting.md(1 hunks)roles/test_report_send/doc/scripts/gen_dcirc.sh(1 hunks)roles/test_report_send/doc/scripts/jenkins_node_labels.sh(1 hunks)roles/test_report_send/doc/splunk.md(1 hunks)roles/test_report_send/meta/argument_specs.yml(1 hunks)roles/test_report_send/meta/main.yml(1 hunks)roles/test_report_send/tasks/ci-detect.yml(1 hunks)roles/test_report_send/tasks/dump-file.yml(1 hunks)roles/test_report_send/tasks/empty.yml(1 hunks)roles/test_report_send/tasks/ensure-file.yml(1 hunks)roles/test_report_send/tasks/env2vars-populate.yml(1 hunks)roles/test_report_send/tasks/main.yml(1 hunks)roles/test_report_send/tasks/metadata-detect.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/dci.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/jenkins.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/unknown.yml(1 hunks)roles/test_report_send/tasks/reporting/splunk.yml(1 hunks)roles/test_report_send/tasks/reporting/validations.yml(1 hunks)roles/test_report_send/templates/env2vars.j2(1 hunks)roles/test_report_send/tests/test.yml(1 hunks)roles/test_report_send/vars/env2vars/example.yml(1 hunks)roles/test_report_send/vars/env2vars/jenkins.yml(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- .github/CODEOWNERS
- roles/junit2json/tasks/ensure-dir.yml
- roles/test_report_send/doc/event.mmd
🚧 Files skipped from review as they are similar to previous changes (27)
- .gitignore
- .markdownlint.json
- roles/test_report_send/tests/test.yml
- galaxy.yml
- roles/junit2json/tasks/merge.yml
- roles/junit2json/tasks/convert.yml
- roles/test_report_send/tasks/env2vars-populate.yml
- roles/test_report_send/tasks/empty.yml
- ansible-collection-redhatci-ocp.spec
- roles/test_report_send/vars/env2vars/jenkins.yml
- roles/test_report_send/meta/main.yml
- roles/test_report_send/tasks/ensure-file.yml
- roles/test_report_send/tasks/metadata-detect/dci.yml
- roles/test_report_send/tasks/dump-file.yml
- roles/test_report_send/doc/scripts/jenkins_node_labels.sh
- roles/test_report_send/meta/argument_specs.yml
- roles/test_report_send/tasks/metadata-detect/unknown.yml
- roles/test_report_send/tasks/main.yml
- roles/test_report_send/tasks/ci-detect.yml
- README.md
- roles/test_report_send/tasks/metadata-detect.yml
- roles/test_report_send/templates/env2vars.j2
- roles/test_report_send/doc/event.json
- roles/test_report_send/tasks/metadata-detect/jenkins.yml
- roles/test_report_send/defaults/main.yml
- roles/test_report_send/doc/scripts/gen_dcirc.sh
- roles/test_report_send/vars/env2vars/example.yml
🧰 Additional context used
🧠 Learnings (7)
📓 Common learnings
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#715
File: roles/copy_and_render/tasks/main.yml:18-24
Timestamp: 2025-06-24T21:40:17.028Z
Learning: The copy_and_render role in the ansible-collection-redhatci-ocp repository is designed to work only with relative paths for car_source_dir, not absolute paths. This is an intentional design constraint.
roles/test_report_send/tasks/reporting/splunk.yml (3)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#652
File: roles/example_cnf_deploy/scripts/get-example-cnf-status.sh:45-45
Timestamp: 2025-04-21T23:02:58.178Z
Learning: When deprecating components in the redhatci/ansible-collection-redhatci-ocp repository, references to the deprecated component in other roles (like references to `cnf-app-mac-operator` in `fbc_catalog`) may be left intact if they serve as examples rather than functional components. Deprecation scope should be limited to the directly affected role (in this case `example_cnf_deploy`).
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/doc/env2vars.md (1)
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/README.md (3)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#715
File: roles/copy_and_render/tasks/main.yml:18-24
Timestamp: 2025-06-24T21:40:17.028Z
Learning: The copy_and_render role in the ansible-collection-redhatci-ocp repository is designed to work only with relative paths for car_source_dir, not absolute paths. This is an intentional design constraint.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/doc/comprehensive_guide.md (1)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
roles/test_report_send/doc/main.md (1)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
roles/test_report_send/tasks/reporting/validations.yml (2)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
🪛 Checkov (3.2.334)
roles/test_report_send/tasks/reporting/splunk.yml
[MEDIUM] 145-161: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 145-161: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
roles/test_report_send/tasks/reporting/validations.yml
[MEDIUM] 28-39: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 28-39: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
🪛 LanguageTool
roles/test_report_send/doc/env2vars.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: ...CI metadata collection and normalization ## Problem description We send data to rep...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...nd normalization ## Problem description We send data to reporting for visualizat...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: Place a period at the end of declarative sentences.
Context: ...reporting for visualization and analysis We send 2 main "chunks" of data in each ...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~7-~7: Use proper spacing conventions.
Context: ...d 2 main "chunks" of data in each event: 1. Tests answer questions such as the fol...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~9-~9: There might be a mistake here.
Context: ... answer questions such as the following: 1. which test suite(s) ran, with which resu...
(QB_NEW_EN_OTHER)
[grammar] ~10-~10: Use an Oxford comma.
Context: ... test suite(s) ran, with which results, timings and errors, and for each suite? 1...
(QB_NEW_EN_OTHER_ERROR_IDS_000014)
[grammar] ~10-~10: Use proper spacing conventions.
Context: ... timings and errors, and for each suite? 1. which test cases ran and with which resu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~11-~11: Use an Oxford comma.
Context: ... test cases ran and with which results, timings and errors? 2. metadata answers the...
(QB_NEW_EN_OTHER_ERROR_IDS_000014)
[grammar] ~11-~11: Use proper spacing conventions.
Context: ... with which results, timings and errors? 2. metadata answers the questions like ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~12-~12: There might be a mistake here.
Context: ...ngs and errors? 2. metadata answers the questions like 1. what triggered the...
(QB_NEW_EN_OTHER)
[grammar] ~12-~12: There might be a mistake here.
Context: ... metadata answers the questions like 1. what triggered the run? 2. where did it r...
(QB_NEW_EN_OTHER)
[grammar] ~13-~13: Use proper spacing conventions.
Context: ...tions like 1. what triggered the run? 2. where did it run? 3. what version(s) ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~14-~14: Use proper spacing conventions.
Context: ...iggered the run? 2. where did it run? 3. what version(s) of which products were t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~15-~15: Use proper spacing conventions.
Context: ...ersion(s) of which products were tested? 4. what types of tests ran? 5. who is th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~16-~16: There might be a problem here.
Context: ... were tested? 4. what types of tests ran? 5. who is the author of the changes? 6. ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~17-~17: Use proper spacing conventions.
Context: ... 5. who is the author of the changes? 6. where is the code? 7. which team supp...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: Use proper spacing conventions.
Context: ...of the changes? 6. where is the code? 7. which team supports issues for this code...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~19-~19: Use proper spacing conventions.
Context: ...hich team supports issues for this code? ### Tests The tests' reports are unified by...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~21-~21: Use proper spacing conventions.
Context: ...upports issues for this code? ### Tests The tests' reports are unified by JUnit ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ...s keeps the tests in the same structure. ### Metadata However, the metadata comes fr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~25-~25: Use proper spacing conventions.
Context: ...sts in the same structure. ### Metadata However, the metadata comes from the CI ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~27-~27: Place a period at the end of declarative sentences.
Context: ...he CI system. And there are many of them #### Abundance Currently, only one group I a...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ...d there are many of them #### Abundance Currently, only one group I am working a...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use correct prepositions.
Context: ... Currently, only one group I am working at uses the following CI system types inte...
(QB_NEW_EN_OTHER_ERROR_IDS_000010)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ...llowing CI system types interchangeably: * [Distributed CI](https://distributed-ci.i...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ...(https://distributed-ci.io) (a.k.a. DCI) * GitLab * [GitHub](...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...stributed-ci.io) (a.k.a. DCI) * GitLab * GitHub * [Jenkins]...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~37-~37: Use proper spacing conventions.
Context: ... GitLab * GitHub * Jenkins * [Pro...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~39-~39: Use proper spacing conventions.
Context: ...GitHub * Jenkins * Prow Ev...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~41-~41: Use proper spacing conventions.
Context: ...enkins](https://www.jenkins.io) * Prow Even though the intent is to reduce the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~44-~44: There might be a mistake here.
Context: ...types, the tools tend to: * change over the time without backward compatibility * n...
(QB_NEW_EN_OTHER)
[grammar] ~44-~44: There might be a mistake here.
Context: ...* change over the time without backward compatibility * new tools come up * the migrations ef...
(QB_NEW_EN_OTHER)
[grammar] ~45-~45: There might be a mistake here.
Context: ...backward compatibility * new tools come up * the migrations efforts are prioritize...
(QB_NEW_EN_OTHER)
[grammar] ~46-~46: Use singular and plural nouns appropriately.
Context: ...compatibility * new tools come up * the migrations efforts are prioritized lower than othe...
(QB_NEW_EN_OTHER_ERROR_IDS_000012)
[grammar] ~46-~46: Place a period at the end of declarative sentences.
Context: ...are prioritized lower than other efforts #### Disparity between CI systems metadata E...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~48-~48: Use proper spacing conventions.
Context: ...## Disparity between CI systems metadata Each CI system generates metadata in its...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~50-~50: Use proper spacing conventions.
Context: ...tes metadata in its own specific manner. There are 2 most common methods to commu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~51-~51: There might be a mistake here.
Context: ...ime dynamic metadata, either by exposing: 1. an extensive set of environment variable...
(QB_NEW_EN_OTHER)
[grammar] ~54-~54: Use articles correctly.
Context: ...tensive set of environment variables 2. single environment variable, pointing at a fil...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~55-~55: Use proper spacing conventions.
Context: ...ile with structured JSON payload 3. both Still, each CI system has its own consid...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~57-~57: There might be a problem here.
Context: ...ach CI system has its own considerations, terminology and this data is kept in different stru...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~57-~57: Use proper spacing conventions.
Context: ...ferent structures/environment variables. ## Solution Overview In short, the user ma...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~59-~59: Use proper spacing conventions.
Context: ...ronment variables. ## Solution Overview In short, the user may be limited by org...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~61-~61: Use proper spacing conventions.
Context: ...traints with *: 1. not enough permissions to allow quick re...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~63-~63: Use proper spacing conventions.
Context: ... on organizational regulations/policies. 2. a healthy desire to generate CI-invarian...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~64-~64: Use proper spacing conventions.
Context: ... CI-invariant queries in the dashboards. Ergo, the minimal external dependency pa...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~66-~66: Use proper spacing conventions.
Context: ...malize the data structure pre-ingestion. ### Implementation For each CI system we cr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~68-~68: Use proper spacing conventions.
Context: ...cture pre-ingestion. ### Implementation For each CI system we create: * `env2va...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~70-~70: Use proper spacing conventions.
Context: ...mentation For each CI system we create: * env2vars maps environment variables to event met...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~72-~72: Use proper spacing conventions.
Context: ... event metadata through trs_vars_dict. * trs_vars_dict contains the data used to directly popu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~73-~73: Use proper spacing conventions.
Context: ...d to directly populate event.metadata. The structure of the event is defined in...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~75-~75: Use proper spacing conventions.
Context: ...ent is defined in this file. It usually has the following information...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~76-~76: Use proper spacing conventions.
Context: ...ng information under event.metadata[]: | event coordinates(*) | trs_vars_dict...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~88-~88: Use proper spacing conventions.
Context: ... | (*) - written using jq notation In env2vars we map this metadata into ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~90-~90: There might be a mistake here.
Context: ... (*) - written using jq notation In env2vars we map this metadata into event's `meta...
(QB_NEW_EN_OTHER)
[grammar] ~90-~90: Use articles correctly.
Context: ...In env2vars we map this metadata into event's metadata. This is done in these stage...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~90-~90: Use proper spacing conventions.
Context: ...p this metadata into event's metadata. This is done in these stages: 1. During...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~91-~91: Use proper spacing conventions.
Context: ...metadata. This is done in these stages: 1. During the development, env2vars` is po...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~93-~93: Use proper spacing conventions.
Context: ...efining keys from environment variables. 2. During runtime the role iterates over `e...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~94-~94: There might be a mistake here.
Context: ...s from environment variables. 2. During runtime the role iterates over env2vars keys,...
(QB_NEW_EN_OTHER)
[grammar] ~94-~94: There might be a mistake here.
Context: ...e the role iterates over env2vars keys, and assigns them in the transition dict...
(QB_NEW_EN_OTHER)
[grammar] ~94-~94: There might be a mistake here.
Context: ...eys, and assigns them in the transition dictionary trs_vars_dict 3. Next, it repeats over the populated `trs...
(QB_NEW_EN_OTHER)
[grammar] ~95-~95: There might be a mistake here.
Context: ... 3. Next, it repeats over the populated trs_vars_dict properly assigning its keys under `meta...
(QB_NEW_EN_OTHER)
[grammar] ~95-~95: There might be a mistake here.
Context: ...g its keys under metadata of the event 4. The translation of trs_vars_dict keys ...
(QB_NEW_EN_OTHER)
[grammar] ~96-~96: Place a period at the end of declarative sentences.
Context: ...t's metadata keys is relatively static This approach allows: * better readabil...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~98-~98: Use proper spacing conventions.
Context: ...relatively static This approach allows: * better readability because of less code ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~100-~100: Use singular and plural nouns appropriately.
Context: ...better readability because of less code duplications and significant similarity between CI s...
(QB_NEW_EN_OTHER_ERROR_IDS_000012)
[grammar] ~100-~100: Add a conjunction or punctuation.
Context: ...ignificant similarity between CI systems * the only exception is DCI: because it is ...
(QB_NEW_EN_OTHER_ERROR_IDS_000068)
[grammar] ~101-~101: Place a period at the end of declarative sentences.
Context: ...oring already passed process information So, trs_vars_dict is a transition vari...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~103-~103: Use articles correctly.
Context: ..._vars_dictis a transition variable to constructmetadata` part of the event being repo...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~103-~103: Use proper spacing conventions.
Context: ...adata` part of the event being reported. 1. For every supported CI type, we should h...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~105-~105: Use proper spacing conventions.
Context: ...vars/{{ trs_ci_type }}.ymlin the role. 2. The listenv2varsis used to updatet...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~106-~106: Use proper spacing conventions.
Context: ... is used to update trs_vars_dict keys. 3. trs_vars_dict keys are used to populate actual `.even...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~107-~107: There might be a mistake here.
Context: ...te actual .event.metadata[] attributes 4. Metadata maintenance is thus reduced to ...
(QB_NEW_EN_OTHER)
[grammar] ~108-~108: There might be a mistake here.
Context: ...e is thus reduced to generating the list, and sometimes adjusting which `trs_vars...
(QB_NEW_EN_OTHER)
[grammar] ~108-~108: There might be a mistake here.
Context: ...mes adjusting which trs_vars_dict keys populate which event.metadata[] attrib...
(QB_NEW_EN_OTHER)
[grammar] ~109-~109: Use proper spacing conventions.
Context: ...ate which event.metadata[] attributes. The following types are supported: | Ty...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~111-~111: Use proper spacing conventions.
Context: ...tes. The following types are supported: | Type | Constraints | | ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~119-~119: Use proper spacing conventions.
Context: ... | | str | string, default | ### (*) Assumes a list of strings, given th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~121-~121: Use proper spacing conventions.
Context: ...` | string, default | ### (*) Assumes a list of strings, given the dat...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~123-~123: Use proper spacing conventions.
Context: ... given the data is formatted as follows: text '<elm><elmsep><elm><elmsep>....<elmsep><elm>' | token | meaning | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~132-~132: Use proper spacing conventions.
Context: ... | | <elmsep> | element separator | Parsed as a list of strings, into: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~134-~134: Use proper spacing conventions.
Context: ... Parsed as a list of strings, into: yaml ${key}: # actual value of `key` in `env2vars` is used - '<elm>' ... - '<elm>' ### (**) Assumes flat dicts, given the data...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~143-~143: Use proper spacing conventions.
Context: ... '' ... - '' ``` ### (**) Assumes flat dicts, given the data is fo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~145-~145: Use proper spacing conventions.
Context: ... given the data is formatted as follows: text '<k><kvsep><v><elmsep><k><kvsep><v>...<elmsep><k><kvsep><v>' | token | meaning | | -...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~156-~156: Use proper spacing conventions.
Context: ... | | <kvsep> | key/value separator | Parsed as a flat dict of into: ```y...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~158-~158: There might be a problem here.
Context: ...parator | Parsed as a flat dict of into: yaml ${key}: # actual value of `key` in `env2vars` is used '<k>': '<v>' '<k>': '<v>' ... '<k>': '<v>' ## Defining variables ### Where to define ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~169-~169: Use proper spacing conventions.
Context: ...'': '' ``` ## Defining variables ### Where to define them 1. Identify the fi...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~171-~171: Use proper spacing conventions.
Context: ...ning variables ### Where to define them 1. Identify the file based on the CI you kn...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~173-~173: Place a period at the end of declarative sentences.
Context: ...entify the file based on the CI you know They need to be added in env2vars list...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~175-~175: There might be a mistake here.
Context: ... the CI you know They need to be added in env2vars list in a file `vars/<trs_ci...
(QB_NEW_EN_OTHER)
[grammar] ~175-~175: There might be a mistake here.
Context: ... list in a file vars/<trs_ci_type>.yml That is, if the trs_ci_type is `github...
(QB_NEW_EN_OTHER)
[grammar] ~176-~176: There might be a mistake here.
Context: ..._typeisgithub, the file you edit is: vars/env2vars/github.yml` 1. If the file is not present, create it #...
(QB_NEW_EN_OTHER)
[grammar] ~178-~178: Place a period at the end of declarative sentences.
Context: ...1. If the file is not present, create it ## How to define each type ### String (`st...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~180-~180: Use proper spacing conventions.
Context: ...t, create it ## How to define each type ### String (str) #### YAML structure ```...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~182-~182: Use proper spacing conventions.
Context: ... to define each type ### String (str) #### YAML structure ```yaml --- env2vars: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~184-~184: Use proper spacing conventions.
Context: ... ### String (str) #### YAML structure yaml --- env2vars: - key: my_key var: MY_ENV_VAR var_type: str ##### Examples | Environment |...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~194-~194: Use proper spacing conventions.
Context: ...AR var_type: str ``` ##### Examples | Environment | `vars_dic...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~198-~198: Use proper spacing conventions.
Context: ...ENV_VAR="kuku"|{"my_key": "kuku"}` | #### Comments This type is the default t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~200-~200: Use proper spacing conventions.
Context: ... | {"my_key": "kuku"} | #### Comments This type is the default type, no ne...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~202-~202: There might be a mistake here.
Context: ...ments This type is the default type, no need to specify it ### List (list...
(QB_NEW_EN_OTHER)
[grammar] ~202-~202: Place a period at the end of declarative sentences.
Context: ... default type, no need to specify it ### List (list) #### YAML structure ```y...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~204-~204: Use proper spacing conventions.
Context: ...no need to specify it ### List (list) #### YAML structure ```yaml env2vars: - ke...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~206-~206: Use proper spacing conventions.
Context: ... ### List (list) #### YAML structure yaml env2vars: - key: my_lst_key var: MY_ENV_LIST_VAR var_type: list splitter: - '/' NOTE: default splitter does not need t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~217-~217: Use articles correctly.
Context: ... splitter: - '/' ``` NOTE: default splitter does not need to be specified ...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~217-~217: Place a period at the end of declarative sentences.
Context: ...t splitter does not need to be specified ##### Examples | Environment | vars_dict as...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~219-~219: Use proper spacing conventions.
Context: ...not need to be specified ##### Examples | Environment | vars_dict as dict | | ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~224-~224: Use proper spacing conventions.
Context: ..."my_lst_key": ["path", "to", "some"]}` | NOTE: spaces are not stripped. ### Di...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~226-~226: Use proper spacing conventions.
Context: ...} | **NOTE:** spaces are not stripped. ### Dictionary (dict`) #### YAML structure...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~228-~228: Use proper spacing conventions.
Context: ...e not stripped. ### Dictionary (dict) #### YAML structure ```yaml --- env2vars: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~230-~230: Use proper spacing conventions.
Context: ...Dictionary (dict) #### YAML structure yaml --- env2vars: - key: my_dict_key var: MY_ENV_DICT_VAR var_type: dict splitter: - ' ' - ':' ##### Examples | Environment | vars_dict co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~243-~243: Use proper spacing conventions.
Context: ... - ' ' - ':' ``` ##### Examples | Environment | vars_dict contents | |...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~247-~247: Use proper spacing conventions.
Context: ...linux", "arch": ["x86_64", "amd64"]}}` | #### Comments The above splitters are the **...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~249-~249: Use proper spacing conventions.
Context: ... ["x86_64", "amd64"]}}` | #### Comments The above splitters are the default,...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~251-~251: Use proper spacing conventions.
Context: ...the default, so they can be omitted. Other interesting combinations of splitt...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~252-~252: Place a period at the end of declarative sentences.
Context: ...g combinations of splitters are possible ### Integer (int) #### YAML structure ``...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~254-~254: Use proper spacing conventions.
Context: ...itters are possible ### Integer (int) #### YAML structure ```yaml env2vars: - ke...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~256-~256: Use proper spacing conventions.
Context: ...### Integer (int) #### YAML structure yaml env2vars: - key: my_number var: MY_ENV_NUMBER var_type: int ##### Examples | Environment | vars_dict as...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~265-~265: Use proper spacing conventions.
Context: ...ER var_type: int ``` ##### Examples | Environment | vars_dict as dict | | ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~269-~269: Use proper spacing conventions.
Context: ..._VAR="34213"|{"my_number": 34213} | ### Boolean (bool) #### YAML structure ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~271-~271: Use proper spacing conventions.
Context: ...number": 34213} | ### Boolean (bool`) #### YAML structure ```yaml --- env2vars: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~273-~273: Use proper spacing conventions.
Context: ...## Boolean (bool) #### YAML structure yaml --- env2vars: - key: my_bool var: MY_BOOL_TRUTH var_type: bool ##### Examples | Environment | `...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~284-~284: Use proper spacing conventions.
Context: ... var_type: bool ``` ##### Examples | Environment | vars_dict...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~292-~292: Use proper spacing conventions.
Context: ...TRUTH="string"|{"my_bool": true}` | ## Constraints *<a name="our-gr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~295-~295: Use proper spacing conventions.
Context: ... {"my_bool": true} | ## Constraints * Our grou...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~298-~298: Use proper spacing conventions.
Context: ...rting systems because we are only users. * So we cannot rely on our capability to p...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~299-~299: Use proper spacing conventions.
Context: ... processing, which is too much overhead.
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/README.md
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...- DOCSIBLE START --> # 📃 Role overview ## test_report_send Description: Pushes ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ... # 📃 Role overview ## test_report_send Description: Pushes JUnit XML files and ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~38-~38: Use articles correctly.
Context: ...SON file to send. Merged into the event under 'test' attribute. For full report synta...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~38-~38: Use proper spacing conventions.
Context: ...d into the event under 'test' attribute. For full report syntax see [doc/event.md...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~51-~51: Use proper spacing conventions.
Context: ...ark special datasets during development. If set to be empty or the file is missin...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~145-~145: Use proper spacing conventions.
Context: ...Used only if trs_event_save is set to true
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~156-~156: Use proper spacing conventions.
Context: ...`
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~160-~160: Use proper spacing conventions.
Context: ...priority** #### File: defaults/main.yml | Var | Type | Value ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~189-~189: Use proper spacing conventions.
Context: ...unk']` | n/a | n/a | ### Tasks #### File: tasks/env2vars-populate.yml | Nam...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~192-~192: Use proper spacing conventions.
Context: ... #### File: tasks/env2vars-populate.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~199-~199: Use proper spacing conventions.
Context: ...True | #### File: tasks/ensure-file.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~207-~207: Use proper spacing conventions.
Context: ...| True | #### File: tasks/ci-detect.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~215-~215: Use proper spacing conventions.
Context: ... | #### File: tasks/metadata-detect.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~234-~234: Use proper spacing conventions.
Context: ...opy | False | #### File: tasks/main.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~246-~246: Use proper spacing conventions.
Context: ...| #### File: tasks/reporting/splunk.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~275-~275: Use proper spacing conventions.
Context: ... File: tasks/metadata-detect/jenkins.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~312-~312: Use proper spacing conventions.
Context: ...tin.fail | False | ## Task Flow Graphs ### Graph for env2vars-populate.yml ```merm...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~316-~316: Use proper spacing conventions.
Context: ...s ### Graph for env2vars-populate.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-->|Include vars| ___role_path____vars_env2vars0[include env2vars variable for trs ci system<br>include_vars: role path vars env2vars]:::includeVars ___role_path____vars_env2vars0-->|Task| Set_facts_from_environment_variables_into_trs_vars_dict1[set facts from environment variables into trs vars<br>dict<br>When: **env2vars default length 0**]:::task Set_facts_from_environment_variables_into_trs_vars_dict1-->End ### Graph for ensure-file.yml ```mermaid fl...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~336-~336: Use proper spacing conventions.
Context: ...>End ### Graph for ensure-file.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_value_of_var_trs_file_path0[print value of var trs file path]:::task Print_value_of_var_trs_file_path0-->|Task| Collect_file_stat_for_file_trs_file_path1[collect file stat for file trs file path
When: trs file path length 0]:::task Collect_file_stat_for_file_trs_file_path1-->|Task| Ensure_validation_requirements_are_met_for_file_trs_file_path2[ensure validation requirements are met for file
trs file path
When: trs file path length 0]:::task Ensure_validation_requirements_are_met_for_file_trs_file_path2-->End ### Graph for ci-detect.yml mermaid flow...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~357-~357: Use proper spacing conventions.
Context: ...-->End ### Graph for ci-detect.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| Recognize_trs_ci_system_as_DCI0[recognize trs ci system as dci
When: trs ci system unknown and lookup env dci
cs url length 0]:::task Recognize_trs_ci_system_as_DCI0-->|Task| Recognize_trs_ci_system_as_Jenkins1[recognize trs ci system as jenkins
When: trs ci system unknown and lookup env
jenkins url length 0]:::task Recognize_trs_ci_system_as_Jenkins1-->|Task| Validating_trs_ci_system_is_supported2[validating trs ci system is supported]:::task Validating_trs_ci_system_is_supported2-->End ### Graph for metadata-detect.yml mermai...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~378-~378: Use proper spacing conventions.
Context: ... ### Graph for metadata-detect.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-->|Include task| ci_detect_yml0[ci system auto detection
When: trs ci system autodetect
include_task: ci detect yml]:::includeTasks ci_detect_yml0-->|Include vars| vars1[include variables for trs ci system
include_vars: vars]:::includeVars vars1-->|Include task| env2vars_populate_yml2[detect dynamic metadata
include_task: env2vars populate yml]:::includeTasks env2vars_populate_yml2-->|Include task| metadata_detect____trs_ci_system____yml3[detect dynamic metadata
include_task: metadata detect trs ci system yml]:::includeTasks metadata_detect____trs_ci_system____yml3-->|Task| Print_generated_dict_trs_ci_runtime4[print generated dict trs ci runtime
When: trs debug]:::task Print_generated_dict_trs_ci_runtime4-->|Task| Update_metadata5[update metadata]:::task Update_metadata5-->|Task| Update_trs_collector_source_for_trs_ci_system6[update trs collector source for trs ci system
When: trs meta data ci url default length 0]:::task Update_trs_collector_source_for_trs_ci_system6-->End ### Graph for dump-file.yml mermaid flow...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~403-~403: Use proper spacing conventions.
Context: ...-->End ### Graph for dump-file.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_variable_trs_file_path0[print variable trs file path]:::task Print_variable_trs_file_path0-->|Task| Dump_the_event_data_to_file1[dump the event data to file]:::task Dump_the_event_data_to_file1-->End ### Graph for main.yml mermaid flowchart...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~423-~423: Use proper spacing conventions.
Context: ...file1-->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_all_required_variables_are_defined0[validate all required variables are defined]:::task Validate_all_required_variables_are_defined0-->|Include task| ensure_file_yml1[ensure presence and readability of essential input
files
When: trs file path length 0
include_task: ensure file yml]:::includeTasks ensure_file_yml1-->|Task| Initialize_trs_meta_data2[initialize trs meta data]:::task Initialize_trs_meta_data2-->|Task| Read_content_of_JSON_file_trs_file_path3[read content of json file trs file path
When: trs metadata path length 0]:::task Read_content_of_JSON_file_trs_file_path3-->|Task| Assign_JSON_content_into_trs_meta_data4[assign json content into trs meta data
When: trs metadata path length 0 and trs metadata
path is defined and trs metadata path content
length 0]:::task Assign_JSON_content_into_trs_meta_data4-->|Include task| metadata_detect_yml5[detect runtime metadata from our environment
include_task: metadata detect yml]:::includeTasks metadata_detect_yml5-->|Include task| reporting____trs_collector____yml6[send trs data event to collector trs collector
When: trs report path length 0
include_task: reporting trs collector yml]:::includeTasks reporting____trs_collector____yml6-->End ### Graph for reporting/splunk.yml merma...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~448-~448: Use proper spacing conventions.
Context: ... ### Graph for reporting/splunk.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_content_from_test_report_JSON_file0[read content from test report json file]:::task Read_content_from_test_report_JSON_file0-->|Task| Decode_JSON_content_of_test_report_file1[decode json content of test report file
When: trs json file content content length 0]:::task Decode_JSON_content_of_test_report_file1-->|Task| Print_currently_used_timestamp_trs_default_ts2[print currently used timestamp trs default ts]:::task Print_currently_used_timestamp_trs_default_ts2-->|Task| Setup_timestamps_broken_down_to_int_float_parts_for_trs_collector3[setup timestamps broken down to int float parts
for trs collector]:::task Setup_timestamps_broken_down_to_int_float_parts_for_trs_collector3-->|Task| Setup_timestamps_as_floats_for_reporting4[setup timestamps as floats for reporting]:::task Setup_timestamps_as_floats_for_reporting4-->|Task| Update_trs_collector_auth_headers_with_trs_collector_auth_token_from_the_user_for_trs_collector5[update trs collector auth headers with trs
collector auth token from the user for trs
collector
When: trs collector auth token length 0 and trs
collector]:::task Update_trs_collector_auth_headers_with_trs_collector_auth_token_from_the_user_for_trs_collector5-->|Task| Update_trs_collector_auth_headers_with_trs_collector_target_from_the_user_for_trs_collector6[update trs collector auth headers with trs
collector target from the user for trs collector
When: trs collector target length 0]:::task Update_trs_collector_auth_headers_with_trs_collector_target_from_the_user_for_trs_collector6-->|Task| Set_default_allowed_status_codes7[set default allowed status codes]:::task Set_default_allowed_status_codes7-->|Task| Set_allowed_status_codes8[set allowed status codes
When: trs do send]:::task Set_allowed_status_codes8-->|Include task| validations_yml9[validate splunk related data
include_task: validations yml]:::includeTasks validations_yml9-->|Task| Create_event_data_attributes10[create event data attributes]:::task Create_event_data_attributes10-->|Task| Print_event_data_before_timestamp_corrections11[print event data before timestamp corrections]:::task Print_event_data_before_timestamp_corrections11-->|Task| Combine_additional_attributes_into_the_data_at_trs_collector_target_for_trs_collector12[combine additional attributes into the data at trs
collector target for trs collector]:::task Combine_additional_attributes_into_the_data_at_trs_collector_target_for_trs_collector12-->|Include task| dump_file_yml13[print variable trs event dump file
When: trs event dump file length 0 and trs event
save
include_task: dump file yml]:::includeTasks dump_file_yml13-->|Task| Send_data_to_trs_collector14[send data to trs collector
When: trs do send default false]:::task Send_data_to_trs_collector14-->End ### Graph for reporting/validations.yml ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~503-~503: Use proper spacing conventions.
Context: ...## Graph for metadata-detect/jenkins.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| Update_is_ci_in_trs_ci_runtime_attribute_for_trs_ci_system0[update is ci in trs ci runtime attribute for trs<br>ci system]:::task Update_is_ci_in_trs_ci_runtime_attribute_for_trs_ci_system0-->|Task| Update_helper_variables_for_ci_attributes_for_trs_ci_system1[update helper variables for ci attributes for trs<br>ci system]:::task Update_helper_variables_for_ci_attributes_for_trs_ci_system1-->|Task| Update_helper_variables_for_ci_attributes_for_trs_ci_system2[update helper variables for ci attributes for trs<br>ci system]:::task Update_helper_variables_for_ci_attributes_for_trs_ci_system2-->|Task| Update_helper_variables_for_ci_runner_attributes_for_trs_ci_system3[update helper variables for ci runner attributes<br>for trs ci system]:::task Update_helper_variables_for_ci_runner_attributes_for_trs_ci_system3-->|Task| Update_helper_variables_for_trs_ci_runtime_attributes_for_trs_ci_system4[update helper variables for trs ci runtime<br>attributes for trs ci system]:::task Update_helper_variables_for_trs_ci_runtime_attributes_for_trs_ci_system4-->|Task| Update_helper_variables_for_job_attributes_for_trs_ci_system5[update helper variables for job attributes for trs<br>ci system]:::task Update_helper_variables_for_job_attributes_for_trs_ci_system5-->|Task| Update_helper_variables_for_source_attributes_for_trs_ci_system6[update helper variables for source attributes for<br>trs ci system]:::task Update_helper_variables_for_source_attributes_for_trs_ci_system6-->|Task| Update_helper_variables_for_source_change_attributes_for_trs_ci_system7[update helper variables for source change<br>attributes for trs ci system]:::task Update_helper_variables_for_source_change_attributes_for_trs_ci_system7-->|Task| Update_helper_variables_for_source_attributes_for_trs_ci_system8[update helper variables for source attributes for<br>trs ci system]:::task Update_helper_variables_for_source_attributes_for_trs_ci_system8-->|Task| Construct_the_final_trs_ci_runtime_metadata_dictionary_for_trs_ci_system9[construct the final trs ci runtime metadata<br>dictionary for trs ci system]:::task Construct_the_final_trs_ci_runtime_metadata_dictionary_for_trs_ci_system9-->End ### Graph for metadata-detect/dci.yml ```me...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~558-~558: Use proper spacing conventions.
Context: ...## Graph for metadata-detect/unknown.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| Unsupported_CI_system0[unsupported ci system]:::task Unsupported_CI_system0-->|Task| Fail_the_role1[fail the role]:::task Fail_the_role1-->End ## Playbook ```yml --- - name: Run test_re...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~578-~578: Use proper spacing conventions.
Context: ... Fail_the_role1-->End ## Playbook yml --- - name: Run test_report_send role hosts: localhost connection: local gather_facts: false roles: - role: redhatci.ocp.test_report_send ## Playbook graphmermaid flowchart TD ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~590-~590: Use proper spacing conventions.
Context: ....test_report_send ## Playbook graphmermaid flowchart TD localhost-->|Role| redhatci_ocp_test_report_send[redhatci ocp test report send] ``` ## Author Information Max Kovgan, Cesare Pl...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~599-~599: Use proper spacing conventions.
Context: ...x Kovgan, Cesare Placanica #### License Apache License, Version 2.0 #### Minimu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~601-~601: Use proper spacing conventions.
Context: ...### License Apache License, Version 2.0 #### Minimum Ansible Version 2.9 #### Platf...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~603-~603: Use proper spacing conventions.
Context: ...ersion 2.0 #### Minimum Ansible Version 2.9 #### Platforms No platforms specif...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~605-~605: Use proper spacing conventions.
Context: ...n 2.0 #### Minimum Ansible Version 2.9 #### Platforms No platforms specified. <!-- ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~607-~607: Use proper spacing conventions.
Context: ...mum Ansible Version 2.9 #### Platforms No platforms specified. <!-- DOCSIBLE EN...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~609-~609: Use proper spacing conventions.
Context: ... #### Platforms No platforms specified.
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/comprehensive_guide.md
[typographical] ~1-~1: To join two clauses or set off examples, consider using an em dash.
Context: # Test Report Send Role - Comprehensive Guide ## Table of Content...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~1-~1: Use proper spacing conventions.
Context: ...t Report Send Role - Comprehensive Guide ## Table of Contents 1. [Overview](#overvi...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...omprehensive Guide ## Table of Contents 1. Overview 2. [Event Structure...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: Use proper spacing conventions.
Context: ...#implementation-guide) --- ## Overview The test_report_send role generates ev...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~20-~20: Use proper spacing conventions.
Context: ...servability and analytics. This enables: - Shared visual and data languages acros...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~26-~26: Use proper spacing conventions.
Context: ...lized event structures ### Key Features - Multi-CI Support: Works with Jenkins, ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ... (Splunk, etc.) --- ## Event Structure Events contain two main components: **me...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~37-~37: Use proper spacing conventions.
Context: ... test data (test execution results). ### Protocol Buffer Schema Definition The e...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~39-~39: Use proper spacing conventions.
Context: .... ### Protocol Buffer Schema Definition The event structure is formally defined ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~58-~58: Use proper spacing conventions.
Context: ...el Event Structure (JSON Representation) json { "source": "<str>", // Information source (team/channel identifier) "host": "<hostname>", // Host/container/service sending the data "sourcetype": "_json", // Event format identifier "_time": "<timestamp>", // Event emission timestamp "event": { "metadata": "<metadata_object>", // CI/CD and environment metadata "test": "<test_data_object>" // Test execution data } } ### Key Components | Component | Ty...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~73-~73: Use proper spacing conventions.
Context: ...ion data } } ``` ### Key Components | Component | Type/Message ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~85-~85: Use proper spacing conventions.
Context: ... ### Benefits of Protocol Buffer Schema The Protocol Buffer definition provides ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~101-~101: Use proper spacing conventions.
Context: ...ication. ### Detailed Schema Components ReportMetadata Structure: ```protobuf...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~103-~103: Use proper spacing conventions.
Context: ... Components ReportMetadata Structure: protobuf message ReportMetadata { bool is_ci = 1; CI ci = 2; Pipeline pipeline = 3; Job job = 4; Source source = 5; Product product = 6; } CI System Structure: ```protobuf mess...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~116-~116: Use proper spacing conventions.
Context: ...oduct = 6; } **CI System Structure:** protobuf message CI { string url = 1; string type = 2; CIRunner runner = 3; } message CIRunner { string name = 1; optional string url = 2; repeated CIRunnerPropertyString properties_string = 3; repeated CIRunnerPropertyInt properties_int = 4; repeated CIRunnerPropertyStringArray properties_string_array = 5; } **Test Statistics Composition:**protob...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~134-~134: There might be a problem here.
Context: ...5; } **Test Statistics Composition:**protobuf message TestStatistics { int32 tests = 1; // Total number of tests int32 skipped = 2; // Number of skipped tests int32 errors = 3; // Number of tests with errors int32 failures = 4; // Number of failed tests float time = 5; // Total execution time } **TestReport Structure:**protobuf message TestRe...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~145-~145: Use proper spacing conventions.
Context: ...tion time } **TestReport Structure:**protobuf message TestReport { TestStatistics stats = 1; // Overall test run statistics repeated TestSuite test_suites = 3; // Individual test suites } message TestSuite { string name = 1; // Suite name TestStatistics stats = 2; // Suite-level statistics string timestamp = 8; // Suite execution timestamp repeated TestSuiteProperty properties = 9; // Suite properties repeated TestCase test_cases = 10; // Individual test cases } message TestCase { string name = 1; // Test case name string classname = 2; // Test class name TestStatistics stats = 3; // Case-level statistics string system_err = 4; // System error output TestResult result = 5; // Test result details } ``` --- ## Metadata Structure The metadata section...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~171-~171: Use proper spacing conventions.
Context: ...etails } ``` --- ## Metadata Structure The metadata section provides comprehens...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~212-~212: Use proper spacing conventions.
Context: ...data ``` ### Metadata Coordinate System The metadata uses a hierarchical coordin...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~228-~228: Use proper spacing conventions.
Context: ...t.name` | --- ## CI System Integration ### Jenkins Integration Jenkins builds expo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~230-~230: Use proper spacing conventions.
Context: ...tem Integration ### Jenkins Integration Jenkins builds expose metadata through e...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~234-~234: Use proper spacing conventions.
Context: ...ructure. #### Key Environment Variables CI System Information: - `JENKINS_URL...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~236-~236: Use proper spacing conventions.
Context: ...ment Variables CI System Information: - JENKINS_URL: Base URL of the Jenkins instance - `NO...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~244-~244: Use proper spacing conventions.
Context: ...st of build triggers Job Information: - JOB_NAME: Jenkins job name - JOB_URL: Job URL ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~253-~253: Use proper spacing conventions.
Context: ...uild results Source Code Information: - GIT_COMMIT: Full SHA-1 hash of current commit - `G...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~264-~264: Use proper spacing conventions.
Context: ...ter/author emails Change Information: GitHub Pull Requests: - CHANGE_ID / ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~276-~276: Use proper spacing conventions.
Context: ...or display name GitLab Merge Requests: - CHANGE_ID / GITLAB_MERGE_REQUEST_IID: Merge req...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~285-~285: Use proper spacing conventions.
Context: ...: MR author email Runner Information: - NODE_NAME: Runner name - NODE_LABELS: Space-sep...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~288-~288: Use proper spacing conventions.
Context: ...LS: Space-separated list of node labels > **Note**: Set NODE_LABELS` on Jenkins nod...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~292-~292: Use proper spacing conventions.
Context: ...n. #### Jenkins-Specific Considerations - Pipeline Object: Jenkins doesn't have ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~294-~294: There might be a mistake here.
Context: ...pipeline" concept, so pipeline: {} by default - Product Information: Can be deriv...
(QB_NEW_EN_OTHER)
[grammar] ~295-~295: There might be a problem here.
Context: ...be derived from job parameters and file paths analysis - Parent/Caller Jobs: Future enhanc...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~296-~296: Place a period at the end of declarative sentences.
Context: ...e pipeline data with parent job metadata ### DCI Integration Distributed CI (DCI) pr...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~298-~298: Use proper spacing conventions.
Context: ...parent job metadata ### DCI Integration Distributed CI (DCI) provides a differen...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~302-~302: Use proper spacing conventions.
Context: ...ng live processes. #### DCI Terminology | DCI Term | Domain | Meaning | |-------...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~314-~314: Use proper spacing conventions.
Context: ...on node | #### DCI vs. Other CI Systems | DCI | Jenkins | GitHub | GitLab | Prow...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~322-~322: Use proper spacing conventions.
Context: ...unner | node | #### DCI API Integration Prerequisites: 1. Working credentials...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~324-~324: Use proper spacing conventions.
Context: ...## DCI API Integration Prerequisites: 1. Working credentials with DCI service acc...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~330-~330: Use proper spacing conventions.
Context: ...ctlcommand-line tool **Setup Process:** 1. Installdcictl` following the [DCI clie...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~338-~338: Use proper spacing conventions.
Context: ...on file Configuration File Structure: bash DCI_CLIENT_ID='remoteci/<UUID>' DCI_API_SECRET='<API_SECRET>' DCI_CS_URL='https://api.distributed-ci.io/' export DCI_CLIENT_ID DCI_API_SECRET DCI_CS_URL Using dcictl: ```bash # Source the co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~347-~347: Use proper spacing conventions.
Context: ...I_SECRET DCI_CS_URL **Using dcictl:** bash # Source the configuration source dcirc.sh # Query examples using Elasticsearch DSL syntax dcictl remoteci-list --query "(eq(name,${myteam}))" dcictl job-list --query "and(eq(team_id,${my_team_id}),eq(topic_id,${my_topic_id}))" # Useful parameters --query # Elasticsearch DSL syntax --where # Alternative syntax, e.g., "tags in [bla, blah, blee]" --limit # Items per page --format json # JSON output for parsing ``` #### DCI Metadata Collection Unlike other CI...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~364-~364: Use proper spacing conventions.
Context: ...arsing ``` #### DCI Metadata Collection Unlike other CI systems that use environ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~368-~368: Use proper spacing conventions.
Context: ...ssing. ### Environment Variable Mapping The env2vars system provides a flexibl...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~372-~372: Use proper spacing conventions.
Context: ... event metadata. #### Problem Statement Different CI systems expose metadata thr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~381-~381: Use proper spacing conventions.
Context: ...# Solution: Normalized Metadata Pipeline The role implements a three-stage normal...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~389-~389: Use proper spacing conventions.
Context: ...nt structure #### Implementation Stages Environment Variables → env2vars → trs_vars_dict → event.metadata 1. Development Stage: Define env2vars m...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~399-~399: Use proper spacing conventions.
Context: ...ture #### Variable Definition Structure Variables are defined in `vars/env2vars/...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~401-~401: Use proper spacing conventions.
Context: ... in vars/env2vars/<ci_type>.yml files: Basic String Variable: ```yaml env2va...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~403-~403: Use proper spacing conventions.
Context: ...e>.yml` files: Basic String Variable: yaml env2vars: - key: my_key var: MY_ENV_VAR var_type: str # Default type, can be omitted List Variable: ```yaml env2vars: - ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~412-~412: Use proper spacing conventions.
Context: ...pe, can be omitted **List Variable:** yaml env2vars: - key: my_list_key var: MY_ENV_LIST_VAR var_type: list splitter: ['/'] # Default splitter, can be omitted **Dictionary Variable:** yaml env2vars...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~422-~422: Use proper spacing conventions.
Context: ...n be omitted **Dictionary Variable:** yaml env2vars: - key: my_dict_key var: MY_ENV_DICT_VAR var_type: dict splitter: [' ', ':'] # Element separator, Key-value separator **Integer Variable:** yaml env2vars: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~432-~432: Use proper spacing conventions.
Context: ...value separator **Integer Variable:** yaml env2vars: - key: my_number var: MY_ENV_NUMBER var_type: int **Boolean Variable:** yaml env2vars: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~441-~441: Use proper spacing conventions.
Context: ... var_type: int **Boolean Variable:** yaml env2vars: - key: my_bool var: MY_BOOL_VAR var_type: bool ``` #### Supported Data Types | Type | Descri...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~450-~450: Use proper spacing conventions.
Context: ...ype: bool ``` #### Supported Data Types | Type | Description | Example In...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~460-~460: Use proper spacing conventions.
Context: ... | #### List Processing Lists are parsed using configurable sepa...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~473-~473: Use proper spacing conventions.
Context: ...item3"]} ``` #### Dictionary Processing Dictionaries support nested key-value pa...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~475-~475: Use proper spacing conventions.
Context: ...ionaries support nested key-value pairs: yaml # Environment: MY_DICT="os:linux arch:x86_64 version:1.0" - key: system_info var: MY_DICT var_type: dict splitter: [' ', ':'] # [element_separator, key_value_separator] # Result: {"system_info": {"os": "linux", "arch": "x86_64", "version": "1.0"}} --- ## Reporting Systems Reporting systems col...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~488-~488: Use proper spacing conventions.
Context: ...: "1.0"}} ``` --- ## Reporting Systems Reporting systems collect, search, and v...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~490-~490: There might be a mistake here.
Context: ...e observability and data-driven decision making. ### Benefits - **Shared Visual...
(QB_NEW_EN_OTHER)
[grammar] ~490-~490: Use proper spacing conventions.
Context: ...ability and data-driven decision making. ### Benefits - Shared Visual Languages:...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~492-~492: Use proper spacing conventions.
Context: ...ta-driven decision making. ### Benefits - Shared Visual Languages: Consistent da...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~496-~496: Use proper spacing conventions.
Context: ...Unified view across different CI systems ### Splunk Integration Splunk serves as the...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~498-~498: Use proper spacing conventions.
Context: ...erent CI systems ### Splunk Integration Splunk serves as the primary reporting b...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~502-~502: Use proper spacing conventions.
Context: ...abilities. #### Event Schema for Splunk Splunk events follow the corrected struc...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~521-~521: Use proper spacing conventions.
Context: ...ma definitions. #### Query Capabilities The schema supports various query patter...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~525-~525: Use proper spacing conventions.
Context: ...per structure: Product-Based Queries: - Filter by product: `.event.metadata.prod...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~530-~530: Use proper spacing conventions.
Context: ...a.product.version **CI System Queries:** - CI type filtering:.event.metadata.ci.t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~536-~536: Use proper spacing conventions.
Context: ...ata.ci.runner[] **Test Result Queries:** - Test suite results:.event.test.test_su...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~545-~545: Use proper spacing conventions.
Context: ....stats.time` #### Timing Considerations All timing data uses consistent time sou...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~547-~547: Use proper spacing conventions.
Context: ... sources to ensure accurate correlation: 1. CI Process Timings: Pipeline, job, and...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~554-~554: Use proper spacing conventions.
Context: ...g correlation. #### Test Data Structure **Test Report Summary (per Protocol Buffer...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~613-~613: Combining words like “every day” changes the meaning.
Context: ...t 'false'" } } ``` ### Benefits of TestStatistics Composition The new composition patter...
(QB_NEW_EN_OTHER_ERROR_IDS_000001)
[grammar] ~613-~613: Use proper spacing conventions.
Context: ...# Benefits of TestStatistics Composition The new composition pattern provides sev...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~615-~615: Use proper spacing conventions.
Context: ...ion pattern provides several advantages: - Consistent Structure: All test-related...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~625-~625: Use proper spacing conventions.
Context: ... one place --- ## Implementation Guide ### Getting Started 1. **Choose Your CI Sys...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~627-~627: Use proper spacing conventions.
Context: ...mplementation Guide ### Getting Started 1. Choose Your CI System: Identify which ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~635-~635: Use proper spacing conventions.
Context: ...eration and delivery ### Best Practices - Consistent Timing: Ensure all CI syste...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~637-~637: There might be a mistake here.
Context: ...re all CI systems use synchronized time sources - Comprehensive Metadata: Include a...
(QB_NEW_EN_OTHER)
[grammar] ~638-~638: There might be a mistake here.
Context: ...vant environment variables for your use case - Test Data Quality: Validate JUnit...
(QB_NEW_EN_OTHER)
[grammar] ~639-~639: There might be a mistake here.
Context: ...Quality**: Validate JUnit report format compliance - Monitoring: Set up alerts for fai...
(QB_NEW_EN_OTHER)
[grammar] ~640-~640: There might be a mistake here.
Context: ...oring**: Set up alerts for failed event deliveries - Documentation: Maintain clear doc...
(QB_NEW_EN_OTHER)
[grammar] ~641-~641: Place a period at the end of declarative sentences.
Context: ...ocumentation of custom variable mappings ### Troubleshooting Common Issues: - **...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~643-~643: Use proper spacing conventions.
Context: ...m variable mappings ### Troubleshooting Common Issues: - **Missing Environment...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~651-~651: Use proper spacing conventions.
Context: ...and credentials ### Future Enhancements - Additional CI Systems: Prow, Tekton, a...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~660-~660: Use proper spacing conventions.
Context: ...to reporting systems --- ## Conclusion The test_report_send role provides a c...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~664-~664: Use proper spacing conventions.
Context: ...cs and observability. ### Key Resources - Protocol Buffer Schema: See [`event.pr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/dci.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # CI: Distributed CI (DCI) The DCI API endpoint is [https://distrib...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...buted-ci.io](https://distributed-ci.io). ## DCI Terminology overview DCI introduces...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~7-~7: Use proper spacing conventions.
Context: ...e concepts compared to other CI systems: | DCI term | LC domain | meaning ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~14-~14: Use proper spacing conventions.
Context: ...nent|remoteci|agent|pipeline|job]` | ### Mapping DCI to Other CI Systems DCI con...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~16-~16: Use proper spacing conventions.
Context: ...` | ### Mapping DCI to Other CI Systems DCI concepts aligned with common CI term...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: Use proper spacing conventions.
Context: ...epts aligned with common CI terminology: | DCI | Jenkins ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~24-~24: Use proper spacing conventions.
Context: ... | runner | runner | node | ## Dynamic environment to metadata conversi...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~26-~26: Use proper spacing conventions.
Context: ...namic environment to metadata conversion In this DCI use case, we do not need to ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~28-~28: Use proper spacing conventions.
Context: ... to dynamically process the environment. When data from DCI reaches us, we can ge...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ...n get the metadata from its API as JSON. ### How to obtain data using dcictl #### ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ... as JSON. ### How to obtain data using dcictl #### Prerequisites 1. Working credential wit...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ... data using dcictl #### Prerequisites 1. Working credential with access to DCI se...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: There might be a mistake here.
Context: ...dcictl` #### Prerequisites 1. Working credential with access to DCI service and the comp...
(QB_NEW_EN_OTHER)
[grammar] ~35-~35: There might be a mistake here.
Context: ... components you're planning to work with 2. Information about team and remoteci ...
(QB_NEW_EN_OTHER)
[grammar] ~36-~36: Use proper spacing conventions.
Context: ...rk with 2. Information about team and remoteci #### Set up 1. See the [dciclient README](ht...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~38-~38: Use proper spacing conventions.
Context: ...about team and remoteci #### Set up 1. See the [dciclient README](https://githu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~40-~40: There might be a mistake here.
Context: ...### Set up 1. See the dciclient README and install the dcictl command-line to...
(QB_NEW_EN_OTHER)
[grammar] ~41-~41: Use proper spacing conventions.
Context: ... install the dcictl command-line tool. 2. Browse to DCI via the web 3. Login with ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~42-~42: There might be a mistake here.
Context: ...and-line tool. 2. Browse to DCI via the web 3. Login with credentials, go to the le...
(QB_NEW_EN_OTHER)
[grammar] ~43-~43: Combining words like “every day” changes the meaning.
Context: ...e tool. 2. Browse to DCI via the web 3. Login with credentials, go to the left hand t...
(QB_NEW_EN_OTHER_ERROR_IDS_000001)
[grammar] ~43-~43: There might be a mistake here.
Context: ...Browse to DCI via the web 3. Login with credentials, go to the left hand to Remotecis 4. I...
(QB_NEW_EN_OTHER)
[grammar] ~43-~43: There might be a mistake here.
Context: .... Login with credentials, go to the left hand to Remotecis 4. In the search fie...
(QB_NEW_EN_OTHER)
[grammar] ~43-~43: There might be a mistake here.
Context: ...n with credentials, go to the left hand to Remotecis 4. In the search field, type remoteci na...
(QB_NEW_EN_OTHER)
[grammar] ~44-~44: There might be a mistake here.
Context: ...4. In the search field, type remoteci name 5. Download dcirc.sh from the **"Remo...
(QB_NEW_EN_OTHER)
[grammar] ~45-~45: Place a period at the end of declarative sentences.
Context: ...dcirc.sh from the "Remotecis" page The contents of dcirc.sh file should l...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~47-~47: Use articles correctly.
Context: ... the "Remotecis" page The contents of dcirc.sh file should look like this: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~47-~47: Use proper spacing conventions.
Context: ...f dcirc.sh file should look like this: bash DCI_CLIENT_ID='remoteci/<UUID{lowercase uuid}>' DCI_API_SECRET='<API_SECRET{random alphanumeric (upper/lower) string 64 chars long}>' DCI_CS_URL='https://api.distributed-ci.io/' export DCI_CLIENT_ID DCI_API_SECRET DCI_CS_URL NOTE: the above data is not real. #### ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~56-~56: Use proper spacing conventions.
Context: ...L ``` NOTE: the above data is not real. #### Running dcictl Before running dcictl,...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~58-~58: Use proper spacing conventions.
Context: ...e data is not real. #### Running dcictl Before running dcictl, the script `dci...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~60-~60: Use proper spacing conventions.
Context: ...d (to set up the environment variables). dcictl allows query of the DCI API The syntax ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~62-~62: There might be a mistake here.
Context: ...). dcictl allows query of the DCI API The syntax is: `dcictl <params...
(QB_NEW_EN_OTHER)
[grammar] ~63-~63: Avoid interrupting sentences with colons.
Context: ...llows query of the DCI API The syntax is: dcictl <command> <params> The most in...
(QB_NEW_EN_OTHER_ERROR_IDS_000069)
[grammar] ~63-~63: There might be a mistake here.
Context: ...e syntax is: dcictl <command> <params> The most interesting parameters are: ##...
(QB_NEW_EN_OTHER)
[grammar] ~64-~64: There might be a mistake here.
Context: ...ms>The most interesting parameters are: ### Existing commands Run:dcictl --help` ...
(QB_NEW_EN_OTHER)
[grammar] ~66-~66: Use proper spacing conventions.
Context: ...g parameters are: ### Existing commands Run: dcictl --help #### Running comma...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~68-~68: Use proper spacing conventions.
Context: ...eters are: ### Existing commands Run: dcictl --help #### Running commands The parameter `--query...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~70-~70: Use proper spacing conventions.
Context: ...: dcictl --help #### Running commands The parameter --query uses ES (elastic...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~72-~72: There might be a mistake here.
Context: ...mands The parameter --query uses ES (elastic search) DSL syntax. Examples: 1. Search by `m...
(QB_NEW_EN_OTHER)
[grammar] ~72-~72: Use proper spacing conventions.
Context: ...S (elastic search) DSL syntax. Examples: 1. Search by myteam name: `dcictl remotec...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~76-~76: Use proper spacing conventions.
Context: ...gather all its sub-objects via dcictl. ##### Additional details - All item commands ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~78-~78: Use proper spacing conventions.
Context: ... via dcictl. ##### Additional details - All item commands (e.g., <bla>-list) s...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~81-~81: Use proper spacing conventions.
Context: ...ntax, e.g., tags in [bla, blah, blee]. - The --limit parameter lets you set how...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~82-~82: Use proper spacing conventions.
Context: ...er page are fetched in a single command. - The global --format json option is ver...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~83-~83: Use proper spacing conventions.
Context: ...` option is very convenient for parsing.
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/event.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # Event structure Sample event data can be seen here [`eve...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Place a period at the end of declarative sentences.
Context: ...ture Sample event data can be seen here event.json The event contains the following main se...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ...nt contains the following main sections: ## Top Structure Overview | Attribute coor...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~7-~7: Use proper spacing conventions.
Context: ...ain sections: ## Top Structure Overview | Attribute coordinate | Contains | | -...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~17-~17: Use proper spacing conventions.
Context: ...ites and test cases | ## Key Components ### Metadata #### CI Information Info abou...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~19-~19: Use proper spacing conventions.
Context: ...cases | ## Key Components ### Metadata #### CI Information Info about the CI - URLs...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~21-~21: Use proper spacing conventions.
Context: ...nents ### Metadata #### CI Information Info about the CI - URLs, type ##### Ru...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[typographical] ~23-~23: To join two clauses or set off examples, consider using an em dash.
Context: ... #### CI Information Info about the CI - URLs, type ##### Runner Runner archite...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ...ormation Info about the CI - URLs, type ##### Runner Runner architecture, container t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~25-~25: Use proper spacing conventions.
Context: ... about the CI - URLs, type ##### Runner Runner architecture, container technolog...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~27-~27: Use proper spacing conventions.
Context: ..., container technology, executor details #### Pipeline Information pipeline info, url...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ...cutor details #### Pipeline Information pipeline info, urls, results and timings...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use an Oxford comma.
Context: ...eline Information pipeline info, urls, results and timings #### Job Information Job/...
(QB_NEW_EN_OTHER_ERROR_IDS_000014)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ...pipeline info, urls, results and timings #### Job Information Job/Build info, URLs, t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ...esults and timings #### Job Information Job/Build info, URLs, triggers, results ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: Use an Oxford comma.
Context: ...mation Job/Build info, URLs, triggers, results and timings #### Source Information A...
(QB_NEW_EN_OTHER_ERROR_IDS_000014)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...nfo, URLs, triggers, results and timings #### Source Information Author details, repo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~37-~37: Use proper spacing conventions.
Context: ...lts and timings #### Source Information Author details, repository details ####...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~39-~39: Use proper spacing conventions.
Context: ...tion Author details, repository details ##### Change Information change/PR informatio...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~41-~41: Use proper spacing conventions.
Context: ...sitory details ##### Change Information change/PR information #### Product Info...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~43-~43: Use proper spacing conventions.
Context: ...hange Information change/PR information #### Product Information product/component/t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~45-~45: There might be a problem here.
Context: ...PR information #### Product Information product/component/topic/version etc. ### Test Results - Summary: ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~47-~47: Use proper spacing conventions.
Context: ...on product/component/topic/version etc. ### Test Results - Summary: Overall tes...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~49-~49: Use proper spacing conventions.
Context: ...ent/topic/version etc. ### Test Results - Summary: Overall test counts (errors, ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~51-~51: Use proper spacing conventions.
Context: ...ounts (errors, failures, skipped, total) #### Test Suites Grouped test results with p...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~53-~53: Use proper spacing conventions.
Context: ...lures, skipped, total) #### Test Suites Grouped test results with properties and...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~55-~55: Use proper spacing conventions.
Context: ...ith properties and individual test cases For each test suite: ##### Test Cases ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~57-~57: Use proper spacing conventions.
Context: ...ividual test cases For each test suite: ##### Test Cases Individual test execution de...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~59-~59: Use proper spacing conventions.
Context: ... For each test suite: ##### Test Cases Individual test execution details with r...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~61-~61: Use proper spacing conventions.
Context: ... with results, timing, and system output
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/jenkins.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # CI: Jenkins Current or past runs of jenkins jobs are...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: End punctuation usually goes inside quotation marks.
Context: ...or past runs of jenkins jobs are called "builds". During a jenkins job build, the execu...
(QB_NEW_EN_OTHER_ERROR_IDS_000049)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...uns of jenkins jobs are called "builds". During a jenkins job build, the executor...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~4-~4: Use proper spacing conventions.
Context: ...nment variables for its child processes. Build's parameters are also seen by the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ... the processes as environment variables. ## Environment to metadata conversion ## M...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~7-~7: Use proper spacing conventions.
Context: .... ## Environment to metadata conversion ## Metadata Sections Following the metadat...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~9-~9: Use proper spacing conventions.
Context: ...etadata conversion ## Metadata Sections Following the metadata schema explained ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~11-~11: Use proper spacing conventions.
Context: ...e're collecting when running in jenkins. ### CI * NODE_NAME: The name of the agent...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~13-~13: Use proper spacing conventions.
Context: ...lecting when running in jenkins. ### CI * NODE_NAME: The name of the agent (or controller) ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~15-~15: Use proper spacing conventions.
Context: ... controller) where the build is running. * WORKSPACE: The absolute path to the directory whe...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~16-~16: Use proper spacing conventions.
Context: ...uts are stored during the build process. * JENKINS_HOME: The directory where Jenkins stores its...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~17-~17: Use proper spacing conventions.
Context: ...guration, build history, and other data. * EXECUTOR_NUMBER: The unique number that identifies the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: There might be a mistake here.
Context: ...rs of the same machine) performing this build * BUILD_CAUSE: A comma-separated lis...
(QB_NEW_EN_OTHER)
[grammar] ~19-~19: Use proper spacing conventions.
Context: ...) performing this build * BUILD_CAUSE: A comma-separated list of causes for th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~19-~19: Use proper spacing conventions.
Context: ...TRIGGER,MANUALTRIGGER,UPSTREAMTRIGGER`). Individual causes are also exposed as ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ... BUILD_CAUSE_USERIDCAUSE=true * etc. * JENKINS_URL: The base URL of the Jenkins instance. ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~24-~24: Use proper spacing conventions.
Context: ...: The base URL of the Jenkins instance. ### Runner * NODE_NAME(name). *NODE_LA...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~26-~26: Use proper spacing conventions.
Context: ...URL of the Jenkins instance. ### Runner * NODE_NAME (name). * NODE_LABELS (space-separate...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~28-~28: Use proper spacing conventions.
Context: ...ance. ### Runner * NODE_NAME (name). * NODE_LABELS (space-separated list of labels). The ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ...ABELS(space-separated list of labels). TheNODE_LABELS` variable should be set...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ...s/jenkins_node_labels.sh) or equivalent. ### Pipeline By default, Jenkins does not h...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ..._labels.sh) or equivalent. ### Pipeline By default, Jenkins does not have an obj...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: There might be a problem here.
Context: ...ult, Jenkins does not have an object of "pipeline", so in the metadata we will have `pipeli...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...he metadata we will have pipeline: {}. However, similar functionality can refer...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~36-~36: Use articles correctly.
Context: ...this and/or other (sibling) jobs, so in future we may decide to populate pipeline wi...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~36-~36: Use proper spacing conventions.
Context: ... with that parent/caller job's metadata. ### Job * JOB_NAME: The name of the Jenki...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~38-~38: Use proper spacing conventions.
Context: ...t parent/caller job's metadata. ### Job * JOB_NAME: The name of the Jenkins job. * `JOB_UR...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~40-~40: Use proper spacing conventions.
Context: ...JOB_NAME: The name of the Jenkins job. * JOB_URL: The URL of the Jenkins job. * `BUILD_N...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~41-~41: Use proper spacing conventions.
Context: ...* JOB_URL: The URL of the Jenkins job. * BUILD_NUMBER: The unique build number for the curren...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~42-~42: Use proper spacing conventions.
Context: ...umber for the current run (e.g., 153). * BUILD_ID: The current build ID, usually identica...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~43-~43: Use proper spacing conventions.
Context: ...UILD_NUMBER for recent Jenkins versions. * BUILD_TAG: A unique tag combining the job name an...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~44-~44: Use proper spacing conventions.
Context: ... jenkins-${JOB_NAME}-${BUILD_NUMBER}). * BUILD_URL: The URL where the results of this spec...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~45-~45: Use proper spacing conventions.
Context: ...lts of this specific build can be found. ### Source * GIT_COMMIT: The full SHA-1...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~47-~47: Use proper spacing conventions.
Context: ...specific build can be found. ### Source * GIT_COMMIT: The full SHA-1 hash of the current G...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~49-~49: Use proper spacing conventions.
Context: ...h of the current Git commit being built. * GIT_BRANCH: The name of the Git branch being built...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~50-~50: Use proper spacing conventions.
Context: ...e.g., origin/master, feature/my-branch). * GIT_URL: The URL of the remote Git repository. ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~51-~51: There might be a problem here.
Context: ...: The URL of the remote Git repository. * GIT_LOCAL_BRANCH`: If a specific local branch is checked o...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~52-~52: Use proper spacing conventions.
Context: ...ut, this variable will contain its name. * GIT_PREVIOUS_COMMIT: The SHA-1 hash of the previous commi...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~53-~53: Use proper spacing conventions.
Context: ...e previous commit on the current branch. * GIT_PREVIOUS_SUCCESSFUL_COMMIT: The SHA-1 hash of the commit of the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~54-~54: Use proper spacing conventions.
Context: ... successful build on the current branch. * GIT_COMMITTER_NAME / GIT_AUTHOR_NAME: The name of the co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~55-~55: Use proper spacing conventions.
Context: ...mitter/author of the current Git commit. * GIT_COMMITTER_EMAIL / GIT_AUTHOR_EMAIL: The email of the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~56-~56: Use proper spacing conventions.
Context: ...mitter/author of the current Git commit. #### The Change: Pull Request/Merge Request/C...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~58-~58: Use proper spacing conventions.
Context: ...nge: Pull Request/Merge Request/ChangeId * CHANGE_ID: for GitHub it is PR, for GitLab it is ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~60-~60: There might be a mistake here.
Context: ...: for GitHub it is PR, for GitLab it is MR, for Gerrit it is ChangeId. * `PULL_REQU...
(QB_NEW_EN_OTHER)
[grammar] ~60-~60: Use proper spacing conventions.
Context: ...Lab it is MR, for Gerrit it is ChangeId. * PULL_REQUEST_ID: GitHub term * `GITLAB_MERGE_REQUEST_II...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~62-~62: Use proper spacing conventions.
Context: ... GITLAB_MERGE_REQUEST_IID: GitLab term ##### GitHub Change Info (PR) * `CHANGE_BRANC...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~64-~64: Use proper spacing conventions.
Context: ...tLab term ##### GitHub Change Info (PR) * CHANGE_BRANCH: source branch name of the PR * `CHANGE...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~69-~69: Use proper spacing conventions.
Context: ...y name * CHANGE_URL: the URL to the PR ###### Author (PR) * CHANGE_AUTHOR: the auth...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~71-~71: Use proper spacing conventions.
Context: ...: the URL to the PR ###### Author (PR) * CHANGE_AUTHOR: the author of the PR * CHANGE_AUTHOR_...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~74-~74: Use proper spacing conventions.
Context: ...NAME: the display name of the PR author ##### GitLab Change Info (MR) * GITLAB_MERGE...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~76-~76: Use proper spacing conventions.
Context: ...PR author ##### GitLab Change Info (MR) * GITLAB_MERGE_REQUEST_SOURCE_BRANCH: source branch of the MR * `GITLAB_MERG...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~80-~80: Use proper spacing conventions.
Context: ...EST_LAST_COMMIT_SHA: last sha of the MR ###### Author (MR) * GITLAB_USER_NAME`: The m...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~82-~82: Use proper spacing conventions.
Context: ...: last sha of the MR ###### Author (MR) * GITLAB_USER_NAME: The merge request author's name. * `GI...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~84-~84: Use proper spacing conventions.
Context: ..._NAME: The merge request author's name. * GITLAB_USER_EMAIL`: The merge request author's email. ###...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~85-~85: Use proper spacing conventions.
Context: ...MAIL`: The merge request author's email. ### Product Jenkins by default does not hav...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~87-~87: Use proper spacing conventions.
Context: ...rge request author's email. ### Product Jenkins by default does not have this co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~89-~89: There might be a problem here.
Context: ...truct, so in the metadata we can assign product: {}, However similar functionality can refer to a jo...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~90-~90: Use proper spacing conventions.
Context: ...refer to a job that triggers other jobs. * UPD: We will probably add this informa...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~92-~92: Use singular and plural nouns appropriately.
Context: ...bably add this information by analyzing files paths and job parameters
(QB_NEW_EN_OTHER_ERROR_IDS_000012)
[grammar] ~92-~92: Place a period at the end of declarative sentences.
Context: ...analyzing files paths and job parameters
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
roles/test_report_send/doc/main.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: ...ecisions for the test_report_send Role ## Abstract The role generates an event fr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...the test_report_send Role ## Abstract The role generates an event from CI meta...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: There might be a mistake here.
Context: ... event from CI metadata and test reports, and sends this event to the reporting s...
(QB_NEW_EN_OTHER)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ...ends this event to the reporting system. ## Table of Contents 1. [Event Structure](...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~7-~7: Use proper spacing conventions.
Context: ... reporting system. ## Table of Contents 1. Event Structure 1. [metadat...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~11-~11: There might be a mistake here.
Context: ...tadata.md), per CI: 1. DCI 2. Jenkins 2. [Reporting]...
(QB_NEW_EN_OTHER)
[grammar] ~12-~12: There might be a mistake here.
Context: ...CI: 1. DCI 2. Jenkins 2. Reporting, per reporting ...
(QB_NEW_EN_OTHER)
[grammar] ~14-~14: Use proper spacing conventions.
Context: ....md), per reporting system: 1. Splunk
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/metadata.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # Metadata structure The metadata resides in the event object...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: There might be a mistake here.
Context: ... in the event object under .metadata[] When everything is properly done, it has...
(QB_NEW_EN_OTHER)
[grammar] ~4-~4: There might be a mistake here.
Context: ...erly done, it has the following sections yaml --- ci: # data about the CI # general info - urls, types runner: # information about the runner # runner details, info about h/w, os pipeline: # information current pipeline when relevant # pipeline details/urls job: # information about the job source: # source code info change: # information about the change/pr/mr # details about the change product: ## information about the product
(QB_NEW_EN_OTHER)
roles/test_report_send/doc/reporting.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # Reporting systems Reporting systems collect information, e...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...ng, and sometimes provide visualization. This helps to reach observability goals,...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~4-~4: Use proper spacing conventions.
Context: ...bserve live system status and analytics. This in its turn enables: - Shared visu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~6-~6: Use proper spacing conventions.
Context: ...nd analytics. This in its turn enables: - Shared visual and data languages - Data-...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~9-~9: Use proper spacing conventions.
Context: ...ges - Data-based decision-making process Supported reporting systems: * [splunk....
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~11-~11: Use proper spacing conventions.
Context: ...ng process Supported reporting systems: * splunk.md
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~13-~13: Use proper spacing conventions.
Context: ...pported reporting systems: * splunk.md
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/splunk.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # Splunk ## Conventions - Example queries are prese...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: # Splunk ## Conventions - Example queries are presented in jq or...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: There might be a problem here.
Context: ...ntions - Example queries are presented in jq or yq -like manner. - The variables ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ...xample queries are presented in jq or yq -like manner. - The variables are presented i...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ... presented in jq or yq -like manner. - The variables are presented in monospace...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~6-~6: There might be a mistake here.
Context: ...anner. - The variables are presented in monospace like this_one ### Abbreviations - S...
(QB_NEW_EN_OTHER)
[grammar] ~6-~6: Use proper spacing conventions.
Context: ...riables are presented in monospace like this_one ### Abbreviations - SUT = system under test...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~8-~8: Use proper spacing conventions.
Context: ...space like this_one ### Abbreviations - SUT = system under test ## The event co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~10-~10: Use proper spacing conventions.
Context: ...Abbreviations - SUT = system under test ## The event contains the following 1. CI ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~12-~12: There might be a mistake here.
Context: ...est ## The event contains the following 1. CI system details - type - endpoin...
(QB_NEW_EN_OTHER)
[grammar] ~14-~14: There might be a mistake here.
Context: ...nt contains the following 1. CI system details - type - endpoints about the syst...
(QB_NEW_EN_OTHER)
[grammar] ~19-~19: There might be a mistake here.
Context: ...as invoked) - results (how have they completed) 2. SUT info: H/W (architecture), and s...
(QB_NEW_EN_OTHER)
[grammar] ~20-~20: There might be a mistake here.
Context: ...mpleted) 2. SUT info: H/W (architecture), and software info (OS, product/componen...
(QB_NEW_EN_OTHER)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ...o JSON) 5. Additional future information ## Schema (objectives) and background It s...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~25-~25: Use proper spacing conventions.
Context: ...n ## Schema (objectives) and background It should provide: 1. Enough data at...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~27-~27: Use proper spacing conventions.
Context: ...ives) and background It should provide: 1. Enough data attributes to support requir...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ...imum data points 3. Ease of extension The schema needs to support querying by ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: There might be a mistake here.
Context: ...t querying by any of the following terms ### Metadata (collected dynamically) - prod...
(QB_NEW_EN_OTHER)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...ms ### Metadata (collected dynamically) - product release(s) - SUT details (os, ar...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~40-~40: Use proper spacing conventions.
Context: ... team(s) - ci status (pipeline/job/step) ### Test data (collected from test reports) ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~42-~42: Use proper spacing conventions.
Context: ... Test data (collected from test reports) - tests: - run (status, counters, start,...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[typographical] ~48-~48: To join two clauses or set off examples, consider using an em dash.
Context: ... start, duration) - for failures - more info ### The importance of Timing ...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~48-~48: Use proper spacing conventions.
Context: ...tion) - for failures - more info ### The importance of Timing Everything wit...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~50-~50: Use proper spacing conventions.
Context: ... more info ### The importance of Timing Everything with timing data must be sele...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~52-~52: Use proper spacing conventions.
Context: ...a must be selected by those time ranges. Thus, to avoid confusion, the time range...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~53-~53: Use proper spacing conventions.
Context: ...h should use only two sources of timing: 1. ci process timings 2. test timings We n...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~56-~56: Use proper spacing conventions.
Context: ...: 1. ci process timings 2. test timings We need to rely on these timings, so all...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~58-~58: Use proper spacing conventions.
Context: ...eed to be properly set up using ntp/ptp. ## Event Schema (structure) Due to the abo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~60-~60: Use proper spacing conventions.
Context: ...ng ntp/ptp. ## Event Schema (structure) Due to the above, the following is propo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~62-~62: There might be a mistake here.
Context: ... to the above, the following is proposed ### Metadata (dynamically obtained for each ...
(QB_NEW_EN_OTHER)
[grammar] ~64-~64: Use proper spacing conventions.
Context: ...ta (dynamically obtained for each event) 1. ci 1. general 1. type ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~87-~87: Use proper spacing conventions.
Context: ...l request 4. author ### Test data 1. test report info (obtained from ci proce...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~89-~89: There might be a mistake here.
Context: ...(obtained from ci process artifact files) 1. run 1. stats 1. suite...
(QB_NEW_EN_OTHER)
[grammar] ~90-~90: There might be a mistake here.
Context: ...d from ci process artifact files) 1. run 1. stats 1. suites, for eac...
(QB_NEW_EN_OTHER)
[grammar] ~91-~91: There might be a mistake here.
Context: ...cess artifact files) 1. run 1. stats 1. suites, for each suite: 1. stats ...
(QB_NEW_EN_OTHER)
[grammar] ~94-~94: There might be a mistake here.
Context: ... 1. stats 1. cases for each case 1. stats 1. err...
(QB_NEW_EN_OTHER)
[grammar] ~98-~98: Use proper spacing conventions.
Context: ... 1. errors ### Top-down structure #### Splunk event structure This structure i...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~100-~100: Use proper spacing conventions.
Context: ...n structure #### Splunk event structure This structure is sent to splunk. ```js...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~102-~102: Use proper spacing conventions.
Context: ...cture This structure is sent to splunk. json { "source": "<str>", // type of information signifying team/channel "host": "<hostname>", // the host or container or service sending the data "sourcetype": "_json", "_time": <timestamp>, // event emission time stamp, note it may happen AFTER event occurrence. "event": <trs_event>, // event data dictionary } The most interesting structure here is `...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~114-~114: There might be a mistake here.
Context: ...nteresting structure here is trs_event, it also has structure of: ```json { ...
(QB_NEW_EN_OTHER)
[grammar] ~114-~114: Use articles correctly.
Context: ...ucture here is trs_event, it also has structure of: ```json { "metadata": <trs_meta_...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~114-~114: There might be a mistake here.
Context: ...is trs_event, it also has structure of: json { "metadata": <trs_meta_data>, "test": <trs_test_data> } Splunk event structure is sent to splunk...
(QB_NEW_EN_OTHER)
[grammar] ~124-~124: There might be a mistake here.
Context: ... to allow queries of the following sorts 1. Select events by product `.metadata.prod...
(QB_NEW_EN_OTHER)
[grammar] ~126-~126: There might be a mistake here.
Context: ...product .metadata.product[] attributes 2. Filter events by any metadata attribute,...
(QB_NEW_EN_OTHER)
[grammar] ~127-~127: There might be a mistake here.
Context: ...r events by any metadata attribute, for example .metadata.ci.type completed with spe...
(QB_NEW_EN_OTHER)
[grammar] ~127-~127: Use proper spacing conventions.
Context: ...tribute, for example .metadata.ci.type completed with specific status
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~127-~127: Place a period at the end of declarative sentences.
Context: ...ci.type` completed with specific status
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
🪛 markdownlint-cli2 (0.17.2)
roles/test_report_send/doc/env2vars.md
44-44: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
61-61: Inline HTML
Element: sup
(MD033, no-inline-html)
206-206: Multiple headings with the same content
(MD024, no-duplicate-heading)
219-219: Multiple headings with the same content
(MD024, no-duplicate-heading)
230-230: Multiple headings with the same content
(MD024, no-duplicate-heading)
243-243: Multiple headings with the same content
(MD024, no-duplicate-heading)
249-249: Multiple headings with the same content
(MD024, no-duplicate-heading)
256-256: Multiple headings with the same content
(MD024, no-duplicate-heading)
265-265: Multiple headings with the same content
(MD024, no-duplicate-heading)
273-273: Multiple headings with the same content
(MD024, no-duplicate-heading)
284-284: Multiple headings with the same content
(MD024, no-duplicate-heading)
294-294: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
297-297: Inline HTML
Element: sup
(MD033, no-inline-html)
297-297: Inline HTML
Element: a
(MD033, no-inline-html)
298-298: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
roles/test_report_send/doc/comprehensive_guide.md
20-20: Line length
Expected: 120; Actual: 171
(MD013, line-length)
99-99: Line length
Expected: 120; Actual: 197
(MD013, line-length)
135-135: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
146-146: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
300-300: Line length
Expected: 120; Actual: 158
(MD013, line-length)
366-366: Line length
Expected: 120; Actual: 228
(MD013, line-length)
375-375: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
391-391: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
519-519: Line length
Expected: 120; Actual: 164
(MD013, line-length)
574-574: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
594-594: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
646-646: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
662-662: Line length
Expected: 120; Actual: 273
(MD013, line-length)
670-670: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
670-670: Line length
Expected: 120; Actual: 150
(MD013, line-length)
670-670: Files should end with a single newline character
(MD047, single-trailing-newline)
roles/test_report_send/doc/jenkins.md
11-11: Line length
Expected: 120; Actual: 158
(MD013, line-length)
18-18: Line length
Expected: 120; Actual: 135
(MD013, line-length)
36-36: Line length
Expected: 120; Actual: 209
(MD013, line-length)
roles/test_report_send/doc/main.md
10-10: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
13-13: Ordered list item prefix
Expected: 1; Actual: 2; Style: 1/1/1
(MD029, ol-prefix)
14-14: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
roles/test_report_send/doc/reporting.md
13-13: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
🪛 Buf (1.54.0)
roles/test_report_send/doc/event.proto
3-3: Files with package "test_report" must be within a directory "test_report" relative to root but were in directory "roles/test_report_send/doc".
(PACKAGE_DIRECTORY_MATCH)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Sanity Check (stable-2.9)
- GitHub Check: Ansible-lint Check
- GitHub Check: Sanity Check (stable-2.18)
| trs_job_time_int: "{{ (trs_meta_data.job.created_at | \ | ||
| default(trs_default_ts, true) | \ | ||
| regex_replace('\\..*$', '') | \ | ||
| to_datetime('%Y-%m-%dT%H:%M:%S')).strftime('%s') | int }}" | ||
| trs_job_time_fraction: "{{ trs_meta_data.job.created_at | \ | ||
| default(trs_default_ts, true) | \ | ||
| regex_replace('^.*\\.', '0.') | float | round(3) }}" | ||
| when: | ||
| - trs_meta_data.job | length > 0 | ||
| - trs_meta_data.job.created_at | length > 0 | ||
|
|
There was a problem hiding this comment.
trs_meta_data.job may be undefined – evaluation will abort early
Jinja evaluates the expression before the when: guard, so accessing
trs_meta_data.job.created_at raises has no attribute when job is missing.
- trs_job_time_int: "{{ (trs_meta_data.job.created_at | \
- default(trs_default_ts, true) | \
+ trs_job_time_int: "{{ ((trs_meta_data.job | default({})) \
+ .created_at | default(trs_default_ts, true) | \Apply the same defensive pattern to trs_job_time_fraction.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| trs_job_time_int: "{{ (trs_meta_data.job.created_at | \ | |
| default(trs_default_ts, true) | \ | |
| regex_replace('\\..*$', '') | \ | |
| to_datetime('%Y-%m-%dT%H:%M:%S')).strftime('%s') | int }}" | |
| trs_job_time_fraction: "{{ trs_meta_data.job.created_at | \ | |
| default(trs_default_ts, true) | \ | |
| regex_replace('^.*\\.', '0.') | float | round(3) }}" | |
| when: | |
| - trs_meta_data.job | length > 0 | |
| - trs_meta_data.job.created_at | length > 0 | |
| trs_job_time_int: "{{ ((trs_meta_data.job | default({})) \ | |
| .created_at | default(trs_default_ts, true) | \ | |
| regex_replace('\\..*$', '') | \ | |
| to_datetime('%Y-%m-%dT%H:%M:%S')).strftime('%s') | int }}" | |
| trs_job_time_fraction: "{{ trs_meta_data.job.created_at | \ | |
| default(trs_default_ts, true) | \ | |
| regex_replace('^.*\\.', '0.') | float | round(3) }}" | |
| when: | |
| - trs_meta_data.job | length > 0 | |
| - trs_meta_data.job.created_at | length > 0 |
🤖 Prompt for AI Agents
In roles/test_report_send/tasks/reporting/splunk.yml around lines 24 to 34, the
code accesses trs_meta_data.job.created_at without confirming that
trs_meta_data.job exists, causing errors if job is undefined. To fix this, add a
default empty dictionary or use a safe default for trs_meta_data.job before
accessing created_at in both trs_job_time_int and trs_job_time_fraction
expressions, ensuring the expressions do not fail when job is missing.
055baee to
c03b574
Compare
|
from change #712:
|
1 similar comment
|
from change #712:
|
|
Build succeeded. ✔️ dci-rpm-build-el8 SUCCESS in 2m 48s |
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (7)
roles/test_report_send/tasks/reporting/validations.yml (1)
11-15: Direct key lookup can crash play when header is missing
trs_collector_auth_headers['Authorization']and its sibling keys are accessed directly.
If the dict is empty or the key is absent, the lookup raises before theis definedtest is evaluated, aborting the run.- - trs_collector_auth_headers['Authorization'] is defined - - trs_collector_auth_headers['X-Splunk-Request-Channel'] is defined - - trs_collector_auth_headers['Authorization'] | regex_search('^Splunk ') - - trs_collector_auth_headers['Authorization'] | length > 10 - - trs_collector_auth_headers['X-Splunk-Request-Channel'] | length > 5 + - "'Authorization' in trs_collector_auth_headers" + - "'X-Splunk-Request-Channel' in trs_collector_auth_headers" + - trs_collector_auth_headers['Authorization'] | default('') | regex_search('^Splunk ') + - trs_collector_auth_headers['Authorization'] | default('') | length > 10 + - trs_collector_auth_headers['X-Splunk-Request-Channel'] | default('') | length > 5This pattern mirrors the defensive guard you already applied elsewhere and avoids fatal errors.
roles/test_report_send/tasks/reporting/splunk.yml (3)
24-34:trs_meta_data.jobmay be undefined – guard before useJinja evaluates the
set_factexpression before thewhen:condition.
Iftrs_meta_datalacks thejobkey the attribute access explodes:trs_meta_data.job.created_atAdd a default for the intermediate dict (same for the pipeline block below):
- trs_job_time_int: "{{ (trs_meta_data.job.created_at | default(trs_default_ts, true) | ... ) }}" + trs_job_time_int: "{{ ((trs_meta_data.job | default({})).created_at + | default(trs_default_ts, true) | ... ) }}"and update the
when:guard to tolerate an undefined dict:- - trs_meta_data.job | length > 0 + - trs_meta_data.job is defined + - trs_meta_data.job | length > 0Same pattern for
trs_meta_data.pipeline.
80-84: Unsafewhen:– baretrs_collectorwill error if undefinedA missing variable bombs out before the condition is checked. Guard it:
- - trs_collector + - trs_collector | default('') | length > 0
90-91: Possible undefined variable in length test
trs_collector_targetmight be unset; calling| lengthon Undefined raises
TypeError. Use a safe default:- - trs_collector_target | length > 0 + - trs_collector_target | default('') | length > 0roles/test_report_send/README.md (1)
37-41: Broken relative link is still unresolvedThe link points to
ocp/role/test_report_send/doc/event.md, which does not exist and will 404. Update it to a valid relative path (e.g.../doc/event.md) or an absolute URL.-For full report syntax see [doc/event.md](ocp/role/test_report_send/doc/event.md). +For full report syntax see [event schema](../doc/event.md).roles/test_report_send/doc/event.proto (2)
10-14: Remove trailing semicolon after message block (proto3 syntax)
proto3doesn’t allow a semicolon after a message declaration.- repeated CIRunnerProperty properties= 3; -}; + repeated CIRunnerProperty properties = 3; +}This was flagged previously and is still present.
3-3: Package-directory mismatch will breakbuf lint/protoc
package test_report;requires this file to live undertest_report/(Buf rulePACKAGE_DIRECTORY_MATCH). Either move the file or update the package statement:-package test_report; +package roles.test_report_send.doc;Fixing this early prevents generation & lint failures.
🧹 Nitpick comments (13)
roles/test_report_send/doc/main.md (1)
9-15: Align list indentation and numberingCurrent spacing mixes 0-, 1- and 2-space indents and restarts numbering, tripping markdownlint (MD005/MD029). Straighten it to a single-level ordered list so renderers show the hierarchy you want.
-1. [Event Structure](event.md) - 1. [metadata generation](metadata.md), per CI: - 1. [DCI](dci.md) - 2. [Jenkins](jenkins.md) -2. [Reporting](reporting.md), per reporting system: - 1. [Splunk](splunk.md) +1. [Event Structure](event.md) + 1. [Metadata generation](metadata.md), per CI: + 1. [DCI](dci.md) + 2. [Jenkins](jenkins.md) +2. [Reporting](reporting.md), per reporting system: + 1. [Splunk](splunk.md)roles/test_report_send/doc/reporting.md (1)
11-13: Use consistent unordered list markerElsewhere you use dashes; switching to
*here is flagged by MD004. Quick tidy:-* [splunk.md](splunk.md) +- [splunk.md](splunk.md)roles/test_report_send/doc/metadata.md (1)
3-4: Minor wording tweak for flowThe sentence reads a bit abruptly. Consider:
-The metadata resides in the event object under `.metadata[]` -When everything is properly done, it has the following sections +Metadata is stored in the event object under `.metadata[]`. +When populated, it is expected to contain the following sections:roles/test_report_send/doc/event.md (1)
9-16: Table column widthSome renderers wrap the long “Contains” column heading, misaligning the table. A short heading keeps it neat:
-| Attribute coordinate | Contains | +| Attribute | Details |roles/test_report_send/doc/dci.md (1)
20-25: Clarify mapping table header
LC domainisn’t immediately obvious; maybe “Lifecycle domain” or another clearer term?-| DCI term | LC domain | meaning | +| DCI term | Domain | Meaning |roles/test_report_send/tasks/reporting/splunk.yml (1)
131-134:hostshould reflect the sender, not the collector URLSplunk’s
hostfield is intended for the originating host; setting it to the
collector URL loses provenance and breaks host-based grouping. Consider:- "host": "{{ trs_collector_url | default(ansible_hostname) }}" + host: "{{ trs_collector_source | default(ansible_hostname) }}"(Minor: the quotes are unnecessary.)
roles/test_report_send/doc/splunk.md (1)
1-128: Pass markdown-lint & LanguageTool for smoother docsThe document is hugely valuable, but lint tools flag dozens of trivial spacing /
capitalisation issues (headings without blank lines, repeated spaces, etc.).
Runningmarkdownlint -fand a quick LanguageTool pass will clean this up
without touching the substance.roles/test_report_send/doc/jenkins.md (1)
1-92: Minor style polishSimilar to the Splunk doc, a run of
markdownlint -fwould fix long lines and
spacing around headings/lists, making future maintenance easier.roles/test_report_send/README.md (1)
1-20: Run markdown-lint to clean up excess blank lines & heading spacingThe file triggers dozens of
MD012/MD022/MD009issues (multiple blank lines, missing blank lines around headings, trailing spaces). A quickmarkdownlint -f(or the VSCode extension) will auto-fix most of them without touching the content.Also applies to: 145-160
roles/test_report_send/doc/comprehensive_guide.md (2)
1-34: TOC & heading levels break common MD rulesThe opening section has eight consecutive blank lines and jumps from
h2→h3without an intervening level, trippingMD012andMD001. Cleaning this up will greatly improve render quality and avoid noise in future diffs.
55-75: Consider running markdown-lint over the guideHundreds of style warnings (excess blank lines, unordered-list style, long lines) make the document hard to maintain. Automating linting in CI (e.g.
markdownlint-cli2) will keep the guide tidy with minimal effort.Also applies to: 450-470
roles/test_report_send/doc/env2vars.md (1)
121-143: Add blank lines around fenced code blocks to satisfy markdownlint (MD031)
A few fenced code blocks (e.g., the<elm>example here and again in the dict section) are not separated from surrounding text by a blank line, which tripsmarkdownlintand hurts readability.-Assumes a list of strings, given the data is formatted as follows: -```text +Assumes a list of strings, given the data is formatted as follows: + +```text '<elm><elmsep><elm><elmsep>....<elmsep><elm>' -``` +``` +Apply the same pattern to the later YAML/
textblocks around lines 145-150 to keep the document lint-clean.roles/test_report_send/doc/event.proto (1)
11-13: Style nit: add spaces around=for field assignments
Consistent spacing (name = 1) aids readability and matches Google style.- repeated CIRunnerProperty properties= 3; + repeated CIRunnerProperty properties = 3;No functional impact, purely cosmetic.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (39)
.github/CODEOWNERS(1 hunks).markdownlint.json(1 hunks)README.md(5 hunks)ansible-collection-redhatci-ocp.spec(2 hunks)galaxy.yml(3 hunks)roles/test_report_send/README.md(1 hunks)roles/test_report_send/defaults/main.yml(1 hunks)roles/test_report_send/doc/comprehensive_guide.md(1 hunks)roles/test_report_send/doc/dci.md(1 hunks)roles/test_report_send/doc/env2vars.md(1 hunks)roles/test_report_send/doc/event.json(1 hunks)roles/test_report_send/doc/event.md(1 hunks)roles/test_report_send/doc/event.mmd(1 hunks)roles/test_report_send/doc/event.proto(1 hunks)roles/test_report_send/doc/jenkins.md(1 hunks)roles/test_report_send/doc/main.md(1 hunks)roles/test_report_send/doc/metadata.md(1 hunks)roles/test_report_send/doc/reporting.md(1 hunks)roles/test_report_send/doc/scripts/gen_dcirc.sh(1 hunks)roles/test_report_send/doc/scripts/jenkins_node_labels.sh(1 hunks)roles/test_report_send/doc/splunk.md(1 hunks)roles/test_report_send/meta/argument_specs.yml(1 hunks)roles/test_report_send/meta/main.yml(1 hunks)roles/test_report_send/tasks/ci-detect.yml(1 hunks)roles/test_report_send/tasks/dump-file.yml(1 hunks)roles/test_report_send/tasks/empty.yml(1 hunks)roles/test_report_send/tasks/ensure-file.yml(1 hunks)roles/test_report_send/tasks/env2vars-populate.yml(1 hunks)roles/test_report_send/tasks/main.yml(1 hunks)roles/test_report_send/tasks/metadata-detect.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/dci.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/jenkins.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/unknown.yml(1 hunks)roles/test_report_send/tasks/reporting/splunk.yml(1 hunks)roles/test_report_send/tasks/reporting/validations.yml(1 hunks)roles/test_report_send/templates/env2vars.j2(1 hunks)roles/test_report_send/tests/test.yml(1 hunks)roles/test_report_send/vars/env2vars/example.yml(1 hunks)roles/test_report_send/vars/env2vars/jenkins.yml(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- roles/test_report_send/tasks/env2vars-populate.yml
- roles/test_report_send/tasks/ensure-file.yml
- roles/test_report_send/tasks/metadata-detect/unknown.yml
- .github/CODEOWNERS
🚧 Files skipped from review as they are similar to previous changes (22)
- roles/test_report_send/tasks/empty.yml
- galaxy.yml
- roles/test_report_send/tests/test.yml
- .markdownlint.json
- ansible-collection-redhatci-ocp.spec
- roles/test_report_send/doc/event.mmd
- roles/test_report_send/vars/env2vars/jenkins.yml
- roles/test_report_send/meta/argument_specs.yml
- roles/test_report_send/tasks/dump-file.yml
- roles/test_report_send/tasks/metadata-detect.yml
- README.md
- roles/test_report_send/tasks/main.yml
- roles/test_report_send/vars/env2vars/example.yml
- roles/test_report_send/doc/scripts/jenkins_node_labels.sh
- roles/test_report_send/templates/env2vars.j2
- roles/test_report_send/meta/main.yml
- roles/test_report_send/tasks/metadata-detect/jenkins.yml
- roles/test_report_send/doc/scripts/gen_dcirc.sh
- roles/test_report_send/tasks/ci-detect.yml
- roles/test_report_send/tasks/metadata-detect/dci.yml
- roles/test_report_send/doc/event.json
- roles/test_report_send/defaults/main.yml
🧰 Additional context used
🧠 Learnings (7)
📓 Common learnings
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#715
File: roles/copy_and_render/tasks/main.yml:18-24
Timestamp: 2025-06-24T21:40:17.028Z
Learning: The copy_and_render role in the ansible-collection-redhatci-ocp repository is designed to work only with relative paths for car_source_dir, not absolute paths. This is an intentional design constraint.
roles/test_report_send/doc/env2vars.md (1)
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/README.md (3)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#715
File: roles/copy_and_render/tasks/main.yml:18-24
Timestamp: 2025-06-24T21:40:17.028Z
Learning: The copy_and_render role in the ansible-collection-redhatci-ocp repository is designed to work only with relative paths for car_source_dir, not absolute paths. This is an intentional design constraint.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/doc/comprehensive_guide.md (1)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
roles/test_report_send/doc/main.md (1)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
roles/test_report_send/tasks/reporting/splunk.yml (3)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#652
File: roles/example_cnf_deploy/scripts/get-example-cnf-status.sh:45-45
Timestamp: 2025-04-21T23:02:58.178Z
Learning: When deprecating components in the redhatci/ansible-collection-redhatci-ocp repository, references to the deprecated component in other roles (like references to `cnf-app-mac-operator` in `fbc_catalog`) may be left intact if they serve as examples rather than functional components. Deprecation scope should be limited to the directly affected role (in this case `example_cnf_deploy`).
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/tasks/reporting/validations.yml (2)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
🪛 LanguageTool
roles/test_report_send/doc/env2vars.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: ...CI metadata collection and normalization ## Problem description We send data to rep...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...nd normalization ## Problem description We send data to reporting for visualizat...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: Place a period at the end of declarative sentences.
Context: ...reporting for visualization and analysis We send 2 main "chunks" of data in each ...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~7-~7: Use proper spacing conventions.
Context: ...d 2 main "chunks" of data in each event: 1. Tests answer questions such as the fol...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~9-~9: There might be a mistake here.
Context: ... answer questions such as the following: 1. which test suite(s) ran, with which resu...
(QB_NEW_EN_OTHER)
[grammar] ~10-~10: Use an Oxford comma.
Context: ... test suite(s) ran, with which results, timings and errors, and for each suite? 1...
(QB_NEW_EN_OTHER_ERROR_IDS_000014)
[grammar] ~10-~10: Use proper spacing conventions.
Context: ... timings and errors, and for each suite? 1. which test cases ran and with which resu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~11-~11: Use an Oxford comma.
Context: ... test cases ran and with which results, timings and errors? 2. metadata answers the...
(QB_NEW_EN_OTHER_ERROR_IDS_000014)
[grammar] ~11-~11: Use proper spacing conventions.
Context: ... with which results, timings and errors? 2. metadata answers the questions like ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~12-~12: There might be a mistake here.
Context: ...ngs and errors? 2. metadata answers the questions like 1. what triggered the...
(QB_NEW_EN_OTHER)
[grammar] ~12-~12: There might be a mistake here.
Context: ... metadata answers the questions like 1. what triggered the run? 2. where did it r...
(QB_NEW_EN_OTHER)
[grammar] ~13-~13: Use proper spacing conventions.
Context: ...tions like 1. what triggered the run? 2. where did it run? 3. what version(s) ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~14-~14: Use proper spacing conventions.
Context: ...iggered the run? 2. where did it run? 3. what version(s) of which products were t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~15-~15: Use proper spacing conventions.
Context: ...ersion(s) of which products were tested? 4. what types of tests ran? 5. who is th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~16-~16: There might be a problem here.
Context: ... were tested? 4. what types of tests ran? 5. who is the author of the changes? 6. ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~17-~17: Use proper spacing conventions.
Context: ... 5. who is the author of the changes? 6. where is the code? 7. which team supp...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: Use proper spacing conventions.
Context: ...of the changes? 6. where is the code? 7. which team supports issues for this code...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~19-~19: Use proper spacing conventions.
Context: ...hich team supports issues for this code? ### Tests The tests' reports are unified by...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~21-~21: Use proper spacing conventions.
Context: ...upports issues for this code? ### Tests The tests' reports are unified by JUnit ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ...s keeps the tests in the same structure. ### Metadata However, the metadata comes fr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~25-~25: Use proper spacing conventions.
Context: ...sts in the same structure. ### Metadata However, the metadata comes from the CI ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~27-~27: Place a period at the end of declarative sentences.
Context: ...he CI system. And there are many of them #### Abundance Currently, only one group I a...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ...d there are many of them #### Abundance Currently, only one group I am working a...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use correct prepositions.
Context: ... Currently, only one group I am working at uses the following CI system types inte...
(QB_NEW_EN_OTHER_ERROR_IDS_000010)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ...llowing CI system types interchangeably: * [Distributed CI](https://distributed-ci.i...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ...(https://distributed-ci.io) (a.k.a. DCI) * GitLab * [GitHub](...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...stributed-ci.io) (a.k.a. DCI) * GitLab * GitHub * [Jenkins]...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~37-~37: Use proper spacing conventions.
Context: ... GitLab * GitHub * Jenkins * [Pro...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~39-~39: Use proper spacing conventions.
Context: ...GitHub * Jenkins * Prow Ev...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~41-~41: Use proper spacing conventions.
Context: ...enkins](https://www.jenkins.io) * Prow Even though the intent is to reduce the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~44-~44: There might be a mistake here.
Context: ...types, the tools tend to: * change over the time without backward compatibility * n...
(QB_NEW_EN_OTHER)
[grammar] ~44-~44: There might be a mistake here.
Context: ...* change over the time without backward compatibility * new tools come up * the migrations ef...
(QB_NEW_EN_OTHER)
[grammar] ~45-~45: There might be a mistake here.
Context: ...backward compatibility * new tools come up * the migrations efforts are prioritize...
(QB_NEW_EN_OTHER)
[grammar] ~46-~46: Use singular and plural nouns appropriately.
Context: ...compatibility * new tools come up * the migrations efforts are prioritized lower than othe...
(QB_NEW_EN_OTHER_ERROR_IDS_000012)
[grammar] ~46-~46: Place a period at the end of declarative sentences.
Context: ...are prioritized lower than other efforts #### Disparity between CI systems metadata E...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~48-~48: Use proper spacing conventions.
Context: ...## Disparity between CI systems metadata Each CI system generates metadata in its...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~50-~50: Use proper spacing conventions.
Context: ...tes metadata in its own specific manner. There are 2 most common methods to commu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~51-~51: There might be a mistake here.
Context: ...ime dynamic metadata, either by exposing: 1. an extensive set of environment variable...
(QB_NEW_EN_OTHER)
[grammar] ~54-~54: Use articles correctly.
Context: ...tensive set of environment variables 2. single environment variable, pointing at a fil...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~55-~55: Use proper spacing conventions.
Context: ...ile with structured JSON payload 3. both Still, each CI system has its own consid...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~57-~57: There might be a problem here.
Context: ...ach CI system has its own considerations, terminology and this data is kept in different stru...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~57-~57: Use proper spacing conventions.
Context: ...ferent structures/environment variables. ## Solution Overview In short, the user ma...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~59-~59: Use proper spacing conventions.
Context: ...ronment variables. ## Solution Overview In short, the user may be limited by org...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~61-~61: Use proper spacing conventions.
Context: ...traints with *: 1. not enough permissions to allow quick re...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~63-~63: Use proper spacing conventions.
Context: ... on organizational regulations/policies. 2. a healthy desire to generate CI-invarian...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~64-~64: Use proper spacing conventions.
Context: ... CI-invariant queries in the dashboards. Ergo, the minimal external dependency pa...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~66-~66: Use proper spacing conventions.
Context: ...malize the data structure pre-ingestion. ### Implementation For each CI system we cr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~68-~68: Use proper spacing conventions.
Context: ...cture pre-ingestion. ### Implementation For each CI system we create: * `env2va...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~70-~70: Use proper spacing conventions.
Context: ...mentation For each CI system we create: * env2vars maps environment variables to event met...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~72-~72: Use proper spacing conventions.
Context: ... event metadata through trs_vars_dict. * trs_vars_dict contains the data used to directly popu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~73-~73: Use proper spacing conventions.
Context: ...d to directly populate event.metadata. The structure of the event is defined in...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~75-~75: Use proper spacing conventions.
Context: ...ent is defined in this file. It usually has the following information...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~76-~76: Use proper spacing conventions.
Context: ...ng information under event.metadata[]: | event coordinates(*) | trs_vars_dict...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~88-~88: Use proper spacing conventions.
Context: ... | (*) - written using jq notation In env2vars we map this metadata into ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~90-~90: There might be a mistake here.
Context: ... (*) - written using jq notation In env2vars we map this metadata into event's `meta...
(QB_NEW_EN_OTHER)
[grammar] ~90-~90: Use articles correctly.
Context: ...In env2vars we map this metadata into event's metadata. This is done in these stage...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~90-~90: Use proper spacing conventions.
Context: ...p this metadata into event's metadata. This is done in these stages: 1. During...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~91-~91: Use proper spacing conventions.
Context: ...metadata. This is done in these stages: 1. During the development, env2vars` is po...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~93-~93: Use proper spacing conventions.
Context: ...efining keys from environment variables. 2. During runtime the role iterates over `e...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~94-~94: There might be a mistake here.
Context: ...s from environment variables. 2. During runtime the role iterates over env2vars keys,...
(QB_NEW_EN_OTHER)
[grammar] ~94-~94: There might be a mistake here.
Context: ...e the role iterates over env2vars keys, and assigns them in the transition dict...
(QB_NEW_EN_OTHER)
[grammar] ~94-~94: There might be a mistake here.
Context: ...eys, and assigns them in the transition dictionary trs_vars_dict 3. Next, it repeats over the populated `trs...
(QB_NEW_EN_OTHER)
[grammar] ~95-~95: There might be a mistake here.
Context: ... 3. Next, it repeats over the populated trs_vars_dict properly assigning its keys under `meta...
(QB_NEW_EN_OTHER)
[grammar] ~95-~95: There might be a mistake here.
Context: ...g its keys under metadata of the event 4. The translation of trs_vars_dict keys ...
(QB_NEW_EN_OTHER)
[grammar] ~96-~96: Place a period at the end of declarative sentences.
Context: ...t's metadata keys is relatively static This approach allows: * better readabil...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~98-~98: Use proper spacing conventions.
Context: ...relatively static This approach allows: * better readability because of less code ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~100-~100: Use singular and plural nouns appropriately.
Context: ...better readability because of less code duplications and significant similarity between CI s...
(QB_NEW_EN_OTHER_ERROR_IDS_000012)
[grammar] ~100-~100: Add a conjunction or punctuation.
Context: ...ignificant similarity between CI systems * the only exception is DCI: because it is ...
(QB_NEW_EN_OTHER_ERROR_IDS_000068)
[grammar] ~101-~101: Place a period at the end of declarative sentences.
Context: ...oring already passed process information So, trs_vars_dict is a transition vari...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~103-~103: Use articles correctly.
Context: ..._vars_dictis a transition variable to constructmetadata` part of the event being repo...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~103-~103: Use proper spacing conventions.
Context: ...adata` part of the event being reported. 1. For every supported CI type, we should h...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~105-~105: Use proper spacing conventions.
Context: ...vars/{{ trs_ci_type }}.ymlin the role. 2. The listenv2varsis used to updatet...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~106-~106: Use proper spacing conventions.
Context: ... is used to update trs_vars_dict keys. 3. trs_vars_dict keys are used to populate actual `.even...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~107-~107: There might be a mistake here.
Context: ...te actual .event.metadata[] attributes 4. Metadata maintenance is thus reduced to ...
(QB_NEW_EN_OTHER)
[grammar] ~108-~108: There might be a mistake here.
Context: ...e is thus reduced to generating the list, and sometimes adjusting which `trs_vars...
(QB_NEW_EN_OTHER)
[grammar] ~108-~108: There might be a mistake here.
Context: ...mes adjusting which trs_vars_dict keys populate which event.metadata[] attrib...
(QB_NEW_EN_OTHER)
[grammar] ~109-~109: Use proper spacing conventions.
Context: ...ate which event.metadata[] attributes. The following types are supported: | Ty...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~111-~111: Use proper spacing conventions.
Context: ...tes. The following types are supported: | Type | Constraints | | ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~119-~119: Use proper spacing conventions.
Context: ... | | str | string, default | ### (*) Assumes a list of strings, given th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~121-~121: Use proper spacing conventions.
Context: ...` | string, default | ### (*) Assumes a list of strings, given the dat...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~123-~123: Use proper spacing conventions.
Context: ... given the data is formatted as follows: text '<elm><elmsep><elm><elmsep>....<elmsep><elm>' | token | meaning | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~132-~132: Use proper spacing conventions.
Context: ... | | <elmsep> | element separator | Parsed as a list of strings, into: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~134-~134: Use proper spacing conventions.
Context: ... Parsed as a list of strings, into: yaml ${key}: # actual value of `key` in `env2vars` is used - '<elm>' ... - '<elm>' ### (**) Assumes flat dicts, given the data...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~143-~143: Use proper spacing conventions.
Context: ... '' ... - '' ``` ### (**) Assumes flat dicts, given the data is fo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~145-~145: Use proper spacing conventions.
Context: ... given the data is formatted as follows: text '<k><kvsep><v><elmsep><k><kvsep><v>...<elmsep><k><kvsep><v>' | token | meaning | | -...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~156-~156: Use proper spacing conventions.
Context: ... | | <kvsep> | key/value separator | Parsed as a flat dict of into: ```y...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~158-~158: There might be a problem here.
Context: ...parator | Parsed as a flat dict of into: yaml ${key}: # actual value of `key` in `env2vars` is used '<k>': '<v>' '<k>': '<v>' ... '<k>': '<v>' ## Defining variables ### Where to define ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~169-~169: Use proper spacing conventions.
Context: ...'': '' ``` ## Defining variables ### Where to define them 1. Identify the fi...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~171-~171: Use proper spacing conventions.
Context: ...ning variables ### Where to define them 1. Identify the file based on the CI you kn...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~173-~173: Place a period at the end of declarative sentences.
Context: ...entify the file based on the CI you know They need to be added in env2vars list...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~175-~175: There might be a mistake here.
Context: ... the CI you know They need to be added in env2vars list in a file `vars/<trs_ci...
(QB_NEW_EN_OTHER)
[grammar] ~175-~175: There might be a mistake here.
Context: ... list in a file vars/<trs_ci_type>.yml That is, if the trs_ci_type is `github...
(QB_NEW_EN_OTHER)
[grammar] ~176-~176: There might be a mistake here.
Context: ..._typeisgithub, the file you edit is: vars/env2vars/github.yml` 1. If the file is not present, create it #...
(QB_NEW_EN_OTHER)
[grammar] ~178-~178: Place a period at the end of declarative sentences.
Context: ...1. If the file is not present, create it ## How to define each type ### String (`st...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~180-~180: Use proper spacing conventions.
Context: ...t, create it ## How to define each type ### String (str) #### YAML structure ```...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~182-~182: Use proper spacing conventions.
Context: ... to define each type ### String (str) #### YAML structure ```yaml --- env2vars: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~184-~184: Use proper spacing conventions.
Context: ... ### String (str) #### YAML structure yaml --- env2vars: - key: my_key var: MY_ENV_VAR var_type: str ##### Examples | Environment |...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~194-~194: Use proper spacing conventions.
Context: ...AR var_type: str ``` ##### Examples | Environment | `vars_dic...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~198-~198: Use proper spacing conventions.
Context: ...ENV_VAR="kuku"|{"my_key": "kuku"}` | #### Comments This type is the default t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~200-~200: Use proper spacing conventions.
Context: ... | {"my_key": "kuku"} | #### Comments This type is the default type, no ne...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~202-~202: There might be a mistake here.
Context: ...ments This type is the default type, no need to specify it ### List (list...
(QB_NEW_EN_OTHER)
[grammar] ~202-~202: Place a period at the end of declarative sentences.
Context: ... default type, no need to specify it ### List (list) #### YAML structure ```y...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~204-~204: Use proper spacing conventions.
Context: ...no need to specify it ### List (list) #### YAML structure ```yaml env2vars: - ke...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~206-~206: Use proper spacing conventions.
Context: ... ### List (list) #### YAML structure yaml env2vars: - key: my_lst_key var: MY_ENV_LIST_VAR var_type: list splitter: - '/' NOTE: default splitter does not need t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~217-~217: Use articles correctly.
Context: ... splitter: - '/' ``` NOTE: default splitter does not need to be specified ...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~217-~217: Place a period at the end of declarative sentences.
Context: ...t splitter does not need to be specified ##### Examples | Environment | vars_dict as...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~219-~219: Use proper spacing conventions.
Context: ...not need to be specified ##### Examples | Environment | vars_dict as dict | | ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~224-~224: Use proper spacing conventions.
Context: ..."my_lst_key": ["path", "to", "some"]}` | NOTE: spaces are not stripped. ### Di...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~226-~226: Use proper spacing conventions.
Context: ...} | **NOTE:** spaces are not stripped. ### Dictionary (dict`) #### YAML structure...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~228-~228: Use proper spacing conventions.
Context: ...e not stripped. ### Dictionary (dict) #### YAML structure ```yaml --- env2vars: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~230-~230: Use proper spacing conventions.
Context: ...Dictionary (dict) #### YAML structure yaml --- env2vars: - key: my_dict_key var: MY_ENV_DICT_VAR var_type: dict splitter: - ' ' - ':' ##### Examples | Environment | vars_dict co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~243-~243: Use proper spacing conventions.
Context: ... - ' ' - ':' ``` ##### Examples | Environment | vars_dict contents | |...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~247-~247: Use proper spacing conventions.
Context: ...linux", "arch": ["x86_64", "amd64"]}}` | #### Comments The above splitters are the **...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~249-~249: Use proper spacing conventions.
Context: ... ["x86_64", "amd64"]}}` | #### Comments The above splitters are the default,...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~251-~251: Use proper spacing conventions.
Context: ...the default, so they can be omitted. Other interesting combinations of splitt...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~252-~252: Place a period at the end of declarative sentences.
Context: ...g combinations of splitters are possible ### Integer (int) #### YAML structure ``...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~254-~254: Use proper spacing conventions.
Context: ...itters are possible ### Integer (int) #### YAML structure ```yaml env2vars: - ke...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~256-~256: Use proper spacing conventions.
Context: ...### Integer (int) #### YAML structure yaml env2vars: - key: my_number var: MY_ENV_NUMBER var_type: int ##### Examples | Environment | vars_dict as...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~265-~265: Use proper spacing conventions.
Context: ...ER var_type: int ``` ##### Examples | Environment | vars_dict as dict | | ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~269-~269: Use proper spacing conventions.
Context: ..._VAR="34213"|{"my_number": 34213} | ### Boolean (bool) #### YAML structure ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~271-~271: Use proper spacing conventions.
Context: ...number": 34213} | ### Boolean (bool`) #### YAML structure ```yaml --- env2vars: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~273-~273: Use proper spacing conventions.
Context: ...## Boolean (bool) #### YAML structure yaml --- env2vars: - key: my_bool var: MY_BOOL_TRUTH var_type: bool ##### Examples | Environment | `...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~284-~284: Use proper spacing conventions.
Context: ... var_type: bool ``` ##### Examples | Environment | vars_dict...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~292-~292: Use proper spacing conventions.
Context: ...TRUTH="string"|{"my_bool": true}` | ## Constraints *<a name="our-gr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~295-~295: Use proper spacing conventions.
Context: ... {"my_bool": true} | ## Constraints * Our grou...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~298-~298: Use proper spacing conventions.
Context: ...rting systems because we are only users. * So we cannot rely on our capability to p...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~299-~299: Use proper spacing conventions.
Context: ... processing, which is too much overhead.
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/README.md
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...- DOCSIBLE START --> # 📃 Role overview ## test_report_send Description: Pushes ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ... # 📃 Role overview ## test_report_send Description: Pushes JUnit XML files and ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~38-~38: Use articles correctly.
Context: ...SON file to send. Merged into the event under 'test' attribute. For full report synta...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~38-~38: Use proper spacing conventions.
Context: ...d into the event under 'test' attribute. For full report syntax see [doc/event.md...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~51-~51: Use proper spacing conventions.
Context: ...ark special datasets during development. If set to be empty or the file is missin...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~145-~145: Use proper spacing conventions.
Context: ...Used only if trs_event_save is set to true
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~156-~156: Use proper spacing conventions.
Context: ...`
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~160-~160: Use proper spacing conventions.
Context: ...priority** #### File: defaults/main.yml | Var | Type | Value ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~189-~189: Use proper spacing conventions.
Context: ...unk']` | n/a | n/a | ### Tasks #### File: tasks/env2vars-populate.yml | Nam...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~192-~192: Use proper spacing conventions.
Context: ... #### File: tasks/env2vars-populate.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~199-~199: Use proper spacing conventions.
Context: ...True | #### File: tasks/ensure-file.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~207-~207: Use proper spacing conventions.
Context: ...| True | #### File: tasks/ci-detect.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~215-~215: Use proper spacing conventions.
Context: ... | #### File: tasks/metadata-detect.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~234-~234: Use proper spacing conventions.
Context: ...opy | False | #### File: tasks/main.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~246-~246: Use proper spacing conventions.
Context: ...| #### File: tasks/reporting/splunk.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~275-~275: Use proper spacing conventions.
Context: ... File: tasks/metadata-detect/jenkins.yml | Name | Module | Has Conditions | | ---...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~312-~312: Use proper spacing conventions.
Context: ...tin.fail | False | ## Task Flow Graphs ### Graph for env2vars-populate.yml ```merm...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~316-~316: Use proper spacing conventions.
Context: ...s ### Graph for env2vars-populate.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-->|Include vars| ___role_path____vars_env2vars0[include env2vars variable for trs ci system<br>include_vars: role path vars env2vars]:::includeVars ___role_path____vars_env2vars0-->|Task| Set_facts_from_environment_variables_into_trs_vars_dict1[set facts from environment variables into trs vars<br>dict<br>When: **env2vars default length 0**]:::task Set_facts_from_environment_variables_into_trs_vars_dict1-->End ### Graph for ensure-file.yml ```mermaid fl...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~336-~336: Use proper spacing conventions.
Context: ...>End ### Graph for ensure-file.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_value_of_var_trs_file_path0[print value of var trs file path]:::task Print_value_of_var_trs_file_path0-->|Task| Collect_file_stat_for_file_trs_file_path1[collect file stat for file trs file path
When: trs file path length 0]:::task Collect_file_stat_for_file_trs_file_path1-->|Task| Ensure_validation_requirements_are_met_for_file_trs_file_path2[ensure validation requirements are met for file
trs file path
When: trs file path length 0]:::task Ensure_validation_requirements_are_met_for_file_trs_file_path2-->End ### Graph for ci-detect.yml mermaid flow...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~357-~357: Use proper spacing conventions.
Context: ...-->End ### Graph for ci-detect.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| Recognize_trs_ci_system_as_DCI0[recognize trs ci system as dci
When: trs ci system unknown and lookup env dci
cs url length 0]:::task Recognize_trs_ci_system_as_DCI0-->|Task| Recognize_trs_ci_system_as_Jenkins1[recognize trs ci system as jenkins
When: trs ci system unknown and lookup env
jenkins url length 0]:::task Recognize_trs_ci_system_as_Jenkins1-->|Task| Validating_trs_ci_system_is_supported2[validating trs ci system is supported]:::task Validating_trs_ci_system_is_supported2-->End ### Graph for metadata-detect.yml mermai...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~378-~378: Use proper spacing conventions.
Context: ... ### Graph for metadata-detect.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-->|Include task| ci_detect_yml0[ci system auto detection
When: trs ci system autodetect
include_task: ci detect yml]:::includeTasks ci_detect_yml0-->|Include vars| vars1[include variables for trs ci system
include_vars: vars]:::includeVars vars1-->|Include task| env2vars_populate_yml2[detect dynamic metadata
include_task: env2vars populate yml]:::includeTasks env2vars_populate_yml2-->|Include task| metadata_detect____trs_ci_system____yml3[detect dynamic metadata
include_task: metadata detect trs ci system yml]:::includeTasks metadata_detect____trs_ci_system____yml3-->|Task| Print_generated_dict_trs_ci_runtime4[print generated dict trs ci runtime
When: trs debug]:::task Print_generated_dict_trs_ci_runtime4-->|Task| Update_metadata5[update metadata]:::task Update_metadata5-->|Task| Update_trs_collector_source_for_trs_ci_system6[update trs collector source for trs ci system
When: trs meta data ci url default length 0]:::task Update_trs_collector_source_for_trs_ci_system6-->End ### Graph for dump-file.yml mermaid flow...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~403-~403: Use proper spacing conventions.
Context: ...-->End ### Graph for dump-file.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_variable_trs_file_path0[print variable trs file path]:::task Print_variable_trs_file_path0-->|Task| Dump_the_event_data_to_file1[dump the event data to file]:::task Dump_the_event_data_to_file1-->End ### Graph for main.yml mermaid flowchart...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~423-~423: Use proper spacing conventions.
Context: ...file1-->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_all_required_variables_are_defined0[validate all required variables are defined]:::task Validate_all_required_variables_are_defined0-->|Include task| ensure_file_yml1[ensure presence and readability of essential input
files
When: trs file path length 0
include_task: ensure file yml]:::includeTasks ensure_file_yml1-->|Task| Initialize_trs_meta_data2[initialize trs meta data]:::task Initialize_trs_meta_data2-->|Task| Read_content_of_JSON_file_trs_file_path3[read content of json file trs file path
When: trs metadata path length 0]:::task Read_content_of_JSON_file_trs_file_path3-->|Task| Assign_JSON_content_into_trs_meta_data4[assign json content into trs meta data
When: trs metadata path length 0 and trs metadata
path is defined and trs metadata path content
length 0]:::task Assign_JSON_content_into_trs_meta_data4-->|Include task| metadata_detect_yml5[detect runtime metadata from our environment
include_task: metadata detect yml]:::includeTasks metadata_detect_yml5-->|Include task| reporting____trs_collector____yml6[send trs data event to collector trs collector
When: trs report path length 0
include_task: reporting trs collector yml]:::includeTasks reporting____trs_collector____yml6-->End ### Graph for reporting/splunk.yml merma...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~448-~448: Use proper spacing conventions.
Context: ... ### Graph for reporting/splunk.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_content_from_test_report_JSON_file0[read content from test report json file]:::task Read_content_from_test_report_JSON_file0-->|Task| Decode_JSON_content_of_test_report_file1[decode json content of test report file
When: trs json file content content length 0]:::task Decode_JSON_content_of_test_report_file1-->|Task| Print_currently_used_timestamp_trs_default_ts2[print currently used timestamp trs default ts]:::task Print_currently_used_timestamp_trs_default_ts2-->|Task| Setup_timestamps_broken_down_to_int_float_parts_for_trs_collector3[setup timestamps broken down to int float parts
for trs collector]:::task Setup_timestamps_broken_down_to_int_float_parts_for_trs_collector3-->|Task| Setup_timestamps_as_floats_for_reporting4[setup timestamps as floats for reporting]:::task Setup_timestamps_as_floats_for_reporting4-->|Task| Update_trs_collector_auth_headers_with_trs_collector_auth_token_from_the_user_for_trs_collector5[update trs collector auth headers with trs
collector auth token from the user for trs
collector
When: trs collector auth token length 0 and trs
collector]:::task Update_trs_collector_auth_headers_with_trs_collector_auth_token_from_the_user_for_trs_collector5-->|Task| Update_trs_collector_auth_headers_with_trs_collector_target_from_the_user_for_trs_collector6[update trs collector auth headers with trs
collector target from the user for trs collector
When: trs collector target length 0]:::task Update_trs_collector_auth_headers_with_trs_collector_target_from_the_user_for_trs_collector6-->|Task| Set_default_allowed_status_codes7[set default allowed status codes]:::task Set_default_allowed_status_codes7-->|Task| Set_allowed_status_codes8[set allowed status codes
When: trs do send]:::task Set_allowed_status_codes8-->|Include task| validations_yml9[validate splunk related data
include_task: validations yml]:::includeTasks validations_yml9-->|Task| Create_event_data_attributes10[create event data attributes]:::task Create_event_data_attributes10-->|Task| Print_event_data_before_timestamp_corrections11[print event data before timestamp corrections]:::task Print_event_data_before_timestamp_corrections11-->|Task| Combine_additional_attributes_into_the_data_at_trs_collector_target_for_trs_collector12[combine additional attributes into the data at trs
collector target for trs collector]:::task Combine_additional_attributes_into_the_data_at_trs_collector_target_for_trs_collector12-->|Include task| dump_file_yml13[print variable trs event dump file
When: trs event dump file length 0 and trs event
save
include_task: dump file yml]:::includeTasks dump_file_yml13-->|Task| Send_data_to_trs_collector14[send data to trs collector
When: trs do send default false]:::task Send_data_to_trs_collector14-->End ### Graph for reporting/validations.yml ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~503-~503: Use proper spacing conventions.
Context: ...## Graph for metadata-detect/jenkins.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| Update_is_ci_in_trs_ci_runtime_attribute_for_trs_ci_system0[update is ci in trs ci runtime attribute for trs<br>ci system]:::task Update_is_ci_in_trs_ci_runtime_attribute_for_trs_ci_system0-->|Task| Update_helper_variables_for_ci_attributes_for_trs_ci_system1[update helper variables for ci attributes for trs<br>ci system]:::task Update_helper_variables_for_ci_attributes_for_trs_ci_system1-->|Task| Update_helper_variables_for_ci_attributes_for_trs_ci_system2[update helper variables for ci attributes for trs<br>ci system]:::task Update_helper_variables_for_ci_attributes_for_trs_ci_system2-->|Task| Update_helper_variables_for_ci_runner_attributes_for_trs_ci_system3[update helper variables for ci runner attributes<br>for trs ci system]:::task Update_helper_variables_for_ci_runner_attributes_for_trs_ci_system3-->|Task| Update_helper_variables_for_trs_ci_runtime_attributes_for_trs_ci_system4[update helper variables for trs ci runtime<br>attributes for trs ci system]:::task Update_helper_variables_for_trs_ci_runtime_attributes_for_trs_ci_system4-->|Task| Update_helper_variables_for_job_attributes_for_trs_ci_system5[update helper variables for job attributes for trs<br>ci system]:::task Update_helper_variables_for_job_attributes_for_trs_ci_system5-->|Task| Update_helper_variables_for_source_attributes_for_trs_ci_system6[update helper variables for source attributes for<br>trs ci system]:::task Update_helper_variables_for_source_attributes_for_trs_ci_system6-->|Task| Update_helper_variables_for_source_change_attributes_for_trs_ci_system7[update helper variables for source change<br>attributes for trs ci system]:::task Update_helper_variables_for_source_change_attributes_for_trs_ci_system7-->|Task| Update_helper_variables_for_source_attributes_for_trs_ci_system8[update helper variables for source attributes for<br>trs ci system]:::task Update_helper_variables_for_source_attributes_for_trs_ci_system8-->|Task| Construct_the_final_trs_ci_runtime_metadata_dictionary_for_trs_ci_system9[construct the final trs ci runtime metadata<br>dictionary for trs ci system]:::task Construct_the_final_trs_ci_runtime_metadata_dictionary_for_trs_ci_system9-->End ### Graph for metadata-detect/dci.yml ```me...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~558-~558: Use proper spacing conventions.
Context: ...## Graph for metadata-detect/unknown.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| Unsupported_CI_system0[unsupported ci system]:::task Unsupported_CI_system0-->|Task| Fail_the_role1[fail the role]:::task Fail_the_role1-->End ## Playbook ```yml --- - name: Run test_re...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~578-~578: Use proper spacing conventions.
Context: ... Fail_the_role1-->End ## Playbook yml --- - name: Run test_report_send role hosts: localhost connection: local gather_facts: false roles: - role: redhatci.ocp.test_report_send ## Playbook graphmermaid flowchart TD ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~590-~590: Use proper spacing conventions.
Context: ....test_report_send ## Playbook graphmermaid flowchart TD localhost-->|Role| redhatci_ocp_test_report_send[redhatci ocp test report send] ``` ## Author Information Max Kovgan, Cesare Pl...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~599-~599: Use proper spacing conventions.
Context: ...x Kovgan, Cesare Placanica #### License Apache License, Version 2.0 #### Minimu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~601-~601: Use proper spacing conventions.
Context: ...### License Apache License, Version 2.0 #### Minimum Ansible Version 2.9 #### Platf...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~603-~603: Use proper spacing conventions.
Context: ...ersion 2.0 #### Minimum Ansible Version 2.9 #### Platforms No platforms specif...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~605-~605: Use proper spacing conventions.
Context: ...n 2.0 #### Minimum Ansible Version 2.9 #### Platforms No platforms specified. <!-- ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~607-~607: Use proper spacing conventions.
Context: ...mum Ansible Version 2.9 #### Platforms No platforms specified. <!-- DOCSIBLE EN...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~609-~609: Use proper spacing conventions.
Context: ... #### Platforms No platforms specified.
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/comprehensive_guide.md
[typographical] ~1-~1: To join two clauses or set off examples, consider using an em dash.
Context: # Test Report Send Role - Comprehensive Guide ## Table of Content...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~1-~1: Use proper spacing conventions.
Context: ...t Report Send Role - Comprehensive Guide ## Table of Contents 1. [Overview](#overvi...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...omprehensive Guide ## Table of Contents 1. Overview 2. [Event Structure...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: Use proper spacing conventions.
Context: ...#implementation-guide) --- ## Overview The test_report_send role generates ev...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~20-~20: Use proper spacing conventions.
Context: ...servability and analytics. This enables: - Shared visual and data languages acros...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~26-~26: Use proper spacing conventions.
Context: ...lized event structures ### Key Features - Multi-CI Support: Works with Jenkins, ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ... (Splunk, etc.) --- ## Event Structure Events contain two main components: **me...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~37-~37: Use proper spacing conventions.
Context: ... test data (test execution results). ### Protocol Buffer Schema Definition The e...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~39-~39: Use proper spacing conventions.
Context: .... ### Protocol Buffer Schema Definition The event structure is formally defined ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~58-~58: Use proper spacing conventions.
Context: ...el Event Structure (JSON Representation) json { "source": "<str>", // Information source (team/channel identifier) "host": "<hostname>", // Host/container/service sending the data "sourcetype": "_json", // Event format identifier "_time": "<timestamp>", // Event emission timestamp "event": { "metadata": "<metadata_object>", // CI/CD and environment metadata "test": "<test_data_object>" // Test execution data } } ### Key Components | Component | Ty...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~73-~73: Use proper spacing conventions.
Context: ...ion data } } ``` ### Key Components | Component | Type/Message ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~85-~85: Use proper spacing conventions.
Context: ... ### Benefits of Protocol Buffer Schema The Protocol Buffer definition provides ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~101-~101: Use proper spacing conventions.
Context: ...ication. ### Detailed Schema Components ReportMetadata Structure: ```protobuf...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~103-~103: Use proper spacing conventions.
Context: ... Components ReportMetadata Structure: protobuf message ReportMetadata { bool is_ci = 1; CI ci = 2; Pipeline pipeline = 3; Job job = 4; Source source = 5; Product product = 6; } CI System Structure: ```protobuf mess...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~116-~116: Use proper spacing conventions.
Context: ...oduct = 6; } **CI System Structure:** protobuf message CI { string url = 1; string type = 2; CIRunner runner = 3; } message CIRunner { string name = 1; optional string url = 2; repeated CIRunnerPropertyString properties_string = 3; repeated CIRunnerPropertyInt properties_int = 4; repeated CIRunnerPropertyStringArray properties_string_array = 5; } **Test Statistics Composition:**protob...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~134-~134: There might be a problem here.
Context: ...5; } **Test Statistics Composition:**protobuf message TestStatistics { int32 tests = 1; // Total number of tests int32 skipped = 2; // Number of skipped tests int32 errors = 3; // Number of tests with errors int32 failures = 4; // Number of failed tests float time = 5; // Total execution time } **TestReport Structure:**protobuf message TestRe...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~145-~145: Use proper spacing conventions.
Context: ...tion time } **TestReport Structure:**protobuf message TestReport { TestStatistics stats = 1; // Overall test run statistics repeated TestSuite test_suites = 3; // Individual test suites } message TestSuite { string name = 1; // Suite name TestStatistics stats = 2; // Suite-level statistics string timestamp = 8; // Suite execution timestamp repeated TestSuiteProperty properties = 9; // Suite properties repeated TestCase test_cases = 10; // Individual test cases } message TestCase { string name = 1; // Test case name string classname = 2; // Test class name TestStatistics stats = 3; // Case-level statistics string system_err = 4; // System error output TestResult result = 5; // Test result details } ``` --- ## Metadata Structure The metadata section...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~171-~171: Use proper spacing conventions.
Context: ...etails } ``` --- ## Metadata Structure The metadata section provides comprehens...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~212-~212: Use proper spacing conventions.
Context: ...data ``` ### Metadata Coordinate System The metadata uses a hierarchical coordin...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~228-~228: Use proper spacing conventions.
Context: ...t.name` | --- ## CI System Integration ### Jenkins Integration Jenkins builds expo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~230-~230: Use proper spacing conventions.
Context: ...tem Integration ### Jenkins Integration Jenkins builds expose metadata through e...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~234-~234: Use proper spacing conventions.
Context: ...ructure. #### Key Environment Variables CI System Information: - `JENKINS_URL...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~236-~236: Use proper spacing conventions.
Context: ...ment Variables CI System Information: - JENKINS_URL: Base URL of the Jenkins instance - `NO...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~244-~244: Use proper spacing conventions.
Context: ...st of build triggers Job Information: - JOB_NAME: Jenkins job name - JOB_URL: Job URL ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~253-~253: Use proper spacing conventions.
Context: ...uild results Source Code Information: - GIT_COMMIT: Full SHA-1 hash of current commit - `G...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~264-~264: Use proper spacing conventions.
Context: ...ter/author emails Change Information: GitHub Pull Requests: - CHANGE_ID / ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~276-~276: Use proper spacing conventions.
Context: ...or display name GitLab Merge Requests: - CHANGE_ID / GITLAB_MERGE_REQUEST_IID: Merge req...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~285-~285: Use proper spacing conventions.
Context: ...: MR author email Runner Information: - NODE_NAME: Runner name - NODE_LABELS: Space-sep...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~288-~288: Use proper spacing conventions.
Context: ...LS: Space-separated list of node labels > **Note**: Set NODE_LABELS` on Jenkins nod...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~292-~292: Use proper spacing conventions.
Context: ...n. #### Jenkins-Specific Considerations - Pipeline Object: Jenkins doesn't have ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~294-~294: There might be a mistake here.
Context: ...pipeline" concept, so pipeline: {} by default - Product Information: Can be deriv...
(QB_NEW_EN_OTHER)
[grammar] ~295-~295: There might be a problem here.
Context: ...be derived from job parameters and file paths analysis - Parent/Caller Jobs: Future enhanc...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~296-~296: Place a period at the end of declarative sentences.
Context: ...e pipeline data with parent job metadata ### DCI Integration Distributed CI (DCI) pr...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~298-~298: Use proper spacing conventions.
Context: ...parent job metadata ### DCI Integration Distributed CI (DCI) provides a differen...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~302-~302: Use proper spacing conventions.
Context: ...ng live processes. #### DCI Terminology | DCI Term | Domain | Meaning | |-------...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~314-~314: Use proper spacing conventions.
Context: ...on node | #### DCI vs. Other CI Systems | DCI | Jenkins | GitHub | GitLab | Prow...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~322-~322: Use proper spacing conventions.
Context: ...unner | node | #### DCI API Integration Prerequisites: 1. Working credentials...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~324-~324: Use proper spacing conventions.
Context: ...## DCI API Integration Prerequisites: 1. Working credentials with DCI service acc...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~330-~330: Use proper spacing conventions.
Context: ...ctlcommand-line tool **Setup Process:** 1. Installdcictl` following the [DCI clie...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~338-~338: Use proper spacing conventions.
Context: ...on file Configuration File Structure: bash DCI_CLIENT_ID='remoteci/<UUID>' DCI_API_SECRET='<API_SECRET>' DCI_CS_URL='https://api.distributed-ci.io/' export DCI_CLIENT_ID DCI_API_SECRET DCI_CS_URL Using dcictl: ```bash # Source the co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~347-~347: Use proper spacing conventions.
Context: ...I_SECRET DCI_CS_URL **Using dcictl:** bash # Source the configuration source dcirc.sh # Query examples using Elasticsearch DSL syntax dcictl remoteci-list --query "(eq(name,${myteam}))" dcictl job-list --query "and(eq(team_id,${my_team_id}),eq(topic_id,${my_topic_id}))" # Useful parameters --query # Elasticsearch DSL syntax --where # Alternative syntax, e.g., "tags in [bla, blah, blee]" --limit # Items per page --format json # JSON output for parsing ``` #### DCI Metadata Collection Unlike other CI...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~364-~364: Use proper spacing conventions.
Context: ...arsing ``` #### DCI Metadata Collection Unlike other CI systems that use environ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~368-~368: Use proper spacing conventions.
Context: ...ssing. ### Environment Variable Mapping The env2vars system provides a flexibl...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~372-~372: Use proper spacing conventions.
Context: ... event metadata. #### Problem Statement Different CI systems expose metadata thr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~381-~381: Use proper spacing conventions.
Context: ...# Solution: Normalized Metadata Pipeline The role implements a three-stage normal...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~389-~389: Use proper spacing conventions.
Context: ...nt structure #### Implementation Stages Environment Variables → env2vars → trs_vars_dict → event.metadata 1. Development Stage: Define env2vars m...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~399-~399: Use proper spacing conventions.
Context: ...ture #### Variable Definition Structure Variables are defined in `vars/env2vars/...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~401-~401: Use proper spacing conventions.
Context: ... in vars/env2vars/<ci_type>.yml files: Basic String Variable: ```yaml env2va...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~403-~403: Use proper spacing conventions.
Context: ...e>.yml` files: Basic String Variable: yaml env2vars: - key: my_key var: MY_ENV_VAR var_type: str # Default type, can be omitted List Variable: ```yaml env2vars: - ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~412-~412: Use proper spacing conventions.
Context: ...pe, can be omitted **List Variable:** yaml env2vars: - key: my_list_key var: MY_ENV_LIST_VAR var_type: list splitter: ['/'] # Default splitter, can be omitted **Dictionary Variable:** yaml env2vars...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~422-~422: Use proper spacing conventions.
Context: ...n be omitted **Dictionary Variable:** yaml env2vars: - key: my_dict_key var: MY_ENV_DICT_VAR var_type: dict splitter: [' ', ':'] # Element separator, Key-value separator **Integer Variable:** yaml env2vars: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~432-~432: Use proper spacing conventions.
Context: ...value separator **Integer Variable:** yaml env2vars: - key: my_number var: MY_ENV_NUMBER var_type: int **Boolean Variable:** yaml env2vars: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~441-~441: Use proper spacing conventions.
Context: ... var_type: int **Boolean Variable:** yaml env2vars: - key: my_bool var: MY_BOOL_VAR var_type: bool ``` #### Supported Data Types | Type | Descri...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~450-~450: Use proper spacing conventions.
Context: ...ype: bool ``` #### Supported Data Types | Type | Description | Example In...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~460-~460: Use proper spacing conventions.
Context: ... | #### List Processing Lists are parsed using configurable sepa...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~473-~473: Use proper spacing conventions.
Context: ...item3"]} ``` #### Dictionary Processing Dictionaries support nested key-value pa...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~475-~475: Use proper spacing conventions.
Context: ...ionaries support nested key-value pairs: yaml # Environment: MY_DICT="os:linux arch:x86_64 version:1.0" - key: system_info var: MY_DICT var_type: dict splitter: [' ', ':'] # [element_separator, key_value_separator] # Result: {"system_info": {"os": "linux", "arch": "x86_64", "version": "1.0"}} --- ## Reporting Systems Reporting systems col...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~488-~488: Use proper spacing conventions.
Context: ...: "1.0"}} ``` --- ## Reporting Systems Reporting systems collect, search, and v...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~490-~490: There might be a mistake here.
Context: ...e observability and data-driven decision making. ### Benefits - **Shared Visual...
(QB_NEW_EN_OTHER)
[grammar] ~490-~490: Use proper spacing conventions.
Context: ...ability and data-driven decision making. ### Benefits - Shared Visual Languages:...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~492-~492: Use proper spacing conventions.
Context: ...ta-driven decision making. ### Benefits - Shared Visual Languages: Consistent da...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~496-~496: Use proper spacing conventions.
Context: ...Unified view across different CI systems ### Splunk Integration Splunk serves as the...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~498-~498: Use proper spacing conventions.
Context: ...erent CI systems ### Splunk Integration Splunk serves as the primary reporting b...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~502-~502: Use proper spacing conventions.
Context: ...abilities. #### Event Schema for Splunk Splunk events follow the corrected struc...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~521-~521: Use proper spacing conventions.
Context: ...ma definitions. #### Query Capabilities The schema supports various query patter...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~525-~525: Use proper spacing conventions.
Context: ...per structure: Product-Based Queries: - Filter by product: `.event.metadata.prod...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~530-~530: Use proper spacing conventions.
Context: ...a.product.version **CI System Queries:** - CI type filtering:.event.metadata.ci.t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~536-~536: Use proper spacing conventions.
Context: ...ata.ci.runner[] **Test Result Queries:** - Test suite results:.event.test.test_su...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~545-~545: Use proper spacing conventions.
Context: ....stats.time` #### Timing Considerations All timing data uses consistent time sou...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~547-~547: Use proper spacing conventions.
Context: ... sources to ensure accurate correlation: 1. CI Process Timings: Pipeline, job, and...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~554-~554: Use proper spacing conventions.
Context: ...g correlation. #### Test Data Structure **Test Report Summary (per Protocol Buffer...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~613-~613: Combining words like “every day” changes the meaning.
Context: ...t 'false'" } } ``` ### Benefits of TestStatistics Composition The new composition patter...
(QB_NEW_EN_OTHER_ERROR_IDS_000001)
[grammar] ~613-~613: Use proper spacing conventions.
Context: ...# Benefits of TestStatistics Composition The new composition pattern provides sev...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~615-~615: Use proper spacing conventions.
Context: ...ion pattern provides several advantages: - Consistent Structure: All test-related...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~625-~625: Use proper spacing conventions.
Context: ... one place --- ## Implementation Guide ### Getting Started 1. **Choose Your CI Sys...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~627-~627: Use proper spacing conventions.
Context: ...mplementation Guide ### Getting Started 1. Choose Your CI System: Identify which ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~635-~635: Use proper spacing conventions.
Context: ...eration and delivery ### Best Practices - Consistent Timing: Ensure all CI syste...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~637-~637: There might be a mistake here.
Context: ...re all CI systems use synchronized time sources - Comprehensive Metadata: Include a...
(QB_NEW_EN_OTHER)
[grammar] ~638-~638: There might be a mistake here.
Context: ...vant environment variables for your use case - Test Data Quality: Validate JUnit...
(QB_NEW_EN_OTHER)
[grammar] ~639-~639: There might be a mistake here.
Context: ...Quality**: Validate JUnit report format compliance - Monitoring: Set up alerts for fai...
(QB_NEW_EN_OTHER)
[grammar] ~640-~640: There might be a mistake here.
Context: ...oring**: Set up alerts for failed event deliveries - Documentation: Maintain clear doc...
(QB_NEW_EN_OTHER)
[grammar] ~641-~641: Place a period at the end of declarative sentences.
Context: ...ocumentation of custom variable mappings ### Troubleshooting Common Issues: - **...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~643-~643: Use proper spacing conventions.
Context: ...m variable mappings ### Troubleshooting Common Issues: - **Missing Environment...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~651-~651: Use proper spacing conventions.
Context: ...and credentials ### Future Enhancements - Additional CI Systems: Prow, Tekton, a...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~660-~660: Use proper spacing conventions.
Context: ...to reporting systems --- ## Conclusion The test_report_send role provides a c...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~664-~664: Use proper spacing conventions.
Context: ...cs and observability. ### Key Resources - Protocol Buffer Schema: See [`event.pr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/dci.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # CI: Distributed CI (DCI) The DCI API endpoint is [https://distrib...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...buted-ci.io](https://distributed-ci.io). ## DCI Terminology overview DCI introduces...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~7-~7: Use proper spacing conventions.
Context: ...e concepts compared to other CI systems: | DCI term | LC domain | meaning ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~14-~14: Use proper spacing conventions.
Context: ...nent|remoteci|agent|pipeline|job]` | ### Mapping DCI to Other CI Systems DCI con...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~16-~16: Use proper spacing conventions.
Context: ...` | ### Mapping DCI to Other CI Systems DCI concepts aligned with common CI term...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: Use proper spacing conventions.
Context: ...epts aligned with common CI terminology: | DCI | Jenkins ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~24-~24: Use proper spacing conventions.
Context: ... | runner | runner | node | ## Dynamic environment to metadata conversi...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~26-~26: Use proper spacing conventions.
Context: ...namic environment to metadata conversion In this DCI use case, we do not need to ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~28-~28: Use proper spacing conventions.
Context: ... to dynamically process the environment. When data from DCI reaches us, we can ge...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ...n get the metadata from its API as JSON. ### How to obtain data using dcictl #### ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ... as JSON. ### How to obtain data using dcictl #### Prerequisites 1. Working credential wit...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ... data using dcictl #### Prerequisites 1. Working credential with access to DCI se...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: There might be a mistake here.
Context: ...dcictl` #### Prerequisites 1. Working credential with access to DCI service and the comp...
(QB_NEW_EN_OTHER)
[grammar] ~35-~35: There might be a mistake here.
Context: ... components you're planning to work with 2. Information about team and remoteci ...
(QB_NEW_EN_OTHER)
[grammar] ~36-~36: Use proper spacing conventions.
Context: ...rk with 2. Information about team and remoteci #### Set up 1. See the [dciclient README](ht...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~38-~38: Use proper spacing conventions.
Context: ...about team and remoteci #### Set up 1. See the [dciclient README](https://githu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~40-~40: There might be a mistake here.
Context: ...### Set up 1. See the dciclient README and install the dcictl command-line to...
(QB_NEW_EN_OTHER)
[grammar] ~41-~41: Use proper spacing conventions.
Context: ... install the dcictl command-line tool. 2. Browse to DCI via the web 3. Login with ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~42-~42: There might be a mistake here.
Context: ...and-line tool. 2. Browse to DCI via the web 3. Login with credentials, go to the le...
(QB_NEW_EN_OTHER)
[grammar] ~43-~43: Combining words like “every day” changes the meaning.
Context: ...e tool. 2. Browse to DCI via the web 3. Login with credentials, go to the left hand t...
(QB_NEW_EN_OTHER_ERROR_IDS_000001)
[grammar] ~43-~43: There might be a mistake here.
Context: ...Browse to DCI via the web 3. Login with credentials, go to the left hand to Remotecis 4. I...
(QB_NEW_EN_OTHER)
[grammar] ~43-~43: There might be a mistake here.
Context: .... Login with credentials, go to the left hand to Remotecis 4. In the search fie...
(QB_NEW_EN_OTHER)
[grammar] ~43-~43: There might be a mistake here.
Context: ...n with credentials, go to the left hand to Remotecis 4. In the search field, type remoteci na...
(QB_NEW_EN_OTHER)
[grammar] ~44-~44: There might be a mistake here.
Context: ...4. In the search field, type remoteci name 5. Download dcirc.sh from the **"Remo...
(QB_NEW_EN_OTHER)
[grammar] ~45-~45: Place a period at the end of declarative sentences.
Context: ...dcirc.sh from the "Remotecis" page The contents of dcirc.sh file should l...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~47-~47: Use articles correctly.
Context: ... the "Remotecis" page The contents of dcirc.sh file should look like this: ...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~47-~47: Use proper spacing conventions.
Context: ...f dcirc.sh file should look like this: bash DCI_CLIENT_ID='remoteci/<UUID{lowercase uuid}>' DCI_API_SECRET='<API_SECRET{random alphanumeric (upper/lower) string 64 chars long}>' DCI_CS_URL='https://api.distributed-ci.io/' export DCI_CLIENT_ID DCI_API_SECRET DCI_CS_URL NOTE: the above data is not real. #### ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~56-~56: Use proper spacing conventions.
Context: ...L ``` NOTE: the above data is not real. #### Running dcictl Before running dcictl,...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~58-~58: Use proper spacing conventions.
Context: ...e data is not real. #### Running dcictl Before running dcictl, the script `dci...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~60-~60: Use proper spacing conventions.
Context: ...d (to set up the environment variables). dcictl allows query of the DCI API The syntax ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~62-~62: There might be a mistake here.
Context: ...). dcictl allows query of the DCI API The syntax is: `dcictl <params...
(QB_NEW_EN_OTHER)
[grammar] ~63-~63: Avoid interrupting sentences with colons.
Context: ...llows query of the DCI API The syntax is: dcictl <command> <params> The most in...
(QB_NEW_EN_OTHER_ERROR_IDS_000069)
[grammar] ~63-~63: There might be a mistake here.
Context: ...e syntax is: dcictl <command> <params> The most interesting parameters are: ##...
(QB_NEW_EN_OTHER)
[grammar] ~64-~64: There might be a mistake here.
Context: ...ms>The most interesting parameters are: ### Existing commands Run:dcictl --help` ...
(QB_NEW_EN_OTHER)
[grammar] ~66-~66: Use proper spacing conventions.
Context: ...g parameters are: ### Existing commands Run: dcictl --help #### Running comma...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~68-~68: Use proper spacing conventions.
Context: ...eters are: ### Existing commands Run: dcictl --help #### Running commands The parameter `--query...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~70-~70: Use proper spacing conventions.
Context: ...: dcictl --help #### Running commands The parameter --query uses ES (elastic...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~72-~72: There might be a mistake here.
Context: ...mands The parameter --query uses ES (elastic search) DSL syntax. Examples: 1. Search by `m...
(QB_NEW_EN_OTHER)
[grammar] ~72-~72: Use proper spacing conventions.
Context: ...S (elastic search) DSL syntax. Examples: 1. Search by myteam name: `dcictl remotec...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~76-~76: Use proper spacing conventions.
Context: ...gather all its sub-objects via dcictl. ##### Additional details - All item commands ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~78-~78: Use proper spacing conventions.
Context: ... via dcictl. ##### Additional details - All item commands (e.g., <bla>-list) s...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~81-~81: Use proper spacing conventions.
Context: ...ntax, e.g., tags in [bla, blah, blee]. - The --limit parameter lets you set how...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~82-~82: Use proper spacing conventions.
Context: ...er page are fetched in a single command. - The global --format json option is ver...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~83-~83: Use proper spacing conventions.
Context: ...` option is very convenient for parsing.
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/event.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # Event structure Sample event data can be seen here [`eve...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Place a period at the end of declarative sentences.
Context: ...ture Sample event data can be seen here event.json The event contains the following main se...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ...nt contains the following main sections: ## Top Structure Overview | Attribute coor...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~7-~7: Use proper spacing conventions.
Context: ...ain sections: ## Top Structure Overview | Attribute coordinate | Contains | | -...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~17-~17: Use proper spacing conventions.
Context: ...ites and test cases | ## Key Components ### Metadata #### CI Information Info abou...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~19-~19: Use proper spacing conventions.
Context: ...cases | ## Key Components ### Metadata #### CI Information Info about the CI - URLs...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~21-~21: Use proper spacing conventions.
Context: ...nents ### Metadata #### CI Information Info about the CI - URLs, type ##### Ru...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[typographical] ~23-~23: To join two clauses or set off examples, consider using an em dash.
Context: ... #### CI Information Info about the CI - URLs, type ##### Runner Runner archite...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ...ormation Info about the CI - URLs, type ##### Runner Runner architecture, container t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~25-~25: Use proper spacing conventions.
Context: ... about the CI - URLs, type ##### Runner Runner architecture, container technolog...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~27-~27: Use proper spacing conventions.
Context: ..., container technology, executor details #### Pipeline Information pipeline info, url...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ...cutor details #### Pipeline Information pipeline info, urls, results and timings...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use an Oxford comma.
Context: ...eline Information pipeline info, urls, results and timings #### Job Information Job/...
(QB_NEW_EN_OTHER_ERROR_IDS_000014)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ...pipeline info, urls, results and timings #### Job Information Job/Build info, URLs, t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ...esults and timings #### Job Information Job/Build info, URLs, triggers, results ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: Use an Oxford comma.
Context: ...mation Job/Build info, URLs, triggers, results and timings #### Source Information A...
(QB_NEW_EN_OTHER_ERROR_IDS_000014)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...nfo, URLs, triggers, results and timings #### Source Information Author details, repo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~37-~37: Use proper spacing conventions.
Context: ...lts and timings #### Source Information Author details, repository details ####...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~39-~39: Use proper spacing conventions.
Context: ...tion Author details, repository details ##### Change Information change/PR informatio...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~41-~41: Use proper spacing conventions.
Context: ...sitory details ##### Change Information change/PR information #### Product Info...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~43-~43: Use proper spacing conventions.
Context: ...hange Information change/PR information #### Product Information product/component/t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~45-~45: There might be a problem here.
Context: ...PR information #### Product Information product/component/topic/version etc. ### Test Results - Summary: ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~47-~47: Use proper spacing conventions.
Context: ...on product/component/topic/version etc. ### Test Results - Summary: Overall tes...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~49-~49: Use proper spacing conventions.
Context: ...ent/topic/version etc. ### Test Results - Summary: Overall test counts (errors, ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~51-~51: Use proper spacing conventions.
Context: ...ounts (errors, failures, skipped, total) #### Test Suites Grouped test results with p...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~53-~53: Use proper spacing conventions.
Context: ...lures, skipped, total) #### Test Suites Grouped test results with properties and...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~55-~55: Use proper spacing conventions.
Context: ...ith properties and individual test cases For each test suite: ##### Test Cases ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~57-~57: Use proper spacing conventions.
Context: ...ividual test cases For each test suite: ##### Test Cases Individual test execution de...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~59-~59: Use proper spacing conventions.
Context: ... For each test suite: ##### Test Cases Individual test execution details with r...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~61-~61: Use proper spacing conventions.
Context: ... with results, timing, and system output
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/jenkins.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # CI: Jenkins Current or past runs of jenkins jobs are...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: End punctuation usually goes inside quotation marks.
Context: ...or past runs of jenkins jobs are called "builds". During a jenkins job build, the execu...
(QB_NEW_EN_OTHER_ERROR_IDS_000049)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...uns of jenkins jobs are called "builds". During a jenkins job build, the executor...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~4-~4: Use proper spacing conventions.
Context: ...nment variables for its child processes. Build's parameters are also seen by the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ... the processes as environment variables. ## Environment to metadata conversion ## M...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~7-~7: Use proper spacing conventions.
Context: .... ## Environment to metadata conversion ## Metadata Sections Following the metadat...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~9-~9: Use proper spacing conventions.
Context: ...etadata conversion ## Metadata Sections Following the metadata schema explained ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~11-~11: Use proper spacing conventions.
Context: ...e're collecting when running in jenkins. ### CI * NODE_NAME: The name of the agent...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~13-~13: Use proper spacing conventions.
Context: ...lecting when running in jenkins. ### CI * NODE_NAME: The name of the agent (or controller) ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~15-~15: Use proper spacing conventions.
Context: ... controller) where the build is running. * WORKSPACE: The absolute path to the directory whe...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~16-~16: Use proper spacing conventions.
Context: ...uts are stored during the build process. * JENKINS_HOME: The directory where Jenkins stores its...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~17-~17: Use proper spacing conventions.
Context: ...guration, build history, and other data. * EXECUTOR_NUMBER: The unique number that identifies the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: There might be a mistake here.
Context: ...rs of the same machine) performing this build * BUILD_CAUSE: A comma-separated lis...
(QB_NEW_EN_OTHER)
[grammar] ~19-~19: Use proper spacing conventions.
Context: ...) performing this build * BUILD_CAUSE: A comma-separated list of causes for th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~19-~19: Use proper spacing conventions.
Context: ...TRIGGER,MANUALTRIGGER,UPSTREAMTRIGGER`). Individual causes are also exposed as ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ... BUILD_CAUSE_USERIDCAUSE=true * etc. * JENKINS_URL: The base URL of the Jenkins instance. ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~24-~24: Use proper spacing conventions.
Context: ...: The base URL of the Jenkins instance. ### Runner * NODE_NAME(name). *NODE_LA...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~26-~26: Use proper spacing conventions.
Context: ...URL of the Jenkins instance. ### Runner * NODE_NAME (name). * NODE_LABELS (space-separate...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~28-~28: Use proper spacing conventions.
Context: ...ance. ### Runner * NODE_NAME (name). * NODE_LABELS (space-separated list of labels). The ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ...ABELS(space-separated list of labels). TheNODE_LABELS` variable should be set...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ...s/jenkins_node_labels.sh) or equivalent. ### Pipeline By default, Jenkins does not h...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ..._labels.sh) or equivalent. ### Pipeline By default, Jenkins does not have an obj...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: There might be a problem here.
Context: ...ult, Jenkins does not have an object of "pipeline", so in the metadata we will have `pipeli...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...he metadata we will have pipeline: {}. However, similar functionality can refer...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~36-~36: Use articles correctly.
Context: ...this and/or other (sibling) jobs, so in future we may decide to populate pipeline wi...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~36-~36: Use proper spacing conventions.
Context: ... with that parent/caller job's metadata. ### Job * JOB_NAME: The name of the Jenki...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~38-~38: Use proper spacing conventions.
Context: ...t parent/caller job's metadata. ### Job * JOB_NAME: The name of the Jenkins job. * `JOB_UR...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~40-~40: Use proper spacing conventions.
Context: ...JOB_NAME: The name of the Jenkins job. * JOB_URL: The URL of the Jenkins job. * `BUILD_N...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~41-~41: Use proper spacing conventions.
Context: ...* JOB_URL: The URL of the Jenkins job. * BUILD_NUMBER: The unique build number for the curren...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~42-~42: Use proper spacing conventions.
Context: ...umber for the current run (e.g., 153). * BUILD_ID: The current build ID, usually identica...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~43-~43: Use proper spacing conventions.
Context: ...UILD_NUMBER for recent Jenkins versions. * BUILD_TAG: A unique tag combining the job name an...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~44-~44: Use proper spacing conventions.
Context: ... jenkins-${JOB_NAME}-${BUILD_NUMBER}). * BUILD_URL: The URL where the results of this spec...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~45-~45: Use proper spacing conventions.
Context: ...lts of this specific build can be found. ### Source * GIT_COMMIT: The full SHA-1...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~47-~47: Use proper spacing conventions.
Context: ...specific build can be found. ### Source * GIT_COMMIT: The full SHA-1 hash of the current G...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~49-~49: Use proper spacing conventions.
Context: ...h of the current Git commit being built. * GIT_BRANCH: The name of the Git branch being built...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~50-~50: Use proper spacing conventions.
Context: ...e.g., origin/master, feature/my-branch). * GIT_URL: The URL of the remote Git repository. ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~51-~51: There might be a problem here.
Context: ...: The URL of the remote Git repository. * GIT_LOCAL_BRANCH`: If a specific local branch is checked o...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~52-~52: Use proper spacing conventions.
Context: ...ut, this variable will contain its name. * GIT_PREVIOUS_COMMIT: The SHA-1 hash of the previous commi...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~53-~53: Use proper spacing conventions.
Context: ...e previous commit on the current branch. * GIT_PREVIOUS_SUCCESSFUL_COMMIT: The SHA-1 hash of the commit of the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~54-~54: Use proper spacing conventions.
Context: ... successful build on the current branch. * GIT_COMMITTER_NAME / GIT_AUTHOR_NAME: The name of the co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~55-~55: Use proper spacing conventions.
Context: ...mitter/author of the current Git commit. * GIT_COMMITTER_EMAIL / GIT_AUTHOR_EMAIL: The email of the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~56-~56: Use proper spacing conventions.
Context: ...mitter/author of the current Git commit. #### The Change: Pull Request/Merge Request/C...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~58-~58: Use proper spacing conventions.
Context: ...nge: Pull Request/Merge Request/ChangeId * CHANGE_ID: for GitHub it is PR, for GitLab it is ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~60-~60: There might be a mistake here.
Context: ...: for GitHub it is PR, for GitLab it is MR, for Gerrit it is ChangeId. * `PULL_REQU...
(QB_NEW_EN_OTHER)
[grammar] ~60-~60: Use proper spacing conventions.
Context: ...Lab it is MR, for Gerrit it is ChangeId. * PULL_REQUEST_ID: GitHub term * `GITLAB_MERGE_REQUEST_II...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~62-~62: Use proper spacing conventions.
Context: ... GITLAB_MERGE_REQUEST_IID: GitLab term ##### GitHub Change Info (PR) * `CHANGE_BRANC...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~64-~64: Use proper spacing conventions.
Context: ...tLab term ##### GitHub Change Info (PR) * CHANGE_BRANCH: source branch name of the PR * `CHANGE...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~69-~69: Use proper spacing conventions.
Context: ...y name * CHANGE_URL: the URL to the PR ###### Author (PR) * CHANGE_AUTHOR: the auth...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~71-~71: Use proper spacing conventions.
Context: ...: the URL to the PR ###### Author (PR) * CHANGE_AUTHOR: the author of the PR * CHANGE_AUTHOR_...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~74-~74: Use proper spacing conventions.
Context: ...NAME: the display name of the PR author ##### GitLab Change Info (MR) * GITLAB_MERGE...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~76-~76: Use proper spacing conventions.
Context: ...PR author ##### GitLab Change Info (MR) * GITLAB_MERGE_REQUEST_SOURCE_BRANCH: source branch of the MR * `GITLAB_MERG...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~80-~80: Use proper spacing conventions.
Context: ...EST_LAST_COMMIT_SHA: last sha of the MR ###### Author (MR) * GITLAB_USER_NAME`: The m...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~82-~82: Use proper spacing conventions.
Context: ...: last sha of the MR ###### Author (MR) * GITLAB_USER_NAME: The merge request author's name. * `GI...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~84-~84: Use proper spacing conventions.
Context: ..._NAME: The merge request author's name. * GITLAB_USER_EMAIL`: The merge request author's email. ###...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~85-~85: Use proper spacing conventions.
Context: ...MAIL`: The merge request author's email. ### Product Jenkins by default does not hav...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~87-~87: Use proper spacing conventions.
Context: ...rge request author's email. ### Product Jenkins by default does not have this co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~89-~89: There might be a problem here.
Context: ...truct, so in the metadata we can assign product: {}, However similar functionality can refer to a jo...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~90-~90: Use proper spacing conventions.
Context: ...refer to a job that triggers other jobs. * UPD: We will probably add this informa...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~92-~92: Use singular and plural nouns appropriately.
Context: ...bably add this information by analyzing files paths and job parameters
(QB_NEW_EN_OTHER_ERROR_IDS_000012)
[grammar] ~92-~92: Place a period at the end of declarative sentences.
Context: ...analyzing files paths and job parameters
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
roles/test_report_send/doc/main.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: ...ecisions for the test_report_send Role ## Abstract The role generates an event fr...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...the test_report_send Role ## Abstract The role generates an event from CI meta...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: There might be a mistake here.
Context: ... event from CI metadata and test reports, and sends this event to the reporting s...
(QB_NEW_EN_OTHER)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ...ends this event to the reporting system. ## Table of Contents 1. [Event Structure](...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~7-~7: Use proper spacing conventions.
Context: ... reporting system. ## Table of Contents 1. Event Structure 1. [metadat...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~11-~11: There might be a mistake here.
Context: ...tadata.md), per CI: 1. DCI 2. Jenkins 2. [Reporting]...
(QB_NEW_EN_OTHER)
[grammar] ~12-~12: There might be a mistake here.
Context: ...CI: 1. DCI 2. Jenkins 2. Reporting, per reporting ...
(QB_NEW_EN_OTHER)
[grammar] ~14-~14: Use proper spacing conventions.
Context: ....md), per reporting system: 1. Splunk
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/metadata.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # Metadata structure The metadata resides in the event object...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: There might be a mistake here.
Context: ... in the event object under .metadata[] When everything is properly done, it has...
(QB_NEW_EN_OTHER)
[grammar] ~4-~4: There might be a mistake here.
Context: ...erly done, it has the following sections yaml --- ci: # data about the CI # general info - urls, types runner: # information about the runner # runner details, info about h/w, os pipeline: # information current pipeline when relevant # pipeline details/urls job: # information about the job source: # source code info change: # information about the change/pr/mr # details about the change product: ## information about the product
(QB_NEW_EN_OTHER)
roles/test_report_send/doc/reporting.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # Reporting systems Reporting systems collect information, e...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...ng, and sometimes provide visualization. This helps to reach observability goals,...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~4-~4: Use proper spacing conventions.
Context: ...bserve live system status and analytics. This in its turn enables: - Shared visu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~6-~6: Use proper spacing conventions.
Context: ...nd analytics. This in its turn enables: - Shared visual and data languages - Data-...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~9-~9: Use proper spacing conventions.
Context: ...ges - Data-based decision-making process Supported reporting systems: * [splunk....
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~11-~11: Use proper spacing conventions.
Context: ...ng process Supported reporting systems: * splunk.md
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~13-~13: Use proper spacing conventions.
Context: ...pported reporting systems: * splunk.md
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
roles/test_report_send/doc/splunk.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # Splunk ## Conventions - Example queries are prese...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: # Splunk ## Conventions - Example queries are presented in jq or...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: There might be a problem here.
Context: ...ntions - Example queries are presented in jq or yq -like manner. - The variables ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ...xample queries are presented in jq or yq -like manner. - The variables are presented i...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ... presented in jq or yq -like manner. - The variables are presented in monospace...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~6-~6: There might be a mistake here.
Context: ...anner. - The variables are presented in monospace like this_one ### Abbreviations - S...
(QB_NEW_EN_OTHER)
[grammar] ~6-~6: Use proper spacing conventions.
Context: ...riables are presented in monospace like this_one ### Abbreviations - SUT = system under test...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~8-~8: Use proper spacing conventions.
Context: ...space like this_one ### Abbreviations - SUT = system under test ## The event co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~10-~10: Use proper spacing conventions.
Context: ...Abbreviations - SUT = system under test ## The event contains the following 1. CI ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~12-~12: There might be a mistake here.
Context: ...est ## The event contains the following 1. CI system details - type - endpoin...
(QB_NEW_EN_OTHER)
[grammar] ~14-~14: There might be a mistake here.
Context: ...nt contains the following 1. CI system details - type - endpoints about the syst...
(QB_NEW_EN_OTHER)
[grammar] ~19-~19: There might be a mistake here.
Context: ...as invoked) - results (how have they completed) 2. SUT info: H/W (architecture), and s...
(QB_NEW_EN_OTHER)
[grammar] ~20-~20: There might be a mistake here.
Context: ...mpleted) 2. SUT info: H/W (architecture), and software info (OS, product/componen...
(QB_NEW_EN_OTHER)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ...o JSON) 5. Additional future information ## Schema (objectives) and background It s...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~25-~25: Use proper spacing conventions.
Context: ...n ## Schema (objectives) and background It should provide: 1. Enough data at...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~27-~27: Use proper spacing conventions.
Context: ...ives) and background It should provide: 1. Enough data attributes to support requir...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ...imum data points 3. Ease of extension The schema needs to support querying by ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: There might be a mistake here.
Context: ...t querying by any of the following terms ### Metadata (collected dynamically) - prod...
(QB_NEW_EN_OTHER)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...ms ### Metadata (collected dynamically) - product release(s) - SUT details (os, ar...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~40-~40: Use proper spacing conventions.
Context: ... team(s) - ci status (pipeline/job/step) ### Test data (collected from test reports) ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~42-~42: Use proper spacing conventions.
Context: ... Test data (collected from test reports) - tests: - run (status, counters, start,...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[typographical] ~48-~48: To join two clauses or set off examples, consider using an em dash.
Context: ... start, duration) - for failures - more info ### The importance of Timing ...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~48-~48: Use proper spacing conventions.
Context: ...tion) - for failures - more info ### The importance of Timing Everything wit...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~50-~50: Use proper spacing conventions.
Context: ... more info ### The importance of Timing Everything with timing data must be sele...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~52-~52: Use proper spacing conventions.
Context: ...a must be selected by those time ranges. Thus, to avoid confusion, the time range...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~53-~53: Use proper spacing conventions.
Context: ...h should use only two sources of timing: 1. ci process timings 2. test timings We n...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~56-~56: Use proper spacing conventions.
Context: ...: 1. ci process timings 2. test timings We need to rely on these timings, so all...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~58-~58: Use proper spacing conventions.
Context: ...eed to be properly set up using ntp/ptp. ## Event Schema (structure) Due to the abo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~60-~60: Use proper spacing conventions.
Context: ...ng ntp/ptp. ## Event Schema (structure) Due to the above, the following is propo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~62-~62: There might be a mistake here.
Context: ... to the above, the following is proposed ### Metadata (dynamically obtained for each ...
(QB_NEW_EN_OTHER)
[grammar] ~64-~64: Use proper spacing conventions.
Context: ...ta (dynamically obtained for each event) 1. ci 1. general 1. type ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~87-~87: Use proper spacing conventions.
Context: ...l request 4. author ### Test data 1. test report info (obtained from ci proce...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~89-~89: There might be a mistake here.
Context: ...(obtained from ci process artifact files) 1. run 1. stats 1. suite...
(QB_NEW_EN_OTHER)
[grammar] ~90-~90: There might be a mistake here.
Context: ...d from ci process artifact files) 1. run 1. stats 1. suites, for eac...
(QB_NEW_EN_OTHER)
[grammar] ~91-~91: There might be a mistake here.
Context: ...cess artifact files) 1. run 1. stats 1. suites, for each suite: 1. stats ...
(QB_NEW_EN_OTHER)
[grammar] ~94-~94: There might be a mistake here.
Context: ... 1. stats 1. cases for each case 1. stats 1. err...
(QB_NEW_EN_OTHER)
[grammar] ~98-~98: Use proper spacing conventions.
Context: ... 1. errors ### Top-down structure #### Splunk event structure This structure i...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~100-~100: Use proper spacing conventions.
Context: ...n structure #### Splunk event structure This structure is sent to splunk. ```js...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~102-~102: Use proper spacing conventions.
Context: ...cture This structure is sent to splunk. json { "source": "<str>", // type of information signifying team/channel "host": "<hostname>", // the host or container or service sending the data "sourcetype": "_json", "_time": <timestamp>, // event emission time stamp, note it may happen AFTER event occurrence. "event": <trs_event>, // event data dictionary } The most interesting structure here is `...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~114-~114: There might be a mistake here.
Context: ...nteresting structure here is trs_event, it also has structure of: ```json { ...
(QB_NEW_EN_OTHER)
[grammar] ~114-~114: Use articles correctly.
Context: ...ucture here is trs_event, it also has structure of: ```json { "metadata": <trs_meta_...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~114-~114: There might be a mistake here.
Context: ...is trs_event, it also has structure of: json { "metadata": <trs_meta_data>, "test": <trs_test_data> } Splunk event structure is sent to splunk...
(QB_NEW_EN_OTHER)
[grammar] ~124-~124: There might be a mistake here.
Context: ... to allow queries of the following sorts 1. Select events by product `.metadata.prod...
(QB_NEW_EN_OTHER)
[grammar] ~126-~126: There might be a mistake here.
Context: ...product .metadata.product[] attributes 2. Filter events by any metadata attribute,...
(QB_NEW_EN_OTHER)
[grammar] ~127-~127: There might be a mistake here.
Context: ...r events by any metadata attribute, for example .metadata.ci.type completed with spe...
(QB_NEW_EN_OTHER)
[grammar] ~127-~127: Use proper spacing conventions.
Context: ...tribute, for example .metadata.ci.type completed with specific status
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~127-~127: Place a period at the end of declarative sentences.
Context: ...ci.type` completed with specific status
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
🪛 markdownlint-cli2 (0.17.2)
roles/test_report_send/doc/env2vars.md
20-20: Line length
Expected: 120; Actual: 171
(MD013, line-length)
99-99: Line length
Expected: 120; Actual: 197
(MD013, line-length)
135-135: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
146-146: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
roles/test_report_send/doc/comprehensive_guide.md
7-7: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
8-8: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
11-11: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
12-12: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
13-13: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
14-14: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
15-15: Multiple consecutive blank lines
Expected: 1; Actual: 6
(MD012, no-multiple-blanks)
16-16: Multiple consecutive blank lines
Expected: 1; Actual: 7
(MD012, no-multiple-blanks)
17-17: Multiple consecutive blank lines
Expected: 1; Actual: 8
(MD012, no-multiple-blanks)
18-18: Inline HTML
Element: details
(MD033, no-inline-html)
19-19: Inline HTML
Element: summary
(MD033, no-inline-html)
19-19: Inline HTML
Element: b
(MD033, no-inline-html)
21-21: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
21-21: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
27-27: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
31-31: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
32-32: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
33-33: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
34-34: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
35-35: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
36-36: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
36-36: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
37-37: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
41-41: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
42-42: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
43-43: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
44-44: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
45-45: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
46-46: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
47-47: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
49-49: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
54-54: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
55-55: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
56-56: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
57-57: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
58-58: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
59-59: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
60-60: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
61-61: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
62-62: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
64-64: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
65-65: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
66-66: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
67-67: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
68-68: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
69-69: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
70-70: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
71-71: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
72-72: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
75-75: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
76-76: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
77-77: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
78-78: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
79-79: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
80-80: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
81-81: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
81-81: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
82-82: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
84-84: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
85-85: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
86-86: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
87-87: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
88-88: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
89-89: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
90-90: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
91-91: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
92-92: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
94-94: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
95-95: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
96-96: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
97-97: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
98-98: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
99-99: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
100-100: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
102-102: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
104-104: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
105-105: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
106-106: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
107-107: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
108-108: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
109-109: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
110-110: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
111-111: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
112-112: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
114-114: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
115-115: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
116-116: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
117-117: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
118-118: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
119-119: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
120-120: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
121-121: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
122-122: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
125-125: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
126-126: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
127-127: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
128-128: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
129-129: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
130-130: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
131-131: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
132-132: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
133-133: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
133-133: Line length
Expected: 120; Actual: 133
(MD013, line-length)
136-136: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
137-137: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
138-138: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
139-139: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
140-140: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
141-141: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
142-142: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
143-143: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
144-144: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
147-147: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
148-148: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
149-149: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
150-150: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
151-151: Multiple consecutive blank lines
Expected: 1; Actual: 6
(MD012, no-multiple-blanks)
152-152: Multiple consecutive blank lines
Expected: 1; Actual: 7
(MD012, no-multiple-blanks)
155-155: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
158-158: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
185-185: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
186-186: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
187-187: Multiple consecutive blank lines
Expected: 1; Actual: 4
(MD012, no-multiple-blanks)
188-188: Multiple consecutive blank lines
Expected: 1; Actual: 5
(MD012, no-multiple-blanks)
191-191: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
311-311: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
314-314: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
315-315: Multiple consecutive blank lines
Expected: 1; Actual: 3
(MD012, no-multiple-blanks)
335-335: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
356-356: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
377-377: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
402-402: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
422-422: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
447-447: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
480-480: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
502-502: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
530-530: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
557-557: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
577-577: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
589-589: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
590-590: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
590-590: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
591-591: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
596-596: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
599-599: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
roles/test_report_send/doc/jenkins.md
11-11: Line length
Expected: 120; Actual: 158
(MD013, line-length)
18-18: Line length
Expected: 120; Actual: 135
(MD013, line-length)
36-36: Line length
Expected: 120; Actual: 209
(MD013, line-length)
roles/test_report_send/doc/main.md
10-10: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
13-13: Ordered list item prefix
Expected: 1; Actual: 2; Style: 1/1/1
(MD029, ol-prefix)
14-14: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
roles/test_report_send/doc/reporting.md
13-13: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
🪛 Buf (1.54.0)
roles/test_report_send/doc/event.proto
3-3: Files with package "test_report" must be within a directory "test_report" relative to root but were in directory "roles/test_report_send/doc".
(PACKAGE_DIRECTORY_MATCH)
🪛 Checkov (3.2.334)
roles/test_report_send/tasks/reporting/splunk.yml
[MEDIUM] 145-161: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 145-161: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
roles/test_report_send/tasks/reporting/validations.yml
[MEDIUM] 28-39: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 28-39: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Sanity Check (stable-2.18)
- GitHub Check: Sanity Check (stable-2.9)
- GitHub Check: Ansible-lint Check
- clarify dir ensuring - improve merge - upd formatting Signed-off-by: Maxim Kovgan <[email protected]>
- the role code
- supported ci:
- dci
- jenkins
- supported reporting servers
- splunk
Signed-off-by: Maxim Kovgan <[email protected]>
- initial docs:
- add fragmented files under docs + scripts
- improve clarity in docs
- comprehensive guide improves on the doc/*.md files
- adding doc/event.proto file describing the event structure
- improvements by @coderabbitai bot
Signed-off-by: Maxim Kovgan <[email protected]>
Suggested-by: @coderabbitai
- fix links - add new entry `redhatci.ocp.test_report_send` to the roles table Signed-off-by: Maxim Kovgan <[email protected]>
- update `.github/CODEOWNERS`: `roles/test_report_send` managed by @redhatci/verification - add `.markdownlint.json`: line_length=120 Signed-off-by: Maxim Kovgan <[email protected]>
- Bump version in:
- `galaxy.yml`
- `.spec` file
Signed-off-by: Maxim Kovgan <[email protected]>
Signed-off-by: Maxim Kovgan <[email protected]>
Signed-off-by: Maxim Kovgan <[email protected]>
Signed-off-by: Maxim Kovgan <[email protected]>
Signed-off-by: Maxim Kovgan <[email protected]>
mvk
force-pushed
the
mvk-role-test_report_send
branch
from
c03b574 to
3750cb9
Compare
|
from change #712:
|
1 similar comment
|
from change #712:
|
|
Build succeeded. ✔️ dci-rpm-build-el8 SUCCESS in 3m 03s |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (5)
roles/test_report_send/tasks/reporting/validations.yml (1)
11-15: Unsafe direct key access may fatally abort the play
trs_collector_auth_headers['Authorization']raises a missing-key error before theis definedtest can protect you. Use membership checks +defaultto stay defensive:- - trs_collector_auth_headers['Authorization'] is defined - - trs_collector_auth_headers['X-Splunk-Request-Channel'] is defined - - trs_collector_auth_headers['Authorization'] | regex_search('^Splunk ') - - trs_collector_auth_headers['Authorization'] | length > 10 - - trs_collector_auth_headers['X-Splunk-Request-Channel'] | length > 5 + - "'Authorization' in trs_collector_auth_headers" + - "'X-Splunk-Request-Channel' in trs_collector_auth_headers" + - trs_collector_auth_headers['Authorization'] | default('') | regex_search('^Splunk ') + - trs_collector_auth_headers['Authorization'] | default('') | length > 10 + - trs_collector_auth_headers['X-Splunk-Request-Channel'] | default('') | length > 5roles/test_report_send/tasks/reporting/splunk.yml (4)
49-61: Same undefined-variable risk forpipelineblock – mirror the defensive guards applied tojob.
88-91:trs_collector_targetmay be unsetLength filter on an undefined var crashes. Add a default:
- when: - - trs_collector_target | length > 0 + when: + - trs_collector_target | default('') | length > 0
131-134:hostfield should reflect the sender, not the collectorSending the collector URL as
hostloses provenance and breaks Splunk host grouping. Prefer the originating host:- "host": "{{ trs_collector_url | default(ansible_hostname) }}" + host: "{{ trs_collector_source | default(ansible_hostname) }}"
22-34:trs_meta_data.jobmay be undefined – evaluation happens before the guardJinja accesses
trs_meta_data.job.created_atwhile rendering the task, so a missingjobkey crashes the run before thewhen:clause is considered. Guard first, then compute:- ansible.builtin.set_fact: - trs_job_time_int: "{{ (trs_meta_data.job.created_at | default(trs_default_ts, true) | regex_replace('\\..*$', '') | to_datetime('%Y-%m-%dT%H:%M:%S')).strftime('%s') | int }}" - trs_job_time_fraction: "{{ trs_meta_data.job.created_at | default(trs_default_ts, true) | regex_replace('^.*\\.', '0.') | float | round(3) }}" - when: - - trs_meta_data.job | length > 0 - - trs_meta_data.job.created_at | length > 0 + when: + - trs_meta_data.job is defined + - trs_meta_data.job.created_at is defined + - trs_meta_data.job.created_at | length > 0 + ansible.builtin.set_fact: + trs_job_time_int: "{{ (trs_meta_data.job.created_at | regex_replace('\\..*$', '') | to_datetime('%Y-%m-%dT%H:%M:%S')).strftime('%s') | int }}" + trs_job_time_fraction: "{{ trs_meta_data.job.created_at | regex_replace('^.*\\.', '0.') | float | round(3) }}"
🧹 Nitpick comments (6)
roles/test_report_send/doc/comprehensive_guide.md (1)
41-43: Nit: bolder code-block caption is redundantThe heading “Protocol Buffer Schema Definition” already explains the snippet; the inline comment
// Protocol Buffer schemaduplicates information. Safe to drop for brevity.roles/test_report_send/doc/env2vars.md (1)
40-44: Minor phrasing tweak“change over the time” → “change over time” reads better:
-* change over the time without backward compatibility +* change over time without backward compatibilityroles/test_report_send/protos/event.proto (4)
10-14: Trim the trailing semicolon and align spacing.
proto3allows, but does not require, a semicolon after a message block. Dropping it keeps the file consistent with the rest of the definitions and avoids noise in some linters. While here, add a space before the=to match surrounding style.- repeated CIRunnerProperty properties= 3; -}; + repeated CIRunnerProperty properties = 3; +}
47-53: Turn free-form status fields into enums.
string statusinvites typos and mixed casing ("SUCCESS","Success","succeeded"…). Defining a smallenum Status { UNKNOWN = 0; PASS = 1; FAIL = 2; SKIPPED = 3; }(or similar) keeps the vocabulary tight and makes downstream filtering simpler.
71-75: Use key-value pairs for component properties.
repeated string propertiescannot express a name/value pair—callers will invent ad-hoc delimiters. Re-use the existingCIRunnerPropertymessage (or a newPropertyone) or amap<string,string>:- repeated string properties = 3; + map<string, string> properties = 3;
135-140: Consistent time typing.Earlier you store
created_at/timestampas strings, heretimeis also a string. Once the file importsgoogle.protobuf.Timestamp, this can become that type too, avoiding three different time encodings in one schema.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (42)
.github/CODEOWNERS(1 hunks).markdownlint.json(1 hunks)README.md(5 hunks)ansible-collection-redhatci-ocp.spec(2 hunks)galaxy.yml(3 hunks)roles/junit2json/tasks/convert.yml(1 hunks)roles/junit2json/tasks/ensure-dir.yml(1 hunks)roles/junit2json/tasks/merge.yml(1 hunks)roles/test_report_send/README.md(1 hunks)roles/test_report_send/defaults/main.yml(1 hunks)roles/test_report_send/doc/comprehensive_guide.md(1 hunks)roles/test_report_send/doc/dci.md(1 hunks)roles/test_report_send/doc/env2vars.md(1 hunks)roles/test_report_send/doc/event.json(1 hunks)roles/test_report_send/doc/event.md(1 hunks)roles/test_report_send/doc/event.mmd(1 hunks)roles/test_report_send/doc/jenkins.md(1 hunks)roles/test_report_send/doc/main.md(1 hunks)roles/test_report_send/doc/metadata.md(1 hunks)roles/test_report_send/doc/reporting.md(1 hunks)roles/test_report_send/doc/scripts/gen_dcirc.sh(1 hunks)roles/test_report_send/doc/scripts/jenkins_node_labels.sh(1 hunks)roles/test_report_send/doc/splunk.md(1 hunks)roles/test_report_send/meta/argument_specs.yml(1 hunks)roles/test_report_send/meta/main.yml(1 hunks)roles/test_report_send/protos/event.proto(1 hunks)roles/test_report_send/tasks/ci-detect.yml(1 hunks)roles/test_report_send/tasks/dump-file.yml(1 hunks)roles/test_report_send/tasks/empty.yml(1 hunks)roles/test_report_send/tasks/ensure-file.yml(1 hunks)roles/test_report_send/tasks/env2vars-populate.yml(1 hunks)roles/test_report_send/tasks/main.yml(1 hunks)roles/test_report_send/tasks/metadata-detect.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/dci.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/jenkins.yml(1 hunks)roles/test_report_send/tasks/metadata-detect/unknown.yml(1 hunks)roles/test_report_send/tasks/reporting/splunk.yml(1 hunks)roles/test_report_send/tasks/reporting/validations.yml(1 hunks)roles/test_report_send/templates/env2vars.j2(1 hunks)roles/test_report_send/tests/test.yml(1 hunks)roles/test_report_send/vars/env2vars/example.yml(1 hunks)roles/test_report_send/vars/env2vars/jenkins.yml(1 hunks)
✅ Files skipped from review due to trivial changes (6)
- roles/test_report_send/tasks/metadata-detect/unknown.yml
- roles/test_report_send/doc/metadata.md
- roles/test_report_send/tasks/env2vars-populate.yml
- roles/test_report_send/tasks/ensure-file.yml
- roles/junit2json/tasks/ensure-dir.yml
- roles/test_report_send/README.md
🚧 Files skipped from review as they are similar to previous changes (30)
- roles/test_report_send/tasks/empty.yml
- roles/junit2json/tasks/merge.yml
- roles/test_report_send/doc/main.md
- roles/test_report_send/tests/test.yml
- roles/test_report_send/doc/reporting.md
- .github/CODEOWNERS
- ansible-collection-redhatci-ocp.spec
- roles/test_report_send/meta/main.yml
- galaxy.yml
- roles/test_report_send/doc/event.md
- roles/junit2json/tasks/convert.yml
- roles/test_report_send/tasks/metadata-detect.yml
- roles/test_report_send/tasks/ci-detect.yml
- roles/test_report_send/tasks/metadata-detect/dci.yml
- roles/test_report_send/doc/scripts/jenkins_node_labels.sh
- roles/test_report_send/vars/env2vars/jenkins.yml
- roles/test_report_send/doc/event.mmd
- roles/test_report_send/doc/event.json
- README.md
- roles/test_report_send/meta/argument_specs.yml
- roles/test_report_send/doc/dci.md
- roles/test_report_send/doc/jenkins.md
- roles/test_report_send/vars/env2vars/example.yml
- roles/test_report_send/tasks/dump-file.yml
- roles/test_report_send/tasks/main.yml
- roles/test_report_send/doc/scripts/gen_dcirc.sh
- roles/test_report_send/templates/env2vars.j2
- roles/test_report_send/tasks/metadata-detect/jenkins.yml
- roles/test_report_send/defaults/main.yml
- roles/test_report_send/doc/splunk.md
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#715
File: roles/copy_and_render/tasks/main.yml:18-24
Timestamp: 2025-06-24T21:40:17.028Z
Learning: The copy_and_render role in the ansible-collection-redhatci-ocp repository is designed to work only with relative paths for car_source_dir, not absolute paths. This is an intentional design constraint.
roles/test_report_send/doc/comprehensive_guide.md (2)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/doc/env2vars.md (1)
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/tasks/reporting/splunk.yml (3)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#652
File: roles/example_cnf_deploy/scripts/get-example-cnf-status.sh:45-45
Timestamp: 2025-04-21T23:02:58.178Z
Learning: When deprecating components in the redhatci/ansible-collection-redhatci-ocp repository, references to the deprecated component in other roles (like references to `cnf-app-mac-operator` in `fbc_catalog`) may be left intact if they serve as examples rather than functional components. Deprecation scope should be limited to the directly affected role (in this case `example_cnf_deploy`).
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
roles/test_report_send/tasks/reporting/validations.yml (2)
Learnt from: mvk
PR: redhatci/ansible-collection-redhatci-ocp#712
File: roles/test_report_send/tasks/reporting/splunk.yml:102-105
Timestamp: 2025-06-24T14:24:20.798Z
Learning: The test_report_send role already includes HTTPS validation in tasks/reporting/validations.yml, which is included by tasks/reporting/splunk.yml, ensuring trs_collector_url uses HTTPS scheme.
Learnt from: tonyskapunk
PR: redhatci/ansible-collection-redhatci-ocp#651
File: roles/odf_setup/tasks/tests.yml:2-2
Timestamp: 2025-05-22T18:25:16.134Z
Learning: When working with the redhatci-ocp collection, task names that will appear in JUnit results should use underscores consistently without spaces (e.g., "Test_CephRBD_PVC" instead of "Test_ CephRBD PVC") to ensure compatibility with the dcijunit callback that generates JUnit reports.
🪛 LanguageTool
roles/test_report_send/doc/comprehensive_guide.md
[grammar] ~333-~333: Ensure spelling is correct
Context: ...als with DCI service access 2. Team and remoteci information 3. Installed dcictl comma...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 Checkov (3.2.334)
roles/test_report_send/tasks/reporting/splunk.yml
[MEDIUM] 145-161: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 145-161: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
roles/test_report_send/tasks/reporting/validations.yml
[MEDIUM] 28-39: Ensure that certificate validation isn't disabled with uri
(CKV_ANSIBLE_1)
[MEDIUM] 28-39: Ensure that HTTPS url is used with uri
(CKV2_ANSIBLE_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Sanity Check (stable-2.18)
- GitHub Check: Sanity Check (stable-2.9)
- GitHub Check: Ansible-lint Check
🔇 Additional comments (1)
.markdownlint.json (1)
1-10: Config looks sensibleRules are explicitly tuned and keep default rule-set active – no objections.
| message ExecStatus { | ||
| string status = 1; | ||
| string message = 2; | ||
| string created_at = 3; | ||
| string duration = 4; | ||
| string result = 5; | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Prefer well-known types for timestamps and durations.
string created_at and string duration lose type safety and force every producer/consumer to agree on formatting. Switching to google.protobuf.Timestamp and google.protobuf.Duration makes this self-describing and harder to misuse.
-import "google/protobuf/timestamp.proto";
-import "google/protobuf/duration.proto";
- string created_at = 3;
- string duration = 4;
+ google.protobuf.Timestamp created_at = 3;
+ google.protobuf.Duration duration = 4;Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In roles/test_report_send/protos/event.proto around lines 22 to 28, replace the
string fields created_at and duration with google.protobuf.Timestamp and
google.protobuf.Duration respectively. Import the necessary well-known types
from google/protobuf/timestamp.proto and google/protobuf/duration.proto at the
top of the file. This change improves type safety and standardizes the format
for timestamps and durations.
test_report_sendtest_report_send (obsolete, was split)
SUMMARY
ISSUE TYPE
Tests
Tested manually using sending an event + func test of generating event json and comparing to expected content for:
as dollows:
https://github.com/mvk:eco-ci-cd.git, branch:mvk-test-report-send-dciThe runs should have printed 0 json diffs and succeed.
bootstrap
using the playbook inside
openshift-kni/eco-ci-cdin branchmvk-test-report-send-dci:cd