Assert with Grace: Benutzerdefinierte Soft Assertions mit AssertJ für saubereren Code

Einführung

Wenn Sie nicht wissen, was eine Soft Assertion ist, lesen Sie bitte Soft Asserts – Warum sollten Sie sie für Unit- und Integrationstests verwenden?

Dieser Artikel ist eine Fortsetzung von Assert with Grace: Custom Assertions for Cleaner Code, der Ihnen zeigt, wie Sie mit AssertJ benutzerdefinierte Assertionen erstellen. Hier erfahren Sie, wie Sie den Ansatz erweitern können, um den Soft-Assertion-Ansatz zusätzlich zur benutzerdefinierten Assertion zu verwenden.

Benutzerdefinierte weiche Behauptungen mit AssertJ

Sie können eine harte Behauptung mit der Assertions-Klasse von AssertJ oder einer benutzerdefinierten Klasse erstellen. Um alle Vorteile der Soft Assertion nutzen zu können, müssen wir Folgendes tun:

• Eine benutzerdefinierte Behauptung implementieren lassen
• Erstellen Sie die benutzerdefinierte Soft-Assertion-Klasse und erweitern Sie die AbstractSoftAssertions von AssertJ

Die benutzerdefinierte Behauptung

Wie Sie eine benutzerdefinierte Behauptung erstellen, haben Sie im Artikel „Assert with Grace: Benutzerdefinierte Behauptungen für saubereren Code“ erfahren. Es sieht so aus:

public class SimulationAssert extends AbstractAssert<SimulationAssert, Simulation> {
    protected SimulationAssert(Simulation actual) {
        super(actual, SimulationAssert.class);
    }
    public static SimulationAssert assertThat(Simulation actual) {
        return new SimulationAssert(actual);
    }
    public SimulationAssert hasValidInstallments() {
        isNotNull();
        if (actual.getInstallments() < 2 || actual.getInstallments() >= 48) {
            failWithMessage("Installments must be must be equal or greater than 2 and equal or less than 48");
        }
        return this;
    }
    public SimulationAssert hasValidAmount() {
        isNotNull();
        var minimum = new BigDecimal("1.000");
        var maximum = new BigDecimal("40.000");
        if (actual.getAmount().compareTo(minimum) < 0 || actual.getAmount().compareTo(maximum) > 0) {
            failWithMessage("Amount must be equal or greater than $ 1.000 or equal or less than than $ 40.000");
        }
        return this;
    }
}

Die Verwendung der benutzerdefinierten Behauptung sorgt für eine bessere Lesbarkeit im Test und überträgt ihr die Verantwortung für das Testen der gültigen Werte:

class SimulationsCustomAssertionTest {
    @Test
    void simulationErrorAssertion() {
        var simulation = Simulation.builder().name("John").cpf("9582728395").email("john@gmail.com")
                .amount(new BigDecimal("1.500")).installments(5).insurance(false).build();
        SimulationAssert.assertThat(simulation).hasValidInstallments();
        SimulationAssert.assertThat(simulation).hasValidAmount();
    }
}

Da die benutzerdefinierte Behauptung vorliegt, ist es an der Zeit, die benutzerdefinierte weiche Behauptung zu implementieren.

Erstellen Sie die benutzerdefinierte Soft-Assertion

Es gibt einen einfachen Prozess zum Erstellen der benutzerdefinierten Soft-Assertion, bei dem die Implementierung einer benutzerdefinierten Assertion die Voraussetzung ist. Angesichts des vorherigen Artikels haben wir die SimulationAssert-Klasse als benutzerdefinierte Assertion und werden SimulationSoftAssert als benutzerdefinierte Soft-Assertion erstellen. Dies sind die Schritte:

1. Erweitern Sie die AbstractSoftAssertions-Klasse
2. Erstellen Sie die Methode „asserThat()“ mit:
   • Die Methode gibt ein Objekt als benutzerdefinierte Assertionsklasse zurück
   • ein Parameter für das Subjekt der Behauptung
   • Die Methode gibt den Methoden-Proxy zurück, wobei die Parameter die benutzerdefinierte Assertionsklasse und das Subjekt der Assertion sind
