feature/fluentvalidation #203

nanotaboada · 2025-04-10T18:36:13Z

Summary by CodeRabbit

New Features
- Enhanced API documentation now dynamically loads metadata (version, title, description, contact, and license details).
- Introduced advanced player data validation that provides improved error handling and user feedback.
Refactor
- Streamlined player request processing with asynchronous validations and cleaner error logging.
- Updated methods related to position management using modern syntax for improved maintainability.
Chores
- Updated dependencies and configuration settings to support the new validation framework and documentation enhancements.
- Added configuration for SonarLint integration.
- Introduced exclusion patterns for Codacy and Codecov to ignore FluentValidation validators.
- Added support for code coverage with coverlet.collector.

coderabbitai · 2025-04-10T18:36:23Z

Walkthrough

The pull request integrates FluentValidation into the API, updating validation logic in the PlayerController for POST and PUT endpoints. It adds a new validator class for PlayerRequestModel, modifies dependency injection in Program.cs, and updates test mocks and assertions to use the new validator. Additionally, configuration files have been enhanced with SonarLint and SwaggerDoc settings, and minor code refactoring is applied in the Position enum. Dependency management files are updated to include FluentValidation, and model validation attributes are removed from certain properties in PlayerRequestModel.

Changes

File(s)	Change Summary
`.vscode/settings.json` `src/.../appsettings.Development.json` `src/.../appsettings.json`	Added configuration sections: SonarLint connected mode in settings.json and SwaggerDoc metadata in both appsettings files
`src/.../Dotnet.Samples.AspNetCore.WebApi.csproj` `src/.../packages.lock.json` `test/.../packages.lock.json`	Added FluentValidation dependency (v11.11.0) to both project and test dependency lock files
`src/Dotnet.Samples.AspNetCore.WebApi/Controllers/PlayerController.cs` `src/Dotnet.Samples.AspNetCore.WebApi/Program.cs`	Updated controller to use IValidator for PlayerRequestModel validation; registered the validator service and updated Swagger configuration in Program.cs
`src/Dotnet.Samples.AspNetCore.WebApi/Models/PlayerRequestModel.cs` `src/Dotnet.Samples.AspNetCore.WebApi/Validators/PlayerRequestModelValidator.cs`	Removed [Required] attributes from certain PlayerRequestModel properties and added a new FluentValidation-based validator class
`test/Dotnet.Samples.AspNetCore.WebApi.Tests/Unit/PlayerControllerTests.cs` `test/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerMocks.cs`	Updated tests to incorporate the new validator for validating requests and modified mock setups to include a validator mock
`src/Dotnet.Samples.AspNetCore.WebApi/Enums/Position.cs`	Refactored methods using expression-bodied syntax and added a new method (IsValidAbbr) for validating position abbreviations

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant PC as PlayerController
    participant V as Validator
    participant S as PlayerService

    C->>PC: POST request with PlayerRequestModel
    PC->>V: ValidateAsync(PlayerRequestModel)
    V-->>PC: ValidationResult (errors or valid)
    alt Validation errors
      PC->>C: Return 400 Bad Request with error details
    else Valid model
      PC->>S: Check if Player exists
      S-->>PC: Player exists or not
      PC->>C: Return appropriate response
    end

Possibly related PRs

feat(data)!: implement Repository pattern #189: The changes in the main PR, which focus on enhancing validation for the PlayerRequestModel and integrating FluentValidation, are related to the retrieved PR as both involve modifications to the PlayerController and its associated tests, specifically in how validation is handled in the controller's methods.
feat(service)!: migrate to AutoMapper for Model mapping #194: The changes in the main PR, which involve the introduction of a new PlayerRequestModel and modifications to the PlayerController to utilize this model, are directly related to the changes in the retrieved PR, where the PlayerControllerTests and PlayerServiceTests have been updated to use PlayerRequestModel and PlayerResponseModel instead of the Player model, indicating a shared focus on the new request and response models.

📜 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 c9e574e and d20e2de.

📒 Files selected for processing (1)

codecov.yml (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

codecov.yml

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

GitHub Check: Codacy Static Code Analysis

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

src/Dotnet.Samples.AspNetCore.WebApi/Validators/PlayerRequestModelValidator.cs

codacy-production · 2025-04-10T18:38:01Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ -2.43%	✅ 55.36%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`2a68b49`)	825	205	24.85%
Head commit (`d20e2de`)	794 (-31)	178 (-27)	22.42% (-2.43%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#203)	56	31	55.36%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

codecov · 2025-04-10T18:38:15Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2a68b49) to head (d20e2de).
Report is 8 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #203   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          158       165    +7     
  Branches         9        14    +5     
=========================================
+ Hits           158       165    +7

Components	Coverage Δ
Controllers	`100.00% <100.00%> (ø)`
Services	`100.00% <ø> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

src/Dotnet.Samples.AspNetCore.WebApi/Validators/PlayerRequestModelValidator.cs (1)
7-26: Well-structured validator implementation with appropriate validation rules.

The validator follows FluentValidation best practices with:

Clear validation rules for required fields

Specific error messages for each validation condition

Domain validation for AbbrPosition using the Position.IsValidAbbr method

Appropriate numerical validation for SquadNumber

This implementation enhances the API's input validation by moving from attribute-based validation to a more flexible and testable approach.

Consider adding validation for DateOfBirth if there are business rules around valid dates (e.g., not in the future, minimum age requirements).
// Example of potential DateOfBirth validation
RuleFor(x => x.DateOfBirth)
    .LessThanOrEqualTo(DateTime.UtcNow.Date)
    .WithMessage("DateOfBirth cannot be in the future.");
src/Dotnet.Samples.AspNetCore.WebApi/Controllers/PlayerController.cs (1)
20-20: Inconsistent naming convention for private field.

The naming convention for the validator field differs from other private fields in the class, which use the underscore prefix (_).
-    private readonly IValidator<PlayerRequestModel> validator = validator;
+    private readonly IValidator<PlayerRequestModel> _validator = validator;
test/Dotnet.Samples.AspNetCore.WebApi.Tests/Unit/PlayerControllerTests.cs (1)
419-426: Code duplication in test setup.

There's duplication in how validation success is set up across multiple test methods. Consider refactoring to a helper method.
+ private static void SetupValidatorSuccess(Mock<IValidator<PlayerRequestModel>> validator)
+ {
+     validator
+         .Setup(validator =>
+             validator.ValidateAsync(
+                 It.IsAny<PlayerRequestModel>(),
+                 It.IsAny<CancellationToken>()
+             )
+         )
+         .ReturnsAsync(new ValidationResult(new List<ValidationFailure> { }));
+ }
+
+ private static void SetupValidatorFailure(Mock<IValidator<PlayerRequestModel>> validator, string propertyName, string errorMessage)
+ {
+     validator
+         .Setup(validator => validator.ValidateAsync(It.IsAny<PlayerRequestModel>(), It.IsAny<CancellationToken>()))
+         .ReturnsAsync(
+             new ValidationResult(
+                 new List<ValidationFailure>
+                 {
+                     new(propertyName, errorMessage)
+                 }
+             )
+         );
+ }
Then use these helper methods in your tests:
// For validation success
SetupValidatorSuccess(validator);

// For validation failure
SetupValidatorFailure(validator, "SquadNumber", "SquadNumber must be greater than 0.");

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2a68b49 and 17ccd5e.

📒 Files selected for processing (13)

.vscode/settings.json (1 hunks)
src/Dotnet.Samples.AspNetCore.WebApi/Controllers/PlayerController.cs (3 hunks)
src/Dotnet.Samples.AspNetCore.WebApi/Dotnet.Samples.AspNetCore.WebApi.csproj (1 hunks)
src/Dotnet.Samples.AspNetCore.WebApi/Enums/Position.cs (1 hunks)
src/Dotnet.Samples.AspNetCore.WebApi/Models/PlayerRequestModel.cs (0 hunks)
src/Dotnet.Samples.AspNetCore.WebApi/Program.cs (2 hunks)
src/Dotnet.Samples.AspNetCore.WebApi/Validators/PlayerRequestModelValidator.cs (1 hunks)
src/Dotnet.Samples.AspNetCore.WebApi/appsettings.Development.json (1 hunks)
src/Dotnet.Samples.AspNetCore.WebApi/appsettings.json (1 hunks)
src/Dotnet.Samples.AspNetCore.WebApi/packages.lock.json (1 hunks)
test/Dotnet.Samples.AspNetCore.WebApi.Tests/Unit/PlayerControllerTests.cs (16 hunks)
test/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerMocks.cs (2 hunks)
test/Dotnet.Samples.AspNetCore.WebApi.Tests/packages.lock.json (2 hunks)

💤 Files with no reviewable changes (1)

src/Dotnet.Samples.AspNetCore.WebApi/Models/PlayerRequestModel.cs

🧰 Additional context used

🧬 Code Graph Analysis (5)

src/Dotnet.Samples.AspNetCore.WebApi/Program.cs (2)

src/Dotnet.Samples.AspNetCore.WebApi/Models/PlayerRequestModel.cs (1)

PlayerRequestModel (13-32)

src/Dotnet.Samples.AspNetCore.WebApi/Validators/PlayerRequestModelValidator.cs (2)

PlayerRequestModelValidator (7-27)

PlayerRequestModelValidator (9-26)

src/Dotnet.Samples.AspNetCore.WebApi/Validators/PlayerRequestModelValidator.cs (2)

src/Dotnet.Samples.AspNetCore.WebApi/Models/PlayerRequestModel.cs (1)

PlayerRequestModel (13-32)

src/Dotnet.Samples.AspNetCore.WebApi/Enums/Position.cs (5)

Position (3-63)

Position (19-20)

Position (33-34)

Position (47-48)

IsValidAbbr (61-62)

test/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerMocks.cs (2)

src/Dotnet.Samples.AspNetCore.WebApi/Models/PlayerRequestModel.cs (1)

PlayerRequestModel (13-32)

test/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerFakes.cs (2)

PlayerRequestModel (208-224)

PlayerRequestModel (253-271)

src/Dotnet.Samples.AspNetCore.WebApi/Controllers/PlayerController.cs (2)

src/Dotnet.Samples.AspNetCore.WebApi/Models/PlayerRequestModel.cs (1)

PlayerRequestModel (13-32)

test/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerFakes.cs (2)

PlayerRequestModel (208-224)

PlayerRequestModel (253-271)

test/Dotnet.Samples.AspNetCore.WebApi.Tests/Unit/PlayerControllerTests.cs (6)

src/Dotnet.Samples.AspNetCore.WebApi/Services/IPlayerService.cs (6)

Task (16-16)

Task (23-23)

Task (33-33)

Task (43-43)

Task (50-50)

Task (57-57)

src/Dotnet.Samples.AspNetCore.WebApi/Services/PlayerService.cs (2)

Task (28-39)

Task (45-77)

test/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerFakes.cs (7)

PlayerFakes (13-292)

List (15-171)

List (173-188)

PlayerRequestModel (208-224)

PlayerRequestModel (253-271)

PlayerResponseModel (226-242)

PlayerResponseModel (273-291)

test/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerMocks.cs (1)

PlayerMocks (22-88)

src/Dotnet.Samples.AspNetCore.WebApi/Models/PlayerRequestModel.cs (1)

PlayerRequestModel (13-32)

src/Dotnet.Samples.AspNetCore.WebApi/Models/PlayerResponseModel.cs (1)

PlayerResponseModel (11-28)

🪛 GitHub Check: Sonarcsharp (reported by Codacy)

src/Dotnet.Samples.AspNetCore.WebApi/Validators/PlayerRequestModelValidator.cs

[warning] 1-1:
Analyzer 'SonarAnalyzer.Rules.CSharp.SymbolicExecutionRunner' threw an exception of type 'System.NullReferenceException' with message 'Object reference not set to an instance of an object.'.
Exception occurred with following context:
Compilation: srcassembly.dll
SyntaxTree: PlayerRequestModelValidator.cs
SyntaxNode: x => x.AbbrPosition [SimpleLambdaExpressionSyntax]@[695..714) (20,16)-(20,35)