Add a faster alternative for generating HTML guides #11036
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The new script `generate_guides.py` builds HTML guides for each profile in the given SCAP source data stream and also it builds a HTML index. The script `generate_guides.py` applies the XSLT template `/usr/share/openscap/xsl/xccdf-guide.xsl` that is shipped in the `openscap` RPM package. That means that this tool still depends on OpenSCAP, but doesn't call the `oscap` tool. The advantage of the new solution is that the given SCAP source data stream is parsed only once, which is faster that parsing this big XML file for each profile. Unfortunately, this new script needs the `lxml` library because the `xml.etree` doesn't provide a XSLT processing feature. Therefore, we will make the usage of the new script optional and we will fall back to the existing solution if `lxml` isn't installed. This way we will improve the CI and the user's machines experience without having to break a build.
|
Start a new ephemeral environment with changes proposed in this pull request: Fedora Environment Oracle Linux 8 Environment |
Mab879
reviewed
Aug 30, 2023
build-scripts/generate_guides.py
Outdated
| f.write(index_source.encode("utf-8")) | ||
|
|
||
|
|
||
| def generate_html_guides(ds, benchmarks, oscap_version, product, output_dir): |
There was a problem hiding this comment.
Code Climate is flagging this method since there are 5 parameters.
If you pulled the outer loop into main you might be able to get to four.
But I'm not too concerned about this one.
The function `generate_html_guides` has more parameters than allowed.
|
I have fixed Code Climate problem. |
|
Code Climate has analyzed commit 4c08686 and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 53.8% (0.5% change). View more on Code Climate. |
Mab879
approved these changes
Aug 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The new script
generate_guides.pybuilds HTML guides for each profile in the given SCAP source data stream and also it builds a HTML index.The script
generate_guides.pyapplies the XSLT template/usr/share/openscap/xsl/xccdf-guide.xslthat is shipped in theopenscapRPM package. That means that this tool still depends on OpenSCAP, but doesn't call theoscaptool.The advantage of the new solution is that the given SCAP source data stream is parsed only once, which is faster that parsing this big XML file for each profile.
Unfortunately, this new script needs the
lxmllibrary because thexml.etreedoesn't provide a XSLT processing feature. Therefore, we will make the usage of the new script optional and we will fall back to the existing solution iflxmlisn't installed. This way we will improve the CI and the developer laptop experience without having to break a build.