Rework of cpe_generate.py
#11644
Rework of cpe_generate.py
#11644
Conversation
openshift-ci
bot
added
the
do-not-merge/work-in-progress
|
Skipping CI for Draft Pull Request. |
|
Start a new ephemeral environment with changes proposed in this pull request: Fedora Environment Oracle Linux 8 Environment |
|
🤖 A k8s content image for this PR is available at: Click here to see how to deploy itIf you alread have Compliance Operator deployed: Otherwise deploy the content and operator together by checking out ComplianceAsCode/compliance-operator and: |
Honny1
force-pushed
the
rework-cpe-generate
branch
from
4ee07e0
to
aef3461
Compare
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
Honny1
added
enhancement
build-scripts/cpe_generate.py
Outdated
| # Lets scrape the shorthand for the list of platforms referenced | ||
| benchmark_cpe_names = get_benchmark_cpe_names(args.shorthandfile) |
There was a problem hiding this comment.
This file actually isn't in shorthand format. It's build/${product}/ssg-${product}-xccdf.xml which is a normal XCCDF document. This comment is outdated. We should change the comment and rename all variables accordingly. Also, we need to rename the argument shorthandfile.
| # skip CPE AL platforms (they are handled later) | ||
| # this is temporary solution until we get rid of old type of platforms in the benchmark | ||
| if cpe_name.startswith("#"): |
There was a problem hiding this comment.
Can you check if what the comment says is still the case?
There was a problem hiding this comment.
Yes, I think it's still relevant because, for example, OS platforms use CPE identifiers and CPE dictionaries.
build-scripts/cpe_generate.py
Outdated
|
|
||
| # parse oval file | ||
| ovaltree = ssg.xml.parse_file(args.ovalfile) | ||
| def load_oval(args): |
There was a problem hiding this comment.
It's better to not pass args down here. Instead, this function should have 2 specific arguments.
build-scripts/cpe_generate.py
Outdated
|
|
||
| # parse oval file | ||
| ovaltree = ssg.xml.parse_file(args.ovalfile) | ||
| def load_oval(args): |
There was a problem hiding this comment.
I think the name of this function is misleading, it's load_oval but it actually does many more actions that just loading. Please rename it.
build-scripts/cpe_generate.py
Outdated
| # turn IDs into meaningless numbers | ||
| translator = ssg.id_translate.IDTranslator(args.idname) | ||
| ovaltree = translator.translate(ovaltree) | ||
| oval_document = translator.translate_oval_document(oval_document, store_defname=True) |
There was a problem hiding this comment.
The IDs aren't turned into "meaningless numbers", they're added prefix, suffix and number, which makes them unique, but not meaningless.
build-scripts/cpe_generate.py
Outdated
|
|
||
| def load_cpe_dictionary(benchmark_cpe_names, product_yaml, args): |
There was a problem hiding this comment.
I don't like that the args is passed down in here. I think that the function should have 2 specific arguments instead of the args argument.
build-scripts/cpe_generate.py
Outdated
| p.add_argument( | ||
| "idname", | ||
| help="Identifier prefix" | ||
| ) |
There was a problem hiding this comment.
When we are here can we actually make this a constant please? I think that it's unlikely to ever be anything different than ssg.
|
Also, I have noticed that there are frequent typos in your commit messages. I think I pointed out this before in one of your previous PRs. Please employ a spell checker. |
Honny1
force-pushed
the
rework-cpe-generate
branch
from
5cc08ba
to
eede727
Compare
Honny1
force-pushed
the
rework-cpe-generate
branch
from
eede727
to
dbf1e69
Compare
|
Code Climate has analyzed commit dbf1e69 and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 50.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 59.8% (0.0% change). View more on Code Climate. |
Description:
This PR reworks the
cpe_generate.pyscript. It simplifies the code for future enhancements such as reducing CPE AL in the data stream. The script uses the OVAL object model to process OVAL. And it separates the process of creating the CPE dictionary and the CPE OVAL.Review Hints:
These changes shouldn't change the functionality of the script.