Skip to content

Improve debugging experience for k0s inttests #5878

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 1 commit into
base: main
Choose a base branch
from

Conversation

juanluisvaladas
Copy link
Contributor

Description

Attaching a debugger or running the inttests with strace is super annoying and every time I need to do it I end up having to make a custom image and modifying the Bootloose suite or launching myself the k0s command. We should have a standardized way of doing this where we don't need to think and it's just a command to get that done.

This PR implements an optional, heavier debug image with delve and strace, a way to replace the command in the BootlooseSuite for a debugging command and documents it.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@juanluisvaladas juanluisvaladas requested review from a team as code owners May 26, 2025 08:05
@juanluisvaladas juanluisvaladas requested review from ncopa and kke May 26, 2025 08:05
@juanluisvaladas juanluisvaladas marked this pull request as draft May 26, 2025 08:09
@juanluisvaladas juanluisvaladas marked this pull request as ready for review May 26, 2025 08:43
@juanluisvaladas juanluisvaladas marked this pull request as draft May 26, 2025 09:05
Implements an optional, heavier debug image with delve and strace, a way
to replace the command in the BootlooseSuite for a debugging command and
documents it.

Signed-off-by: Juan-Luis de Sousa-Valadas Castaño <[email protected]>
@juanluisvaladas
Copy link
Contributor Author

Closing and reopening to retrigger CI as github is having problems

@juanluisvaladas juanluisvaladas marked this pull request as ready for review May 26, 2025 09:14
# Determine the bootloose stamp dependency based on K0S_DEBUG
# Default to .bootloose-alpine.stamp (the "otherwise" case from the request)
BOOTLOOSE_STAMP_DEP := .bootloose-alpine.stamp
ifeq ($(K0S_DEBUG_TESTS),true)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe we should rename this variable to DEBUG, which is used to build a non stripped k0s binary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/smoke-tests enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant