.Net Core Unit Testing - Mock IOptions <T>

ฉันรู้สึกว่าฉันพลาดอะไรบางอย่างที่เห็นได้ชัดที่นี่ ฉันมีคลาสที่ต้องการการฉีดตัวเลือกโดยใช้รูปแบบ. Net Core IOptions (?) เมื่อฉันไปทดสอบหน่วยชั้นเรียนนั้นฉันต้องการจำลองเวอร์ชันต่างๆของตัวเลือกในการตรวจสอบการทำงานของชั้นเรียน มีใครรู้วิธีจำลอง / สร้างอินสแตนซ์ / เติมข้อมูล 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()
        {
        }
    }
}

การทดสอบหน่วยในแอสเซมบลีที่แตกต่างจากคลาสอื่น ๆ :

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

คุณต้องสร้างและเติมข้อมูลIOptions<SampleOptions>วัตถุด้วยตนเอง คุณสามารถทำได้ผ่านMicrosoft.Extensions.Options.Optionsคลาสตัวช่วย ตัวอย่างเช่น:

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

คุณสามารถทำให้ง่ายขึ้นเล็กน้อยเพื่อ:

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

เห็นได้ชัดว่าสิ่งนี้ไม่มีประโยชน์มากนัก คุณจะต้องสร้างและเติมข้อมูลออบเจ็กต์ SampleOptions และส่งผ่านไปยังเมธอด Create

หากคุณตั้งใจจะใช้ Mocking Framework ตามที่ @TSeng ระบุในความคิดเห็นคุณต้องเพิ่มการอ้างอิงต่อไปนี้ในไฟล์ project.json ของคุณ

   "Moq": "4.6.38-alpha",

เมื่อเรียกคืนการพึ่งพาแล้วการใช้กรอบขั้นต่ำจะทำได้ง่ายเพียงแค่สร้างอินสแตนซ์ของคลาส 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);

เมื่อตั้งค่าการจำลองแล้วคุณสามารถส่งต่อวัตถุจำลองไปยังตัวสร้างภาพได้ในขณะนี้

SampleRepo sr = new SampleRepo(mock.Object);   

HTH

ฉันมีที่เก็บ git ที่สรุป 2 แนวทางนี้ในGithub / patvin80

คุณสามารถหลีกเลี่ยงการใช้ 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);
    }
}

กำหนดคลาส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");
    }
}

คุณสามารถสร้างตัวเลือกได้ตลอดเวลาผ่าน Options.Create () และใช้ AutoMocker ใช้ (ตัวเลือก) ก่อนสร้างอินสแตนซ์จำลองของที่เก็บที่คุณกำลังทดสอบ การใช้ 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; }
}

นี่เป็นอีกวิธีง่ายๆที่ไม่ต้องใช้ 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);

สำหรับระบบและการทดสอบการรวมของฉันฉันต้องการให้มีสำเนา / ลิงก์ของไฟล์กำหนดค่าของฉันภายในโครงการทดสอบ จากนั้นฉันใช้ 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 ได้ทุกที่ภายใน TestProject ของฉัน สำหรับการทดสอบหน่วยฉันชอบใช้ MOQ เหมือนที่ patvin80 อธิบายไว้

เห็นด้วยกับ Aleha ว่าการใช้ไฟล์คอนฟิก testSettings.json น่าจะดีกว่า จากนั้นแทนที่จะฉีด IOption คุณสามารถฉีด SampleOptions จริงในตัวสร้างคลาสของคุณได้เมื่อหน่วยทดสอบคลาสคุณสามารถทำสิ่งต่อไปนี้ในฟิกซ์เจอร์หรืออีกครั้งในตัวสร้างคลาสทดสอบ:

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

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