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.

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

Update html report with oval details #2055

Merged
merged 2 commits into from
Dec 6, 2023

Conversation

Xeicker
Copy link
Contributor

@Xeicker Xeicker commented Nov 23, 2023

With this update it is clearer when a test fails due to a few objects from many collected

Attaching some examples to show the suggested change in action, and how can it be useful:
image

image

Note:
If there is a cleaner way and it is preferable let me know. I'm not quite familiarized with xsl

With this update it is clearer when a test fails due to a few objects
from many collected

Signed-off-by: Edgar Aguilar <edgar.aguilar@oracle.com>
@jan-cerny jan-cerny self-assigned this Nov 28, 2023
Copy link
Member

@jan-cerny jan-cerny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thank you very much for opening this PR.

While adding this can be useful in many situations, it's affected by the problem that our details section doesn't show the full structure of the OVAL tree. Specifically, if you add these results, the users don't know if there is a state element in the given test and what this state contains. That can cause confusion. I'm not sure how to address this, though.

I suggest at least to be more clear by renaming the Result column to Result of item-state comparison. Hopefully, renaming it will slightly lower the confusion.

Also on a related note I would like to invite you to check the https://github.com/OpenSCAP/openscap-report project which aims to generate a more verbose and modern HTML report than what we have here.

Signed-off-by: Edgar Aguilar <edgar.aguilar@oracle.com>
@Honny1
Copy link
Member

Honny1 commented Nov 30, 2023

I like the idea of showing which collected object does not meet the object state. However, this list could be infinitely long. How about showing only the first failed test object to avoid a huge HTML report?

@Xeicker
Copy link
Contributor Author

Xeicker commented Nov 30, 2023

I like the idea of showing which collected object does not meet the object state. However, this list could be infinitely long. How about showing only the first failed test object to avoid a huge HTML report?

This only introduce a new column on the existing items list. Which is actually limited to a max of 100 items

@jan-cerny
Copy link
Member

/packit build

@jan-cerny jan-cerny added this to the 1.3.10 milestone Dec 5, 2023
@jan-cerny jan-cerny merged commit a930dc7 into OpenSCAP:maint-1.3 Dec 6, 2023
18 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants