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

[GSOC23] - C - Implement a StAX parser for OVAL files #7510

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

HoussemNasri
Copy link
Collaborator

@HoussemNasri HoussemNasri commented Sep 7, 2023

NOTE: Please start the review from commit 15624fb, the other commits are reviewed in #7509.

What does this PR change?

Introduce a StAX parser (instead of the current JAXB parser) for OVAL files to increase memory efficiency when parsing large OVAL files.

Useful Links

GUI diff

No difference.

Before:

After:

  • DONE

Documentation

Test coverage

  • No tests: add explanation

  • No tests: already covered

  • Unit tests were added

  • Cucumber tests were added

  • DONE

Links

Fixes #
Tracks # add downstream PR, if any

  • DONE

Changelogs

Make sure the changelogs entries you are adding are compliant with https://github.com/uyuni-project/uyuni/wiki/Contributing#changelogs and https://github.com/uyuni-project/uyuni/wiki/Contributing#uyuni-projectuyuni-repository

If you don't need a changelog check, please mark this checkbox:

  • No changelog needed

If you uncheck the checkbox after the PR is created, you will need to re-run changelog_test (see below)

Re-run a test

If you need to re-run a test, please mark the related checkbox, it will be unchecked automatically once it has re-run:

  • Re-run test "changelog_test"
  • Re-run test "backend_unittests_pgsql"
  • Re-run test "java_pgsql_tests"
  • Re-run test "schema_migration_test_pgsql"
  • Re-run test "susemanager_unittests"
  • Re-run test "javascript_lint"
  • Re-run test "spacecmd_unittests"

@github-actions
Copy link
Contributor

github-actions bot commented Sep 7, 2023

Suggested tests to cover this Pull Request
  • srv_docker_cve_audit
  • min_cve_audit

@github-actions
Copy link
Contributor

github-actions bot commented Oct 26, 2023

👋 Hello! Thanks for contributing to our project.
Acceptance tests will take some time (aprox. 1h), please be patient ☕
You can see the progress at the end of this page and at https://github.com/uyuni-project/uyuni/pull/7510/checks
Once tests finish, if they fail, you can check 👀 the cucumber report. See the link at the output of the action.
You can also check the artifacts section, which contains the logs at https://github.com/uyuni-project/uyuni/pull/7510/checks.

If you are unsure the failing tests are related to your code, you can check the "reference jobs". These are jobs that run on a scheduled time with code from master. If they fail for the same reason as your build, it means the tests or the infrastructure are broken. If they do not fail, but yours do, it means it is related to your code.

Reference tests:

KNOWN ISSUES

Sometimes the build can fail when pulling new jar files from download.opensuse.org . This is a known limitation. Given this happens rarely, when it does, all you need to do is rerun the test. Sorry for the inconvenience.

For more tips on troubleshooting, see the troubleshooting guide.

Happy hacking!
⚠️ You should not merge if acceptance tests fail to pass. ⚠️

Copy link
Contributor

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 10 days.

@github-actions github-actions bot added the Stale label Dec 26, 2023
Copy link
Contributor

github-actions bot commented Jan 5, 2024

This PR was closed because it has been stalled for 10 days with no activity.

@github-actions github-actions bot closed this Jan 5, 2024
@mcalmer
Copy link
Contributor

mcalmer commented Jan 5, 2024

@HoussemNasri @parlt91 i think this is still needed, right?

@HoussemNasri
Copy link
Collaborator Author

@HoussemNasri @parlt91 i think this is still needed, right?

Yes, the A and B pull requests need to be reviewed first before we can move to this one in case there was some changes that would affect this one (all PRs are kind of stacked on each other). Right now, pr A is under review.

@mcalmer
Copy link
Contributor

mcalmer commented Jan 5, 2024

Than we better reopen this request

@mcalmer mcalmer reopened this Jan 5, 2024
@rjmateus rjmateus removed the Stale label Jul 8, 2024
Copy link
Contributor

github-actions bot commented Sep 7, 2024

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 10 days.

@github-actions github-actions bot added the Stale label Sep 7, 2024
@parlt91 parlt91 removed the Stale label Sep 9, 2024
@HoussemNasri HoussemNasri marked this pull request as ready for review September 15, 2024 18:16
@HoussemNasri HoussemNasri requested review from a team as code owners September 15, 2024 18:16
@HoussemNasri HoussemNasri requested review from rjpmestre and meaksh and removed request for a team September 15, 2024 18:16
@github-actions github-actions bot added the API label Sep 15, 2024
Copy link
Member

@Etheryte Etheryte left a comment

Choose a reason for hiding this comment

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

The issues that were pointed out regarding styles and how they're used in the previous pull request are still present in this one. The comments are marked as resolved, but the issues have not been addressed, see e.g. #7509 (comment) and #7509 (comment). Please do not mark issues as resolved if they have not been addressed.

@HoussemNasri HoussemNasri force-pushed the oval-stax-parser branch 2 times, most recently from 86f2025 to 9a8b53c Compare October 8, 2024 11:30
* @param bulkHandler an operation to applied on every bulk of parsed OVAL definitions.
* */
public void parseDefinitionsInBulk(File ovalFile, OVALDefinitionsBulkHandler bulkHandler) {
XMLInputFactory xmlInputFactory = XMLInputFactory.newInstance();

Check failure

Code scanning / SonarCloud

XML parsers should not be vulnerable to XXE attacks High

Disable access to external entities in XML parsing. See more on SonarCloud
* @return an {@link OVALResources} object containing OVAL objects, states and tests.
* */
public OVALResources parseResources(File ovalFile) {
XMLInputFactory xmlInputFactory = XMLInputFactory.newInstance();

Check failure

Code scanning / SonarCloud

XML parsers should not be vulnerable to XXE attacks High

Disable access to external entities in XML parsing. See more on SonarCloud
Copy link
Member

@Etheryte Etheryte left a comment

Choose a reason for hiding this comment

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

No frontend changes in the latest summa summarum changeset.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants