Moq C# (Cómo funciona para desarrolladores)

Crear un nuevo proyecto C

Sigue los siguientes pasos para crear un nuevo proyecto:

1. Abre Visual Studio, ve a "Archivo" > "Nuevo" > "Proyecto...".
2. Elige una plantilla de proyecto, configura los ajustes y haz clic en "Crear".

Supongamos que estás desarrollando software para un cajero automático (ATM), y necesitas probar la funcionalidad de autenticación y retiro. El ATM depende de dos interfaces: IHostBank y IHSMModule. Queremos probar la clase ATMCashWithdrawal, que representa la funcionalidad de retiro de efectivo del ATM.

Crea dos interfaces, IHostBank y IHSMModule, que representan las dependencias del sistema ATM. Define métodos relevantes como AuthenticateAmount y 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);
}

Crea la clase ATMCashWithdrawal, que utiliza las dependencias mencionadas anteriormente para realizar operaciones del ATM. En esta clase, implementarás un método específico como 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;
    }
}

Crear un proyecto de prueba unitaria

Ahora, vamos a crear pruebas unitarias para la clase ATMCashWithdrawal usando MOQ para mockear las dependencias.

Crea un nuevo proyecto de prueba unitaria en tu solución y llámalo ATMSystem.Tests.

Para agregar un proyecto de prueba NUnit a tu solución de Visual Studio, sigue estos pasos:

1. Haz clic derecho en la Solución: En el Explorador de Soluciones (normalmente en el lado derecho), haz clic derecho en el nombre de la solución.
2. Agregar > Nuevo Proyecto: Desde el menú contextual, selecciona "Agregar" y luego "Nuevo Proyecto...".
3. Crea un Nuevo Proyecto: En el cuadro de diálogo "Agregar Nuevo Proyecto", puedes buscar "NUnit" para encontrar las plantillas de NUnit disponibles. Elige el Proyecto de Prueba NUnit como se muestra a continuación.

4. Configura el Proyecto: Configura la configuración del proyecto según sea necesario, incluido el nombre y ubicación del proyecto.
5. Haz clic en OK: Haz clic en el botón "Crear" o "OK" para agregar el proyecto de prueba NUnit a tu solución.

Ahora, tienes un proyecto de prueba NUnit separado dentro de tu solución donde puedes escribir y administrar tus pruebas unitarias. También puedes agregar referencias a los proyectos que deseas probar y comenzar a escribir tus casos de prueba NUnit en este proyecto.

Para comenzar a usar MOQ en el proyecto de prueba, necesitarás agregar el paquete NuGet de MOQ a tu solución. Puedes hacerlo usando el Administrador de Paquetes NuGet en Visual Studio o ejecutando el siguiente comando en la Consola del Administrador de Paquetes:

Install-Package Moq

Este comando instalará el paquete y agregará todas las dependencias necesarias al proyecto.

Escribe pruebas unitarias usando NUnit y MOQ para mockear las dependencias (IHostBank y IHSMModule) de la clase 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)
    }
}

En este código de prueba, estamos usando MOQ para crear objetos mock para IHSMModule y IHostBank y especificar su comportamiento cuando se llaman durante la prueba.

En el ejemplo de código anterior, hemos demostrado el concepto de mockear objetos usando MOQ en C#. Creamos objetos mock para las interfaces IHSMModule y IHostBank, simulando su comportamiento durante las pruebas unitarias. Esto nos permite aislar y probar a fondo la clase ATMCashWithdrawal controlando las respuestas de estos objetos mock. A través de la utilización de mock, podemos garantizar que nuestro código interactúe correctamente con estas dependencias, haciendo nuestras pruebas enfocadas, predecibles y efectivas en identificar problemas dentro de la unidad específica de código bajo examen. Esta práctica mejora la confiabilidad general, mantenibilidad y calidad del código de prueba.

Paso 3 Ejecutar las pruebas

1. Compila tu solución para asegurarte de que todo esté actualizado.
2. Abre el Explorador de Pruebas en Visual Studio (Prueba > Explorador de Pruebas).
3. Haz clic en el botón "Ejecutar Todo" en el Explorador de Pruebas para ejecutar tus pruebas unitarias.
4. Revisa los resultados de las pruebas. Deberías ver la prueba que escribiste (WithdrawAmount_ValidTransaction_ReturnsTrue) pasar.

De esta manera, podemos aislar el código que queremos probar y asegurar que se comporte como se espera bajo varios escenarios al mockear efectivamente las dependencias. Esta práctica mejora la confiabilidad y mantenibilidad de tu software, haciendo más fácil identificar y corregir problemas temprano en el proceso de desarrollo.

Crear objetos simulados para generar PDF

Supongamos que estás desarrollando una aplicación que genera reportes financieros, y estos reportes deben ser guardados y distribuidos como documentos PDF. En este escenario, podrías querer probar la generación de PDF y asegurar que el contenido y formato sean correctos.

Primero, necesitamos agregar IronPDF a nuestro proyecto. Escribe el siguiente comando en la Consola del Administrador de Paquetes NuGet para instalar IronPDF.

Install-Package IronPdf

Este comando instalará y agregará las dependencias necesarias a nuestro proyecto.

Así es como IronPDF puede incorporarse en el proceso de prueba unitaria:

Generación de PDF simulados

Puedes usar IronPDF para crear documentos PDF mock con contenido y estilos específicos para imitar reportes financieros reales. Estos PDFs mock pueden servir como fixtures de prueba para tus pruebas unitarias, como se muestra en el siguiente fragmento de código:

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

Pruebas unitarias con PDF simulados

Escribiremos pruebas para usar IronPDF para generar PDFs mock que representen varios escenarios de reporte. Entonces, compararemos los PDFs reales generados por nuestro código con estos PDFs mock para asegurar que el contenido, formato y estructura son los esperados.

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

En este código de prueba, generamos un PDF mock (expectedPdf) que representa la salida esperada y lo comparamos con el PDF (actualPdf) generado por el PDFGenerator. Hemos extraído el contenido de ambos PDFs para verificar si tienen el mismo contenido.