无法使用 ConfigurationManager 在 C# .NET Core 单元测试项目中读取 app.config

查看 github 问题的评论，我发现了可以在 msbuild 文件中解决的解决方法...

<Target Name="CopyCustomContent" AfterTargets="AfterBuild">
  <Copy SourceFiles="app.config" DestinationFiles="$(OutDir)\testhost.dll.config" />
</Target>

这使得在将配置数据移植到 json 配置文件之前，可以更轻松地验证 .NET Core 下的现有测试。

编辑

如果在 Resharper 下运行，前面的答案不起作用，因为 Resharper 代理程序集，所以你需要

<Target Name="CopyCustomContent" AfterTargets="AfterBuild">
  <Copy SourceFiles="app.config" DestinationFiles="$(OutDir)\ReSharperTestRunner64.dll.config" />
</Target>

---

如果您检查对 ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None); 的调用结果

它应该告诉您在为该程序集运行单元测试时所需的配置文件应该在哪里。

我发现 ConfigurationManager 不是在寻找 app.config 文件，而是在寻找 testhost.dll.config 文件。

这是针对以 netcoreapp2.1 为目标的项目，并引用了 Microsoft.NET.Test.Sdk、NUnit 3.11 和 Nunit3TestAdapter 3.12.0

---

.CORE 3.1 为了找出正在使用的 dll.config 文件，我通过添加这一行并查看值是什么来调试测试。

string path = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None).FilePath;

然后我发现 resharper 使用的是 testhost.dll.config 而 VStest 使用的是 testhost.x86.dll.config。我需要将以下行添加到项目文件中。

  <Target Name="CopyCustomContent" AfterTargets="AfterBuild">
    <Copy SourceFiles="app.config" DestinationFiles="$(OutDir)\testhost.dll.config" />
    <Copy SourceFiles="app.config" DestinationFiles="$(OutDir)\testhost.x86.dll.config" />
  </Target>

---

我在 xunit 测试中遇到了同样的问题，并通过使用 ConfigurationManager 中的配置实例解决了这个问题。在展示它在所有三个中工作的替代方式之前，我将它的静态（正常）方式放在核心、框架（但不是单元测试）中：

        var appSettingValFromStatic = ConfigurationManager.AppSettings["mySetting"];
        var appSettingValFromInstance = ConfigurationManager.OpenExeConfiguration(Assembly.GetExecutingAssembly().Location).AppSettings.Settings["mySetting"].Value;

这是一个类似/相关的问题。如果有人需要获取一个部分，您可以执行类似的操作，但类型必须在应用配置中更改：

<configSections>
    <section name="customAppSettingsSection" type="System.Configuration.AppSettingsSection"/>
    <section name="customNameValueSectionHandlerSection" type="System.Configuration.NameValueSectionHandler"/>
</configSections>

<customAppSettingsSection>
    <add key="customKey" value="customValue" />
</customAppSettingsSection>

<customNameValueSectionHandlerSection>
    <add key="customKey" value="customValue" />
</customNameValueSectionHandlerSection>

抓取部分的代码：

        var valFromStatic = ((NameValueCollection)ConfigurationManager.GetSection("customNameValueSectionHandlerSection"))["customKey"];
        var valFromInstance = ((AppSettingsSection)ConfigurationManager.OpenExeConfiguration(Assembly.GetExecutingAssembly().Location).GetSection("customAppSettingsSection")).Settings["customKey"].Value;

我觉得我也很疯狂，而且我知道有更新的方式在核心中进行配置，但如果有人想做跨平台的事情，这是我知道的唯一方法。如果有人有替代品，我会很感兴趣

---

对于我的混合 .NET-Core 和 .NET-Framework 项目，我在单元测试全局设置中添加了以下内容：

#if NETCOREAPP
using System.Configuration;
using System.IO;
using System.Reflection;
#endif

...

// In your global setup:
#if NETCOREAPP
    string configFile = $"{Assembly.GetExecutingAssembly().Location}.config";
    string outputConfigFile = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None).FilePath;
    File.Copy(configFile, outputConfigFile, true);
#endif

这会将配置文件复制到输出路径 testhost.dll.config，但应具有足够的弹性以应对测试框架中的未来变化。

或者您可以复制到下面，这相当于同一件事：

string outputConfigFile = Path.Combine(Path.GetDirectoryName(configFile), $"{Path.GetFileName(Assembly.GetEntryAssembly().Location)}.config");

感谢@stop-cran 和@PaulHatcher 的解决方案，这是这两者的结合。

---

当您处理直接访问静态 ConfigurationManager 属性（例如 AppSettings 或 ConnectionStrings）的代码时，此处给出的答案都没有提供可行的解决方法。

事实是，目前是不可能的。您可以通读此处的讨论以了解原因：https://github.com/dotnet/corefx/issues/22101

有讨论在这里实现对它的支持：https://github.com/Microsoft/vstest/issues/1758

在我看来，支持这种方案是有意义的，因为它一直在 .NET Framework 上工作，而且 System.Configuration.ConfigurationManager 现在是一个 .NET Standard 2.0 库。

