.Net Core Unit Testing - Mock IOptions <T>

Я чувствую, что мне не хватает чего-то действительно очевидного здесь. У меня есть классы, которые требуют инъекции опций, используя шаблон .Net Core IOptions (?). Когда я перехожу к unit test этому классу, я хочу издеваться над различными версиями опций для проверки функциональности класса. Кто-нибудь знает, как правильно издеваться/создавать/заполнять IOptions за пределами класса Startup?

Вот несколько примеров классов, с которыми я работаю:

Параметры/Опции Модель

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()
        {
        }
    }
}

Unit test в другой сборке из других классов:

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

Ответы

Ответ 1

Вам нужно вручную создать и заполнить объект IOptions<SampleOptions>. Вы можете сделать это с помощью вспомогательного класса Microsoft.Extensions.Options.Options. Например:

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

Вы можете немного упростить это:

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

Очевидно, что это не очень полезно, как есть. Вам нужно будет фактически создать и заполнить объект SampleOptions и передать его в метод Create.

Ответ 2

Если вы намерены использовать Mocking Framework, как указано @TSeng в комментарии, вам нужно добавить следующую зависимость в файл project.json.

   "Moq": "4.6.38-alpha",

Как только зависимость будет восстановлена, использование структуры MOQ так же просто, как создание экземпляра класса SampleOptions, а затем, как упоминалось, присвойте ему значение.

Вот схема кода, как она будет выглядеть.

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

Как только макет будет настроен, вы можете передать макету объекту в contructor как

SampleRepo sr = new SampleRepo(mock.Object);

НТН.

FYI У меня есть репозиторий git, который описывает эти 2 подхода на Github/patvin80

Ответ 3

Вы можете вообще не использовать 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);
    }
}

Ответ 4

Данный класс 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> можно 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");
    }
}

Ответ 5

Вот еще один простой способ, который не требует 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);

Ответ 6

Для моих системных и интеграционных тестов я предпочитаю иметь копию/ссылку моего конфигурационного файла внутри тестового проекта. И затем я использую 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();
        }
    }
}
}

Таким образом, я могу использовать config везде внутри моего тестового проекта. Для модульных тестов я предпочитаю использовать MOQ, как описано patvin80.

Ответ 7

Согласитесь с Aleha, что лучше использовать файл конфигурации testSettings.json. И затем вместо внедрения IOption вы можете просто внедрить реальные SampleOptions в ваш конструктор класса, когда при модульном тестировании класса вы можете сделать следующее в фиксаторе или снова просто в конструкторе тестового класса:

   var builder = new ConfigurationBuilder()
  .AddJsonFile("testSettings.json", true, true)
  .AddEnvironmentVariables();

  var configurationRoot = builder.Build();
  configurationRoot.GetSection("SampleRepo").Bind(_sampleRepo);

Ответ 8

Вы всегда можете создать свои параметры с помощью Options.Create(), а затем просто использовать AutoMocker.Use (параметры) перед тем, как создавать поддельный экземпляр тестируемого репозитория. Использование 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; }
}