VisualStudio C# のテストで｢PrivateObject｣が使用できません

Question

C#の単体テストを作成しています
｢MainWindow｣にprivateなメソッドがある為
そのテストを行う為、色々調べた結果
PrivateObject　を使用すると出てきたので記述してしましたが
変数の宣言部分でエラーが出てしまいます

C#も単体テストも勉強を始めたばかりなので
的外れなコーディングかも知れませんが
アドバイスをお願いします

調べたこと

TestFrameworkのバージョンが関係あるような記述も発見したので
ソリューションエクスプローラーで確認してみましたが

　プロジェクト名Tests － 依存関係 － パッケージ － MSTest.TestFramework(2.0.0)

の中に

Microsoft.VisualStudio.TestPlatform.TestFramework.dll
Microsoft.VisualStudio.TestPlatform.TestFramework.Extensions.dll

の二つが存在しており、バージョンも2.0で最新のようです

---

PrivateObject が存在する
Namespace:Microsoft.VisualStudio.TestTools.UnitTesting
に同じく存在しているAssertなどは使えています

---

エラーの内容

エラー CS0246
型または名前空間の名前 'PrivateObject' が見つかりませんでした (using ディレクティブまたはアセンブリ参照が指定されていることを確認してください)。

---

using Microsoft.VisualStudio.TestTools.UnitTesting;
using PlaceTheProcessingData;
using System;
using System.Collections.Generic;
using System.Text;

namespace PlaceTheProcessingData.Tests
{
    [TestClass()]
    public class MainWindowTests
    {
        [TestMethod()]
        public void MainWindowTest()
        {
            Assert.Fail();
        }

        [TestMethod()]
        public void GetDataGridItemTest()
        {
            Assert.Fail();
        }

        [TestMethod()]
        public void setDataTest()
        {

            PrivateObject privateObject = new PrivateObject(); // ここにエラーが出ます

            Assert.Fail();
        }

        [TestMethod()]
        public void test_ClickTest()
        {
            Assert.Fail();
        }
    }
}

Comments

[BluOxy]

PrivateObjectクラスには引数なしのコンストラクタはなさそうです。
https://docs.microsoft.com/en-us/dotnet/api/microsoft.visualstudio.testtools.unittesting.privateobject?view=mstest-net-1.2.0

何か引数を入れたらコンパイルは通りませんか。

[as00000]

アドバイスありがとうございます

PrivateObject privateObject = new PrivateObject();　の部分を
　↓
MainWindow mainWindow = new MainWindow();
PrivateObject privateObject = new PrivateObject(mainWindow);

にしてみましたが、同じエラーが出ています

[BluOxy]

.NET Frameworkもしくは.NET Coreのバージョンはいくつでしょうか。

[as00000]

プロジェクト　－　プロパティ　で確認出来る
対象のフレームワーク　は
.NET Core 3.0 にしてあります

（これで質問の回答になっているかも分かっていない状況です。申し訳ありません）

Answer 1

こんにちは。

PrivateObject は MSTest.TestFramework の中で net45 or later にのみ提供されています。
UWP や .NET Core で書かれたアプリケーションプロジェクトとその単体テストプロジェクトに対しては PrivateObject は利用できません。
どうして廃止されたのかは分かりませんが。

テストのポリシーはいろいろありますが、個人的な意見を述べると、
private なメソッドは「テスト対象にはならない」と考えます。
単体テストの「単体」とは「一つの機能」のことであり、「機能」とは、「public に公開された API」のことであるとみなすことができ、このとき「公開されていないメソッド」は「機能」に該当しないわけです。
もし、private なメソッドにテストしたいほどのロジックが含まれているとすると、そのクラスは多すぎる責務を持っていると考えることができます。
private メソッドが含んでいる「機能」を洗い出し、その「機能を提供するクラス」を新たに作り public メソッドとして機能を定義し直すことで、「公開されていないロジック」を「public に提供されている機能」に置き換えることができ、単体テストの対象にすることができます。
private なメソッドをテストしなければならないようなコードを書かないように少しずつセオリーを覚えていくと良いです。

Comments

[as00000]

回答ありがとうございます
基本的な事が分かっていませんでしたが
「やるべきではない」事だったから、機能が提供されなくなったのかも知れませんね
ご指摘された事を理解し実現出来るよう、勉強して行きたいと思います

Answer 2

.NET Core 2.0の場合、利用不可とのことです。3.0も同様と思います。
The type or namespace name 'PrivateObject' could not be found

しかし、C#の機能の１つであるリフレクションを用いることでPrivateObject相当のことができることにはできます。

ただ、それを試すのは、もうリリース済みで手を簡単には入れられないコードをテストしたいケース に陥ったときの最終手段だと考えてください。

そもそも論

privateメソッドに対するテストは上記のようなケースでしか一般的には行いません。

使う側は、そのモジュールで用意されているpublicなメソッドを呼び、そのメソッド経由で呼ばれるprivateメソッドを呼び、最終的にpublicメソッドから意図した戻り値が返ってくればテストとして十分であるためです。

privateメソッドの責務が肥大している場合は、どうしてもprivateなメソッドをテストしたくなります。
しかし、その場合はPrivateObjectを使うのではなく、privateメソッドを複数のpublicメソッドに分割し、privateメソッドをテストしないよう見直す方が良いでしょう。

Comments

[as00000]

ご回答ありがとうございます
tamotoさん　も同じようなご指摘を頂いたのですが
「.NET Framework　.NET Coreのバージョン」について
言及して頂いたBluOxyさんの回答をベストアンサーにさせて頂きました

[as00000]

ちなみにですが
private で　void な メソッドの動作確認を行うときは
単体テストを使わないのが一般的なのでしょうか？
（コメント欄での質問で申し訳ありません）

[BluOxy]

voidである・ないに関わらず、privateなメソッドは単体テストを使わないのが一般的ですが、publicかつvoidなメソッドは、そのオブジェクトが持っているプロパティに影響する場合がありますから、そこの状態が正しいかどうかをテストすることができます。

あとは、どのpublicメソッド(void含め)にも言えますが、呼び出し時に例外が発生するかどうかもテストできます。

[as00000]

何でもかんでも「単体テスト」するものだと思い込んでいたのですが
classなどオブジェクトのメソッドが、外からつつかれた時に
期待通りに動くかをメソッド毎にテストする　という感じでしょうか・・・

何にしても「単体テスト」という物の定義などについて、勉強が必要だな　と感じました

初歩的な質問にまでご回答頂きありがとうございました
また、分からない事がありましたら、お世話になるかも知れませんが
その時はよろしくお願いいたします