Moq C# (Jak to działa dla programistów)

Utwórz nowy projekt C

Aby utworzyć nowy projekt, wykonaj następujące kroki:

1. Otwórz Visual Studio, przejdź do "Plik" > "Nowy" > "Projekt...".
2. Wybierz szablon projektu, skonfiguruj ustawienia i kliknij "Utwórz".

Załóżmy, że tworzysz oprogramowanie dla bankomatu (ATM) i musisz przetestować funkcje uwierzytelniania oraz wypłaty gotówki. Bankomat zalezy od dwoch interfejsow: IHostBank oraz IHSMModule. Chcemy przetestowac klase ATMCashWithdrawal, ktora przedstawia funkcjonalnosc wyplaty gotowki przez bankomat.

Utworz dwa interfejsy, IHostBank i IHSMModule, ktore reprezentuja zaleznosci systemu bankomatu. Zdefiniuj odpowiednie metody, takie jak AuthenticateAmount i 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);
}

' IHostBank.cs
Public Interface IHostBank
	Function AuthenticateAmount(ByVal accountNumber As String, ByVal amount As Integer) As Boolean
End Interface

' IHSMModule.cs
Public Interface IHSMModule
	Function ValidatePIN(ByVal cardNumber As String, ByVal pin As Integer) As Boolean
End Interface

Utworz klase ATMCashWithdrawal, ktora wykorzystuje wspomniane powyzej zaleznosci do wykonywania operacji bankomatu. W tej klasie zaimplementujesz pewna metode, jak 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;
    }
}

' ATMCashWithdrawal.cs
Public Class ATMCashWithdrawal
	Private ReadOnly hsmModule As IHSMModule
	Private ReadOnly hostBank As IHostBank

	Public Sub New(ByVal hsmModule As IHSMModule, ByVal hostBank As IHostBank)
		Me.hsmModule = hsmModule
		Me.hostBank = hostBank
	End Sub

	' Withdraw amount after validating PIN and balance
	Public Function WithdrawAmount(ByVal cardNumber As String, ByVal pin As Integer, ByVal amount As Integer) As Boolean
		If Not hsmModule.ValidatePIN(cardNumber, pin) Then
			Return False
		End If

		If Not hostBank.AuthenticateAmount(cardNumber, amount) Then
			Return False
		End If

		' Withdraw the specified amount and perform other operations
		Return True
	End Function
End Class

Utwórz projekt testów jednostkowych

Teraz utworzmy testy jednostkowe dla klasy ATMCashWithdrawal, uzywajac MOQ do symulacji zaleznosci.

Utworz nowy projekt testow jednostkowych w swoim rozwiazaniu i nazwij go ATMSystem.Tests.

Aby dodać projekt testowy NUnit do rozwiązania Visual Studio, wykonaj następujące czynności:

1. Kliknij prawym przyciskiem myszy na Solution: W Solution Explorer (zwykle po prawej stronie), kliknij prawym przyciskiem myszy na nazwę rozwiązania.
2. Dodaj > Nowy projekt: Z menu kontekstowego wybierz "Dodaj", a następnie "Nowy projekt...".
3. Utwórz nowy projekt: W oknie dialogowym "Dodaj nowy projekt" możesz wyszukać "NUnit", aby znaleźć dostępne szablony NUnit. Wybierz projekt testowy NUnit, jak pokazano poniżej.

4. Skonfiguruj projekt: Skonfiguruj ustawienia projektu zgodnie z potrzebami, w tym nazwę i lokalizację projektu.
5. Kliknij OK: Kliknij przycisk "Utwórz" lub "OK", aby dodać projekt testowy NUnit do swojego rozwiązania.

Teraz w ramach rozwiązania masz oddzielny projekt testowy NUnit, w którym możesz pisać testy jednostkowe i nimi zarządzać. Możesz również dodać odniesienia do projektów, które chcesz przetestować, i rozpocząć pisanie przypadków testowych NUnit w tym projekcie.

Aby rozpocząć korzystanie z MOQ w projekcie testowym, należy dodać pakiet MOQ NuGet do swojego rozwiązania. Można to zrobić za pomocą menedżera pakietów NuGet w Visual Studio lub uruchamiając następujące polecenie w konsoli menedżera pakietów:

Install-Package Moq

To polecenie zainstaluje pakiet i doda wszystkie wymagane zależności do projektu.

Napisz testy jednostkowe, uzywajac NUnit i MOQ do symulacji zaleznosci (IHostBank i IHSMModule) klasy ATMCashWithdrawal.

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)
    }
}

Imports Moq
Imports NUnit.Framework

Namespace ATMSystem.Tests
	Public Class ATMTests
		Private atmCash As ATMCashWithdrawal

		<SetUp>
		Public Sub Setup()
			' Arrange - Setup mock objects
			Dim hsmModuleMock = New Mock(Of IHSMModule)()
			hsmModuleMock.Setup(Function(h) h.ValidatePIN("123456781234", 1234)).Returns(True)

			Dim hostBankMock = New Mock(Of IHostBank)()
			hostBankMock.Setup(Function(h) h.AuthenticateAmount("123456781234", 500)).Returns(True)

			atmCash = New ATMCashWithdrawal(hsmModuleMock.Object, hostBankMock.Object)
		End Sub

		<Test>
		Public Sub WithdrawAmount_ValidTransaction_ReturnsTrue()
			' Act - Execute the method under test
			Dim result As Boolean = atmCash.WithdrawAmount("123456781234", 1234, 500)

			' Assert - Verify the result
			Assert.IsTrue(result)
		End Sub

		' More test cases for different scenarios (e.g., invalid PIN, insufficient funds)
	End Class
