.Net核心单元测试 - 模拟IOptions <T>

Question

我觉得我错过了一些非常明显的东西.我有类需要使用.Net Core IOptions模式注入选项(？).当我去单元测试那个类时,我想模拟各种版本的选项来验证类的功能.有谁知道如何正确模拟/实例化/填充Startup类之外的IOptions？

以下是我正在使用的类的一些示例:

设置/选项模型

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);
        }
    }
}

Answer 1

您需要手动创建和填充IOptions<SampleOptions>对象.您可以通过Microsoft.Extensions.Options.Options帮助程序类完成此操作.例如:

IOptions<SampleOptions> someOptions = Options.Create<SampleOptions>(new SampleOptions());

你可以简化一下:

var someOptions = Options.Create(new SampleOptions());

显然这不是很有用.您需要实际创建并填充SampleOptions对象并将其传递给Create方法.

Answer 2

如果您打算在注释中使用@TSeng指示的Mocking Framework,则需要在project.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);

设置模拟后,您现在可以将模拟对象传递给构造函数

SampleRepo sr = new SampleRepo(mock.Object);   

HTH.

仅供参考我有一个git存储库,它在Github/patvin80上概述了这两种方法

Answer 3

使用 Microsoft.Extensions.Options.Options 类：

var someOptions= Options.Create(new SampleOptions(){Field1="Value1",Field2="Value2"});

或者

var someOptions= Options.Create(new SampleOptions{Field1="Value1",Field2="Value2"});

Answer 4

您始终可以通过 Options.Create() 创建您的选项，而不是在实际创建您正在测试的存储库的模拟实例之前简单地使用 AutoMocker.Use(options)。使用 AutoMocker.CreateInstance<>() 可以更轻松地创建实例，而无需手动传递参数

为了能够重现我认为您想要实现的行为，我对您的 SampleRepo 进行了一些更改。

public class SampleRepoTests
{
    private readonly AutoMocker _mocker = new AutoMocker();
    private readonly ISampleRepo _sampleRepo;

    private readonly IOptions<SampleOptions> _options = Options.Create(new SampleOptions()
        {FirstSetting = "firstSetting"});

    public SampleRepoTests()
    {
        _mocker.Use(_options);
        _sampleRepo = _mocker.CreateInstance<SampleRepo>();
    }

    [Fact]
    public void Test_Options_Injected()
    {
        var firstSetting = _sampleRepo.GetFirstSetting();
        Assert.True(firstSetting == "firstSetting");
    }
}

public class SampleRepo : ISampleRepo
{
    private SampleOptions _options;

    public SampleRepo(IOptions<SampleOptions> options)
    {
        _options = options.Value;
    }

    public string GetFirstSetting()
    {
        return _options.FirstSetting;
    }
}

public interface ISampleRepo
{
    string GetFirstSetting();
}

public class SampleOptions
{
    public string FirstSetting { get; set; }
}

Answer 5

您可以完全避免使用MOQ.在测试.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);
    }
}

Answer 6

给定的类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,而不是明确地传递给构造函数,使用此代码:

[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");
    }
}

Answer 7

这是不需要Mock的另一种简单方法，而是使用OptionsWrapper：

var myAppSettingsOptions = new MyAppSettingsOptions();
appSettingsOptions.MyObjects = new MyObject[]{new MyObject(){MyProp1 = "one", MyProp2 = "two", }};
var optionsWrapper = new OptionsWrapper<MyAppSettingsOptions>(myAppSettingsOptions );
var myClassToTest = new MyClassToTest(optionsWrapper);