uyuni icon indicating copy to clipboard operation
uyuni copied to clipboard

Go api generation

Open cbosdo opened this issue 1 year ago • 4 comments

What does this PR change?

Add a doclet to generate go code from the API javadoc comments. This is a one-shot tool to generate code for use in mgrctl

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:

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

Before you merge

Check How to branch and merge properly!

cbosdo avatar Feb 07 '24 08:02 cbosdo

: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/8272/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/8272/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 Feb 07 '24 08:02 github-actions[bot]

Suggested tests to cover this Pull Request
  • proxy_cobbler_pxeboot
  • srv_monitoring
  • allcli_sanity
  • srv_first_settings
  • srv_rename_hostname
  • proxy_as_pod_basic_tests
  • proxy_branch_network
  • min_bootstrap_api
  • min_activationkey
  • min_retracted_patches
  • srv_sync_products
  • min_monitoring
  • min_salt_install_with_staging
  • srv_maintenance_windows
  • srv_sync_channels
  • srv_cobbler_distro
  • srv_enable_sync_products
  • min_salt_pkgset_beacon
  • min_config_state_channel_subscriptions
  • srv_channel_api
  • min_action_chain
  • minssh_action_chain
  • srv_wait_for_reposync
  • proxy_register_as_minion_with_script
  • min_deblike_salt_install_with_staging
  • min_salt_software_states
  • min_deblike_salt_install_package
  • min_rhlike_salt_install_package_and_patch
  • proxy_retail_pxeboot_and_mass_import
  • minssh_bootstrap_api
  • allcli_action_chain
  • min_salt_install_package
  • srv_user_configuration_salt_states
  • min_bootstrap_script
  • minssh_salt_install_package
  • min_ssh_tunnel
  • srv_distro_cobbler
  • min_config_state_channel_api

github-actions[bot] avatar Feb 07 '24 08:02 github-actions[bot]

First version only dumps the types, I'll update this PR with the rest later

cbosdo avatar Feb 07 '24 08:02 cbosdo

Hi ! We fixed a spelling mistake in the name of the tests and you will have to rebase your PR for the correct tests to run. Sorry for the inconvenience.

jordimassaguerpla avatar Feb 20 '24 15:02 jordimassaguerpla

We probably don't want to generate the API yet. Closing for now

cbosdo avatar Mar 08 '24 12:03 cbosdo