Skip to content

lint check fail instead of warn #3661

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

bajertom
Copy link
Collaborator

@bajertom bajertom commented Apr 11, 2025

Pull Request Checklist

  • implement the feature
  • include a release note

Also this is my first PR opened with the use of Graphite app. Let's see.

Copy link
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@bajertom bajertom requested a review from martinhoyer April 11, 2025 14:34
@bajertom bajertom marked this pull request as ready for review April 11, 2025 14:34
@happz
Copy link
Collaborator

happz commented Apr 11, 2025

I'm not sure we're ready for schema validation being a hard fail lint check because it will report many false positives :/ We need at least a way users could override it for a given repo, in-repo config file, or something, otherwise, it may be complicated. Imagine a provision without how - tmt will work, it will fill in virtual, but schema will complain...

Copy link

coderabbitai bot commented Apr 11, 2025

📝 Walkthrough

Walkthrough

This pull request updates the release documentation and error handling for the tmt lint command. A new release entry (tmt-1.47.0) is added to the release notes. The behavior of the tmt lint command has been modified so that it now exits with code 1 when an invalid key is encountered in fmf metadata. Additionally, in the Core.lint_validate method within the code, the outcome for schema validation errors has been changed from a warning to a failure.

Changes

File Change Summary
docs/releases.rst Added a new release entry for tmt-1.47.0, noting that tmt lint now fails with exit code 1 on invalid fmf metadata.
tmt/base.py Updated Core.lint_validate to yield LinterOutcome.FAIL (instead of WARN) when an fmf node fails schema validation, altering error handling behavior.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant L as tmt-lint
    participant C as Core.lint_validate

    U->>L: Execute "tmt lint" command
    L->>C: Validate fmf metadata
    C-->>L: Return FAILURE outcome on invalid key
    L-->>U: Exit with code 1
Loading

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • 📝 Generate Docstrings

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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1ab48bc and 4a3fd3b.

📒 Files selected for processing (2)
  • docs/releases.rst (1 hunks)
  • tmt/base.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
tmt/base.py (1)
tmt/lint.py (1)
  • LinterOutcome (93-98)
⏰ Context from checks skipped due to timeout of 90000ms (63)
  • GitHub Check: testing-farm:centos-stream-9-x86_64:core
  • GitHub Check: testing-farm:centos-stream-9-x86_64:core
  • GitHub Check: testing-farm:centos-stream-9-x86_64:core
  • GitHub Check: testing-farm:centos-stream-9-x86_64:core
  • GitHub Check: testing-farm:centos-stream-9-x86_64:core
  • GitHub Check: testing-farm:centos-stream-9-x86_64:core
  • GitHub Check: osh-diff-scan:fedora-rawhide-x86_64
  • GitHub Check: testing-farm:fedora-41-x86_64:core
  • GitHub Check: testing-farm:fedora-41-x86_64:core
  • GitHub Check: testing-farm:fedora-41-x86_64:core
  • GitHub Check: testing-farm:fedora-41-x86_64:internal-wow
  • GitHub Check: testing-farm:fedora-41-x86_64:internal-plugins
  • GitHub Check: testing-farm:fedora-41-x86_64:provision
  • GitHub Check: testing-farm:fedora-rawhide-x86_64:full
  • GitHub Check: testing-farm:fedora-41-x86_64:extended-unit-tests
  • GitHub Check: testing-farm:fedora-40-x86_64:full
  • GitHub Check: rpm-build:fedora-rawhide-x86_64
  • GitHub Check: testing-farm:fedora-41-x86_64:full
  • GitHub Check: rpm-build:fedora-40-x86_64
  • GitHub Check: testing-farm:fedora-41-x86_64:core
  • GitHub Check: rpm-build:fedora-41-x86_64
  • GitHub Check: testing-farm:fedora-42-x86_64:full
  • GitHub Check: testing-farm:centos-stream-9-x86_64:full
  • GitHub Check: rpm-build:fedora-42-x86_64
  • GitHub Check: testing-farm:centos-stream-9-x86_64:core
  • GitHub Check: rpm-build:epel-9-x86_64
  • GitHub Check: rpm-build:fedora-rawhide-x86_64
  • GitHub Check: rpm-build:fedora-41-x86_64
  • GitHub Check: rpm-build:fedora-40-x86_64
  • GitHub Check: rpm-build:fedora-42-x86_64
  • GitHub Check: rpm-build:epel-9-x86_64
  • GitHub Check: testing-farm:fedora-41-x86_64:internal-wow
  • GitHub Check: testing-farm:fedora-41-x86_64:internal-plugins
  • GitHub Check: testing-farm:fedora-41-x86_64:provision
  • GitHub Check: testing-farm:fedora-41-x86_64:extended-unit-tests
  • GitHub Check: testing-farm:fedora-rawhide-x86_64:full
  • GitHub Check: testing-farm:centos-stream-9-x86_64:full
  • GitHub Check: testing-farm:fedora-40-x86_64:full
  • GitHub Check: testing-farm:fedora-42-x86_64:full
  • GitHub Check: testing-farm:fedora-41-x86_64:full
  • GitHub Check: testing-farm:centos-stream-9-x86_64:core
  • GitHub Check: testing-farm:fedora-41-x86_64:core
  • GitHub Check: rpm-build:fedora-rawhide-x86_64
  • GitHub Check: rpm-build:fedora-41-x86_64
  • GitHub Check: rpm-build:fedora-40-x86_64
  • GitHub Check: rpm-build:fedora-42-x86_64
  • GitHub Check: testing-farm:fedora-42-x86_64:internal-wow
  • GitHub Check: rpm-build:epel-9-x86_64
  • GitHub Check: testing-farm:fedora-42-x86_64:internal-plugins
  • GitHub Check: testing-farm:fedora-42-x86_64:provision
  • GitHub Check: testing-farm:fedora-42-x86_64:extended-unit-tests
  • GitHub Check: testing-farm:fedora-41-x86_64:full
  • GitHub Check: testing-farm:fedora-42-x86_64:full
  • GitHub Check: testing-farm:fedora-40-x86_64:full
  • GitHub Check: testing-farm:fedora-rawhide-x86_64:full
  • GitHub Check: testing-farm:centos-stream-9-x86_64:full
  • GitHub Check: testing-farm:centos-stream-9-x86_64:core
  • GitHub Check: testing-farm:fedora-42-x86_64:core
  • GitHub Check: rpm-build:fedora-42-x86_64
  • GitHub Check: rpm-build:fedora-41-x86_64
  • GitHub Check: rpm-build:fedora-40-x86_64
  • GitHub Check: rpm-build:fedora-rawhide-x86_64
  • GitHub Check: rpm-build:epel-9-x86_64
🔇 Additional comments (1)
tmt/base.py (1)

1089-1089: Schema validation failures now cause lint checks to fail rather than just warn.

The schema validation outcome has been changed from LinterOutcome.WARN to LinterOutcome.FAIL, which aligns with the PR objective of making lint checks fail instead of warn. This change will enforce stricter validation and cause the tmt lint command to exit with code 1 when an invalid key is encountered in fmf metadata.

@teemtee teemtee deleted a comment from coderabbitai bot Apr 11, 2025
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.

3 participants