End Namespace

W tym kodzie testowym uzywamy MOQ do tworzenia obiektow symulujacych IHSMModule i IHostBank oraz okreslania ich zachowania podczas wywolania w tescie.

W powyższym przykładzie kodu zademonstrowaliśmy koncepcję tworzenia obiektów mockowych przy użyciu MOQ w języku C#. Tworzymy obiekty symulacyjne dla interfejsow IHSMModule i IHostBank, symulujac ich zachowanie podczas testowania jednostkowego. Pozwala nam to na izolowanie i dokladne przetestowanie klasy ATMCashWithdrawal poprzez kontrolowanie odpowiedzi tych obiektow symulacyjnych. Dzięki mockowaniu możemy zapewnić, że nasz kod prawidłowo współdziała z tymi zależnościami, dzięki czemu nasze testy są ukierunkowane, przewidywalne i skuteczne w identyfikowaniu problemów w konkretnej jednostce kodu poddanej badaniu. Takie podejście zwiększa ogólną niezawodność, łatwość konserwacji i jakość kodu testowego.

Krok 3 Uruchomienie testów

1. Stwórz swoje rozwiązanie, aby mieć pewność, że wszystko jest aktualne.
2. Otwórz Eksplorator testów w Visual Studio (Test > Eksplorator testów).
3. Kliknij przycisk "Run All" w Test Explorer, aby uruchomić testy jednostkowe.
4. Przejrzyj wyniki testów. Powinienes zobaczyc, ze napisany przez ciebie test (WithdrawAmount_ValidTransaction_ReturnsTrue) przechodzi.

W ten sposób możemy wyodrębnić kod, który chcemy przetestować, i zapewnić, że zachowuje się on zgodnie z oczekiwaniami w różnych scenariuszach poprzez skuteczne symulowanie zależności. Takie podejście zwiększa niezawodność i łatwość konserwacji oprogramowania, ułatwiając identyfikację i naprawę problemów na wczesnym etapie procesu tworzenia.

Tworzenie obiektów zastępczych do generowania plików PDF

Załóżmy, że tworzysz aplikację generującą raporty finansowe, a raporty te muszą być zapisywane i dystrybuowane jako dokumenty PDF. W tym scenariuszu warto przetestować generowanie pliku PDF i upewnić się, że treść oraz formatowanie są poprawne.

Najpierw musimy dodać IronPDF do naszego projektu. Wpisz następujące polecenie w konsoli NuGet Package Manager Console, aby zainstalować IronPDF.

Install-Package IronPdf

To polecenie zainstaluje i doda niezbędne zależności do naszego projektu.

Oto, w jaki sposób IronPDF można włączyć do procesu testowania jednostkowego:

Generowanie przykładowych plików PDF

Możesz użyć IronPDF do tworzenia przykładowych dokumentów PDF o określonej treści i stylistyce, aby naśladować prawdziwe raporty finansowe. Te przykładowe pliki PDF mogą służyć jako elementy testowe dla testów jednostkowych, jak pokazano w poniższym fragmencie kodu:

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>";
    }
}

Public Class PDFGenerator
	Public Sub GenerateFinancialReport(ByVal reportData As String)
		Dim renderer = New ChromePdfRenderer()

		' Generate the report HTML
		Dim reportHtml As String = GenerateReportHtml(reportData)
		Dim pdfDocument As PdfDocument = renderer.RenderHtmlAsPdf(reportHtml)

		' Save the PDF to a file or memory stream
		pdfDocument.SaveAs("FinancialReport.pdf")
	End Sub

	Private Function GenerateReportHtml(ByVal reportData As String) As String
		' 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>"
	End Function
End Class

Testowanie jednostkowe z wykorzystaniem plików PDF typu mock

Napiszemy testy wykorzystujące IronPDF do generowania przykładowych plików PDF przedstawiających różne scenariusze raportów. Następnie porównamy rzeczywiste pliki PDF wygenerowane przez nasz kod z tymi przykładowymi plikami PDF, aby upewnić się, że treść, formatowanie i struktura są zgodne z oczekiwaniami.

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());
    }
}

Imports IronPdf
Imports NUnit.Framework

Friend Class PDFGeneratorTests
	<Test>
	Public Sub GenerateFinancialReport_CreatesCorrectPDF()
		' Arrange
		Dim pdfGenerator As New PDFGenerator()
		Dim expectedPdf = PdfDocument.FromFile("ExpectedFinancialReport.pdf") ' Load a mock PDF

		' Act
		pdfGenerator.GenerateFinancialReport("Sample report data")
		Dim actualPdf = PdfDocument.FromFile("FinancialReport.pdf")

		' Assert
		Assert.AreEqual(actualPdf.ExtractAllText(), expectedPdf.ExtractAllText())
	End Sub
End Class

W tym kodzie testowym generujemy symulowany PDF (expectedPdf) reprezentujacy oczekiwany wynik i porownujemy go z PDF-em (actualPdf) wygenerowanym przez PDFGenerator. Wyodrębniliśmy treść obu plików PDF, aby sprawdzić, czy mają one tę samą treść.