Add validation for zip_release and zip_filename with refactor

[klaasnicolaas]

Proposed change

This PR will add validation support for zip_release and zip_filename.

But I did also a refactor to make it easier to do add custom validations in the future.

Additional information

• This PR fixes or closes issue: fixes #

Checklist

• I have updated the documentation if needed.
• I have updated the tests if needed.

Summary by CodeRabbit

• New Features

  • Added optional fields for zip release validation in manifest checks
  • Introduced zip_release and zip_filename configuration options

• Refactor

  • Improved error handling and validation logic for manifest checks
  • Restructured validation process with dedicated methods for schema and custom rule checks

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes modify the manifest validation process in the rhfest/checks/manifest.py file. Two new optional fields, zip_release and zip_filename, are introduced to the MANIFEST_SCHEMA. The validation logic is refactored to improve error handling and add specific checks for these new fields. The ManifestCheck class now uses a more structured approach to validation, with separate methods for schema validation and custom rule checking, and collects errors in a dedicated list for more comprehensive reporting.

Changes

File	Change Summary
rhfest/checks/manifest.py	- Added zip_release (boolean) field to MANIFEST_SCHEMA - Added zip_filename (string with regex validation) field to MANIFEST_SCHEMA - Refactored validation logic in ManifestCheck class - Introduced self.errors list for error tracking - Created _validate_schema and _validate_custom_rules methods - Added _add_error method for error formatting

Sequence Diagram

sequenceDiagram
    participant MC as ManifestCheck
    participant VS as Validation Schema
    participant CR as Custom Rules

    MC->>VS: _validate_schema()
    VS-->>MC: Capture schema validation errors

    MC->>CR: _validate_custom_rules()
    CR-->>MC: Check zip-related conditions

    MC->>MC: Collect errors in self.errors

    alt Errors exist
        MC->>MC: Log failure message
    else No errors
        MC->>MC: Log success message
    end

Loading

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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. (Beta)
• @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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

rhfest/checks/manifest.py (1)

22-23: Consider broader filename patterns for .zip.
The regex enforces strictly lowercase alphanumeric, underscores, or hyphens, plus the .zip extension. If uppercase or other valid characters (e.g., uppercase .ZIP) are acceptable, extend the pattern or make it case-insensitive.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 83b30da and 6a435a7.

📒 Files selected for processing (1)

• rhfest/checks/manifest.py (3 hunks)

🔇 Additional comments (5)

rhfest/checks/manifest.py (5)

36-37: Good practice to initialize error tracking.
Initializing self.errors here ensures a clean slate for each class instance.

---

38-49: Centralized error logging is clean and maintainable.
Capturing and formatting the error path is a neat approach, improving clarity during debugging.

---

50-65: Schema validation segregated for clarity.
Separating the schema validation logic into its own method enhances readability and maintainability.

---

66-78: Optional rule: Validate the inverse relationship.
If zip_filename is provided without zip_release set to true, consider whether it should also trigger an error. Currently, this code only checks that zip_filename is present if zip_release is true.

---

91-106: Refined validation flow looks clean.
Reinitializing errors and calling separate validation methods fosters a clear and modular approach. Returning pass/fail statuses with error logging is also well-structured.