| | 1 | package org.openstreetmap.josm.gui.mappaint.mapcss; |
| | 2 | |
| | 3 | import static org.junit.jupiter.api.Assertions.*; |
| | 4 | |
| | 5 | import java.util.Collections; |
| | 6 | |
| | 7 | import org.junit.jupiter.api.Test; |
| | 8 | |
| | 9 | /** |
| | 10 | * Unit tests for {@link MapCSSRule} verifying the contracts of |
| | 11 | * {@code equals}, {@code hashCode}, and {@code compareTo}. |
| | 12 | */ |
| | 13 | class MapCSSRuleTest { |
| | 14 | |
| | 15 | /** |
| | 16 | * Helper method to create test instances with a specific index. |
| | 17 | * Adjust this factory method to match the actual constructor of MapCSSRule. |
| | 18 | * |
| | 19 | * @param idx the declaration index to assign |
| | 20 | * @return a new {@link MapCSSRule} instance |
| | 21 | */ |
| | 22 | private MapCSSRule createRuleWithIdx(int idx) { |
| | 23 | final Declaration decl = new Declaration(Collections.emptyList(), idx); |
| | 24 | return new MapCSSRule(Collections.emptyList(), decl); |
| | 25 | } |
| | 26 | |
| | 27 | /** |
| | 28 | * Verifies that {@link MapCSSRule#equals(Object)} fulfills the general contract: |
| | 29 | * reflexivity, symmetry, transitivity, and non-nullity. |
| | 30 | */ |
| | 31 | @Test |
| | 32 | void testEqualsContract() { |
| | 33 | final MapCSSRule rule1 = createRuleWithIdx(10); |
| | 34 | final MapCSSRule rule2 = createRuleWithIdx(10); |
| | 35 | final MapCSSRule rule3 = createRuleWithIdx(10); |
| | 36 | final MapCSSRule differentRule = createRuleWithIdx(20); |
| | 37 | |
| | 38 | // Reflexivity: an object must equal itself |
| | 39 | assertEquals(rule1, rule1); |
| | 40 | |
| | 41 | // Symmetry: rule1.equals(rule2) == rule2.equals(rule1) |
| | 42 | assertEquals(rule1, rule2); |
| | 43 | assertEquals(rule2, rule1); |
| | 44 | |
| | 45 | // Transitivity: rule1 == rule2 and rule2 == rule3 => rule1 == rule3 |
| | 46 | assertEquals(rule2, rule3); |
| | 47 | assertEquals(rule1, rule3); |
| | 48 | |
| | 49 | // Inequality for different index values |
| | 50 | assertNotEquals(rule1, differentRule); |
| | 51 | |
| | 52 | // Null and type safety |
| | 53 | assertNotEquals(null, rule1); |
| | 54 | assertNotEquals("A String", rule1); |
| | 55 | } |
| | 56 | |
| | 57 | /** |
| | 58 | * Verifies that equal objects produce identical hash codes |
| | 59 | * as required by {@link Object#hashCode()}. |
| | 60 | */ |
| | 61 | @Test |
| | 62 | void testHashCodeConsistency() { |
| | 63 | final MapCSSRule rule1 = createRuleWithIdx(42); |
| | 64 | final MapCSSRule rule2 = createRuleWithIdx(42); |
| | 65 | |
| | 66 | // Equal objects must return the same hashCode |
| | 67 | assertEquals(rule1, rule2); |
| | 68 | assertEquals(rule1.hashCode(), rule2.hashCode()); |
| | 69 | } |
| | 70 | |
| | 71 | /** |
| | 72 | * Verifies that {@link MapCSSRule#compareTo(MapCSSRule)} is consistent with {@code equals} |
| | 73 | * and orders elements properly. |
| | 74 | */ |
| | 75 | @Test |
| | 76 | void testCompareToAndEqualsConsistency() { |
| | 77 | final MapCSSRule smaller = createRuleWithIdx(5); |
| | 78 | final MapCSSRule equal1 = createRuleWithIdx(10); |
| | 79 | final MapCSSRule equal2 = createRuleWithIdx(10); |
| | 80 | final MapCSSRule larger = createRuleWithIdx(15); |
| | 81 | |
| | 82 | // Consistency with equals: compareTo == 0 if and only if equals == true |
| | 83 | assertEquals(0, equal1.compareTo(equal2)); |
| | 84 | assertEquals(equal1, equal2); |
| | 85 | |
| | 86 | // Verify natural ordering |
| | 87 | assertTrue(smaller.compareTo(larger) < 0); |
| | 88 | assertTrue(larger.compareTo(smaller) > 0); |
| | 89 | } |
| | 90 | |
| | 91 | /** |
| | 92 | * Ensures {@link MapCSSRule#compareTo(MapCSSRule)} handles extreme integer values |
| | 93 | * without suffering from integer overflow. |
| | 94 | */ |
| | 95 | @Test |
| | 96 | void testCompareToNoIntegerOverflow() { |
| | 97 | final MapCSSRule minRule = createRuleWithIdx(Integer.MIN_VALUE); |
| | 98 | final MapCSSRule maxRule = createRuleWithIdx(Integer.MAX_VALUE); |
| | 99 | |
| | 100 | // Verify Integer.compare prevents sign-flipping overflow |
| | 101 | assertTrue(minRule.compareTo(maxRule) < 0); |
| | 102 | assertTrue(maxRule.compareTo(minRule) > 0); |
| | 103 | } |
| | 104 | } |