3. Erstellen Sie die AssertSoftly()-Methode mit:
   • ein Parameter als Verbraucher für die benutzerdefinierte Soft Assert-Klasse
   • Verwenden Sie die Methode SoftAssertionsProvider.assertSoftly(), da der Parameter die benutzerdefinierte Soft-Assertion-Klasse und der Methodenparameter ist

Die Schritte sehen komplex aus, aber in der Praxis werden Sie am Ende auf Folgendes stoßen:

public class SimulationSoftAssert extends AbstractSoftAssertions {
    public SimulationAssert assertThat(Simulation actual) {
        return proxy(SimulationAssert.class, Simulation.class, actual);
    }
    public static void assertSoftly(Consumer<SimulationSoftAssert> softly) {
        SoftAssertionsProvider.assertSoftly(SimulationSoftAssert.class, softly);
    }
}

Verwenden der benutzerdefinierten Soft Assertion

Die AssertJ SoftAssertion-Klasse ist für die Soft Assertions verantwortlich. Dies ist das Beispiel, das auf den Simulationskontext anwendbar ist:

Die AssertJ SoftAssertion-Klasse ist für die Soft Assertions verantwortlich. Dies ist das Beispiel, das auf den Simulationskontext anwendbar ist:

public class SimulationAssert extends AbstractAssert<SimulationAssert, Simulation> {
    protected SimulationAssert(Simulation actual) {
        super(actual, SimulationAssert.class);
    }
    public static SimulationAssert assertThat(Simulation actual) {
        return new SimulationAssert(actual);
    }
    public SimulationAssert hasValidInstallments() {
        isNotNull();
        if (actual.getInstallments() < 2 || actual.getInstallments() >= 48) {
            failWithMessage("Installments must be must be equal or greater than 2 and equal or less than 48");
        }
        return this;
    }
    public SimulationAssert hasValidAmount() {
        isNotNull();
        var minimum = new BigDecimal("1.000");
        var maximum = new BigDecimal("40.000");
        if (actual.getAmount().compareTo(minimum) < 0 || actual.getAmount().compareTo(maximum) > 0) {
            failWithMessage("Amount must be equal or greater than $ 1.000 or equal or less than than $ 40.000");
        }
        return this;
    }
}

Das „Problem“ bei der Verwendung besteht darin, dass wir die von uns erstellte benutzerdefinierte Behauptung nicht verwenden können. Im obigen Beispiel können Sie die Zusicherungen in den Raten und dem Betrag mithilfe von isEqualTo() sehen, da die SoftAssertions-Klasse keinen Zugriff auf die benutzerdefinierte Zusicherung hat.

Wir haben dieses Problem gelöst, indem wir die benutzerdefinierte Soft-Assertions-Klasse erstellt haben. Anstatt also die SoftAssertions-Klasse zu verwenden, verwenden wir die benutzerdefinierte: SimulationSoftAssert.

class SimulationsCustomAssertionTest {
    @Test
    void simulationErrorAssertion() {
        var simulation = Simulation.builder().name("John").cpf("9582728395").email("john@gmail.com")
                .amount(new BigDecimal("1.500")).installments(5).insurance(false).build();
        SimulationAssert.assertThat(simulation).hasValidInstallments();
        SimulationAssert.assertThat(simulation).hasValidAmount();
    }
}

SimulationSoftAssert.assertSoftly() ist ein Anbieter für die Soft-Assertion, der alle internen Methoden aufruft, um die Fehler und andere Aktivitäten während der Assertionen verwalten zu können. Das verwendete „asserThat()“ innerhalb von „asserSoftly()“ ist das benutzerdefinierte Element, das Zugriff auf die benutzerdefinierte Assertion durch „proxy()“ zwischen der Soft-Assertion und dem Subjekt der Assertion hat.

Mit diesem Ansatz stehen uns die benutzerdefinierten Behauptungen in der Soft-Assertion durch die Implementierung einer benutzerdefinierten Behauptung zur Verfügung.

Das Ende

Das ist alles, Leute!

Ein vollständig implementiertes und funktionierendes Beispiel finden Sie im Credit-API-Projekt, wo Sie Folgendes sehen können:

• SimulationAssert-Klasse
• Testverwendung in der SimulationsCustomAssertionTest-Klasse

Das obige ist der detaillierte Inhalt vonAssert with Grace: Benutzerdefinierte Soft Assertions mit AssertJ für saubereren Code. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!