我觉得我忽略了一些很明显的东西。我有一些类需要使用. net Core IOptions模式(?)注入选项。当我对该类进行单元测试时,我想模拟选项的各种版本,以验证该类的功能。有人知道如何正确模拟/实例化/填充IOptions<T>之外的启动类吗?
以下是我正在使用的一些类示例:
设置/选择模型
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace OptionsSample.Models
{
public class SampleOptions
{
public string FirstSetting { get; set; }
public int SecondSetting { get; set; }
}
}
要测试的类,它使用设置:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using OptionsSample.Models
using System.Net.Http;
using Microsoft.Extensions.Options;
using System.IO;
using Microsoft.AspNetCore.Http;
using System.Xml.Linq;
using Newtonsoft.Json;
using System.Dynamic;
using Microsoft.Extensions.Logging;
namespace OptionsSample.Repositories
{
public class SampleRepo : ISampleRepo
{
private SampleOptions _options;
private ILogger<AzureStorageQueuePassthru> _logger;
public SampleRepo(IOptions<SampleOptions> options)
{
_options = options.Value;
}
public async Task Get()
{
}
}
}
在与其他类不同的程序集中进行单元测试:
using OptionsSample.Repositories;
using OptionsSample.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Xunit;
using Microsoft.Extensions.Logging;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Options;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Configuration;
namespace OptionsSample.Repositories.Tests
{
public class SampleRepoTests
{
private IOptions<SampleOptions> _options;
private SampleRepo _sampleRepo;
public SampleRepoTests()
{
//Not sure how to populate IOptions<SampleOptions> here
_options = options;
_sampleRepo = new SampleRepo(_options);
}
}
}
同意Aleha使用testSettings。Json配置文件可能更好。
然后,不是注入IOption<SampleOptions>,你可以简单地在你的类构造函数中注入真正的SampleOptions,当单元测试类时,你可以在一个fixture中或在测试类构造函数中执行以下操作:
var builder = new ConfigurationBuilder()
.AddJsonFile("testSettings.json", true, true)
.AddEnvironmentVariables();
var configurationRoot = builder.Build();
configurationRoot.GetSection("SampleRepo").Bind(_sampleRepo);
对于我的系统和集成测试,我更喜欢在测试项目中有配置文件的副本/链接。然后我使用ConfigurationBuilder来获取选项。
using System.Linq;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
namespace SomeProject.Test
{
public static class TestEnvironment
{
private static object configLock = new object();
public static ServiceProvider ServiceProvider { get; private set; }
public static T GetOption<T>()
{
lock (configLock)
{
if (ServiceProvider != null) return (T)ServiceProvider.GetServices(typeof(T)).First();
var builder = new ConfigurationBuilder()
.AddJsonFile("config/appsettings.json", optional: false, reloadOnChange: true)
.AddEnvironmentVariables();
var configuration = builder.Build();
var services = new ServiceCollection();
services.AddOptions();
services.Configure<ProductOptions>(configuration.GetSection("Products"));
services.Configure<MonitoringOptions>(configuration.GetSection("Monitoring"));
services.Configure<WcfServiceOptions>(configuration.GetSection("Services"));
ServiceProvider = services.BuildServiceProvider();
return (T)ServiceProvider.GetServices(typeof(T)).First();
}
}
}
}
这样我就可以在TestProject中的任何地方使用配置。对于单元测试,我更喜欢使用像patvin80所描述的MOQ。
给定类Person依赖于PersonSettings,如下所示:
public class PersonSettings
{
public string Name;
}
public class Person
{
PersonSettings _settings;
public Person(IOptions<PersonSettings> settings)
{
_settings = settings.Value;
}
public string Name => _settings.Name;
}
IOptions<PersonSettings>可以被模拟,Person可以被测试如下:
[TestFixture]
public class Test
{
ServiceProvider _provider;
[OneTimeSetUp]
public void Setup()
{
var services = new ServiceCollection();
// mock PersonSettings
services.AddTransient<IOptions<PersonSettings>>(
provider => Options.Create<PersonSettings>(new PersonSettings
{
Name = "Matt"
}));
_provider = services.BuildServiceProvider();
}
[Test]
public void TestName()
{
IOptions<PersonSettings> options = _provider.GetService<IOptions<PersonSettings>>();
Assert.IsNotNull(options, "options could not be created");
Person person = new Person(options);
Assert.IsTrue(person.Name == "Matt", "person is not Matt");
}
}
要将IOptions<PersonSettings>注入到Person中,而不是显式地传递给ctor,使用以下代码:
[TestFixture]
public class Test
{
ServiceProvider _provider;
[OneTimeSetUp]
public void Setup()
{
var services = new ServiceCollection();
services.AddTransient<IOptions<PersonSettings>>(
provider => Options.Create<PersonSettings>(new PersonSettings
{
Name = "Matt"
}));
services.AddTransient<Person>();
_provider = services.BuildServiceProvider();
}
[Test]
public void TestName()
{
Person person = _provider.GetService<Person>();
Assert.IsNotNull(person, "person could not be created");
Assert.IsTrue(person.Name == "Matt", "person is not Matt");
}
}
同意Aleha使用testSettings。Json配置文件可能更好。
然后,不是注入IOption<SampleOptions>,你可以简单地在你的类构造函数中注入真正的SampleOptions,当单元测试类时,你可以在一个fixture中或在测试类构造函数中执行以下操作:
var builder = new ConfigurationBuilder()
.AddJsonFile("testSettings.json", true, true)
.AddEnvironmentVariables();
var configurationRoot = builder.Build();
configurationRoot.GetSection("SampleRepo").Bind(_sampleRepo);
你完全可以避免使用最小起订量。
在测试中使用.json配置文件。一个文件用于多个测试类文件。在本例中使用ConfigurationBuilder就可以了。
appsetting.json的示例
{
"someService" {
"someProp": "someValue
}
}
设置映射类示例:
public class SomeServiceConfiguration
{
public string SomeProp { get; set; }
}
需要测试的服务示例:
public class SomeService
{
public SomeService(IOptions<SomeServiceConfiguration> config)
{
_config = config ?? throw new ArgumentNullException(nameof(_config));
}
}
NUnit测试类:
[TestFixture]
public class SomeServiceTests
{
private IOptions<SomeServiceConfiguration> _config;
private SomeService _service;
[OneTimeSetUp]
public void GlobalPrepare()
{
var configuration = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json", false)
.Build();
_config = Options.Create(configuration.GetSection("someService").Get<SomeServiceConfiguration>());
}
[SetUp]
public void PerTestPrepare()
{
_service = new SomeService(_config);
}
}
如果你打算使用@TSeng在评论中指出的mock框架,你需要在你的项目中添加以下依赖项。json文件。
"Moq": "4.6.38-alpha",
一旦恢复了依赖关系,使用MOQ框架就像创建SampleOptions类的实例一样简单,然后将其分配给Value。
下面是一个代码概要。
SampleOptions app = new SampleOptions(){Title="New Website Title Mocked"}; // Sample property
// Make sure you include using Moq;
var mock = new Mock<IOptions<SampleOptions>>();
// We need to set the Value of IOptions to be the SampleOptions Class
mock.Setup(ap => ap.Value).Returns(app);
模拟设置完成后,现在可以将模拟对象传递给构造函数as
SampleRepo sr = new SampleRepo(mock.Object);
HTH。
仅供参考,我在Github/patvin80上有一个git存储库,概述了这2种方法