Tegaskan dengan Rahmat: Penegasan Lembut Tersuai menggunakan AssertJ untuk Kod Lebih Bersih

pengenalan

Jika anda tidak tahu apa itu penegasan lembut, sila baca Penegasan Lembut – Mengapa anda perlu menggunakannya untuk ujian Unit dan Penyepaduan?

Artikel ini ialah kesinambungan dari Assert with Grace: Custom Assertions for Cleaner Code yang menunjukkan kepada anda cara membuat penegasan tersuai menggunakan AssertJ. Di sini anda akan belajar cara melanjutkan pendekatannya untuk menggunakan pendekatan penegasan lembut di atas penegasan tersuai.

Penegasan Lembut Tersuai dengan AssertJ

Anda boleh mempunyai penegasan keras menggunakan kelas Assertions daripada AssertJ atau yang tersuai. Untuk mendapatkan semua faedah penegasan lembut kita perlu:

• mempunyai penegasan tersuai yang dilaksanakan
• buat kelas penegasan lembut tersuai dan lanjutkan AbstractSoftAssertions daripada AssertJ

Penegasan adat

Anda mempelajari cara membuat penegasan tersuai dalam artikel Assert with Grace: Custom Assertions for Cleaner Code. Ia kelihatan seperti ini:

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

Penggunaan penegasan tersuai menunjukkan lebih kebolehbacaan dalam ujian serta menghantar tanggungjawab untuk menguji nilai yang sah kepadanya:

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

Dengan penegasan tersuai tersedia, tiba masanya untuk melaksanakan penegasan lembut tersuai.

Buat penegasan lembut tersuai

Terdapat proses mudah untuk mencipta penegasan lembut tersuai di mana prasyaratnya adalah untuk melaksanakan penegasan tersuai. Memandangkan artikel sebelumnya, kami mempunyai kelas SimulationAssert sebagai penegasan tersuai dan akan mencipta SimulationSoftAssert sebagai penegasan lembut tersuai. Ini adalah langkah-langkahnya:

1. Melanjutkan kelas AbstractSoftAssertions
2. Buat kaedah assertThat() dengan:
   • kaedah mengembalikan objek sebagai kelas penegasan tersuai
   • parameter kepada subjek penegasan
   • kaedah mengembalikan proksi kaedah dengan parameter ialah kelas penegasan tersuai dan subjek penegasan
3. Buat kaedah assertSoftly() dengan:
   • parameter sebagai Pengguna kepada kelas penegasan lembut tersuai
   • Gunakan kaedah SoftAssertionsProvider.assertSoftly() kerana parameter ialah kelas penegasan lembut tersuai dan parameter kaedah

Langkah-langkahnya kelihatan rumit, tetapi dalam amalan, anda akan berakhir dengan ini:

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

Menggunakan Penegasan Lembut Tersuai

Kelas AssertJ SoftAssertion bertanggungjawab untuk pernyataan lembut. Ini ialah contoh yang boleh digunakan pada konteks Simulasi:

Kelas AssertJ SoftAssertion bertanggungjawab untuk pernyataan lembut. Ini ialah contoh yang boleh digunakan pada konteks Simulasi:

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

"Masalah" menggunakannya ialah kami tidak akan dapat menggunakan penegasan tersuai yang telah kami buat. Dalam contoh di atas, anda boleh melihat penegasan dalam ansuran dan amaun menggunakan isEqualTo() kerana kelas SoftAssertions tidak mempunyai akses kepada penegasan tersuai.

Kami telah menyelesaikan masalah ini dengan mencipta kelas penegasan lembut tersuai. Jadi, daripada menggunakan kelas SoftAssertions, kami akan menggunakan kelas tersuai: 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() ialah penyedia untuk penegasan lembut yang akan memanggil semua kaedah dalaman untuk dapat mengurus ralat dan aktiviti lain semasa penegasan. AssertThat() yang digunakan, di dalam assertSoftly() akan menjadi tersuai yang akan mempunyai akses kepada penegasan tersuai oleh proksi() antara penegasan lembut dan subjek penegasan.

Menggunakan pendekatan ini, kami mempunyai penegasan tersuai yang tersedia dalam penegasan lembut dengan pelaksanaan yang tersuai.

penghujungnya

Itu sahaja semua!

Anda boleh menemui contoh yang dilaksanakan dan berfungsi sepenuhnya dalam projek credit-api, di mana anda boleh melihat perkara berikut:

• Kelas SimulationAssert
• Uji penggunaan dalam kelas SimulationsCustomAssertionTest

Atas ialah kandungan terperinci Tegaskan dengan Rahmat: Penegasan Lembut Tersuai menggunakan AssertJ untuk Kod Lebih Bersih. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!