Skip to content

testsuite: add feature to run health check tool #10179

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

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

Conversation

meaksh
Copy link
Member

@meaksh meaksh commented Apr 11, 2025

What does this PR change?

This PR adds a new testsuite feature to run health check tool against a generated supportconfig.

It does some minimal checks to verify that health check is working properly and extracting metrics from the supportconfig as expected.

Related PRs: uyuni-project/sumaform#1829

Testing

This PR is now deployed at suma-test-ion-controller. To test:

  • ssh into suma-test-ion-controller
  • execute cd ~/spacewalk/testsuite
  • execute the test:
/usr/bin/ruby.ruby3.3 -S bundle exec cucumber --profile default -f html -o results/output_20250424143747-secondary.html -f json -o results/output_20250424143747-secondary.json -f junit -o results_junit -f pretty -r features --tags "@scope_salt" features/secondary/srv_health_check_supportconfig.feature

GUI diff

No difference.

  • DONE

Documentation

  • No documentation needed: only internal and user invisible changes

  • DONE

Test coverage

ℹ️ If a major new functionality is added, it is strongly recommended that tests for the new functionality are added to the Cucumber test suite

  • Cucumber tests were added

  • DONE

Links

Issue(s): https://github.com/SUSE/spacewalk/issues/24380

  • 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"

Before you merge

Check How to branch and merge properly!

@meaksh meaksh requested a review from a team as a code owner April 11, 2025 15:57
Copy link
Contributor

👋 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/10179/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/10179/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. ⚠️

@m-czernek m-czernek changed the title WIP: testsuite: add feature to run health check tool testsuite: add feature to run health check tool May 2, 2025
@m-czernek m-czernek requested a review from srbarrios May 2, 2025 11:14
@m-czernek
Copy link
Contributor

Note: This tests cannot run on Github, because we can't take a supportconfig from the GH Uyuni deployment. Not sure why the tests are executing even when we use the @skip_if_github_validation tag

When I run "curl localhost:3000/api/health -o /dev/null" on "localhost" with timeout at most 10 seconds

Scenario: Health Check containers are healthy and running
When I run "curl -s localhost:9000 -o /dev/null" on "localhost"
Copy link
Member

Choose a reason for hiding this comment

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

What about using this step?

    And I wait until port "9000" is listening on "localhost" host

And I run "curl -s localhost:3000 -o /dev/null" on "localhost"

Scenario: Health Check containers are exposing metrics
When I run "curl -s localhost:9000/metrics.json | python3 -c 'import sys, json; print(json.load(sys.stdin).keys())'" on "localhost"
Copy link
Member

@srbarrios srbarrios May 21, 2025

Choose a reason for hiding this comment

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

Let's build a step definition for this please.

Then I check the health check tool metrics are exposed in "localhost"

Then I obtain and extract the supportconfig from the server

Scenario: Execute health check tool with server supportconfig
When I run "mgr-health-check -v -s /root/server-supportconfig/uyuni-server-supportconfig/ start" on "localhost"
Copy link
Member

Choose a reason for hiding this comment

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

When I start health check tool with support config "/root/server-supportconfig/uyuni-server-supportconfig/" on "localhost"


Scenario: Execute health check tool with server supportconfig
When I run "mgr-health-check -v -s /root/server-supportconfig/uyuni-server-supportconfig/ start" on "localhost"
Then I run "test $(podman ps | grep health-check | wc -l) == 4" on "localhost"
Copy link
Member

Choose a reason for hiding this comment

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

Then I check that Health check tool container is running

When I run "curl -s localhost:9000/metrics.json | python3 -c 'import sys, json; print(json.load(sys.stdin).keys())'" on "localhost"

Scenario: Cleanup: Remove health check tool
When I run "mgr-health-check stop" on "localhost"
Copy link
Member

Choose a reason for hiding this comment

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

Same, let's build some step for this

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.

3 participants