[解決] .NET 5.0 の xUnit 単体テストプロジェクトに app.config を配置しても読み取れない

C# による Windows OS 用のアプリケーション開発における話。

.NET Framework 製の古いプログラムを .NET5.0 に移植を進めたりすることがある。

そのような古いプログラムでは、System.Configuration.ConfigurationManager クラスを使い、その静的プロパティ AppSettings[] を参照して、アプリケーション構成を読み取る実装だったりする。

ここでいうアプリケーション構成は、<.exeファイル名>.config という XML 形式のファイル中、"appSettings" というノード内のエントリとして設定される。

例えば下記のような XML だ。

<configuration>

  <appSettings>

    <add key="foo" value="bar"/>

  </appSettings>

</configuration>

このような <.exeファイル名>.config がある場合、その .exe を実行したときには、ConfigurationManager.AppSettings["foo"] を参照すると "bar" が返る、といった次第。

また、プロジェクトフォルダ直下に App.config というファイル名で構成ファイルを置いておけば、ビルド時に自動で出力フォルダに <.exe ファイル名>.config というファイル名でコピーされるようになっている。

xUnit 単体テストでアプリケーション構成が読み取れない

さてこのような古いプログラムの .NET 5.0 化を進めるにあたり、アプリケーション構成の読み取りも IOptions<T> ベースのモダンな方式に移行するのが本来なのだろう。

だが、諸事情でなかなかそうもいかないこともある。

ということで、ある日とある案件にて、ConfigurationManager.AppSettings[] を使う方式のまま、xUnit による単体テストを追加するという、希な機会に恵まれ (?) た。 

ということで、xUnit 単体テストを作成し、その単体テストプロジェクト直下に App.config ファイルを配置。

しかしこれで実行したところ、当初の期待に反し、問題発生。
その App.config の内容がテストコード内で読み取れなかったのだ。

原因は?

このテストプロジェクトの出力フォルダを参照してみたところ、下図のように、構成ファイルのファイル名は "TestProject1.config" となっていた。

しかし上図を見るとわかるように、どうやら単体テスト実行時のプロセス名 (.exe 名) は "testhost.exe" であるらしいことがわかる。

更に言うと、実は上図で見えている "testhost.exe" はどうやら "ドライバー" とよばれる .NET Core プログラムのブートストラッパーであるらしく、単体テスト実行プログラム本体は "testhost.dll" とのこと。

すなわち、System.Configuration.ConfigurationManager が参照する .config ファイル名は、"testhost.dll.config" ということになる。

ところが、ビルドシステムの都合上、プロジェクトフォルダ直下においた App.config ファイルは、単体テストアセンブリファイル名 + .config で出力フォルダにコピーされる。
そのため、上記事例では .config ファイル名が "TestProject1.dll.config" となってしまった。

以上のカラクリのために、単体テストコード中から App.config に設定した内容を読み取れない (参照する .config ファイル名が、単体テスト実行時のプロセス名と合致しないから) ということになるようだ。

解決

ということで、原因がわかってしまえば、対処は簡単だ。

単体テストプロジェクトフォルダ直下に配置する構成ファイルのファイル名を、App.config ではなく、"testhost.dll.config" とし、出力フォルダへのコピーの設定を "新しければコピー" に設定しておくのだ。

これで xUnit 単体テストコード中からも、期待したとおり、.config ファイルの内容を読み取れるようになった。