猶予付きアサート: AssertJ を使用したよりクリーンなコードのためのカスタムソフトアサーション-＆＃＆チュートリアル-php.cn

猶予付きアサート: AssertJ を使用したよりクリーンなコードのためのカスタムソフトアサーション

Mary-Kate Olsen

リリース： 2024-11-23 09:11:35

オリジナル

511 人が閲覧しました

Assert with Grace: Custom Soft Assertions using AssertJ for Cleaner Code

導入

ソフトアサーションが何なのかわからない場合は、「ソフトアサーション – 単体テストと統合テストにソフトアサーションを使用する必要がある理由」をお読みください。

この記事は、Assert J を使用してカスタムアサーションを作成する方法を説明する「Assert with Grace: Custom Assertions for Cleaner Code」の続きです。ここでは、そのアプローチを拡張して、カスタムアサーションに加えてソフトアサーションアプローチを使用する方法を学びます。

AssertJ を使用したカスタムソフトアサーション

AssertJ の Assertions クラスまたはカスタムクラスを使用して、ハードアサーションを作成できます。ソフトアサーションの利点をすべて得るには、次のことを行う必要があります。

カスタムアサーションを実装する
カスタムソフトアサーションクラスを作成し、AssertJ から AbstractSoftAssertion を拡張します

カスタムアサーション

カスタムアサーションの作成方法については、「猶予付きアサート: よりクリーンなコードのためのカスタムアサーション」の記事で学習しました。次のようになります:

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

ログイン後にコピー

カスタムアサーションを使用すると、テストでの読みやすさが向上するだけでなく、有効な値をテストする責任がカスタムアサーションに送信されます。

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

ログイン後にコピー

カスタムアサーションを用意したら、カスタムソフトアサーションを実装します。

カスタムソフトアサーションを作成する

カスタムソフトアサーションを作成する簡単なプロセスがあり、前提条件としてカスタムアサーションを実装する必要があります。前の記事を考慮すると、カスタムアサーションとして SimulationAssert クラスがあり、カスタムソフトアサーションとして SimulationSoftAssert を作成します。手順は次のとおりです:

AbstractSoftAssertions クラスを拡張します
次のコマンドを使用して、assertThat() メソッドを作成します。
- メソッドはカスタムアサーションクラスとしてオブジェクトを返します
- アサーションの主題へのパラメータ
- メソッドは、パラメータがカスタムアサーションクラスとアサーションのサブジェクトであるメソッドプロキシを返します
次のコマンドを使用して、assertSoftly() メソッドを作成します。
- カスタムソフトアサートクラスのコンシューマとしてのパラメータ
- パラメータがカスタムソフトアサーションクラスとメソッドパラメータであるため、SoftAssertionsProvider.assertSoftly() メソッドを使用します

手順は複雑に見えますが、実際には次のようになります。

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

ログイン後にコピー

カスタムソフトアサーションの使用

AssertJ SoftAssertion クラスはソフトアサーションを担当します。これは、シミュレーションコンテキストに適用できる例です:

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

ログイン後にコピー

これを使用する場合の「問題」は、作成したカスタムアサーションを使用できないことです。上記の例では、SoftAssertions クラスはカスタムアサーションにアクセスできないため、isEqualTo() を使用して分割払いと金額のアサーションを確認できます。

カスタムソフトアサーションクラスを作成することで、この問題を解決しました。したがって、SoftAssertions クラスを使用する代わりに、カスタムクラス 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() は、アサーション中のエラーやその他のアクティビティを管理できるようにすべての内部メソッドを呼び出すソフトアサーションのプロバイダーです。使用中のassertThat()は、assertSoftly()内で、ソフト・アサートとアサーションのサブジェクトの間のproxy()によってカスタム・アサーションにアクセスできるカスタムのものになります。

このアプローチを使用すると、カスタムアサーションを実装することにより、ソフトアサーションでカスタムアサーションを利用できるようになります。