LinkedDequeTests.java 12.7 KB
Newer Older
Adam Blank's avatar
Adam Blank committed
1
2
3
package edu.caltech.cs2.datastructures;

import edu.caltech.cs2.helpers.Inspection;
4
import edu.caltech.cs2.helpers.NodeChecker;
Adam Blank's avatar
Adam Blank committed
5
6
import edu.caltech.cs2.helpers.Reflection;
import edu.caltech.cs2.helpers.RuntimeInstrumentation;
7
import edu.caltech.cs2.interfaces.*;
Adam Blank's avatar
Adam Blank committed
8
9
10
11
12
13
14
import org.junit.jupiter.api.*;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import org.junit.jupiter.params.provider.ValueSource;

import java.lang.reflect.Constructor;
import java.util.*;
15
import java.util.ArrayDeque;
Adam Blank's avatar
Adam Blank committed
16
17
18
19
import java.util.function.Consumer;
import java.util.function.Function;

import static edu.caltech.cs2.project03.Project03TestOrdering.*;
20
import static java.util.concurrent.TimeUnit.SECONDS;
Adam Blank's avatar
Adam Blank committed
21
import static org.junit.jupiter.api.Assertions.assertEquals;
22
import static org.junit.jupiter.api.Assertions.assertNull;
Adam Blank's avatar
Adam Blank committed
23
24
25

@Tag("C")
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
26
public class LinkedDequeTests implements IDequeTests, IStackTests, IQueueTests {
27
  private static String LINKED_DEQUE_SOURCE = "src/edu/caltech/cs2/datastructures/LinkedDeque.java";
Adam Blank's avatar
Adam Blank committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

  private Constructor linkedDequeConstructor = Reflection.getConstructor(LinkedDeque.class);

  public ICollection<Object> newCollection() {
    return Reflection.newInstance(linkedDequeConstructor);
  }

  public IDeque<Object> newDeque() {
    return Reflection.newInstance(linkedDequeConstructor);
  }

  public IStack<Object> newStack() {
    return Reflection.newInstance(linkedDequeConstructor);
  }

  public IQueue<Object> newQueue() {
    return Reflection.newInstance(linkedDequeConstructor);
  }

  public IQueue<Object> newQueue(int size) {
    return newQueue();
  }

  // LINKEDDEQUE-SPECIFIC TESTS ----------------------------------------

  @Order(classSpecificTestLevel)
  @DisplayName("Does not use or import disallowed classes")
  @Test
  public void testForInvalidClasses() {
    List<String> regexps = List.of("java\\.util\\.(?!Iterator)", "java\\.lang\\.reflect", "java\\.io");
    Inspection.assertNoImportsOf(LINKED_DEQUE_SOURCE, regexps);
    Inspection.assertNoUsageOf(LINKED_DEQUE_SOURCE, regexps);
  }

  @Order(classSpecificTestLevel)
  @DisplayName("There are no static fields")
  @Test
  public void testConstantFields() {
    Reflection.assertFieldsEqualTo(LinkedDeque.class, "static", 0);
  }

  @Order(classSpecificTestLevel)
  @DisplayName("The overall number of fields is small")
  @Test
  public void testSmallNumberOfFields() {
    Reflection.assertFieldsLessThan(LinkedDeque.class, "private", 4);
  }

  @Order(classSpecificTestLevel)
  @DisplayName("There are no public fields")
  @Test
  public void testNoPublicFields() {
    Reflection.assertNoPublicFields(LinkedDeque.class);
  }

83
84
85
86
87
88
89
90
91
92
93
94
95
96
  @Order(classSpecificTestLevel)
  @DisplayName("There are no protected fields")
  @Test
  public void testNoProtectedFields() {
    Reflection.assertNoProtectedFields(LinkedDeque.class);
  }

  @Order(classSpecificTestLevel)
  @DisplayName("All fields in LinkedDeque have modifiers")
  @Test
  public void testFieldModifiers() {
    Reflection.assertFieldModifiers(LinkedDeque.class);
  }

Adam Blank's avatar
Adam Blank committed
97
98
99
100
  @Order(classSpecificTestLevel)
  @DisplayName("The public interface is correct")
  @Test
  public void testPublicInterface() {
101
102
    Reflection.assertPublicInterface(LinkedDeque.class, List.of("addFront", "addBack", "removeFront", "removeBack",
        "enqueue", "dequeue", "push", "pop", "peek", "peekFront", "peekBack", "iterator", "size", "toString"));
Adam Blank's avatar
Adam Blank committed
103
104
105
106
107
108
109
110
111
  }

  @Order(classSpecificTestLevel)
  @DisplayName("Uses this(...) notation in all but one constructor")
  @Test
  public void testForThisConstructors() {
    Inspection.assertConstructorHygiene(LINKED_DEQUE_SOURCE);
  }

112
  @Order(classSpecificTestLevel)
113
  @DisplayName("Check that LinkedDeque uses a node class")
114
115
116
117
118
119
120
121
122
123
  @Test
  public void testLinkedNode() {
    Class[] classes = LinkedDeque.class.getDeclaredClasses();
    for (Class clazz : classes) {
      if (Iterator.class.isAssignableFrom(clazz)) {
        continue;
      }
      NodeChecker.isNode(clazz, true);
    }
  }
Adam Blank's avatar
Adam Blank committed
124
125
126
127
128
129
130
131
132
133
134
135
136

  // TOSTRING TESTS ---------------------------------------------------

  @Order(toStringTestLevel)
  @DisplayName("toString is correctly overridden")
  @Test
  public void testToStringOverride() {
    Reflection.assertMethodCorrectlyOverridden(LinkedDeque.class, "toString");
  }

  @Order(toStringTestLevel)
  @DisplayName("toString() matches java.util.ArrayDeque")
  @ParameterizedTest(name = "Test toString() on [{arguments}]")
137
  @ValueSource(strings = { "0, 1, 2, 3", "5, 4, 3, 2, 1", "8, 3, 5, 7, 4, 3, 12, 12, 1" })
Adam Blank's avatar
Adam Blank committed
138
139
140
141
142
143
144
145
146
147
148
149
150
151
  public void testToString(String inputs) {
    java.util.ArrayDeque<String> reference = new java.util.ArrayDeque<String>();
    LinkedDeque<String> me = new LinkedDeque<>();
    for (String value : inputs.trim().split(", ")) {
      assertEquals(reference.toString(), me.toString(), "toString outputs should be the same");
      reference.addLast(value);
      me.addBack(value);
    }
  }

  // TIME COMPLEXITY TESTS ------------------------------------------------

  @Order(complexityTestLevel)
  @DisplayName("addFront() and removeFront() take constant time")
152
  @Timeout(value = 10, unit = SECONDS)
Adam Blank's avatar
Adam Blank committed
153
154
155
156
157
158
159
160
161
162
163
164
  @Test
  public void testFrontDequeOperationComplexity() {
    Function<Integer, IDeque<Integer>> provide = (Integer numElements) -> {
      IDeque<Integer> q = new LinkedDeque<>();
      for (int i = 0; i < numElements; i++) {
        q.addFront(i);
      }
      return q;
    };
    Consumer<IDeque<Integer>> addFront = (IDeque<Integer> q) -> q.addFront(0);
    Consumer<IDeque<Integer>> removeFront = (IDeque<Integer> q) -> q.removeFront();

165
166
167
168
    RuntimeInstrumentation.assertAtMost("addFront", RuntimeInstrumentation.ComplexityType.CONSTANT, provide, addFront,
        8);
    RuntimeInstrumentation.assertAtMost("removeFront", RuntimeInstrumentation.ComplexityType.CONSTANT, provide,
        removeFront, 8);
Adam Blank's avatar
Adam Blank committed
169
170
171
172
  }

  @Order(complexityTestLevel)
  @DisplayName("addBack() and removeBack() take constant time")
173
  @Timeout(value = 10, unit = SECONDS)
Adam Blank's avatar
Adam Blank committed
174
175
176
177
178
179
180
181
182
183
184
185
186
  @Test
  public void testBackDequeOperationComplexity() {
    Function<Integer, IDeque<Integer>> provide = (Integer numElements) -> {
      IDeque<Integer> q = new LinkedDeque<>();
      for (int i = 0; i < numElements; i++) {
        q.addBack(i);
      }
      return q;
    };
    Consumer<IDeque<Integer>> addBack = (IDeque<Integer> q) -> q.addBack(0);
    Consumer<IDeque<Integer>> removeBack = (IDeque<Integer> q) -> q.removeBack();

    RuntimeInstrumentation.assertAtMost("addBack", RuntimeInstrumentation.ComplexityType.CONSTANT, provide, addBack, 8);
187
188
    RuntimeInstrumentation.assertAtMost("removeBack", RuntimeInstrumentation.ComplexityType.CONSTANT, provide,
        removeBack, 8);
Adam Blank's avatar
Adam Blank committed
189
190
191
192
  }

  @Order(complexityTestLevel)
  @DisplayName("enqueue() and dequeue() take constant time")
193
  @Timeout(value = 10, unit = SECONDS)
Adam Blank's avatar
Adam Blank committed
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
  @Test
  public void testQueueOperationComplexity() {
    Function<Integer, IQueue<Integer>> provide = (Integer numElements) -> {
      IQueue<Integer> q = new LinkedDeque<>();
      for (int i = 0; i < numElements; i++) {
        q.enqueue(i);
      }
      return q;
    };
    Consumer<IQueue<Integer>> enqueue = (IQueue<Integer> q) -> q.enqueue(0);
    Consumer<IQueue<Integer>> dequeue = (IQueue<Integer> q) -> q.dequeue();

    RuntimeInstrumentation.assertAtMost("enqueue", RuntimeInstrumentation.ComplexityType.CONSTANT, provide, enqueue, 8);
    RuntimeInstrumentation.assertAtMost("dequeue", RuntimeInstrumentation.ComplexityType.CONSTANT, provide, dequeue, 8);
  }

  @Order(complexityTestLevel)
  @DisplayName("push() and pop() take constant time")
212
  @Timeout(value = 10, unit = SECONDS)
Adam Blank's avatar
Adam Blank committed
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
  @Test
  public void testStackOperationComplexity() {
    Function<Integer, IStack<Integer>> provide = (Integer numElements) -> {
      IStack<Integer> q = new LinkedDeque<>();
      for (int i = 0; i < numElements; i++) {
        q.push(i);
      }
      return q;
    };
    Consumer<IStack<Integer>> push = (IStack<Integer> q) -> q.push(0);
    Consumer<IStack<Integer>> pop = (IStack<Integer> q) -> q.pop();

    RuntimeInstrumentation.assertAtMost("push", RuntimeInstrumentation.ComplexityType.CONSTANT, provide, push, 8);
    RuntimeInstrumentation.assertAtMost("pop", RuntimeInstrumentation.ComplexityType.CONSTANT, provide, pop, 8);
  }

  @Order(complexityTestLevel)
  @DisplayName("peek() takes constant time")
231
  @Timeout(value = 10, unit = SECONDS)
Adam Blank's avatar
Adam Blank committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
  @Test
  public void testPeekComplexity() {
    Function<Integer, IStack<Integer>> provide = (Integer numElements) -> {
      IStack<Integer> q = new LinkedDeque<>();
      for (int i = 0; i < numElements; i++) {
        q.push(i);
      }
      return q;
    };
    Consumer<IStack<Integer>> peek = (IStack<Integer> q) -> q.peek();

    RuntimeInstrumentation.assertAtMost("peek", RuntimeInstrumentation.ComplexityType.CONSTANT, provide, peek, 8);
  }

  @Order(complexityTestLevel)
  @DisplayName("peekFront() takes constant time")
248
  @Timeout(value = 10, unit = SECONDS)
Adam Blank's avatar
Adam Blank committed
249
250
251
252
253
254
255
256
257
258
259
  @Test
  public void testPeekFrontComplexity() {
    Function<Integer, IDeque<Integer>> provide = (Integer numElements) -> {
      IDeque<Integer> q = new LinkedDeque<>();
      for (int i = 0; i < numElements; i++) {
        q.addFront(i);
      }
      return q;
    };
    Consumer<IDeque<Integer>> peekFront = (IDeque<Integer> q) -> q.peekFront();

260
261
    RuntimeInstrumentation.assertAtMost("peekFront", RuntimeInstrumentation.ComplexityType.CONSTANT, provide, peekFront,
        8);
Adam Blank's avatar
Adam Blank committed
262
263
264
265
  }

