用于 MSTest [ASP.NET Core 3.1] 的 appsettings.json

Question

我想为 MSTest 项目中的单元测试创​​建自定义 appsettings.json 文件。我称它为 testsettings.json。我在主项目中使用存储库模式，所以我有一个 IUnitOfWork 和 UnitOfWork，我在 ASP.NET 端声明为 Singleton。这可以访问各种存储库。

这个 UnitOfWork 确实依赖于一些配置变量，所以我使用 appsettings.json 来存储这些。因此，UnitOfWork 的构造函数接受一个 IConfiguration 变量，该变量通过依赖注入和 ASP.NET 中的所有智能事物进行解析。

但是，在 MSTest 项目中没有这样的。因此，我需要自己创建 IConfiguration 对象才能使用构造函数。我查看了这些 StackOverflow 链接中的代码：

How can I create an instance of IConfiguration locally?

Populate IConfiguration for unit tests

How can I add a custom JSON file into IConfiguration?

Using IConfiguration in C# Class Library

但是，问题是在 NET Core 3.1 中我不能使用这个：

IConfigurationRoot configuration = new ConfigurationBuilder()
            .SetBasePath([PATH_WHERE_appsettings.json_RESIDES])
            .AddJsonFile("appsettings.json")
            .Build();

因此，我求助于将 JSON 文件作为字符串读取，使用 Newtonsoft.Json 将其转换为 Dict<string, string>，然后将其解析为配置文件。它没有经过优化，我必须使用不同的 appsettings.json 结构，因为我无法将 JSON 对象解析为字符串字典。

所以我必须这样做：

{
  "var1": "abc",
  "var2": "def",
  "var3": "hij"
}

而不是这个：

{
  "obj1": {
    "var1": "abc",
    "var2": "def",
    "var3":  "hij"    
  }
}

这是我的实现：

//setup logger
//-------------------
var loggerFactory = LoggerFactory.Create(builder =>
    {
    builder
       .AddFilter("Microsoft", LogLevel.Warning)
       .AddFilter("System", LogLevel.Warning)
       .AddFilter("LoggingConsoleApp.Program", LogLevel.Debug);
    });
    testLogger = loggerFactory.CreateLogger<LocationRecordManagerTests>();
    testLogger.LogInformation("Init FileName of unit tests");

//setup config file
//-------------------
//get file path
string liveFolder = Directory.GetParent(Directory.GetCurrentDirectory()).Parent.FullName;
string projectFolder = Directory.GetParent(liveFolder).FullName;
string filePath = Path.Combine(projectFolder, "testsettings.json");
//get json as string data
string jsonString = File.ReadAllText(filePath);
Dictionary<string, string> jsonDict = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonString);
//build config file
var configBuilder = new ConfigurationBuilder();
configBuilder.AddInMemoryCollection(jsonDict);
var configFile = configBuilder.Build();
//test - this works
//object value = configFile.GetSection("var1");

//create UnitOfWork
//-------------------
testUnitOfWork = new UnitOfWork(testLogger, configFile);

Edit - 解决上面的Json对象解析问题

为了解决将 Json 对象添加到我的 testsettings.json 中的问题，我使用了以下内容：

//setup config file
//-------------------
//get file path
string liveFolder = Directory.GetParent(Directory.GetCurrentDirectory()).Parent.FullName;
string projectFolder = Directory.GetParent(liveFolder).FullName;
string filePath = Path.Combine(projectFolder, "testsettings.json");
//get json as string data
string jsonString = File.ReadAllText(filePath);
Dictionary<string, string> jsonDict, jsonObjectValues;

try
{

    Dictionary<string, object> objectDict = JsonConvert.DeserializeObject<Dictionary<string, object>>(jsonString);

    //get objectData
    object objectData = objectDict.GetValueOrDefault("RecordCollections");
    var jsonObjectData = JsonConvert.SerializeObject(recordData);
    jsonObjectValues = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonRecordData);

    //then use objectDict.Remove(..) to remove duplications

    jsonDict = objectDict.ToDictionary(x => x.Key, x => x.Value.ToString());
}
catch (Exception e)
{
    throw e;
}

//build config file
var configBuilder = new ConfigurationBuilder();
//add variables from json file
configBuilder.AddInMemoryCollection(jsonDict);
// add object variables from json file
configBuilder.AddInMemoryCollection(jsonObjectValues);
var configFile = configBuilder.Build();

有谁知道如何以更好的方式做到这一点？

Answer 1

请参阅此Configuration in ASP.NET Core 示例 bind-hierarchical-configuration-data-using-the-options-pattern。无论将配置放在appsettings.json 还是testsettings.json 中，您都可以将它们绑定到您的模型中，命名为UnitOfWorkModel，例如下面的示例。

appsettings.json

{
  "Logging": {
    "LogLevel": {
      "Default": "Information"
    }
  },
  "UnitOfWork": {
    "var1": "abc",
    "var2": "def",
    "var3": "hij"
  }
}

testsettings.json

{
  "var1": "abc",
  "var2": "def",
  "var3": "hij"
}

你可以先声明一个绑定模型进行配置

public class UnitOfWorkModel
{
    public string Var1 { get; set; }
    public string Var2 { get; set; }
    public string Var3 { get; set; }
}

然后，在 .NET Core 启动时从原生 IConfiguration 对象绑定到 UnitOfWorkModel

public Startup(IConfiguration configuration)
{
    IConfigurationSection section = configuration.GetSection("UnitOfWork");
    IConfiguration configuration = section as IConfiguration;

    IEnumerable<IConfigurationSection> items = configuration.GetSection("UnitOfWork").GetChildren();
    // items.Count() == 3

    Dictionary<string, string> dict = items.ToDictionary(o => o.Key, o => o.Value);
    // dict.Count() == 3

    var unitOfWorkModel = new UnitOfWorkModel();
    section.Bind(unitOfWorkModel);
    // unitOfWorkModel.Var1 == "abc";
    // unitOfWorkModel.Var2 == "def";
    // unitOfWorkModel.Var3 == "hij";
}

或者，通过 unittest 测试绑定结果（这里是带有依赖关系的 .NET Core 的 xUnit 测试框架示例，Microsoft.Extensions.Configuration.Json NuGet 包）

[xUnit]
public void BindTest()
{
    IConfigurationRoot root = new ConfigurationBuilder()
        .AddJsonFile("testsettings.json")
        .Build();

    IConfiguration configuration = root as IConfiguration;
    Assert.NotNull(configuration);

    var unitOfWorkModel = new UnitOfWorkModel();
    root.Bind(unitOfWorkModel);

    Assert.Equals("abc", unitOfWorkModel.Var1);
    Assert.Equals("def", unitOfWorkModel.Var2);
    Assert.Equals("hij", unitOfWorkModel.Var3);
}

任何一种方式都应该适用于超级界面IConfiguration。