Moq C# (開発者のための仕組み)

新しいC#プロジェクトを作成します

新しいプロジェクトを作成するために次の手順に従います:

1. Visual Studioを開き、"ファイル">"新規">"プロジェクト..."に進みます。
2. プロジェクトテンプレートを選択し、設定を構成して"作成"をクリックします。

あなたがATM（自動現金支払機）のソフトウェアを開発していて、認証と引き出し機能をテストする必要があると仮定します。 ATM は、IHostBank と IHSMModule の 2 つのインターフェイスに依存します。 ATM の現金引き出し機能を表す ATMCashWithdrawal クラスをテストします。

ATM システムの依存関係を表す 2 つのインターフェイス IHostBank と IHSMModule を作成します。 AuthenticateAmount や ValidatePIN などの関連メソッドを定義します。

// IHostBank.cs
public interface IHostBank
{
    bool AuthenticateAmount(string accountNumber, int amount);
}

// IHSMModule.cs
public interface IHSMModule
{
    bool ValidatePIN(string cardNumber, int pin);
}

// IHostBank.cs
public interface IHostBank
{
    bool AuthenticateAmount(string accountNumber, int amount);
}

// IHSMModule.cs
public interface IHSMModule
{
    bool ValidatePIN(string cardNumber, int pin);
}

上記の依存関係を使用して ATM 操作を実行する ATMCashWithdrawal クラスを作成します。 このクラスでは、WithdrawAmount のような特定のメソッドを実装します。

// ATMCashWithdrawal.cs
public class ATMCashWithdrawal
{
    private readonly IHSMModule hsmModule;
    private readonly IHostBank hostBank;

    public ATMCashWithdrawal(IHSMModule hsmModule, IHostBank hostBank)
    {
        this.hsmModule = hsmModule;
        this.hostBank = hostBank;
    }

    // Withdraw amount after validating PIN and balance
    public bool WithdrawAmount(string cardNumber, int pin, int amount)
    {
        if (!hsmModule.ValidatePIN(cardNumber, pin))
        {
            return false;
        }

        if (!hostBank.AuthenticateAmount(cardNumber, amount))
        {
            return false;
        }

        // Withdraw the specified amount and perform other operations
        return true;
    }
}

// ATMCashWithdrawal.cs
public class ATMCashWithdrawal
{
    private readonly IHSMModule hsmModule;
    private readonly IHostBank hostBank;

    public ATMCashWithdrawal(IHSMModule hsmModule, IHostBank hostBank)
    {
        this.hsmModule = hsmModule;
        this.hostBank = hostBank;
    }

    // Withdraw amount after validating PIN and balance
    public bool WithdrawAmount(string cardNumber, int pin, int amount)
    {
        if (!hsmModule.ValidatePIN(cardNumber, pin))
        {
            return false;
        }

        if (!hostBank.AuthenticateAmount(cardNumber, amount))
        {
            return false;
        }

        // Withdraw the specified amount and perform other operations
        return true;
    }
}

ユニットテストプロジェクトを作成します

ここで、MOQ を使用して依存関係をモックし、ATMCashWithdrawal クラスの単体テストを作成しましょう。

ソリューションに新しい単体テスト プロジェクトを作成し、ATMSystem.Tests という名前を付けます。

Visual StudioソリューションにNUnitテストプロジェクトを追加するには、次の手順に従います：

1. ソリューションを右クリック: ソリューションエクスプローラー(通常は右側)でソリューション名を右クリックします。
2. 追加 > 新規プロジェクト: コンテキストメニューで"追加"から"新規プロジェクト..."を選択します。
3. 新しいプロジェクトを作成: "新しいプロジェクトの追加"ダイアログで"NUnit"で検索し、利用可能なNUnitテンプレートを見つけます。 以下に示すようにNUnitテストプロジェクトを選択します。

4. プロジェクトを構成: プロジェクト名と場所を含む必要に応じたプロジェクト設定を構成します。
5. OKをクリック: "作成"または"OK"ボタンをクリックしてNUnitテストプロジェクトをソリューションに追加します。

これで、ソリューション内に別のNUnitテストプロジェクトが作成され、ユニットテストを記述および管理できます。 テストしたいプロジェクトへの参照を追加し、このプロジェクトでNUnitテストケースの記述を開始することもできます。

テストプロジェクトでMOQを使用し始めるには、MOQ NuGetパッケージをソリューションに追加する必要があります。 Visual StudioのNuGetパッケージマネージャーを使用するか、パッケージマネージャーコンソールで次のコマンドを実行してこれを行います：

Install-Package Moq

このコマンドにより、プロジェクトに必要なすべての依存関係がインストールされ、追加されます。

NUnit と MOQ を使用して単体テストを記述し、ATMCashWithdrawal クラスの依存関係 (IHostBank および IHSMModule) をモックします。

using Moq;
using NUnit.Framework;

namespace ATMSystem.Tests
{
    public class ATMTests
    {
        private ATMCashWithdrawal atmCash;

        [SetUp]
        public void Setup()
        {
            // Arrange - Setup mock objects
            var hsmModuleMock = new Mock<IHSMModule>();
            hsmModuleMock.Setup(h => h.ValidatePIN("123456781234", 1234)).Returns(true);

            var hostBankMock = new Mock<IHostBank>();
            hostBankMock.Setup(h => h.AuthenticateAmount("123456781234", 500)).Returns(true);

            atmCash = new ATMCashWithdrawal(hsmModuleMock.Object, hostBankMock.Object);
        }

        [Test]
        public void WithdrawAmount_ValidTransaction_ReturnsTrue()
        {
            // Act - Execute the method under test
            bool result = atmCash.WithdrawAmount("123456781234", 1234, 500);

            // Assert - Verify the result
            Assert.IsTrue(result);
        }

        // More test cases for different scenarios (e.g., invalid PIN, insufficient funds)
    }
}

using Moq;
using NUnit.Framework;

namespace ATMSystem.Tests
{
    public class ATMTests
    {
        private ATMCashWithdrawal atmCash;

        [SetUp]
        public void Setup()
        {
            // Arrange - Setup mock objects
            var hsmModuleMock = new Mock<IHSMModule>();
            hsmModuleMock.Setup(h => h.ValidatePIN("123456781234", 1234)).Returns(true);

            var hostBankMock = new Mock<IHostBank>();
            hostBankMock.Setup(h => h.AuthenticateAmount("123456781234", 500)).Returns(true);

            atmCash = new ATMCashWithdrawal(hsmModuleMock.Object, hostBankMock.Object);
        }

        [Test]
        public void WithdrawAmount_ValidTransaction_ReturnsTrue()
        {
            // Act - Execute the method under test
            bool result = atmCash.WithdrawAmount("123456781234", 1234, 500);

            // Assert - Verify the result
            Assert.IsTrue(result);
        }

        // More test cases for different scenarios (e.g., invalid PIN, insufficient funds)
    }
}

このテスト コードでは、MOQ を使用して IHSMModule および IHostBank のモック オブジェクトを作成し、テスト中に呼び出されたときの動作を指定しています。

上記のコード例では、C#のMOQを使用してオブジェクトをモックする概念を示しました。 IHSMModule および IHostBank インターフェイスのモック オブジェクトを作成し、ユニット テスト中の動作をシミュレートします。 これにより、これらのモック オブジェクトの応答を制御することで、ATMCashWithdrawal クラスを分離して徹底的にテストできるようになります。 モッキングを通じて、これらの依存関係とコードが正しく対話することを確認し、テストを焦点を絞って予測可能で、コードの特定の単位内の問題を効果的に特定できます。 このプラクティスは、ソフトウェアの全体的な信頼性、保守性、テストコードの品質を向上させます。

ステップ3 テストの実行

1. すべて最新の状態にするためにあなたのソリューションをビルドします。
2. Visual Studioのテストエクスプローラーを開きます(テスト > テストエクスプローラー)。
3. テストエクスプローラーの"すべて実行"ボタンをクリックしてユニットテストを実行します。
4. テスト結果を確認します。 作成したテスト (WithdrawAmount_ValidTransaction_ReturnsTrue) が合格するはずです。

この方法で、テストを行いたいコードを分離し、依存関係を効果的にモックすることで、さまざまなシナリオで期待通りに動作することを確認できます。 このプラクティスは、開発プロセスの初期に問題を特定および修正するのを容易にし、ソフトウェアの信頼性と保守性を向上させます。

PDF生成のためのモックオブジェクトを作成する

財務報告書を作成し、これらの報告書をPDFドキュメントとして保存し配布する必要があるアプリケーションを開発していると仮定します。 このシナリオでは、PDF生成をテストし、内容とフォーマットが正しいことを確認したいでしょう。

まず、プロジェクトにIronPDFを追加する必要があります。 NuGetパッケージマネージャーコンソールで次のコマンドを書き込んでIronPDFをインストールします。

Install-Package IronPdf

このコマンドはプロジェクトに必要な依存関係をインストールし追加します。

ここでは、IronPDFをユニットテストプロセスに取り入れる方法を紹介します：

モックPDFの生成

IronPDFを使用して、実際の財務報告書を模倣する特定のコンテンツとスタイリングを持つモックPDFドキュメントを作成することができます。 これらのモックPDFは、以下のコードスニペットに示すように、ユニットテストのテストフィクスチャとして使用できます：

public class PDFGenerator
{
    public void GenerateFinancialReport(string reportData)
    {
        var renderer = new ChromePdfRenderer();

        // Generate the report HTML
        string reportHtml = GenerateReportHtml(reportData);
        PdfDocument pdfDocument = renderer.RenderHtmlAsPdf(reportHtml);

        // Save the PDF to a file or memory stream
        pdfDocument.SaveAs("FinancialReport.pdf");
    }

    private string GenerateReportHtml(string reportData)
    {
        // Generate the report HTML based on the provided data
        // (e.g., using Razor views or any HTML templating mechanism)
        // Return the HTML as a string
        return "<h1>my Report</h1>";
    }
}

public class PDFGenerator
{
    public void GenerateFinancialReport(string reportData)
    {
        var renderer = new ChromePdfRenderer();

        // Generate the report HTML
        string reportHtml = GenerateReportHtml(reportData);
        PdfDocument pdfDocument = renderer.RenderHtmlAsPdf(reportHtml);

        // Save the PDF to a file or memory stream
        pdfDocument.SaveAs("FinancialReport.pdf");
    }

    private string GenerateReportHtml(string reportData)
    {
        // Generate the report HTML based on the provided data
        // (e.g., using Razor views or any HTML templating mechanism)
        // Return the HTML as a string
        return "<h1>my Report</h1>";
    }
}

モックPDFを用いたユニットテスト

IronPDFを使用して様々な報告書シナリオを表すモックPDFを生成するテストを書きます。 そして、コードが生成した実際のPDFをこれらのモックPDFと比較して、コンテンツ、フォーマット、構造が期待どおりであるかを確認します。

using IronPdf;
using NUnit.Framework;

internal class PDFGeneratorTests
{
    [Test]
    public void GenerateFinancialReport_CreatesCorrectPDF()
    {
        // Arrange
        var pdfGenerator = new PDFGenerator();
        var expectedPdf = PdfDocument.FromFile("ExpectedFinancialReport.pdf"); // Load a mock PDF

        // Act
        pdfGenerator.GenerateFinancialReport("Sample report data");
        var actualPdf = PdfDocument.FromFile("FinancialReport.pdf");

        // Assert
        Assert.AreEqual(actualPdf.ExtractAllText(), expectedPdf.ExtractAllText());
    }
}

using IronPdf;
using NUnit.Framework;

internal class PDFGeneratorTests
{
    [Test]
    public void GenerateFinancialReport_CreatesCorrectPDF()
    {
        // Arrange
        var pdfGenerator = new PDFGenerator();
        var expectedPdf = PdfDocument.FromFile("ExpectedFinancialReport.pdf"); // Load a mock PDF

        // Act
        pdfGenerator.GenerateFinancialReport("Sample report data");
        var actualPdf = PdfDocument.FromFile("FinancialReport.pdf");

        // Assert
        Assert.AreEqual(actualPdf.ExtractAllText(), expectedPdf.ExtractAllText());
    }
}

このテスト コードでは、予想される出力を表すモック PDF (expectedPdf) を生成し、PDFGenerator によって生成された PDF (actualPdf) と比較します。 両方のPDFのコンテンツを抽出して、同じコンテンツを持っているかどうかを確認しています。