Comparator Verifier #

Comparison method violates its general contract! #

Jeśli napisałeś komparator, który nie spełnia kontraktu opisanego w Javadoc, to właśnie w ten sposób zazwyczaj się o tym dowiadujesz:

java.lang.IllegalArgumentException: Comparison method violates its general contract!
    at java.util.ComparableTimSort.mergeHi(ComparableTimSort.java:835)
    at java.util.ComparableTimSort.mergeAt(ComparableTimSort.java:453)
    at java.util.ComparableTimSort.mergeForceCollapse(ComparableTimSort.java:392)
    at java.util.ComparableTimSort.sort(ComparableTimSort.java:191)
    at java.util.ComparableTimSort.sort(ComparableTimSort.java:146)
    at java.util.Arrays.sort(Arrays.java:472)
    at java.util.Collections.sort(Collections.java:155)
    ...

Naprawmy to.

Rozpoczęcie pracy #

Comparator Verifier to płynne API do testowania, czy implementacja Comparator spełnia wymagany kontrakt — poprzez napisanie prostego testu jednostkowego.

Dodaj Zależność #

Maven

Dodaj comparatorverifier do swojego pliku pom.xml.

<dependency>
    <groupId>io.github.tomregan</groupId>
    <artifactId>comparatorverifier</artifactId>
    <version>1.0.0</version>
    <scope>test</scope>
</dependency>

Gradle Groovy

Dodaj comparatorverifier do swojego pliku build.gradle.

dependencies {
    testImplementation 'io.github.tomregan:comparatorverifier:1.0.0'
}

Gradle Kotlin

Dodaj comparatorverifier do swojego pliku build.gradle.kts.

dependencies {
    testImplementation("io.github.tomregan:comparatorverifier:1.0.0")
}

Napisz Test #

Napisz test jednostkowy dla swojego komparatora.

@Test
void comparatorContract() {
    ComparatorVerifier.forComparator(FooComparator.class).verify();
}

Dalsze wykorzystanie #

Przykładowe użycie z JUnit #

Comparator Verifier umożliwia konfigurowalną weryfikację, pozwalając na stosowanie zarówno ścisłych, jak i łagodnych sprawdzeń.

Poniżej znajdują się przykładowe przypadki testowe JUnit demonstrujące różne konfiguracje Comparator Verifier.

Weryfikacja łagodna #

import co.mp.ComparatorVerifier;
import org.junit.jupiter.api.DisplayNameGeneration;
import org.junit.jupiter.api.DisplayNameGenerator;
import org.junit.jupiter.api.Test;

@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)
final class FooComparatorTest {

    @Test
    void comparator_contract_is_met() {
        ComparatorVerifier.forComparator(FooComparator.class)
            .permissive()
            .withExamples(new Foo("x"), new Foo("y"))
            .verify();
    }
}

Weryfikacja ścisła #

import co.mp.ComparatorVerifier;
import org.junit.jupiter.api.DisplayNameGeneration;
import org.junit.jupiter.api.DisplayNameGenerator;
import org.junit.jupiter.api.Test;

@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)
final class FooComparatorTest {

    @Test
    void comparator_can_be_serialized_in_a_tree_set() {
        ComparatorVerifier.forComparator(FooComparator.class)
            .strict()
            .withExamples(new Foo("a"), new Foo("b"))
            .verify();
    }
}

Weryfikacja z wyłączonymi ostrzeżeniami #

Comparator, który nie spełnia kontraktu comparatora, nie będzie bezpieczny w użyciu z kolekcjami Javy.
Rozważ użycie permissive() lub strict() aby zmienić zachowanie weryfikacji.

import co.mp.ComparatorVerifier;
import co.mp.Warning;
import org.junit.jupiter.api.DisplayNameGeneration;
import org.junit.jupiter.api.DisplayNameGenerator;
import org.junit.jupiter.api.Test;

@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)
final class FooComparatorTest {

    @Test
    void comparator_contract_is_met() {
        ComparatorVerifier.forComparator(FooComparator.class)
            .withExamples(new Foo("1"), new Foo("2"), new Foo("3"))
            .suppress(Warning.TRANSITIVITY)
            .verify();
    }
}