  @Order(complexityTestLevel)
  @DisplayName("peekBack() takes constant time")
266
  @Timeout(value = 10, unit = SECONDS)
Adam Blank's avatar
Adam Blank committed
267
268
269
270
271
272
273
274
275
276
277
  @Test
  public void testPeekBackComplexity() {
    Function<Integer, IDeque<Integer>> provide = (Integer numElements) -> {
      IDeque<Integer> q = new LinkedDeque<>();
      for (int i = 0; i < numElements; i++) {
        q.addBack(i);
      }
      return q;
    };
    Consumer<IDeque<Integer>> peekBack = (IDeque<Integer> q) -> q.peekBack();

278
279
280
281
    RuntimeInstrumentation.assertAtMost("peekBack", RuntimeInstrumentation.ComplexityType.CONSTANT, provide, peekBack,
        8);
  }

282
283
  // "LINKED-NESS" TESTS ------------------------------------------------

284
285
286
287
288
289
290
291
292
293
  @Order(dequeTestLevel)
  @DisplayName("Cycle detection for addFront(...), addBack(...), removeFront(...), and removeBack(...)")
  @ParameterizedTest(name = "Test cycles - {1} random numbers with seed = {0}")
  @CsvSource({ "69, 2000", "20, 3000" })
  public void checkForCycles(int seed, int size) {
    Random r = new Random(seed);
    Deque<Object> reference = new ArrayDeque<>();
    IDeque<Object> impl = new LinkedDeque<>();
    // Test that first peek is null
    assertNull(impl.peekFront(), "empty peek should return null");
294
    // Randomly add / remove elements to the front / back
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
    for (int i = 0; i < size; i++) {
      int num = r.nextInt();
      if (num % 2 == 0) {
        reference.addLast(num);
        impl.addBack(num);
      } else {
        reference.addFirst(num);
        impl.addFront(num);
      }
      if (reference.size() > 1 && impl.size() > 1) {
        if (num % 5 == 0) {
          reference.removeFirst();
          impl.removeFront();
        } else if (num % 7 == 0) {
          reference.removeLast();
          impl.removeBack();
        }
      }
313
      // After each operation, check whether cycles have formed
314
      NodeChecker.cycleDetection(impl, true);
315
      // Sanity checks, though these aren't super necessary
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
      assertEquals(reference.size(), impl.size(), "size()s are not equal");
      assertEquals(reference.toString(), impl.toString(), "toStrings()s are not equal");
    }
  }

  @Order(dequeTestLevel)
  @DisplayName("Check reverses for addFront(...), addBack(...), removeFront(...), and removeBack(...)")
  @ParameterizedTest(name = "Test reverse - {1} random numbers with seed = {0}")
  @CsvSource({ "31, 2000", "64, 3000" })
  public void checkReverses(int seed, int size) {
    Random r = new Random(seed);
    Deque<Object> reference = new ArrayDeque<>();
    IDeque<Object> impl = new LinkedDeque<>();
    // Test that first peek is null
    assertNull(impl.peekFront(), "empty peek should return null");
331
    // Randomly add / remove elements to the front / back
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
    for (int i = 0; i < size; i++) {
      int num = r.nextInt();
      if (num % 2 == 0) {
        reference.addLast(num);
        impl.addBack(num);
      } else {
        reference.addFirst(num);
        impl.addFront(num);
      }
      if (reference.size() > 1 && impl.size() > 1) {
        if (num % 5 == 0) {
          reference.removeFirst();
          impl.removeFront();
        } else if (num % 7 == 0) {
          reference.removeLast();
          impl.removeBack();
        }
      }
350
      // Check that forwards and backwards iteration are sane
351
352
353
354
      NodeChecker.checkReverse(impl);
      assertEquals(reference.size(), impl.size(), "size()s are not equal");
      assertEquals(reference.toString(), impl.toString(), "toStrings()s are not equal");
    }
Adam Blank's avatar
Adam Blank committed
355
356
357
  }

}