Rename WebApi project to Vegasco.Server.Api

And update all references including comments etc.
2025-06-12 18:22:37 +02:00
parent 9d71c86474
commit a1999bfe41
71 changed files with 177 additions and 224 deletions
--- a/tests/Vegasco.Server.Api.Tests.Unit/Authentication/UserAccessorTests.cs
+++ b/tests/Vegasco.Server.Api.Tests.Unit/Authentication/UserAccessorTests.cs
@@ -0,0 +1,179 @@
+using FluentAssertions;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.Options;
+using NSubstitute;
+using System.Security.Claims;
+using Vegasco.Server.Api.Authentication;
+
+namespace Vegasco.Server.Api.Tests.Unit.Authentication;
+public sealed class UserAccessorTests
+{
+	private readonly UserAccessor _sut;
+	private readonly IHttpContextAccessor _httpContextAccessor;
+
+	private static readonly string _nameClaimType = "name";
+	private readonly JwtOptions _jwtOptions = new()
+	{
+		NameClaimType = _nameClaimType
+	};
+
+	private readonly IOptions<JwtOptions> _options = Substitute.For<IOptions<JwtOptions>>();
+
+	private static readonly string _defaultUsername = "username";
+	private static readonly string _defaultId = "id";
+	private readonly ClaimsPrincipal _defaultUser = new(new ClaimsIdentity(
+	[
+		new Claim(_nameClaimType, _defaultUsername),
+		new Claim(ClaimTypes.NameIdentifier, _defaultId)
+	]));
+
+	public UserAccessorTests()
+	{
+		_httpContextAccessor = new HttpContextAccessor
+		{
+			HttpContext = new DefaultHttpContext()
+			{
+				User = _defaultUser
+			}
+		};
+
+		_options.Value.Returns(_jwtOptions);
+
+		_sut = new UserAccessor(_httpContextAccessor, _options);
+	}
+
+	#region GetUsername
+
+	[Fact]
+	public void GetUsername_ShouldReturnUsername_WhenOptionsNameClaimTypeMatches()
+	{
+		// Arrange
+
+		// Act
+		string result = _sut.GetUsername();
+
+		// Assert
+		result.Should().Be(_defaultUsername);
+	}
+
+	[Fact]
+	public void GetUsername_ShouldReturnUsername_WhenNameClaimTypeIsNotSetAndUsernameIsInUriNameClaimType()
+	{
+		// Arrange
+		_jwtOptions.NameClaimType = null;
+		_httpContextAccessor.HttpContext!.User = new ClaimsPrincipal(new ClaimsIdentity(
+		[
+			new Claim(ClaimTypes.Name, _defaultUsername)
+		]));
+
+		// Act
+		string result = _sut.GetUsername();
+
+		// Assert
+		result.Should().Be(_defaultUsername);
+	}
+
+	[Fact]
+	public void GetUsername_ShouldCacheUsername_WhenFirstCalled()
+	{
+		// Arrange
+		_ = _sut.GetUsername();
+		_options.ClearReceivedCalls();
+
+		// Act
+		string result = _sut.GetUsername();
+
+		// Assert
+		result.Should().Be(_defaultUsername);
+		_ = _options.Received(0).Value;
+	}
+
+	[Fact]
+	public void GetUsername_ShouldThrowInvalidOperationException_WhenHttpContextIsNull()
+	{
+		// Arrange
+		_httpContextAccessor.HttpContext = null;
+
+		// Act
+		Func<string> action = () => _sut.GetUsername();
+
+		// Assert
+		action.Should().ThrowExactly<InvalidOperationException>()
+			.Which.Message.Should().Be("No HttpContext available.");
+	}
+
+	[Fact]
+	public void GetUsername_ShouldThrowInvalidOperationException_WhenNameClaimIsNotFound()
+	{
+		// Arrange
+		_httpContextAccessor.HttpContext!.User = new ClaimsPrincipal();
+
+		// Act
+		Func<string> action = () => _sut.GetUsername();
+
+		// Assert
+		action.Should().ThrowExactly<InvalidOperationException>()
+			.Which.Message.Should().Be($"No claim of type '{_nameClaimType}' found on the current user.");
+	}
+
+	#endregion
+
+	#region GetUserId
+
+	[Fact]
+	public void GetUserId_ShouldReturnUserId_WhenUserIdClaimExists()
+	{
+		// Arrange
+
+		// Act
+		string result = _sut.GetUserId();
+
+		// Assert
+		result.Should().Be(_defaultId);
+	}
+
+	[Fact]
+	public void GetUserId_ShouldCacheUserId_WhenFirstCalled()
+	{
+		// Arrange
+		_ = _sut.GetUserId();
+		_options.ClearReceivedCalls();
+
+		// Act
+		string result = _sut.GetUserId();
+
+		// Assert
+		result.Should().Be(_defaultId);
+		_ = _options.Received(0).Value;
+	}
+
+	[Fact]
+	public void GetUserId_ShouldThrowInvalidOperationException_WhenHttpContextIsNull()
+	{
+		// Arrange
+		_httpContextAccessor.HttpContext = null;
+
+		// Act
+		Func<string> action = () => _sut.GetUserId();
+
+		// Assert
+		action.Should().ThrowExactly<InvalidOperationException>()
+			.Which.Message.Should().Be("No HttpContext available.");
+	}
+
+	[Fact]
+	public void GetUserId_ShouldThrowInvalidOperationException_WhenIdClaimIsNotFound()
+	{
+		// Arrange
+		_httpContextAccessor.HttpContext!.User = new ClaimsPrincipal();
+
+		// Act
+		Func<string> action = () => _sut.GetUserId();
+
+		// Assert
+		action.Should().ThrowExactly<InvalidOperationException>()
+			.Which.Message.Should().Be($"No claim of type '{ClaimTypes.NameIdentifier}' found on the current user.");
+	}
+
+	#endregion
+}
--- a/tests/Vegasco.Server.Api.Tests.Unit/Cars/CreateCarRequestValidatorTests.cs
+++ b/tests/Vegasco.Server.Api.Tests.Unit/Cars/CreateCarRequestValidatorTests.cs
@@ -0,0 +1,72 @@
+using FluentAssertions;
+using FluentValidation.Results;
+using Vegasco.Server.Api.Cars;
+
+namespace Vegasco.Server.Api.Tests.Unit.Cars;
+
+public sealed class CreateCarRequestValidatorTests
+{
+	private readonly CreateCar.Validator _sut = new();
+
+	private readonly CreateCar.Request _validRequest = new("Ford Focus");
+
+	[Fact]
+	public async Task ValidateAsync_ShouldBeValid_WhenRequestIsValid()
+	{
+		// Arrange
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(_validRequest);
+
+		// Assert
+		result.IsValid.Should().BeTrue();
+	}
+
+	[Theory]
+	[InlineData(1)]
+	[InlineData(50)]
+	public async Task ValidateAsync_ShouldBeValid_WhenNameIsJustWithinTheLimits(int nameLength)
+	{
+		// Arrange
+		CreateCar.Request request = _validRequest with { Name = new string('s', nameLength) };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeTrue();
+	}
+
+	[Fact]
+	public async Task ValidateAsync_ShouldNotBeValid_WhenNameIsEmpty()
+	{
+		// Arrange
+		CreateCar.Request request = _validRequest with { Name = "" };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle()
+			.Which
+			.PropertyName.Should().Be(nameof(CreateCar.Request.Name));
+	}
+
+	[Fact]
+	public async Task ValidateAsync_ShouldNotBeValid_WhenNameIsTooLong()
+	{
+		// Arrange
+		const int nameMaxLength = 50;
+		CreateCar.Request request = _validRequest with { Name = new string('s', nameMaxLength + 1) };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle()
+			.Which
+			.PropertyName.Should().Be(nameof(CreateCar.Request.Name));
+	}
+}
--- a/tests/Vegasco.Server.Api.Tests.Unit/Cars/UpdateCarRequestValidatorTests.cs
+++ b/tests/Vegasco.Server.Api.Tests.Unit/Cars/UpdateCarRequestValidatorTests.cs
@@ -0,0 +1,72 @@
+using FluentAssertions;
+using FluentValidation.Results;
+using Vegasco.Server.Api.Cars;
+
+namespace Vegasco.Server.Api.Tests.Unit.Cars;
+
+public sealed class UpdateCarRequestValidatorTests
+{
+	private readonly UpdateCar.Validator _sut = new();
+
+	private readonly UpdateCar.Request _validRequest = new("Ford Focus");
+
+	[Fact]
+	public async Task ValidateAsync_ShouldBeValid_WhenRequestIsValid()
+	{
+		// Arrange
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(_validRequest);
+
+		// Assert
+		result.IsValid.Should().BeTrue();
+	}
+
+	[Theory]
+	[InlineData(1)]
+	[InlineData(50)]
+	public async Task ValidateAsync_ShouldBeValid_WhenNameIsJustWithinTheLimits(int nameLength)
+	{
+		// Arrange
+		UpdateCar.Request request = _validRequest with { Name = new string('s', nameLength) };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeTrue();
+	}
+
+	[Fact]
+	public async Task ValidateAsync_ShouldNotBeValid_WhenNameIsEmpty()
+	{
+		// Arrange
+		UpdateCar.Request request = _validRequest with { Name = "" };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle()
+			.Which
+			.PropertyName.Should().Be(nameof(UpdateCar.Request.Name));
+	}
+
+	[Fact]
+	public async Task ValidateAsync_ShouldNotBeValid_WhenNameIsTooLong()
+	{
+		// Arrange
+		const int nameMaxLength = 50;
+		UpdateCar.Request request = _validRequest with { Name = new string('s', nameMaxLength + 1) };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle()
+			.Which
+			.PropertyName.Should().Be(nameof(UpdateCar.Request.Name));
+	}
+}
--- a/tests/Vegasco.Server.Api.Tests.Unit/Consumptions/CreateConsumptionRequestValidatorTests.cs
+++ b/tests/Vegasco.Server.Api.Tests.Unit/Consumptions/CreateConsumptionRequestValidatorTests.cs
@@ -0,0 +1,100 @@
+using FluentAssertions;
+using FluentValidation.Results;
+using NSubstitute;
+using Vegasco.Server.Api.Consumptions;
+
+namespace Vegasco.Server.Api.Tests.Unit.Consumptions;
+public class CreateConsumptionRequestValidatorTests
+{
+	private readonly CreateConsumption.Validator _sut;
+	private readonly TimeProvider _timeProvider = Substitute.For<TimeProvider>();
+
+	private readonly DateTimeOffset _utcNow = new DateTimeOffset(2024, 8, 18, 13, 2, 53, TimeSpan.Zero);
+
+	private readonly CreateConsumption.Request _validRequest;
+
+	public CreateConsumptionRequestValidatorTests()
+	{
+		_timeProvider.GetUtcNow().Returns(_utcNow);
+		_sut = new CreateConsumption.Validator(_timeProvider);
+
+		_validRequest = new CreateConsumption.Request(
+			_utcNow.AddDays(-1),
+			1,
+			1,
+			false,
+			Guid.NewGuid());
+	}
+
+	[Fact]
+	public async Task ValidateAsync_ShouldBeValid_WhenRequestIsValid()
+	{
+		// Arrange
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(_validRequest);
+
+		// Assert
+		result.IsValid.Should().BeTrue();
+	}
+
+	[Fact]
+	public async Task ValidateAsync_ShouldBeInvalid_WhenDateTimeIsGreaterThanUtcNow()
+	{
+		// Arrange
+		CreateConsumption.Request request = _validRequest with { DateTime = _utcNow.AddDays(1) };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle(x => x.PropertyName == nameof(CreateConsumption.Request.DateTime));
+	}
+
+	[Theory]
+	[InlineData(0)]
+	[InlineData(-1)]
+	public async Task ValidateAsync_ShouldBeInvalid_WhenDistanceIsLessThanOrEqualToZero(double distance)
+	{
+		// Arrange
+		CreateConsumption.Request request = _validRequest with { Distance = distance };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle(x => x.PropertyName == nameof(CreateConsumption.Request.Distance));
+	}
+
+	[Theory]
+	[InlineData(0)]
+	[InlineData(-1)]
+	public async Task ValidateAsync_ShouldBeInvalid_WhenAmountIsLessThanOrEqualToZero(double amount)
+	{
+		// Arrange
+		CreateConsumption.Request request = _validRequest with { Amount = amount };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle(x => x.PropertyName == nameof(CreateConsumption.Request.Amount));
+	}
+
+	[Fact]
+	public async Task ValidateAsync_ShouldBeInvalid_WhenCarIdIsEmpty()
+	{
+		// Arrange
+		CreateConsumption.Request request = _validRequest with { CarId = Guid.Empty };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle(x => x.PropertyName == nameof(CreateConsumption.Request.CarId));
+	}
+}
--- a/tests/Vegasco.Server.Api.Tests.Unit/Consumptions/UpdateConsumptionRequestValidatorTests.cs
+++ b/tests/Vegasco.Server.Api.Tests.Unit/Consumptions/UpdateConsumptionRequestValidatorTests.cs
@@ -0,0 +1,86 @@
+using FluentAssertions;
+using FluentValidation.Results;
+using NSubstitute;
+using Vegasco.Server.Api.Consumptions;
+
+namespace Vegasco.Server.Api.Tests.Unit.Consumptions;
+
+public class UpdateConsumptionRequestValidatorTests
+{
+	private readonly UpdateConsumption.Validator _sut;
+	private readonly TimeProvider _timeProvider = Substitute.For<TimeProvider>();
+
+	private readonly DateTimeOffset _utcNow = new DateTimeOffset(2024, 8, 18, 13, 2, 53, TimeSpan.Zero);
+
+	private readonly UpdateConsumption.Request _validRequest;
+
+	public UpdateConsumptionRequestValidatorTests()
+	{
+		_timeProvider.GetUtcNow().Returns(_utcNow);
+		_sut = new UpdateConsumption.Validator(_timeProvider);
+
+		_validRequest = new UpdateConsumption.Request(
+			_utcNow.AddDays(-1),
+			1,
+			1,
+			false);
+	}
+
+	[Fact]
+	public async Task ValidateAsync_ShouldBeValid_WhenRequestIsValid()
+	{
+		// Arrange
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(_validRequest);
+
+		// Assert
+		result.IsValid.Should().BeTrue();
+	}
+
+	[Fact]
+	public async Task ValidateAsync_ShouldBeInvalid_WhenDateTimeIsGreaterThanUtcNow()
+	{
+		// Arrange
+		UpdateConsumption.Request request = _validRequest with { DateTime = _utcNow.AddDays(1) };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle(x => x.PropertyName == nameof(UpdateConsumption.Request.DateTime));
+	}
+
+	[Theory]
+	[InlineData(0)]
+	[InlineData(-1)]
+	public async Task ValidateAsync_ShouldBeInvalid_WhenDistanceIsLessThanOrEqualToZero(double distance)
+	{
+		// Arrange
+		UpdateConsumption.Request request = _validRequest with { Distance = distance };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle(x => x.PropertyName == nameof(UpdateConsumption.Request.Distance));
+	}
+
+	[Theory]
+	[InlineData(0)]
+	[InlineData(-1)]
+	public async Task ValidateAsync_ShouldBeInvalid_WhenAmountIsLessThanOrEqualToZero(double amount)
+	{
+		// Arrange
+		UpdateConsumption.Request request = _validRequest with { Amount = amount };
+
+		// Act
+		ValidationResult? result = await _sut.ValidateAsync(request);
+
+		// Assert
+		result.IsValid.Should().BeFalse();
+		result.Errors.Should().ContainSingle(x => x.PropertyName == nameof(UpdateConsumption.Request.Amount));
+	}
+}
--- a/tests/Vegasco.Server.Api.Tests.Unit/Vegasco.Server.Api.Tests.Unit.csproj
+++ b/tests/Vegasco.Server.Api.Tests.Unit/Vegasco.Server.Api.Tests.Unit.csproj
@@ -0,0 +1,40 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+
+    <IsPackable>false</IsPackable>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="coverlet.collector" Version="6.0.4">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="FluentAssertions" Version="8.3.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Relational" Version="9.0.5" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
+    <PackageReference Include="NSubstitute" Version="5.3.0" />
+    <PackageReference Include="xunit" Version="2.9.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="3.1.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Vegasco.Server.Api\Vegasco.Server.Api.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Using Include="Xunit" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Update="Nerdbank.GitVersioning" Version="3.7.115" />
+  </ItemGroup>
+
+</Project>