From 0335b7bddaa457e7d71b9449c2fe4f31c6ecfc91 Mon Sep 17 00:00:00 2001 From: StevanFreeborn Date: Wed, 29 Jun 2022 12:35:13 -0500 Subject: [PATCH] begin writing tests for controllers --- .editorconfig | 6 +++ criminalmindsapi.sln | 6 +++ server/Controllers/v1/CharactersController.cs | 4 +- server/Controllers/v1/EpisodesController.cs | 4 +- server/Controllers/v1/QuotesController.cs | 4 +- server/Controllers/v1/SeasonsController.cs | 4 +- server/server.csproj | 1 + tests/Usings.cs | 1 + .../controllers/CharactersControllerTests.cs | 40 +++++++++++++++++++ tests/tests.csproj | 28 +++++++++++++ 10 files changed, 90 insertions(+), 8 deletions(-) create mode 100644 tests/Usings.cs create mode 100644 tests/controllers/CharactersControllerTests.cs create mode 100644 tests/tests.csproj diff --git a/.editorconfig b/.editorconfig index 801f4f7..732666a 100644 --- a/.editorconfig +++ b/.editorconfig @@ -8,3 +8,9 @@ dotnet_diagnostic.CS8604.severity = none # CS1591: Missing XML comment for publicly visible type or member dotnet_diagnostic.CS1591.severity = none + +# CS8629: Nullable value type may be null. +dotnet_diagnostic.CS8629.severity = silent + +# CS8602: Dereference of a possibly null reference. +dotnet_diagnostic.CS8602.severity = silent diff --git a/criminalmindsapi.sln b/criminalmindsapi.sln index 71e421e..e3a131e 100644 --- a/criminalmindsapi.sln +++ b/criminalmindsapi.sln @@ -15,6 +15,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution .editorconfig = .editorconfig EndProjectSection EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "tests", "tests\tests.csproj", "{B78134BA-1C1D-43CC-9B41-78C67B057AAC}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -31,6 +33,10 @@ Global {1EF6EB3C-FCA0-4FF6-8A99-373AFAC6E4EC}.Debug|Any CPU.Build.0 = Debug|Any CPU {1EF6EB3C-FCA0-4FF6-8A99-373AFAC6E4EC}.Release|Any CPU.ActiveCfg = Release|Any CPU {1EF6EB3C-FCA0-4FF6-8A99-373AFAC6E4EC}.Release|Any CPU.Build.0 = Release|Any CPU + {B78134BA-1C1D-43CC-9B41-78C67B057AAC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B78134BA-1C1D-43CC-9B41-78C67B057AAC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B78134BA-1C1D-43CC-9B41-78C67B057AAC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B78134BA-1C1D-43CC-9B41-78C67B057AAC}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/server/Controllers/v1/CharactersController.cs b/server/Controllers/v1/CharactersController.cs index 9e1c3e6..ddc3fdf 100644 --- a/server/Controllers/v1/CharactersController.cs +++ b/server/Controllers/v1/CharactersController.cs @@ -31,7 +31,7 @@ namespace server.Controllers.v1 [ProducesResponseType(typeof(List), StatusCodes.Status200OK)] [ProducesResponseType(typeof(ValidationProblemDetails), StatusCodes.Status400BadRequest)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)] - public async Task>> GetCharactersAsync([FromQuery] CharacterFilter? filter) + public async Task GetCharactersAsync([FromQuery] CharacterFilter? filter) { try { @@ -60,7 +60,7 @@ namespace server.Controllers.v1 [ProducesResponseType(typeof(ValidationProblemDetails), StatusCodes.Status400BadRequest)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)] - public async Task> GetCharacterByIdAsync(string id) + public async Task GetCharacterByIdAsync(string id) { if (!ObjectId.TryParse(id, out _)) diff --git a/server/Controllers/v1/EpisodesController.cs b/server/Controllers/v1/EpisodesController.cs index dbb131c..7ee0864 100644 --- a/server/Controllers/v1/EpisodesController.cs +++ b/server/Controllers/v1/EpisodesController.cs @@ -30,7 +30,7 @@ namespace server.Controllers.v1 [ProducesResponseType(typeof(List), StatusCodes.Status200OK)] [ProducesResponseType(typeof(ValidationProblemDetails), StatusCodes.Status400BadRequest)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)] - public async Task>> GetEpisodesAsync([FromQuery] EpisodeFilter? filter) + public async Task GetEpisodesAsync([FromQuery] EpisodeFilter? filter) { try { @@ -59,7 +59,7 @@ namespace server.Controllers.v1 [ProducesResponseType(typeof(ValidationProblemDetails), StatusCodes.Status400BadRequest)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)] - public async Task> GetEpisodeByNumberAsync(int number) + public async Task GetEpisodeByNumberAsync(int number) { try { diff --git a/server/Controllers/v1/QuotesController.cs b/server/Controllers/v1/QuotesController.cs index e8f838c..a5a18d6 100644 --- a/server/Controllers/v1/QuotesController.cs +++ b/server/Controllers/v1/QuotesController.cs @@ -32,7 +32,7 @@ namespace server.Controllers.v1 [ProducesResponseType(typeof(List), StatusCodes.Status200OK)] [ProducesResponseType(typeof(ValidationProblemDetails), StatusCodes.Status400BadRequest)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)] - public async Task>> GetQuotesAsync([FromQuery] QuoteFilter? filter) + public async Task GetQuotesAsync([FromQuery] QuoteFilter? filter) { try { @@ -61,7 +61,7 @@ namespace server.Controllers.v1 [ProducesResponseType(typeof(ValidationProblemDetails), StatusCodes.Status400BadRequest)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)] - public async Task> GetQuoteByIdAsync(string id) + public async Task GetQuoteByIdAsync(string id) { if (!ObjectId.TryParse(id, out _)) diff --git a/server/Controllers/v1/SeasonsController.cs b/server/Controllers/v1/SeasonsController.cs index fd84db7..5dfdd41 100644 --- a/server/Controllers/v1/SeasonsController.cs +++ b/server/Controllers/v1/SeasonsController.cs @@ -27,7 +27,7 @@ namespace server.Controllers.v1 [HttpGet] [ProducesResponseType(typeof(List), StatusCodes.Status200OK)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)] - public async Task>> GetSeasonsAsync() + public async Task GetSeasonsAsync() { try { @@ -53,7 +53,7 @@ namespace server.Controllers.v1 [ProducesResponseType(typeof(Season), StatusCodes.Status200OK)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)] [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)] - public async Task> GetSeasonByNumberAsync(int number) + public async Task GetSeasonByNumberAsync(int number) { try { diff --git a/server/server.csproj b/server/server.csproj index e3944a6..c124798 100644 --- a/server/server.csproj +++ b/server/server.csproj @@ -16,6 +16,7 @@ + diff --git a/tests/Usings.cs b/tests/Usings.cs new file mode 100644 index 0000000..8c927eb --- /dev/null +++ b/tests/Usings.cs @@ -0,0 +1 @@ +global using Xunit; \ No newline at end of file diff --git a/tests/controllers/CharactersControllerTests.cs b/tests/controllers/CharactersControllerTests.cs new file mode 100644 index 0000000..a753c04 --- /dev/null +++ b/tests/controllers/CharactersControllerTests.cs @@ -0,0 +1,40 @@ +using Microsoft.AspNetCore.Mvc; +using Moq; +using server.Controllers.v1; +using server.Models; +using server.Persistence.Repositories; +using System.Net; + +namespace tests.controllers +{ + public class CharactersControllerTests + { + private readonly Mock _mockRepo; + private readonly CharactersController _controller; + + public CharactersControllerTests() + { + _mockRepo = new Mock(); + _controller = new CharactersController(_mockRepo.Object); + } + + [Fact] + public async Task GetCharactersAsync_NoFilterNoCharacters_Returns200StatusWithEmptyCollection() + { + var filter = new CharacterFilter(); + + _mockRepo + .Setup(repo => repo.GetCharactersAsync(filter)) + .ReturnsAsync( new List()); + + var result = await _controller.GetCharactersAsync(filter) as ObjectResult; + var data = result?.Value as List; + + _mockRepo.Verify(c => c.GetCharactersAsync(filter), Times.Once()); + Assert.IsType(result); + Assert.IsType>(data); + Assert.Equal(HttpStatusCode.OK, (HttpStatusCode)result.StatusCode); + Assert.Empty(data); + } + } +} diff --git a/tests/tests.csproj b/tests/tests.csproj new file mode 100644 index 0000000..bc23e61 --- /dev/null +++ b/tests/tests.csproj @@ -0,0 +1,28 @@ + + + + net6.0 + enable + enable + + false + + + + + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + + + + + +