Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve layout of test details window #239

Merged
merged 7 commits into from
Jul 24, 2024
Merged

Improve layout of test details window #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
96651a9
Add function add_kv_entry
jan-cerny Jul 4, 2024
8f62de3
Add function get_header
jan-cerny Jul 4, 2024
49c9aeb
Improve layout of test details window
jan-cerny Jul 4, 2024
d47251d
Fix a missing declaration
jan-cerny Jul 4, 2024
5321e20
Prevent showing UUID in the report
jan-cerny Jul 11, 2024
8676dcc
Show direct child elements
jan-cerny Jul 11, 2024
377f0a7
Show attributes of child elements of OVAL variables
jan-cerny Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
230 changes: 123 additions & 107 deletions openscap_report/report_generators/html_templates/js/oval_graph_generation_script.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,26 @@ function render_OVAL_test(node_data) {
return test_node;
}

function add_kv_entry(tbody, key, value) {
const row = ROW.cloneNode();
row.setAttribute("role", "row");
tbody.appendChild(row);
const first_col = COL.cloneNode();
first_col.setAttribute("role", "cell");
first_col.className = "pf-m-truncate pf-m-fit-content";
first_col.appendChild(get_bold_text(key + ":"));
row.appendChild(first_col);
const second_col = COL.cloneNode();
second_col.setAttribute("role", "cell");
second_col.className = "pf-m-truncate pf-m-fit-content";
if (typeof value === "string") {
second_col.textContent = value;
} else {
second_col.appendChild(value);
}
row.appendChild(second_col);
}

