[英]ASP.NET Core is using non-default constructor if no public default constructor found
[英]AWS .NET Core unit test load non-default profile
为了进行开发,我有许多AWS配置文件,我使用appsettings.json中的AWS Profile部分来定义要使用的配置文件:
"AWS": {
"Profile": "CorpAccount",
"Region": "us-east-1"
}
由于这不是默认概要文件,因此在调试和运行单元测试(xunit)时,我需要上下文使用命名的概要文件。 我想知道的是配置配置文件的最佳实践。
这是一堂课,展示了三种方法(两种在本地工作):
public class EmailQueueService : IEmailQueueService
{
private IConfiguration _configuration;
private readonly ILogger _logger;
public EmailQueueService(IConfiguration configuration, ILogger<EmailQueueService> logger)
{
_configuration = configuration;
_logger = logger;
}
public async Task<bool> Add1Async(ContactFormModel contactForm)
{
var sqsClient = new AmazonSQSClient();
var sendRequest = // removed for clarity
var response = await sqsClient.SendMessageAsync(sendRequest);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
public async Task<bool> Add2Async(ContactFormModel contactForm)
{
var sqsClient = _configuration.GetAWSOptions().CreateServiceClient<IAmazonSQS>();
var sendRequest = // removed for clarity
var response = await sqsClient.SendMessageAsync(sendRequest);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
public async Task<bool> Add3Async(ContactFormModel contactForm)
{
var sqsClient = new AmazonSQSClient(credentials: Common.Credentials(_configuration));
var sendRequest = // removed for clarity
var response = await sqsClient.SendMessageAsync(sendRequest);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
public AWSCredentials Credentials(IConfiguration config)
{
var chain = new CredentialProfileStoreChain();
if (!chain.TryGetAWSCredentials(config.GetAWSOptions().Profile, out AWSCredentials awsCredentials))
{
throw new Exception("Profile not found.");
}
return awsCredentials;
}
}
结果:
Add1Async
在本地失败,因为它使用默认配置文件而不是“ CorpAccount”。 Add2Async
在本地工作,但似乎是创建新实例的一种奇怪方法。 Add3Async
在本地工作,但部署后可能会失败,因为config.GetAWSOptions().Profile
在本地环境之外不存在。 为了完整起见,这是一个单元测试,我从以下位置调用它:
[Fact]
public async void AddAsyncTest()
{
// Arrange
var configuration = TestConfigure.Getconfiguration();
var service = new EmailQueueService(configuration, Mock.Of<ILogger<EmailQueueService>>());
// Act
var result = await service.AddAsync(ContactFormModelMock.GetNew());
// Assert
Assert.True(result);
}
public static IConfiguration Getconfiguration()
{
var builder = new ConfigurationBuilder()
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
.AddEnvironmentVariables();
return builder.Build();
}
这是一个设计问题。 您将代码与实现问题紧密联系在一起,这使孤立地测试代码变得困难。
首先,您需要重构客户端的创建(实现关注),并将其抽象显式地注入到依赖类中。
确实不需要在服务中注入IConfiguration
类的框架问题。 这可以看作是代码气味,您的类没有遵循显式依赖项原则 ,并且误导了它实际依赖的内容。
这样,从属类简化为
public class EmailQueueService : IEmailQueueService {
private readonly IAmazonSQS sqsClient
private readonly ILogger logger;
public EmailQueueService(IAmazonSQS sqsClient, ILogger<EmailQueueService> logger) {
this.sqsClient = sqsClient;
this.logger = logger;
}
public async Task<bool> AddAsync(ContactFormModel contactForm) {
var sendRequest = //...removed for clarity
var response = await sqsClient.SendMessageAsync(sendRequest);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
}
现在,将客户端的创建及其对选项的依赖关系移至合成根目录,这将在启动时进行。
public Startup(IHostingEnvironment env) {
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
.AddEnvironmentVariables();
Configuration = builder.Build();
}
IConfiguration Configuration;
public void ConfigureServices(IServiceCollection services) {
// Add framework services.
services.AddMvc();
// Add AWS services
var options = Configuration.GetAWSOptions();
services.AddDefaultAWSOptions(options);
services.AddAWSService<IAmazonSQS>();
services.AddAWSService<IAmazonDynamoDB>();
services.AddSingleton<IEmailQueueService, EmailQueueService>();
//...omitted for brevity
}
参考使用.NET Core配置适用于.NET的AWS开发工具包
这需要清理代码,以便它可以在本地运行,部署或在测试时运行。
测试时,您可以在测试对象的外部创建客户端,并根据需要专门针对测试进行配置
public class EmailQueueServiceTests {
[Fact]
public async Task Should_AddAsync() {
// Arrange
var configuration = GetConfiguration();
IAmazonSQS client = configuration.GetAWSOptions().CreateServiceClient<IAmazonSQS>();
var subject = new EmailQueueService(client, Mock.Of<ILogger<EmailQueueService>>());
// Act
var result = await subject.AddAsync(ContactFormModelMock.GetNew());
// Assert
Assert.True(result);
}
static IConfiguration GetConfiguration() {
var builder = new ConfigurationBuilder()
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
.AddEnvironmentVariables();
return builder.Build();
}
}
如果需要,也可以完全模拟IConfiguration
或使用测试所需的值手动创建AWSOptions
。
现在,您的可用选择增加了,并且更加灵活。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.