View Javadoc
1   /*
2    * Copyright (C) 2020-2023 Dipl.-Inform. Kai Hofmann. All rights reserved!
3    */
4   package de.powerstat.validation.values.test;
5   
6   
7   import static org.junit.jupiter.api.Assertions.assertAll;
8   import static org.junit.jupiter.api.Assertions.assertEquals;
9   import static org.junit.jupiter.api.Assertions.assertFalse;
10  import static org.junit.jupiter.api.Assertions.assertNotEquals;
11  import static org.junit.jupiter.api.Assertions.assertThrows;
12  import static org.junit.jupiter.api.Assertions.assertTrue;
13  
14  import org.junit.jupiter.api.Test;
15  import org.junit.jupiter.params.ParameterizedTest;
16  import org.junit.jupiter.params.provider.ValueSource;
17  
18  import de.powerstat.validation.values.Neighbourhood;
19  import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
20  
21  
22  /**
23   * Neighbourhood tests.
24   */
25  @SuppressFBWarnings({"EC_NULL_ARG", "RV_NEGATING_RESULT_OF_COMPARETO", "RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT", "SPP_USE_ZERO_WITH_COMPARATOR"})
26  final class NeighbourhoodTests
27   {
28    /**
29     * Unknown.
30     */
31    private static final String UNKNOWN = "Unknown"; //$NON-NLS-1$
32  
33    /**
34     * Unknown 2.
35     */
36    private static final String UNKNOWN2 = "Unknown2"; //$NON-NLS-1$
37  
38    /**
39     * Illegal argument exception expected constant.
40     */
41    private static final String ILLEGAL_ARGUMENT = "Illegal argument exception expected"; //$NON-NLS-1$
42  
43    /**
44     * Neighbourhood not as expected constant.
45     */
46    private static final String NEIGHBOURHOOD_NOT_AS_EXPECTED = "Neighbourhood not as expected"; //$NON-NLS-1$
47  
48  
49    /**
50     * Default constructor.
51     */
52    /* default */ NeighbourhoodTests()
53     {
54      super();
55     }
56  
57  
58    /**
59     * Test correct Neighbourhood.
60     *
61     * @param neighbourhood Neighbourhood
62     */
63    @ParameterizedTest
64    @ValueSource(strings = {"A", "Abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijkl"})
65    /* default */ void testNeighbourhoodCorrect(final String neighbourhood)
66     {
67      final Neighbourhood cleanNeighbourhood = Neighbourhood.of(neighbourhood);
68      assertEquals(neighbourhood, cleanNeighbourhood.stringValue(), NeighbourhoodTests.NEIGHBOURHOOD_NOT_AS_EXPECTED);
69     }
70  
71  
72    /**
73     * Test Neighbourhood with wrong lengths.
74     *
75     * @param neighbourhood Neighbourhood
76     */
77    @ParameterizedTest
78    @ValueSource(strings = {"", "Abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklm"})
79    /* default */ void testNeighbourhoodLength(final String neighbourhood)
80     {
81      assertThrows(IllegalArgumentException.class, () ->
82       {
83        /* final Neighbourhood cleanNeighbourhood = */ Neighbourhood.of(neighbourhood);
84       }, NeighbourhoodTests.ILLEGAL_ARGUMENT
85      );
86     }
87  
88  
89    /**
90     * Test wrong Neighbourhood.
91     *
92     * @param neighbourhood Neighbourhood
93     */
94    @ParameterizedTest
95    @ValueSource(strings = {"abc_def"})
96    /* default */ void testNeighbourhoodWrong(final String neighbourhood)
97     {
98      assertThrows(IllegalArgumentException.class, () ->
99       {
100       /* final Neighbourhood cleanNeighbourhood = */ Neighbourhood.of(neighbourhood);
101      }, NeighbourhoodTests.ILLEGAL_ARGUMENT
102     );
103    }
104 
105 
106   /**
107    * Test get Neighbourhood.
108    */
109   @Test
110   /* default */ void testStringValue()
111    {
112     final Neighbourhood neighbourhood = Neighbourhood.of(NeighbourhoodTests.UNKNOWN);
113     assertEquals(NeighbourhoodTests.UNKNOWN, neighbourhood.stringValue(), NeighbourhoodTests.NEIGHBOURHOOD_NOT_AS_EXPECTED);
114    }
115 
116 
117   /**
118    * Test hash code.
119    */
120   @Test
121   /* default */ void testHashCode()
122    {
123     final Neighbourhood neighbourhood1 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN);
124     final Neighbourhood neighbourhood2 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN);
125     final Neighbourhood neighbourhood3 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN2);
126     assertAll("testHashCode", //$NON-NLS-1$
127       () -> assertEquals(neighbourhood1.hashCode(), neighbourhood2.hashCode(), "hashCodes are not equal"), //$NON-NLS-1$
128       () -> assertNotEquals(neighbourhood1.hashCode(), neighbourhood3.hashCode(), "hashCodes are equal") //$NON-NLS-1$
129     );
130    }
131 
132 
133   /**
134    * Test equals.
135    */
136   @Test
137   @SuppressWarnings("java:S5785")
138   /* default */ void testEquals()
139    {
140     final Neighbourhood neighbourhood1 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN);
141     final Neighbourhood neighbourhood2 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN);
142     final Neighbourhood neighbourhood3 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN2);
143     final Neighbourhood neighbourhood4 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN);
144     assertAll("testEquals", //$NON-NLS-1$
145       () -> assertTrue(neighbourhood1.equals(neighbourhood1), "neighbourhood11 is not equal"), //$NON-NLS-1$
146       () -> assertTrue(neighbourhood1.equals(neighbourhood2), "neighbourhood12 are not equal"), //$NON-NLS-1$
147       () -> assertTrue(neighbourhood2.equals(neighbourhood1), "neighbourhood21 are not equal"), //$NON-NLS-1$
148       () -> assertTrue(neighbourhood2.equals(neighbourhood4), "neighbourhood24 are not equal"), //$NON-NLS-1$
149       () -> assertTrue(neighbourhood1.equals(neighbourhood4), "neighbourhood14 are not equal"), //$NON-NLS-1$
150       () -> assertFalse(neighbourhood1.equals(neighbourhood3), "neighbourhood13 are equal"), //$NON-NLS-1$
151       () -> assertFalse(neighbourhood3.equals(neighbourhood1), "neighbourhood31 are equal"), //$NON-NLS-1$
152       () -> assertFalse(neighbourhood1.equals(null), "neighbourhood10 is equal") //$NON-NLS-1$
153     );
154    }
155 
156 
157   /**
158    * Test toString.
159    */
160   @Test
161   /* default */ void testToString()
162    {
163     final Neighbourhood neighbourhood = Neighbourhood.of(NeighbourhoodTests.UNKNOWN);
164     assertEquals("Neighbourhood[neighbourhood=Unknown]", neighbourhood.toString(), "toString not equal"); //$NON-NLS-1$ //$NON-NLS-2$
165    }
166 
167 
168   /**
169    * Test compareTo.
170    */
171   @Test
172   @SuppressWarnings("java:S5785")
173   /* default */ void testCompareTo()
174    {
175     final Neighbourhood neighbourhood1 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN);
176     final Neighbourhood neighbourhood2 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN);
177     final Neighbourhood neighbourhood3 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN2);
178     final Neighbourhood neighbourhood4 = Neighbourhood.of("Unknown3r"); //$NON-NLS-1$
179     final Neighbourhood neighbourhood5 = Neighbourhood.of(NeighbourhoodTests.UNKNOWN);
180     assertAll("testCompareTo", //$NON-NLS-1$
181       () -> assertTrue(neighbourhood1.compareTo(neighbourhood2) == -neighbourhood2.compareTo(neighbourhood1), "reflexive1"), //$NON-NLS-1$
182       () -> assertTrue(neighbourhood1.compareTo(neighbourhood3) == -neighbourhood3.compareTo(neighbourhood1), "reflexive2"), //$NON-NLS-1$
183       () -> assertTrue((neighbourhood4.compareTo(neighbourhood3) > 0) && (neighbourhood3.compareTo(neighbourhood1) > 0) && (neighbourhood4.compareTo(neighbourhood1) > 0), "transitive1"), //$NON-NLS-1$
184       () -> assertTrue((neighbourhood1.compareTo(neighbourhood2) == 0) && (Math.abs(neighbourhood1.compareTo(neighbourhood5)) == Math.abs(neighbourhood2.compareTo(neighbourhood5))), "sgn1"), //$NON-NLS-1$
185       () -> assertTrue((neighbourhood1.compareTo(neighbourhood2) == 0) && neighbourhood1.equals(neighbourhood2), "equals") //$NON-NLS-1$
186     );
187    }
188 
189  }