nhyatt/bitwarden
1
0
Fork 0
mirror of https://github.com/bitwarden/server.git synced 2025-06-07 11:40:31 -05:00
Code

Clean up

Browse Source
This commit is contained in:
Thomas Rittson 2025-05-26 16:28:43 +10:00
parent 68a333c293
commit 79a0073a2c
No known key found for this signature in database
GPG Key ID: CDDDA03861C35E27
1 changed files with 55 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
test/Core.Test/Services/UserServiceTests.cs
View File

@ -26,7 +26,6 @@ using Microsoft.AspNetCore.Identity;
using Microsoft.Extensions.Caching.Distributed;
using Microsoft.Extensions.Options;
using NSubstitute;
using NSubstitute.ReceivedExtensions;
using Xunit;
namespace Bit.Core.Test.Services;
@ -167,9 +166,13 @@ public class UserServiceTests
[Theory]
[BitAutoData(DeviceType.UnknownBrowser, "Unknown Browser")]
[BitAutoData(DeviceType.Android, "Android")]
public async Task SendNewDeviceVerificationEmailAsync_DeviceMatches(DeviceType deviceType, string deviceTypeName, SutProvider<UserService> sutProvider, User user)
public async Task SendNewDeviceVerificationEmailAsync_DeviceMatches(DeviceType deviceType, string deviceTypeName,
User user)
{
// WithFakeTokenProvider(sutProvider, user);
var sutProvider = new SutProvider<UserService>()
.WithFakeTokenProvider(user)
.Create();
var context = sutProvider.GetDependency<ICurrentContext>();
context.DeviceType = deviceType;
context.IpAddress = "1.1.1.1";
@ -182,9 +185,12 @@ public class UserServiceTests
}
[Theory, BitAutoData]
public async Task SendNewDeviceVerificationEmailAsync_NullDeviceTypeShouldSendUnkownBrowserType(SutProvider<UserService> sutProvider, User user)
public async Task SendNewDeviceVerificationEmailAsync_NullDeviceTypeShouldSendUnkownBrowserType(User user)
{
// WithFakeTokenProvider(sutProvider, user);
var sutProvider = new SutProvider<UserService>()
.WithFakeTokenProvider(user)
.Create();
var context = sutProvider.GetDependency<ICurrentContext>();
context.DeviceType = null;
context.IpAddress = "1.1.1.1";
@ -259,29 +265,21 @@ public class UserServiceTests
// Arrange
SetupUserAndDevice(user, shouldHavePassword);
var sutProvider = new SutProvider<UserService>()
.WithUserPasswordStore()
.WithFakeTokenProvider(user)
.Create()
.FixPasswordHasherBug();
// Setup the fake password verification
var substitutedUserPasswordStore = Substitute.For<IUserPasswordStore<User>>();
substitutedUserPasswordStore
sutProvider.GetDependency<IUserPasswordStore<User>>()
.GetPasswordHashAsync(user, Arg.Any<CancellationToken>())
.Returns(Task.FromResult("hashed_test_password"));
var sutProvider = new SutProvider<UserService>()
// IUserPasswordStore must be registered under the IUserStore parameter
.SetDependency<IUserStore<User>>(substitutedUserPasswordStore)
.WithFakeTokenProvider(user)
.Create();
sutProvider.GetDependency<IPasswordHasher<User>>()
.VerifyHashedPassword(user, "hashed_test_password", "test_password")
.Returns(PasswordVerificationResult.Success);
// HACK: reassign public property on base class after it's overwritten by autofixture
sutProvider.Sut.PasswordHasher = sutProvider.GetDependency<IPasswordHasher<User>>();
// DEBUG: check the public property on the base class matches the mock in SutProvider.
// If you remove the HACK above, this will fail (and so will the rest of the test).
Assert.Equal(sutProvider.Sut.PasswordHasher, sutProvider.GetDependency<IPasswordHasher<User>>());
var actualIsVerified = await sutProvider.Sut.VerifySecretAsync(user, secret);
Assert.Equal(expectedIsVerified, actualIsVerified);
@ -493,25 +491,28 @@ public class UserServiceTests
}
[Theory, BitAutoData]
public async Task ResendNewDeviceVerificationEmail_SendsToken_Success(
SutProvider<UserService> sutProvider, User user)
public async Task ResendNewDeviceVerificationEmail_SendsToken_Success(User user)
{
// Arrange
var testPassword = "test_password";
SetupUserAndDevice(user, true);
var sutProvider = new SutProvider<UserService>()
.WithUserPasswordStore()
.WithFakeTokenProvider(user)
.Create()
.FixPasswordHasherBug();
// Setup the fake password verification
var substitutedUserPasswordStore = Substitute.For<IUserPasswordStore<User>>();
substitutedUserPasswordStore
sutProvider
.GetDependency<IUserPasswordStore<User>>()
.GetPasswordHashAsync(user, Arg.Any<CancellationToken>())
.Returns((ci) =>
{
return Task.FromResult("hashed_test_password");
});
sutProvider.SetDependency<IUserStore<User>>(substitutedUserPasswordStore, "store");
sutProvider.GetDependency<IPasswordHasher<User>>("passwordHasher")
sutProvider.GetDependency<IPasswordHasher<User>>()
.VerifyHashedPassword(user, "hashed_test_password", testPassword)
.Returns((ci) =>
{
@ -526,10 +527,7 @@ public class UserServiceTests
context.DeviceType = DeviceType.Android;
context.IpAddress = "1.1.1.1";
// HACK: SutProvider is being weird about not injecting the IPasswordHasher that I configured
var sut = sutProvider.Sut;
await sut.ResendNewDeviceVerificationEmail(user.Email, testPassword);
await sutProvider.Sut.ResendNewDeviceVerificationEmail(user.Email, testPassword);
await sutProvider.GetDependency<IMailService>()
.Received(1)
@ -721,4 +719,30 @@ public static class UserServiceSutProviderExtensions
return sutProvider;
}
public static SutProvider<UserService> WithUserPasswordStore(this SutProvider<UserService> sutProvider)
{
var substitutedUserPasswordStore = Substitute.For<IUserPasswordStore<User>>();
// IUserPasswordStore must be registered under the IUserStore parameter to be properly injected
sutProvider.SetDependency<IUserStore<User>>(substitutedUserPasswordStore);
// also store it under its own type for retrieval and configuration
sutProvider.SetDependency(substitutedUserPasswordStore);
return sutProvider;
}
/// <summary>
/// This is a hack: when autofixture initializes the sut in sutProvider, it overwrites the public
/// PasswordHasher property with a new substitute, so it loses the configured sutProvider mock.
/// This doesn't usually happen because our dependencies are not usually public.
/// Call this AFTER SutProvider.Create().
/// </summary>
public static SutProvider<UserService> FixPasswordHasherBug(this SutProvider<UserService> sutProvider)
{
// Get the configured sutProvider mock and assign it back to the public property in the base class
sutProvider.Sut.PasswordHasher = sutProvider.GetDependency<IPasswordHasher<User>>();
return sutProvider;
}
}