---

一个 hacky 但可行的方法是将配置复制到与条目程序集相同的文件夹中，无论它是什么：

[SetUpFixture]
public class ConfigKludge
{
    [OneTimeSetUp]
    public void Setup() =>
        File.Copy(
            Assembly.GetExecutingAssembly().Location + ".config",
            Assembly.GetEntryAssembly().Location + ".config",
            true);

    [OneTimeTearDown]
    public void Teardown() =>
        File.Delete(Assembly.GetEntryAssembly().Location + ".config");
}

除了添加这个类之外，唯一让它工作的是在测试项目中包含 app.config 文件（没有任何复制选项）。它应该在构建步骤中作为 <your test project name>.dll.config 复制到输出文件夹，因为它是一种默认逻辑。

请注意 OneTimeSetUpAttribute 的文档：

摘要：标识在运行任何子测试之前调用一次以执行设置的方法。

虽然它应该适用于单个项目的并行测试运行，但同时运行两个测试项目时可能会出现明显的问题，因为配置会被覆盖。

但是，它仍然适用于容器化测试运行，例如 Travis。

---

当我们回答这样一个经过充分研究和明确表达的问题时，我们最好假设它是由一个有见识和聪明的人提出的。而不是用明显的新的，伟大的方式来编写大量样板代码来解析各种 JSON 等，被强加于我们并被知识渊博的人推到我们的喉咙里，而不是光顾他们，我们应该专注于回答这一点.

由于 OP 已经在使用 System.Configuration 访问设置，因此他们已经知道如何到达这一点。唯一缺少的是一点点触动：将这一行添加到构建后事件中：

copy $(OutDir)<appname>.dll.config $(OutDir)testhost.dll.config

其中 是正在单元测试的项目。

我赞扬所有仍在使用（最初是蹩脚但可行的）实施 app.config 的人，因为这样做可以保护我们和我们的客户对技术的投资，而不是重新发明轮子。阿门。

---

ConfigurationManager API 将仅使用当前运行的应用程序的配置。在单元测试项目中，这意味着测试项目的 app.config，而不是控制台应用程序。

.NET Core 应用程序不应使用 app.config 或 ConfigurationManager，因为它是旧的“完整框架”配置系统。

考虑改用 Microsoft.Extensions.Configuration 来读取 JSON、XML 或 INI 配置文件。请参阅此文档：https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration

---

幸运的是，现在有一种方法可以在运行时设置预期配置文件的名称。您可以为当前应用程序域设置 APP_CONFIG_FILE 数据。

我创建了以下 SetUpFixture 来自动执行此操作：

[SetUpFixture]
public class SetUpFixture
{
    [OneTimeSetUp]
    public void OneTimeSetUp()
    {
        var testDllName = Assembly.GetAssembly(GetType())
                                  .GetName()
                                  .Name;
        var configName = testDllName + ".dll.config";
        AppDomain.CurrentDomain.SetData("APP_CONFIG_FILE", configName);
    }
}

相关的 GitHub 讨论是：

ConfigurationManager 找不到带有“dotnet test”的配置文件 · 问题 #22720 · dotnet/runtime

提供一种覆盖全局配置文件路径的方法 · 问题 #931 · dotnet/runtime

通过 krwq 使用 APP_CONFIG_FILE 键尊重 AppContext.SetData · Pull Request #56748 · dotnet/runtime

---

通常在 .NET Framework 项目中，任何 App.config 文件都由 Visual Studio 复制到 bin 文件夹中，并带有可执行文件的名称 (myApp.exe.config)，因此可以在运行时访问它。在 .NET Standard 或 Core Framework 中不再存在。您必须手动复制并设置 bin/debug 或 release 文件夹中的文件。之后，它可能会得到类似的东西：

                string AssemblyName = System.IO.Path.GetFileName(System.Reflection.Assembly.GetEntryAssembly().GetName().CodeBase);
            AppConfig = (System.Configuration.Configuration)System.Configuration.ConfigurationManager.OpenExeConfiguration(AssemblyName);

---

虽然 app.config 存在于根项目文件夹中，但将以下字符串添加到 Post-build event command line

xcopy /Y $(ProjectDir)app.config $(ProjectDir)$(OutDir)testhost.dll.config*

---

添加配置文件

首先，在集成测试项目中添加一个 appconfig.json 文件

通过更新配置将appconfig.json文件复制到输出目录

https://i.stack.imgur.com/vWblN.png

添加 NuGet 包

Microsoft.Extensions.Configuration.Json

在单元测试中使用配置

[TestClass]
public class IntegrationTests
{


    public IntegrationTests()
    {
        var config = new ConfigurationBuilder().AddJsonFile("appconfig.json").Build();

        _numberOfPumps = Convert.ToInt32(config["NumberOfPumps"]);

        _numberOfMessages = Convert.ToInt32(config["NumberOfMessages"]);

        _databaseUrl = config["DatabaseUrlAddress"];
    }
} 

---