Skip to content
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

ADD IMMUTABLE TESTS? #203

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Warxcell
Copy link

@Warxcell Warxcell commented Aug 14, 2024

Reason for This PR

roadrunner-server/static#126

Description of Changes

Add tests to assure that immutable works same way as mutable.

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the MIT license.

PR Checklist

[Author TODO: Meet these criteria.]
[Reviewer TODO: Verify that these criteria are met. Request changes if not]

  • All commits in this PR are signed (git commit -s).
  • The reason for this PR is clearly provided (issue no. or explanation).
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • Any user-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.

Summary by CodeRabbit

  • Tests
    • Refactored test functions for improved clarity and reusability.
    • Introduced helper functions for better organization and reduced redundancy in tests.
    • Updated plugin test configuration to streamline the setup process, allowing easy toggling between immutable and mutable settings.

Copy link

coderabbitai bot commented Aug 14, 2024

Walkthrough

The recent changes to the test suite in http_plugin_test.go enhance code clarity by introducing helper functions for common testing scenarios. This refactoring reduces redundancy and streamlines the configuration process, allowing for easier toggling of settings. The overall test logic and error handling remain intact, ensuring robust testing while improving maintainability and organization.

Changes

Files Change Summary
tests/http_plugin_test.go Refactored test functions into reusable helper functions. Updated configuration to include Flags for http.static.immutable, enhancing clarity and reducing redundancy.

Poem

In a world of code so bright,
A rabbit hops with pure delight.
With helpers here to ease the strain,
Our tests now dance in joyful gain.
So let us cheer, with hearts so light,
For clearer paths in coding's flight! 🐇✨


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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 696d5e9 and 0132c18.

Files selected for processing (1)
  • tests/http_plugin_test.go (4 hunks)
Additional comments not posted (4)
tests/http_plugin_test.go (4)

1799-1868: Helper Function staticEtagPlugin Introduced.

The introduction of staticEtagPlugin as a helper function improves test modularity and reusability. The use of the immutable flag allows for flexible testing of both mutable and immutable configurations.


1917-1985: Helper Function staticPluginSecurity Introduced.

The staticPluginSecurity function is a well-structured addition that enhances test clarity and reusability. It effectively uses the immutable flag to test different configurations.


2145-2215: Helper Function staticPlugin Introduced.

The staticPlugin function is a well-organized helper that aids in testing static plugin behavior with both mutable and immutable settings. This enhances the test suite's modularity and readability.


2369-2448: Helper Function staticFilesForbidWrapper Introduced.

The staticFilesForbidWrapper function is a well-structured addition that tests file forbidding functionality using the immutable flag. It maintains consistency with other helper functions, improving test clarity and reusability.

@rustatian
Copy link
Member

Hey @Warxcell 👋
Thank you for the PR, I remember about it and your PR, I need some more time to review that due to the lack of time 😢

@rustatian rustatian marked this pull request as draft September 5, 2024 13:11
@rustatian rustatian self-requested a review September 5, 2024 13:11
@rustatian rustatian added the enhancement New feature or request label Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants