uyuni icon indicating copy to clipboard operation
uyuni copied to clipboard

Remove simple-xml dependecy in favor of JAXB

Open mackdk opened this issue 1 year ago • 6 comments

What does this PR change?

This PR drops the dependency on simple-xml in favor of standard JAXB.

GUI diff

No difference.

  • [X] DONE

Documentation

  • No documentation needed: only internal and user invisible changes

  • [X] DONE

Test coverage

  • No tests: already covered

  • [X] 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"

mackdk avatar Nov 10 '23 10:11 mackdk

:wave: Hello! Thanks for contributing to our project. Acceptance tests will take some time (aprox. 1h), please be patient :coffee: You can see the progress at the end of this page and at https://github.com/uyuni-project/uyuni/pull/7855/checks Once tests finish, if they fail, you can check :eyes: 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/7855/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:

  • https://github.com/uyuni-project/uyuni/actions/workflows/acceptance_tests_secondary_parallel.yml?query=event%3Aschedule

  • https://github.com/uyuni-project/uyuni/actions/workflows/acceptance_tests_secondary.yml?query=event%3Aschedule

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! :warning: You should not merge if acceptance tests fail to pass. :warning:

github-actions[bot] avatar Nov 10 '23 10:11 github-actions[bot]

Suggested tests to cover this Pull Request
  • min_deblike_openscap_audit
  • srv_menu
  • min_salt_openscap_audit
  • min_rhlike_openscap_audit
  • srv_task_status_engine
  • srv_sync_products

github-actions[bot] avatar Nov 10 '23 10:11 github-actions[bot]

More for an FYI: We decided to use StAX over JAXB but that's because we had big dataset here https://github.com/uyuni-project/uyuni/issues/7108. Here in this case, we should be fine with JAXB. Ideally, would have been nice to use the same library though.

admd avatar Feb 20 '24 12:02 admd

Ideally, would have been nice to use the same library though.

Indeed, that would require rewriting all the scap logic since StAX does not map XML to objects. It's totally doable, maybe even better, but requires changing how we process the results. Other drop in alternative might be Jackson but that would need an additional jar we currently don't have (jackson-dataformat-xml)

mackdk avatar Feb 20 '24 13:02 mackdk

Ideally, would have been nice to use the same library though.

Indeed, that would require rewriting all the scap logic since StAX does not map XML to objects. It's totally doable, maybe even better, but requires changing how we process the results. Other drop in alternative might be Jackson but that would need an additional jar we currently don't have (jackson-dataformat-xml)

@mackdk For now, I would say we are fine but I would appreciate if you could create a card to revisit this so we could align it depending on the effort required.

@rjmateus any thoughts on this one?

admd avatar Feb 21 '24 10:02 admd

I agree with Abid, I think we are fine on moving forward with this one, and creating a card to revisit in the future. It's great to get rid of simple-xml. Stax is a different implementation, but is the best approach for large data sets, like in the CVE case. For small datasets jaxb is a much more convenient library, and simpler to use.

rjmateus avatar Feb 22 '24 10:02 rjmateus