tmt Refactor DiscoverFmf.go()

Pull Request Checklist

Would it be also worth it to refactor the part between these two helper methods?

[x] implement the feature

Fixes #2448

Apr 28 '25 15:04 bajertom

I've found a typo in tests/discover/adjust-tests.sh so I've fixed it in this PR if that's okay. Also mypy found unused import of subprocess in steps/discover/fmf.py and removed it.

May 06 '25 07:05 bajertom

@coderabbitai full review

Jun 03 '25 08:06 martinhoyer

[!WARNING]

Rate limit exceeded

@happz has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 702717662a91ea535384620e50971d7287cdda0d and aab52842a5dff6c853937ff9aeb72369e88d08db.

📒 Files selected for processing (2)

tests/discover/adjust-tests.sh (1 hunks)

tmt/steps/discover/fmf.py (4 hunks)

📝 Walkthrough

Walkthrough

The DiscoverFmf.go() method in tmt/steps/discover/fmf.py was refactored by extracting two logical sections into new methods: one for validating FMF ID requirements and another for processing dist-git sources. Related imports were adjusted, and the test script was updated to use the correct assertion for file existence.

Changes

Files/Paths	Change Summary
tmt/steps/discover/fmf.py	Refactored `go()` by extracting logic into `validate_fmf_id_requirements()` and `process_distgit_source()`. Cleaned up imports.
tests/discover/adjust-tests.sh	Replaced `rlAssertExits` with `rlAssertExists` for correct file existence assertion.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DiscoverFmf
    participant fmf.Tree
    participant Git

    User->>DiscoverFmf: go()
    DiscoverFmf->>DiscoverFmf: validate_fmf_id_requirements()
    DiscoverFmf->>fmf.Tree: Check FMF root and URL (if needed)
    DiscoverFmf->>DiscoverFmf: process_distgit_source() (if dist-git source)
    DiscoverFmf->>Git: Download sources, copy files, insert prepare step
    DiscoverFmf->>DiscoverFmf: Continue with remaining go() logic

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Refactor the `DiscoverFmf.go()` method (#2448)	✅

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Update test assertion from `rlAssertExits` to `rlAssertExists` (tests/discover/adjust-tests.sh)	This change is unrelated to the refactoring of `DiscoverFmf.go()` and not mentioned in the linked issue.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Jun 03 '25 09:06 coderabbitai[bot]

@coderabbitai full review

Jun 15 '25 15:06 happz

✅ Actions performed

Full review triggered.

Jun 15 '25 15:06 coderabbitai[bot]

Addressed coderabbitai's comment in https://github.com/teemtee/tmt/pull/3701/commits/5d71903e89368b48ba0c5228dc5f8e0d9f3a6f1c @coderabbitai full review

Jun 16 '25 13:06 bajertom

[!TIP] For best results, initiate chat on the files or code changes.

🧩 Analysis chain

@bajertom, I'll conduct a full review of the current state of your refactoring PR. Let me examine the files and the specific commit where you addressed my previous feedback.

🏁 Script executed:

#!/bin/bash
# First, let's examine the current state of the main refactored file
echo "=== Current state of tmt/steps/discover/fmf.py ==="
cat tmt/steps/discover/fmf.py

echo -e "\n=== Current state of tests/discover/adjust-tests.sh ==="
cat tests/discover/adjust-tests.sh

# Let's also check the specific commit mentioned to see what was addressed
echo -e "\n=== Examining the specific commit 5d71903e89368b48ba0c5228dc5f8e0d9f3a6f1c ==="
git show 5d71903e89368b48ba0c5228dc5f8e0d9f3a6f1c --stat

echo -e "\n=== Detailed diff of the addressing commit ==="
git show 5d71903e89368b48ba0c5228dc5f8e0d9f3a6f1c

Length of output: 69866

Let me get a more focused view of the specific commit and examine the current code:

🏁 Script executed:

#!/bin/bash
# Get the specific commit diff more precisely
echo "=== Specific commit changes ==="
git show 5d71903e89368b48ba0c5228dc5f8e0d9f3a6f1c --name-only
echo -e "\n=== Diff for that commit ==="
git show 5d71903e89368b48ba0c5228dc5f8e0d9f3a6f1c --stat --no-merges

# Let me also check recent commits on this branch
echo -e "\n=== Recent commits ==="
git log --oneline -5

# Let's examine the validate_fmf_id_requirements method specifically since that's likely what was addressed
echo -e "\n=== validate_fmf_id_requirements method ==="
ast-grep --pattern $'def validate_fmf_id_requirements($$$):
    $$$'

# Check process_distgit_source method
echo -e "\n=== process_distgit_source method ==="
ast-grep --pattern $'def process_distgit_source($$$):
    $$$'

Length of output: 78005

Let me focus on examining the current implementation and the specific changes for this PR:

🏁 Script executed:

#!/bin/bash
# Get the specific changes for this PR
echo "=== Current PR branch vs base ==="
git log --oneline HEAD~5..HEAD

# Let's examine the current implementation of the two extracted methods
echo -e "\n=== validate_fmf_id_requirements method implementation ==="
rg -A 30 "def validate_fmf_id_requirements" tmt/steps/discover/fmf.py

echo -e "\n=== process_distgit_source method implementation ==="  
rg -A 20 "def process_distgit_source" tmt/steps/discover/fmf.py

# Check if there are any issues with the current implementation
echo -e "\n=== Looking for potential issues in exception handling ==="
rg -A 5 -B 5 "except.*:" tmt/steps/discover/fmf.py

Length of output: 7690

@bajertom Excellent work on the refactoring! I can see you've successfully addressed the feedback and created a well-structured solution. Here's my comprehensive review:

✅ Successful Refactoring

Your refactoring of DiscoverFmf.go() is very well executed:

1. Clean Method Extraction

validate_fmf_id_requirements(): Properly encapsulates the complex FMF ID validation logic
process_distgit_source(): Cleanly separates dist-git source processing concerns
Both methods have clear single responsibilities and appropriate names

2. Improved Exception Handling

The exception handling improvements are particularly noteworthy:

except fmf.utils.RootError as exc:
    raise tmt.utils.DiscoverError(
        "No metadata found in the current directory. Use 'tmt init' to get started."
    ) from exc

Proper exception chaining with from exc
Specific exception types instead of generic Exception
Clear, actionable error messages

3. Code Quality Enhancements

✅ Proper type hints: def validate_fmf_id_requirements(self, url: Optional[str] = None) -> None
✅ Clear docstrings for both extracted methods
✅ Maintained original logic flow and functionality
✅ Used contextlib.suppress() appropriately for expected exceptions

4. Additional Improvements

Test script fix: Correctly changed rlAssertExits → rlAssertExists for file existence check
Import cleanup: Removed unused subprocess import as flagged by mypy
Maintained backwards compatibility: No breaking changes to the public API

Method Signatures & Documentation

Both extracted methods have excellent signatures:

def validate_fmf_id_requirements(self, url: Optional[str] = None) -> None:
    """Validate environment requirements for the --fmf-id option."""

def process_distgit_source(self, distgit_dir: Path, sourcedir: Path) -> None:
    """Process dist-git source during the discover step."""

Overall Assessment

This refactoring successfully:

🎯 Addresses the original issue (#2448) by breaking down the large method
🔧 Improves maintainability through better separation of concerns
🛡️ Enhances error handling with proper exception chaining
📚 Maintains readability with clear method names and documentation
✨ Includes bonus improvements (test fix, import cleanup)

The code is now much more maintainable and the extracted methods can be easily unit tested independently. Great job on this refactoring! 🎉

Jun 16 '25 13:06 coderabbitai[bot]

@bajertom it would really help me if you would describe in the merge request description the changes done, and the logic behind them, kind of summary of the refactoring would be great.

Jun 30 '25 14:06 thrix

@thrix

I have improved the summary to describe the refactoring changes. I welcome any other improvement idea.

Jul 01 '25 12:07 bajertom

/packit retest-failed

Jul 07 '25 18:07 thrix

Testing failures are flakes, see https://github.com/teemtee/tmt/pull/3861 which passed with raised timeouts

Jul 07 '25 23:07 thrix