[C#]Moqを使って単体テストをやってみよう！Moqのインストール方法・プロパティの読み書き・結果確認・返却する値を変化させる方法

この記事でわかること

システム
エンジニア

Moqを使った単体テストのやり方が知りたいです。

プロジェクト
マネージャー

まずは、Moqのインストール方法などから説明しますね。

[C#]Moqを使って単体テストをやってみよう！

今回は、C#でのMoqの使い方について説明します。Moqとは、.NET環境の単体テストで使用する、テストの代役を簡単に作るためのライブラリです。ここでは、Moqのインストール方法、プロパティの読み書き、結果確認、返却する値を変化させる方法について紹介します。

C#でのMoqの使い方に興味のある方はぜひご覧ください。

インストール方法

まずはプロジェクトにMoq をインストールします。ここでは、統合開発環境にMicrosoft Visual Studio Community 2019 Previewを使用します。

ツール（T） → NuGet パッケージマネージャー（N） → パッケージマネージャーコンソール（O）と進み、以下のコマンドを実行します。

PM> Install-Package Moq

1	PM> Install-Package Moq

コマンドが成功すると、Moqが使えるようになります。プログラムの頭に「using Moq;」を記載してください。

プロパティの読み書き

C#でMoqを使ったプロパティの読み書きについて紹介します。実際のソースコードを見てみましょう。

using Microsoft.VisualStudio.TestTools.UnitTesting; using Moq; namespace UnitTestProject1 { public interface ISample { // プロパティ string MyProp{ get; set; } } [TestClass] public class UnitTest1 { [TestMethod] public void TestMethod1() { // ISample interfaceのMoqを作成 Mock mock = new Mock(); // 返却する値を変化させる mock.SetupProperty(x => x.MyProp, "sample"); // Moqのインスタンス化。interfaceが返却される System.Console.WriteLine(mock.Object.MyProp); // sample } } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

using Microsoft.VisualStudio.TestTools.UnitTesting; using Moq;   namespace UnitTestProject1 {     public interface ISample     {         // プロパティ         string MyProp{ get; set; }     }       [TestClass]     public class UnitTest1     {         [TestMethod]         public void TestMethod1()         {             // ISample interfaceのMoqを作成             Mock mock = new Mock();               // 返却する値を変化させる             mock.SetupProperty(x => x.MyProp, "sample");               // Moqのインスタンス化。interfaceが返却される             System.Console.WriteLine(mock.Object.MyProp); // sample         }     } }

テストを実行すると、テストエクスプローラーが開きます。テストの成功失敗はアイコンで表示されます。テスト詳細の概要ペインで「この結果に対して追加の出力を開く」をクリックすると、標準出力の内容（この場合、sample）を確認できます。

このようにC#では、Moqを使ったプロパティの読み書きのテストができます。

結果確認（int）

C#でMoqを使った比較（結果確認）の方法について紹介します。Assert.AreEqualメソッドを使用します。実際のソースコードを見てみましょう。

using Microsoft.VisualStudio.TestTools.UnitTesting; using Moq; namespace UnitTestProject1 { public interface ISample { // 加算メソッド int Add(int x, int y); } [TestClass] public class UnitTest1 { [TestMethod] public void TestMethod1() { // ISample interfaceのMoqを作成 Mock mock = new Mock(); // Add(1, 2) = 3を返す設定 mock.Setup(m => m.Add(1, 2)).Returns(3); // Add(3, 4) = 7を返す設定 mock.Setup(m => m.Add(3, 4)).Returns(7); // Moqのインスタンス化。interfaceが返却される var mockMethod = mock.Object; // 結果確認 Assert.AreEqual(3, mockMethod.Add(1, 2)); // 1+2 = 3であることの確認 Assert.AreEqual(7, mockMethod.Add(3, 4)); // 3+4 = 7であることの確認 // Moqが全て呼び出されたか確認 mock.VerifyAll(); } } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

using Microsoft.VisualStudio.TestTools.UnitTesting; using Moq;   namespace UnitTestProject1 {     public interface ISample     {         // 加算メソッド         int Add(int x, int y);     }       [TestClass]     public class UnitTest1     {         [TestMethod]         public void TestMethod1()         {             // ISample interfaceのMoqを作成             Mock mock = new Mock();               // Add(1, 2) = 3を返す設定             mock.Setup(m => m.Add(1, 2)).Returns(3);             // Add(3, 4) = 7を返す設定             mock.Setup(m => m.Add(3, 4)).Returns(7);               // Moqのインスタンス化。interfaceが返却される             var mockMethod = mock.Object;               // 結果確認             Assert.AreEqual(3, mockMethod.Add(1, 2)); // 1+2 = 3であることの確認             Assert.AreEqual(7, mockMethod.Add(3, 4)); // 3+4 = 7であることの確認               // Moqが全て呼び出されたか確認             mock.VerifyAll();         }     } }

テスト実行すると、成功することが分かります。Assert.AreEqual(10, mockMethod.Add(3, 4));などとすると、テストは失敗します。このようにC#では、Assert.AreEqualメソッドで比較（結果の確認）ができます。

結果確認（bool）

C#でMoqを使った結果確認について、戻り値がboolの場合の方法を紹介します。実際のソースコードを見てみましょう。

using Microsoft.VisualStudio.TestTools.UnitTesting; using Moq; namespace UnitTestProject1 { public interface ISample { // 偶数チェックメソッド bool IsEven(int x); } [TestClass] public class UnitTest1 { [TestMethod] public void TestMethod1() { // ISample interfaceのMoqを作成 Mock mock = new Mock(); // IsEven(1) = falseを返す設定 mock.Setup(m => m.IsEven(1)).Returns(false); // IsEven(2) = trueを返す設定 mock.Setup(m => m.IsEven(2)).Returns(true); // Moqのインスタンス化。interfaceが返却される var mockMethod = mock.Object; // 結果確認 Assert.AreEqual(false, mockMethod.IsEven(1)); // 1を入力するとfalseが返却されることの確認 Assert.AreEqual(true, mockMethod.IsEven(2)); // 2を入力するとtrueが返却されることの確認 // Moqが全て呼び出されたか確認 mock.VerifyAll(); } } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

using Microsoft.VisualStudio.TestTools.UnitTesting; using Moq;   namespace UnitTestProject1 {     public interface ISample     {         // 偶数チェックメソッド         bool IsEven(int x);     }       [TestClass]     public class UnitTest1     {         [TestMethod]         public void TestMethod1()         {             // ISample interfaceのMoqを作成             Mock mock = new Mock();               // IsEven(1) = falseを返す設定             mock.Setup(m => m.IsEven(1)).Returns(false);             // IsEven(2) = trueを返す設定             mock.Setup(m => m.IsEven(2)).Returns(true);               // Moqのインスタンス化。interfaceが返却される             var mockMethod = mock.Object;               // 結果確認             Assert.AreEqual(false, mockMethod.IsEven(1)); // 1を入力するとfalseが返却されることの確認             Assert.AreEqual(true, mockMethod.IsEven(2)); // 2を入力するとtrueが返却されることの確認               // Moqが全て呼び出されたか確認             mock.VerifyAll();         }     } }

返却する値を変化させる

C#でMoqを使って、返却する値を変化させられます。SetupSequenceメソッドを使用します。実際のソースコードを見てみましょう。

using Microsoft.VisualStudio.TestTools.UnitTesting; using Moq; namespace UnitTestProject1 { public interface ISample { // 様々な値を返却するメソッド int MySequence(); } [TestClass] public class UnitTest1 { [TestMethod] public void TestMethod1() { // ISample interfaceのMoqを作成 Mock mock = new Mock(); // 返却する値を変化させる mock.SetupSequence(m => m.MySequence()).Returns(1).Returns(2).Returns(3); // Moqのインスタンス化。interfaceが返却される var mockMethod = mock.Object; // 結果確認 System.Console.WriteLine(mockMethod.MySequence()); // 1 System.Console.WriteLine(mockMethod.MySequence()); // 2 System.Console.WriteLine(mockMethod.MySequence()); // 3 } } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

using Microsoft.VisualStudio.TestTools.UnitTesting; using Moq;   namespace UnitTestProject1 {     public interface ISample     {         // 様々な値を返却するメソッド         int MySequence();     }       [TestClass]     public class UnitTest1     {         [TestMethod]         public void TestMethod1()         {             // ISample interfaceのMoqを作成             Mock mock = new Mock();               // 返却する値を変化させる             mock.SetupSequence(m => m.MySequence()).Returns(1).Returns(2).Returns(3);               // Moqのインスタンス化。interfaceが返却される             var mockMethod = mock.Object;               // 結果確認             System.Console.WriteLine(mockMethod.MySequence()); // 1             System.Console.WriteLine(mockMethod.MySequence()); // 2             System.Console.WriteLine(mockMethod.MySequence()); // 3         }     } }

テスト実行し、テスト詳細の概要ペインで「この結果に対して追加の出力を開く」をクリックすると、標準出力の内容（この場合、1,2,3）を確認できます。このようにC#では、Moqを使って返却する値を変化させられます。

システム
エンジニア

Moqの使い方が分かりました。

プロジェクト
マネージャー

Moqについての理解を深めて、実際にコードを書いてみましょう。

まとめ

いかがでしたでしょうか。C#でのMoqの使い方について説明しました。Moqのインストール方法、プロパティの読み書き、結果確認、返却する値を変化させる方法について紹介しました。

ぜひご自身でC#のソースコードを書いて、理解を深めてください。

FEnet.NETナビ・.NETコラムは株式会社オープンアップシステムが運営しています。

株式会社オープンアップシステムはこんな会社です

秋葉原オフィスには株式会社オープンアップシステムをはじめグループのIT企業が集結！
数多くのエンジニアが集まります。

• スマホアプリから業務系システムまで

  

  スマホアプリから業務系システムまで開発案件多数。システムエンジニア・プログラマーとしての多彩なキャリアパスがあります。

• 充実した研修制度

  

  毎年、IT技術のトレンドや社員の要望に合わせて、カリキュラムを刷新し展開しています。社内講師の丁寧なサポートを受けながら、自分のペースで学ぶことができます。

• 資格取得を応援

  

  スキルアップしたい社員を応援するために資格取得一時金制度を設けています。受験料(実費)と合わせて資格レベルに合わせた最大10万円の一時金も支給しています。

• 東証プライム上場企業グループ

  

  オープンアップシステムは東証プライム上場「株式会社オープンアップグループ」のグループ企業です。

  安定した経営基盤とグループ間のスムーズな連携でコロナ禍でも安定した雇用を実現させています。

株式会社オープンアップシステムに興味を持った方へ

株式会社オープンアップシステムでは、開発系エンジニア・プログラマを募集しています。

年収をアップしたい！スキルアップしたい！大手の上流案件にチャレンジしたい！
まずは話だけでも聞いてみたい場合もOK。お気軽にご登録ください。

C＃新着案件New Job

• システム開発/東京都新宿区/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務

  月給29万～34万円
  東京都新宿区(新宿駅)
  • C＃
  • C＋＋
  • C

• システム開発/東京都新宿区/【WEB面談可/C#経験者/20代後半～40代の方活躍中/経験年数不問】/在宅勤務

  月給41万～50万円
  東京都新宿区(新宿駅)
  • C＃
  • C＋＋
  • C

• デバック、テスト項目の作成/神奈川県横浜市/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務

  月給29万～34万円
  神奈川県横浜市(桜木町駅)
  • C＃
  • C＋＋

• デバック、テスト項目の作成/神奈川県横浜市/【WEB面談可/C#経験者/20代後半～40代の方活躍中/経験年数不問】/在宅勤務

  月給41万～50万円
  神奈川県横浜市(桜木町駅)
  • C＃
  • C＋＋

• 基幹システム開発導入/東京都新宿区/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務

  月給29万～34万円
  東京都新宿区(西新宿駅)
  • C＃

• 基幹システム開発導入/東京都新宿区/【WEB面談可/C#経験者/20代後半～40代の方活躍中/経験年数不問】/在宅勤務

  月給41万～50万円
  東京都新宿区(西新宿駅)
  • C＃