Skip to content

Conversation

kkaarreell
Copy link
Collaborator

@kkaarreell kkaarreell commented Sep 17, 2025

Summary by Sourcery

Provide additional debug output for swtpm configuration failures by printing /dev/tpm* listings and service journal logs when emulator startup fails

Enhancements:

  • Add print_swtpm_service_debug_logs function to output TPM device listings and journal logs
  • Invoke debug logging when TPM emulator start fails for both standard and malformed EK setups

@kkaarreell kkaarreell self-assigned this Sep 17, 2025
Copy link

sourcery-ai bot commented Sep 17, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Enhances diagnostic output in the swtpm configuration tests by adding a helper to collect service logs and listing TPM devices, and invoking it when the TPM emulator fails to start.

File-Level Changes

Change Details Files
Add helper for capturing swtpm service debug output
  • Define function print_swtpm_service_debug_logs to list TPM device nodes and fetch journal logs for a given service
setup/configure_swtpm_device/test.sh
Integrate device listing and debug logging into failure paths
  • Insert ls -l /dev/tpm* before starting each TPM emulator to show current device state
  • On limeWaitForTPMEmulator failure, call print_swtpm_service_debug_logs with the appropriate service name
setup/configure_swtpm_device/test.sh

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@kkaarreell kkaarreell merged commit c02166f into main Sep 17, 2025
1 of 6 checks passed
@kkaarreell kkaarreell deleted the ks_tpm_more_logs branch September 17, 2025 09:47
ls -l /dev/tpm*
rlServiceStart ${TPM_EMULATOR}${SUFFIX}
rlRun "limeTPMDevNo=${NEW_TPM_DEV_NO} limeWaitForTPMEmulator"
[ $? -eq 0 ] || print_swtpm_service_debug_logs ${TPM_EMULATOR}${SUFFIX}

Check warning

Code scanning / shellcheck

SC2181 Warning test

Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
ls -l /dev/tpm*
rlServiceStart ${TPM_EMULATOR_BAD_EK}${SUFFIX}
rlRun "limeTPMDevNo=${NEW_TPM_DEV_NO} limeWaitForTPMEmulator"
[ $? -eq 0 ] || print_swtpm_service_debug_logs ${TPM_EMULATOR_BAD_EK}${SUFFIX}

Check warning

Code scanning / shellcheck

SC2181 Warning test

Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant