Made Security Header Parameters safe for C# when unsafe characters are present

[AragornHL]

When adding security parameters with characters not safe as C# parameter names (e.g. Punctuation characters '.') we need to convert these characters to safe characters (e.g. '_')

Summary by CodeRabbit

• New Features
  • Improved handling of authentication headers with unsafe characters in generated code.
• Tests
  • Added new tests to verify correct code generation for authentication headers with unsafe characters using various Swagger Petstore specification formats (JSON/YAML, OpenAPI 2/3).
• Chores
  • Added new sample Swagger and OpenAPI specification files with unsafe authentication headers for comprehensive test coverage.

[coderabbitai]

Walkthrough

The changes introduce logic to sanitize variable names for authentication headers by replacing unsafe Unicode punctuation characters with underscores in the core parameter extraction process. To support this, new sample Swagger/OpenAPI specification files with intentionally "unsafe" authentication header names are added for both v2 and v3, in JSON and YAML formats. The test infrastructure is extended with new enum members and resource accessors for these files. Parameterized tests are introduced to verify that code generation correctly handles these unsafe header names, ensuring the generated code uses safe variable names while preserving the original header string.

Changes

File(s) / Group	Change Summary
src/Refitter.Core/ParameterExtractor.cs	Added a private static method to replace unsafe Unicode punctuation characters in variable names. Updated parameter extraction logic to use this sanitization for header parameters from security schemes.
src/Refitter.Tests/Resources/EmbeddedResources.cs src/Refitter.Tests/Resources/SampleOpenSpecifications.cs	Added four new enum members and corresponding static properties to access new sample specs with unsafe authentication headers. Updated resource accessor method to support these cases.
src/Refitter.Tests/Resources/V2/SwaggerPetstoreWithUnsafeAuthenticationHeaders.json src/Refitter.Tests/Resources/V2/SwaggerPetstoreWithUnsafeAuthenticationHeaders.yaml src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithUnsafeAuthenticationHeaders.json src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithUnsafeAuthenticationHeaders.yaml	Added four new Swagger/OpenAPI specification files (v2 and v3, JSON and YAML) with authentication headers using unsafe characters.
src/Refitter.Tests/SwaggerPetstoreTests.cs src/Refitter.Tests/SwaggerPetstoreApizrTests.cs	Added new parameterized test methods to verify code generation with unsafe authentication headers, asserting correct header attribute and variable name sanitization.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant CodeGenerator
    participant ParameterExtractor

    TestRunner->>CodeGenerator: Generate code from spec with unsafe header
    CodeGenerator->>ParameterExtractor: Extract parameters (including headers)
    ParameterExtractor->>ParameterExtractor: ReplaceUnsafeCharacters(headerName)
    ParameterExtractor-->>CodeGenerator: Return sanitized variable name and original header string
    CodeGenerator-->>TestRunner: Output code with [Header("auth.key")] string auth_key
    TestRunner->>TestRunner: Assert code contains correct header attribute and variable name

Loading

Poem

In files and specs, some headers misbehave,
With dots and dashes, quite hard to save.
But now with code that cleans each name,
Unsafe to safe, it tames the game!
Tests hop along, all passing through—
A rabbit’s cheer: “Sanitize, renew!”
🐇✨

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2f3b918 and 8955d64.

📒 Files selected for processing (9)

• src/Refitter.Core/ParameterExtractor.cs (3 hunks)
• src/Refitter.Tests/Resources/EmbeddedResources.cs (2 hunks)
• src/Refitter.Tests/Resources/SampleOpenSpecifications.cs (1 hunks)
• src/Refitter.Tests/Resources/V2/SwaggerPetstoreWithUnsafeAuthenticationHeaders.json (1 hunks)
• src/Refitter.Tests/Resources/V2/SwaggerPetstoreWithUnsafeAuthenticationHeaders.yaml (1 hunks)
• src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithUnsafeAuthenticationHeaders.json (1 hunks)
• src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithUnsafeAuthenticationHeaders.yaml (1 hunks)
• src/Refitter.Tests/SwaggerPetstoreApizrTests.cs (1 hunks)
• src/Refitter.Tests/SwaggerPetstoreTests.cs (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/Refitter.Tests/SwaggerPetstoreTests.cs (1)

src/Refitter.Core/RefitGenerator.cs (2)

• Task (17-26)
• Task (28-38)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: 👌 Verify build
• GitHub Check: script
• GitHub Check: 👌 Verify build
• GitHub Check: 👌 Verify build

🔇 Additional comments (11)

src/Refitter.Core/ParameterExtractor.cs (2)

58-58: Good implementation of character replacement for security header parameters.

The code now replaces unsafe characters in security scheme names, ensuring they're valid variable names in C# while preserving the original header name in the API request.

---

99-115: LGTM! Character sanitization implementation looks correct.

The ReplaceUnsafeCharacters method properly handles Unicode punctuation characters by:

1. Iterating through each character
2. Checking for characters in the UnicodeCategory.OtherPunctuation category
3. Replacing them with underscores
4. Preserving all other characters

This effectively addresses the issue with unsafe characters in header parameter names.

src/Refitter.Tests/Resources/SampleOpenSpecifications.cs (1)

17-20: LGTM! Appropriate test specifications added.

The new enum values properly extend the test matrix to include unsafe authentication header scenarios in multiple formats.

src/Refitter.Tests/SwaggerPetstoreApizrTests.cs (1)

261-271: LGTM! Test case properly validates the unsafe header handling.

This test case correctly verifies that headers with unsafe characters (like "auth.key") are properly handled while maintaining the original header name in the request but using a safe variable name (auth_key) in the generated code.

src/Refitter.Tests/SwaggerPetstoreTests.cs (1)

264-275: LGTM! Comprehensive test coverage for the feature.

This test correctly validates the same functionality as in the Apizr test case, ensuring consistent behavior across different test scenarios. The test properly confirms that unsafe header names are preserved in the Header attribute while variable names are sanitized.

src/Refitter.Tests/Resources/V2/SwaggerPetstoreWithUnsafeAuthenticationHeaders.yaml (1)

554-558: Well-structured test case for unsafe authentication headers!

The security definition correctly includes an API key with the name "auth.key" containing a character (.) that is unsafe for C# parameter names, providing a good test case for the character sanitization feature.

src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithUnsafeAuthenticationHeaders.yaml (1)

732-735: Proper OpenAPI v3 test case for unsafe header names!

The security scheme correctly defines an API key with name "auth.key" containing a dot character, which is unsafe for C# parameter names. This provides a comprehensive test case for the character sanitization feature in OpenAPI v3 format.

src/Refitter.Tests/Resources/V2/SwaggerPetstoreWithUnsafeAuthenticationHeaders.json (1)

788-792: Appropriate JSON test resource for unsafe auth headers!

The security definition properly includes an API key with name "auth.key" that contains a character unsafe for C# parameter names. This JSON format complements the YAML version to ensure comprehensive format coverage for testing the character sanitization feature.

src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithUnsafeAuthenticationHeaders.json (1)

1102-1107: Complete OpenAPI v3 JSON test case for unsafe headers!

The security scheme correctly defines an API key with name "auth.key", providing a JSON-formatted test case for the character sanitization feature. This complements the YAML version and ensures thorough testing across different formats and OpenAPI versions.

src/Refitter.Tests/Resources/EmbeddedResources.cs (2)

143-185: Clean implementation of resource accessors!

The new properties follow the established pattern in this class and correctly expose the new test resources with unsafe authentication headers in both JSON and YAML formats for Swagger v2 and OpenAPI v3.

---

233-240: Proper extension of the GetSwaggerPetstore method!

The switch cases for the new specifications are correctly added, maintaining consistency with the existing pattern and ensuring the new test resources are accessible through the standard method.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in 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.

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.

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

Attention: Patch coverage is 75.75758% with 8 lines in your changes missing coverage. Please review.

Project coverage is 98.49%. Comparing base (2ebf63f) to head (8955d64).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
src/Refitter.Tests/Resources/EmbeddedResources.cs	66.66%	0 Missing and 8 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #663      +/-   ##
==========================================
+ Coverage   95.47%   98.49%   +3.02%     
==========================================
  Files          59       59              
  Lines        2896     2863      -33     
==========================================
+ Hits         2765     2820      +55     
+ Misses         99        4      -95     
- Partials       32       39       +7     

Flag	Coverage Δ
unittests	98.49% <75.75%> (+3.02%)	⬆️

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.

[AragornHL]

@christianhelle Created this PR to fix an issue when unsafe Authentication Headers are used

[Copilot]

Pull Request Overview

This PR improves the handling of security header parameters by replacing unsafe characters (e.g. punctuation) with safe ones (e.g. underscores) to generate valid C# parameter names.

• Added new tests to verify that code generation correctly sanitizes unsafe authentication header names in both SwaggerPetstoreTests.cs and SwaggerPetstoreApizrTests.cs.
• Extended resource files with specifications containing unsafe headers.
• Updated ParameterExtractor.cs to replace unsafe characters during header parameter extraction.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/Refitter.Tests/SwaggerPetstoreTests.cs	Adds tests for generating code with unsafe authentication headers.
src/Refitter.Tests/SwaggerPetstoreApizrTests.cs	Adds similar tests for Apizr integration ensuring unsafe headers are sanitized appropriately.
src/Refitter.Tests/Resources/SampleOpenSpecifications.cs	Includes new enumeration entries for specifications with unsafe headers.
src/Refitter.Tests/Resources/EmbeddedResources.cs	Provides new embedded resource getters for unsafe header specification files.
src/Refitter.Core/ParameterExtractor.cs	Implements character sanitization by replacing unsafe characters in header names.

[christianhelle]

@AragornHL good catch!

Thanks for the contribution