function get_icon_as_html(icon) {
const html_icon = SPAN.cloneNode();
html_icon.className = "pf-c-label__icon";
Expand All @@ -385,6 +405,13 @@ function get_bold_text(text) {
return b;
}

function get_header(title) {
const h1 = H1.cloneNode();
h1.textContent = title;
h1.className = "pf-c-title pf-m-2xl";
return h1;
}

function get_tooltip(text) {
const div = DIV.cloneNode();
div.className = "tooltip-wrapper";
Expand Down Expand Up @@ -582,55 +609,42 @@ function get_table_body(objects) {
return tbody;
}

function generate_property_elements(table_div, endpoint, data) {
for (const [key, value] of Object.entries(data)) { // eslint-disable-line array-element-newline
if(Object.values(value).every(v => typeof v === "object")) {
const h1 = H1.cloneNode();
h1.textContent = `Element ${remove_uuid(key)} contains this elements:`;
h1.className = "pf-c-title pf-m-md";
table_div.appendChild(h1);

generate_property_elements(table_div, endpoint, value);
function generate_endpoint_element(tbody, element_id, element_dict) {
const row = ROW.cloneNode();
row.setAttribute("role", "row");
tbody.appendChild(row);

const first_col = COL.cloneNode();
first_col.setAttribute("role", "cell");
first_col.className = "pf-m-truncate pf-m-fit-content";
row.appendChild(first_col);
first_col.appendChild(get_bold_text(remove_uuid(element_id) + ":"));
const second_col = COL.cloneNode();
second_col.setAttribute("role", "cell");
second_col.className = "pf-m-truncate pf-m-fit-content";
row.appendChild(second_col);
for (const [key, value] of Object.entries(element_dict)) {
if (key.endsWith("@text") || key.startsWith("var_ref@") || key.startsWith("object_ref@")) {
second_col.textContent = value;
} else if (typeof value == "object") {
// recursion
generate_endpoint_element(second_col, key, value);
} else {
const h1 = H1.cloneNode();
h1.textContent = `Element ${remove_uuid(key)}:`;
h1.className = "pf-c-title pf-m-md";
table_div.appendChild(h1);

const table = TABLE.cloneNode();
table.className = "pf-c-table pf-m-compact pf-m-grid-md";
table.setAttribute("role", "grid");
table_div.appendChild(table);

const objects = [];
objects.push(filter_object(value, endpoint));

table.appendChild(get_table_header(objects));
table.appendChild(get_table_body(objects));
const label_key = remove_uuid(key);
first_col.appendChild(get_label("pf-m-blue", `${label_key}: ${value}`));
}
}
}

function get_OVAL_object_info_heading(oval_object) {
const div = DIV.cloneNode();
const h1 = H1.cloneNode();
h1.textContent ='OVAL Object definition: ';
h1.className = "pf-c-title pf-m-lg";
div.appendChild(BR.cloneNode());
div.appendChild(h1);

div.appendChild(get_label("pf-m-blue", `OVAL Object ID: ${oval_object.object_id}\u00A0`, undefined, "", "", oval_object.comment));
div.appendChild(get_label("pf-m-blue", `OVAL Object type: ${oval_object.object_type}\u00A0`));
div.appendChild(get_label("pf-m-blue", `Flag: ${oval_object.flag}\u00A0`));

return div;
function generate_endpoint_elements(tbody, data) {
for (const [element_id, element_dict] of Object.entries(data)) {
generate_endpoint_element(tbody, element_id, element_dict);
}
}

function generate_collected_items(collected_items, div) {
const h1 = H1.cloneNode();
h1.textContent = "Collected Items:";
h1.className = "pf-c-title pf-m-lg";
div.appendChild(h1);
div.appendChild(get_header("Collected Items"));
div.appendChild(BR.cloneNode());

if (collected_items == null) {
const explanation = DIV.cloneNode();
Expand Down Expand Up @@ -696,87 +710,68 @@ function generate_collected_items(collected_items, div) {
}
}

function generate_OVAL_object(test_info, oval_object, div) {
if (oval_object === undefined) {
// eslint-disable-next-line no-console
console.error("Error: The test information has no OVAL Objects.");
return;
}
div.appendChild(get_OVAL_object_info_heading(oval_object));
function generate_OVAL_endpoint(div, title, kv_entries, data, referenced_id, test_info) {
div.appendChild(get_header(title));
div.appendChild(BR.cloneNode());
const table_div = DIV.cloneNode();
table_div.className = "pf-c-scroll-inner-wrapper oval-test-detail-table";
div.appendChild(table_div);

generate_property_elements(table_div, oval_object, oval_object.object_data);
const table = TABLE.cloneNode();
table.className = "pf-c-table pf-m-compact pf-m-grid-md";
table.setAttribute("role", "grid");
table_div.appendChild(table);

const tbody = TBODY.cloneNode();
tbody.setAttribute("role", "rowgroup");
table.appendChild(tbody);

if (oval_object.object_id in test_info.map_referenced_oval_endpoints) {
generate_referenced_endpoints(test_info, oval_object.object_id, table_div);
for (const [key, value] of Object.entries(kv_entries)) {
add_kv_entry(tbody, key, value);
}
}

function get_OVAL_state_heading() {
const div = DIV.cloneNode();
const h1 = H1.cloneNode();
h1.textContent ='OVAL State definitions: ';
h1.className = "pf-c-title pf-m-lg";
div.appendChild(h1);
return div;
}
generate_endpoint_elements(tbody, data);

function get_OVAL_state_info(oval_state, off_heading=false) {
const div = DIV.cloneNode();
if(off_heading) {
const h1 = H1.cloneNode();
h1.textContent ='OVAL State definition: ';
h1.className = "pf-c-title pf-m-lg";
div.appendChild(h1);
if (referenced_id in test_info.map_referenced_oval_endpoints) {
generate_referenced_endpoints(test_info, referenced_id, table_div);
}
div.appendChild(get_label("pf-m-blue", `OVAL State ID: ${oval_state.state_id}\u00A0`, undefined, "", "", oval_state.comment));
return div;
}

// eslint-disable-next-line max-params
function generate_OVAL_state(test_info, oval_state, div, off_heading=false) {
if (oval_state === null) {
function generate_OVAL_object(test_info, oval_object, div) {
if (oval_object === undefined) {
// eslint-disable-next-line no-console
console.error("Error: The test information has no OVAL Objects.");
return;
}
div.appendChild(get_OVAL_state_info(oval_state, off_heading));
const table_div = DIV.cloneNode();
table_div.className = "pf-c-scroll-inner-wrapper oval-test-detail-table";
div.appendChild(table_div);

generate_property_elements(table_div, oval_state, oval_state.state_data);
if (oval_state.state_id in test_info.map_referenced_oval_endpoints) {
generate_referenced_endpoints(test_info, oval_state.state_id, table_div);
}
const kv_entries = {
"OVAL Object ID": oval_object.object_id,
"OVAL Object Type": oval_object.object_type,
"Flag": oval_object.flag,
};
generate_OVAL_endpoint(div, "OVAL Object", kv_entries, oval_object.object_data, oval_object.object_id, test_info);
}

function get_OVAL_variable_info_heading(oval_variable) {
const div = DIV.cloneNode();
const h1 = H1.cloneNode();
h1.textContent ='OVAL Variable definition: ';
h1.className = "pf-c-title pf-m-lg";
div.appendChild(BR.cloneNode());
div.appendChild(h1);

div.appendChild(get_label("pf-m-blue", `OVAL Variable ID: ${oval_variable.variable_id}\u00A0`, undefined, "", "", oval_variable.comment));
div.appendChild(get_label("pf-m-blue", `OVAL Variable type: ${oval_variable.variable_type}\u00A0`));
return div;
function generate_OVAL_state(test_info, oval_state, div) {
if (oval_state === null) {
return;
}
const kv_entries = {
"OVAL State ID": oval_state.state_id,
"OVAL State Type": oval_state.state_type
};
generate_OVAL_endpoint(div, "OVAL State", kv_entries, oval_state.state_data, oval_state.state_id, test_info);
}

function generate_OVAL_variable(test_info, oval_variable, div) {
if (oval_variable === null) {
return;
}
div.appendChild(get_OVAL_variable_info_heading(oval_variable));
const table_div = DIV.cloneNode();
table_div.className = "pf-c-scroll-inner-wrapper oval-test-detail-table";
div.appendChild(table_div);

generate_property_elements(table_div, oval_variable, oval_variable.variable_data);
if (oval_variable.variable_id in test_info.map_referenced_oval_endpoints) {
generate_referenced_endpoints(test_info, oval_variable.variable_id, table_div);
}
const kv_entries = {
"OVAL Variable ID": oval_variable.variable_id,
"OVAL Variable Type": oval_variable.variable_type
};
generate_OVAL_endpoint(div, "OVAL Variable", kv_entries, oval_variable.variable_data, oval_variable.variable_id, test_info);
}

function generate_OVAL_error_message(test_info, div) {
Expand Down Expand Up @@ -859,7 +854,7 @@ function generate_endpoint(id, test_info, body) {
} else if(id.includes(":obj:")) {
generate_OVAL_object(test_info, endpoint, body);
} else if(id.includes(":ste:")) {
generate_OVAL_state(test_info, endpoint, body, true);
generate_OVAL_state(test_info, endpoint, body);
} else {
// eslint-disable-next-line no-console
console.error("Not implemented endpoint type!");
Expand Down Expand Up @@ -890,27 +885,48 @@ function get_spacer() {
function get_OVAL_test_info(test_info) {
const div = DIV.cloneNode();
div.className = "pf-c-accordion__expanded-content-body";
div.appendChild(get_label("", `${test_info.test_id}\u00A0`, undefined, "", "", test_info.comment));
div.appendChild(get_header("OVAL Test"));
div.appendChild(BR.cloneNode());

const table_div = DIV.cloneNode();
table_div.className = "pf-c-scroll-inner-wrapper oval-test-detail-table";
div.appendChild(table_div);

const table = TABLE.cloneNode();
table.className = "pf-c-table pf-m-compact pf-m-grid-md";
table.setAttribute("role", "grid");
table_div.appendChild(table);

const tbody = TBODY.cloneNode();
tbody.setAttribute("role", "rowgroup");
table.appendChild(tbody);

add_kv_entry(tbody, "Test ID", test_info.test_id);
add_kv_entry(tbody, "Test Type", test_info.test_type);
add_kv_entry(tbody, "Comment", test_info.comment);

if (test_info.check && test_info.check in CHECK_ATTRIBUTE_TO_TEXT) {
div.appendChild(get_label("pf-m-cyan", `Check atribute: ${test_info.check}\u00A0`, undefined, "", "", CHECK_ATTRIBUTE_TO_TEXT[test_info.check]));
add_kv_entry(tbody, "Check", get_label("pf-m-blue", test_info.check, undefined, "", "", CHECK_ATTRIBUTE_TO_TEXT[test_info.check]));
}
if (test_info.check_existence && test_info.check_existence in CHECK_EXISTENCE_ATTRIBUTE_TO_TEXT) {
div.appendChild(get_label("pf-m-cyan", `Check existence atribute: ${test_info.check_existence}\u00A0`, undefined, "", "", CHECK_EXISTENCE_ATTRIBUTE_TO_TEXT[test_info.check_existence]));
add_kv_entry(tbody, "Check existence", get_label("pf-m-blue", test_info.check_existence, undefined, "", "", CHECK_EXISTENCE_ATTRIBUTE_TO_TEXT[test_info.check_existence]));
}

div.appendChild(get_spacer());


generate_OVAL_object(test_info, test_info.oval_object, div);

if (test_info.oval_object.message !== null) {
generate_OVAL_error_message(test_info, div);
}

generate_OVAL_object(test_info, test_info.oval_object, div);

div.appendChild(get_spacer());

generate_collected_items(test_info.oval_object.collected_items, div);

if (test_info.oval_states.length > 0) {
div.appendChild(get_spacer());
div.appendChild(get_OVAL_state_heading());
}

for (const oval_state of test_info.oval_states) {
Expand Down
3 changes: 2 additions & 1 deletion openscap_report/scap_results_parser/parsers/oval_endpoint_information_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ def _get_items(self, xml_test_property):
element_dict
)
if len(element):
element_dict = self._get_items(element)
# parse children like set, regex_capture, concat
element_dict.update(self._get_items(element))

items_of_test_property[id_in_items_of_test_property] = element_dict
return items_of_test_property