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

🧹 chore: Mark unused tests with t.SkipNow #3366

Merged
merged 2 commits into from
Mar 20, 2025

Conversation

alexandear
Copy link
Contributor

Description

This PR uncomments Test_CSRF_UnsafeHeaderValue and marks it with t.SkipNow().

Using t.SkipNow in tests allows the test to be skipped while still being compiled and visible in the test output, which helps in tracking and revisiting skipped tests. Commenting out tests removes them from the compilation and test output, making it easier to forget about them.

Changes introduced

List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide.

  • Benchmarks: Describe any performance benchmarks and improvements related to the changes.
  • Documentation Update: Detail the updates made to the documentation and links to the changed files.
  • Changelog/What's New: Include a summary of the additions for the upcoming release notes.
  • Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes.
  • API Alignment with Express: Explain how the changes align with the Express API.
  • API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes.
  • Examples: Provide examples demonstrating the new features or changes in action.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • Enhancement (improvement to existing features and functionality)
  • Documentation update (changes to documentation)
  • Performance improvement (non-breaking change which improves efficiency)
  • Code consistency (non-breaking change which improves code reliability and robustness)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

  • Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.
  • Added or updated unit tests to validate the effectiveness of the changes or new features.
  • Ensured that new and existing unit tests pass locally with the changes.
  • Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
  • Aimed for optimal performance with minimal allocations in the new code.
  • Provided benchmarks for the new code to analyze and improve upon.

Commit formatting

Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md

@alexandear alexandear requested a review from a team as a code owner March 20, 2025 12:39
@alexandear alexandear requested review from gaby, sixcolors, ReneWerner87 and efectn and removed request for a team March 20, 2025 12:39
Copy link

welcome bot commented Mar 20, 2025

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Copy link
Contributor

coderabbitai bot commented Mar 20, 2025

Walkthrough

The pull request integrates a previously commented-out test by adding the Test_CSRF_UnsafeHeaderValue function in the CSRF middleware test file. The new test sets up a Fiber application with GET and POST routes, then verifies CSRF token generation and validation, particularly with unsafe header values. The test now uses t.SkipNow() to mark it as incomplete and logs via t.Log instead of using fmt.Println, ensuring that assertions regarding CSRF protection are in place.

Changes

File Change Summary
middleware/csrf/csrf_test.go Added Test_CSRF_UnsafeHeaderValue to test handling of unsafe header values. Sets up a Fiber app with GET/POST routes, logs via t.Log, uses t.SkipNow(), and re-integrates previously commented-out testing code.

Sequence Diagram(s)

sequenceDiagram
    participant T as Test
    participant A as Fiber App
    participant M as CSRF Middleware

    T->>A: Send GET request to retrieve CSRF token
    A->>M: Request token generation
    M-->>A: Return generated token
    A-->>T: Respond with CSRF token
    T->>A: Send POST request with unsafe header and token
    A->>M: Validate CSRF token and header
    M-->>A: Return validation result
    A-->>T: Respond with CSRF validation outcome
Loading

Poem

I'm a little rabbit, coding in delight,
Hopping through tests in the soft moonlight.
CSRF tokens dance, headers play their part,
With Fiber and logs, they've won my heart.
Happy changes make my code world bright! 🐰✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b570cd5 and 3a748eb.

📒 Files selected for processing (1)
  • middleware/csrf/csrf_test.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • middleware/csrf/csrf_test.go

Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

🪧 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 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.

@gaby gaby changed the title 🚨 test: uncomment test and mark it with t.SkipNow 🧹 chore: Mark unused tests with t.SkipNow Mar 20, 2025
@gaby gaby added the v3 label Mar 20, 2025
Copy link
Member

@gaby gaby left a comment

Choose a reason for hiding this comment

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

👍 LGTM

Copy link

codecov bot commented Mar 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.73%. Comparing base (87f3f0c) to head (3a748eb).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3366   +/-   ##
=======================================
  Coverage   83.73%   83.73%           
=======================================
  Files         118      118           
  Lines       11728    11728           
=======================================
  Hits         9821     9821           
  Misses       1481     1481           
  Partials      426      426           
Flag Coverage Δ
unittests 83.73% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gaby
Copy link
Member

gaby commented Mar 20, 2025

@alexandear Lint checks are failing. Make sure to run latesr golangci-lint locally

@ReneWerner87 ReneWerner87 merged commit f6ac929 into gofiber:main Mar 20, 2025
17 of 18 checks passed
Copy link

welcome bot commented Mar 20, 2025

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

@alexandear alexandear deleted the chore/uncomment-test branch March 20, 2025 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants