mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Valery Kharseko
yesterday dc20037ee9959ab05d841422015d7e4358162cbb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2009-2010 Sun Microsystems, Inc.
 * Portions Copyright 2011-2016 ForgeRock AS.
 * Portions Copyright 2026 3A Systems, LLC
 */
package org.opends.server.replication.plugin;
 
import static java.util.concurrent.TimeUnit.*;
 
import static org.mockito.Mockito.*;
import static org.opends.server.util.CollectionUtils.*;
import static org.testng.Assert.*;
 
import java.io.IOException;
import java.net.SocketTimeoutException;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.concurrent.atomic.AtomicBoolean;
 
import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.i18n.slf4j.LocalizedLogger;
import org.forgerock.opendj.config.server.ConfigurationChangeListener;
import org.forgerock.opendj.ldap.DN;
import org.forgerock.opendj.server.config.server.ReplicationSynchronizationProviderCfg;
import org.forgerock.opendj.server.config.server.SynchronizationProviderCfg;
import org.opends.server.TestCaseUtils;
import org.opends.server.api.SynchronizationProvider;
import org.opends.server.core.DirectoryServer;
import org.opends.server.replication.ReplicationTestCase;
import org.opends.server.replication.common.CSNGenerator;
import org.opends.server.replication.common.DSInfo;
import org.opends.server.replication.common.ServerState;
import org.opends.server.replication.common.ServerStatus;
import org.opends.server.replication.protocol.AddMsg;
import org.opends.server.replication.protocol.DoneMsg;
import org.opends.server.replication.protocol.EntryMsg;
import org.opends.server.replication.protocol.InitializeTargetMsg;
import org.opends.server.replication.protocol.ReplSessionSecurity;
import org.opends.server.replication.protocol.ReplicationMsg;
import org.opends.server.replication.protocol.ResetGenerationIdMsg;
import org.opends.server.replication.protocol.RoutableMsg;
import org.opends.server.replication.server.ReplServerFakeConfiguration;
import org.opends.server.replication.server.ReplicationServer;
import org.opends.server.replication.service.ReplicationBroker;
import org.opends.server.types.Entry;
import org.opends.server.util.TestTimer;
import org.opends.server.util.TestTimer.CallableVoid;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
 
/**
 * Some tests to go through the DS state machine and validate we get the
 * expected status according to the actions we perform.
 */
@SuppressWarnings("javadoc")
public class StateMachineTest extends ReplicationTestCase
{
  /** Server id definitions. */
  private static final String EXAMPLE_DN = "dc=example,dc=com";
  private static DN EXAMPLE_DN_;
 
  private static final int DS1_ID = 1;
  private static final int DS2_ID = 2;
  private static final int DS3_ID = 3;
  private static final int RS1_ID = 41;
  private int rs1Port = -1;
  private LDAPReplicationDomain ds1;
  private ReplicationBroker ds2;
  private ReplicationBroker ds3;
  private ReplicationServer rs1;
  /** The tracer object for the debug logger. */
  private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
  private final int initWindow = 100;
 
  private void debugInfo(String s)
  {
    logger.error(LocalizableMessage.raw(s));
    if (logger.isTraceEnabled())
    {
      logger.trace("** TEST **" + s);
    }
  }
 
  private static void shutdown(BrokerReader reader)
  {
    if (reader != null)
    {
      reader.shutdown();
    }
  }
 
  private static void shutdown(BrokerWriter writer)
  {
    if (writer != null)
    {
      writer.shutdown();
    }
  }
 
  private void initTest() throws IOException
  {
    rs1Port = -1;
    ds1 = null;
    ds2 = null;
    ds3 = null;
    rs1Port = TestCaseUtils.findFreePort();
  }
 
  private void endTest() throws Exception
  {
    if (ds1 != null)
    {
      ds1.shutdown();
      ds1 = null;
    }
 
    // Clear any reference to a domain in synchro plugin
    MultimasterReplication.deleteDomain(EXAMPLE_DN_);
    stop(ds2, ds3);
    ds2 = ds3 = null;
    remove(rs1);
    rs1 = null;
    rs1Port = -1;
  }
 
  /** Waits until the provided ds is connected to the replication server. */
  private void waitUntiConnected(final int dsId) throws Exception
  {
    TestTimer timer = new TestTimer.Builder()
      .maxSleep(30, SECONDS)
      .sleepTimes(100, MILLISECONDS)
      .toTimer();
    timer.repeatUntilSuccess(new CallableVoid()
    {
      @Override
      public void call() throws Exception
      {
        assertTrue(isConnected(dsId), "checkConnection: DS " + dsId + " is not connected to the RS");
      }
    });
  }
 
  private boolean isConnected(final int dsId)
  {
    switch (dsId)
    {
    case DS1_ID:
      return ds1.isConnected();
    case DS2_ID:
      return ds2.isConnected();
    case DS3_ID:
      return ds3.isConnected();
    default:
      fail("Unknown ds server id.");
      return false;
    }
  }
 
  /** Creates a new ReplicationServer. */
  private ReplicationServer createReplicationServer(String testCase,
      int degradedStatusThreshold) throws Exception
  {
    SortedSet<String> replServers = new TreeSet<>();
 
    String dir = "stateMachineTest" + RS1_ID + testCase + "Db";
    ReplServerFakeConfiguration conf =
        new ReplServerFakeConfiguration(rs1Port, dir, 0, RS1_ID, 0,
            100, replServers, 1, 1000, degradedStatusThreshold);
    return new ReplicationServer(conf);
  }
 
  /** Creates and starts a new ReplicationDomain configured for the replication server. */
  @SuppressWarnings("unchecked")
  private LDAPReplicationDomain createReplicationDomain(int dsId) throws Exception
  {
    SortedSet<String> replServers = new TreeSet<>();
    replServers.add("localhost:" + rs1Port);
 
    DomainFakeCfg domainConf = new DomainFakeCfg(EXAMPLE_DN_, dsId, replServers);
    LDAPReplicationDomain replicationDomain = MultimasterReplication.createNewDomain(domainConf);
    replicationDomain.start();
    SynchronizationProvider<SynchronizationProviderCfg> provider =
        DirectoryServer.getSynchronizationProviders().get(0);
    if (provider instanceof ConfigurationChangeListener)
    {
      ConfigurationChangeListener<ReplicationSynchronizationProviderCfg> mmr =
          (ConfigurationChangeListener<ReplicationSynchronizationProviderCfg>) provider;
      // An unstubbed mock would return 0 for getNumUpdateReplayThreads()
      // (Mockito's default for Integer instead of null), silently killing the
      // replay thread pool of MultimasterReplication for the rest of the test:
      // stub it so that the default number of replay threads is used.
      ReplicationSynchronizationProviderCfg providerCfg = mock(ReplicationSynchronizationProviderCfg.class);
      when(providerCfg.getNumUpdateReplayThreads()).thenReturn(null);
      when(providerCfg.getConnectionTimeout()).thenReturn(5000L);
      mmr.applyConfigurationChange(providerCfg);
    }
 
    return replicationDomain;
  }
 
  /**
   * Create and connect a replication broker to the replication server with the
   * given state and generation id.
   */
  private ReplicationBroker createReplicationBroker(int dsId,
      ServerState state, long generationId) throws Exception
  {
    SortedSet<String> replServers = newTreeSet("localhost:" + rs1Port);
    DomainFakeCfg fakeCfg = new DomainFakeCfg(EXAMPLE_DN_, dsId, replServers);
    fakeCfg.setHeartbeatInterval(0);
    fakeCfg.setChangetimeHeartbeatInterval(500);
    ReplSessionSecurity security = new ReplSessionSecurity(null, null, null, true);
    ReplicationBroker broker = new ReplicationBroker(
        new DummyReplicationDomain(generationId), state, fakeCfg, security);
    broker.start();
    checkConnection(30, broker);
    return broker;
  }
 
  /**
   * Make simple state machine test.
   *
   * NC = Not connected status
   * N = Normal status
   * D = Degraded status
   * FU = Full update status
   * BG = Bad generation id status
   *
   * The test path should be:
   * ->NC->N->NC
   * @throws Exception If a problem occurred
   */
  @Test(enabled=true)
  public void testStateMachineBasic() throws Exception
  {
    String testCase = "testStateMachineBasic";
 
    debugInfo("Starting " + testCase);
 
    initTest();
 
    try
    {
      // DS1 start, no RS available: DS1 should be in not connected status
      ds1 = createReplicationDomain(DS1_ID);
      waitUntilStatusEquals(ds1, ServerStatus.NOT_CONNECTED_STATUS);
 
      // RS1 starts , DS1 should connect to it and be in normal status
      rs1 = createReplicationServer(testCase, 5000);
      waitUntilStatusEquals(ds1, ServerStatus.NORMAL_STATUS);
 
      // RS1 stops, DS1 should go in not connected status
      rs1.remove();
      waitUntilStatusEquals(ds1, ServerStatus.NOT_CONNECTED_STATUS);
    } finally
    {
      endTest();
    }
  }
 
  /** Returns various init values for test testStateMachineStatusAnalyzer. */
  @DataProvider(name="stateMachineStatusAnalyzerTestProvider")
  public Object [][] stateMachineStatusAnalyzerTestProvider() throws Exception
  {
    return new Object [][] { {1} , {10}, {50}, {120} };
  }
 
  /**
   * Test the status analyzer system that allows to go from normal to degraded
   * and vice versa, using the configured threshold value
   *
   * NC = Not connected status
   * N = Normal status
   * D = Degraded status
   * FU = Full update status
   * BG = Bad generation id status
   *
   * Expected path:
   * ->NC->N->D->N->NC
   * @throws Exception If a problem occurred
   */
  @Test(enabled=true, groups="slow", dataProvider="stateMachineStatusAnalyzerTestProvider")
  public void testStateMachineStatusAnalyzer(int thresholdValue) throws Throwable
  {
    String testCase = "testStateMachineStatusAnalyzer with threhold " + thresholdValue;
 
    debugInfo("Starting " + testCase + " with " + thresholdValue);
 
      initTest();
 
      BrokerReader br3 = null;
      BrokerReader br2 = null;
      BrokerWriter bw = null;
 
    try
    {
      /* RS1 starts with specified threshold value */
      rs1 = createReplicationServer(testCase, thresholdValue);
 
      /*
       * DS2 starts and connects to RS1. No reader and low window value at the beginning
       * so writer for DS2 in RS should enqueue changes after first changes sent to DS.
       * (window value reached: a window msg needed by RS for following sending changes to DS)
       */
      ds2 = createReplicationBroker(DS2_ID, new ServerState(), EMPTY_DN_GENID);
      waitUntiConnected(DS2_ID);
 
      /* DS3 starts and connects to RS1 */
      ds3 = createReplicationBroker(DS3_ID, new ServerState(), EMPTY_DN_GENID);
      br3 = new BrokerReader(ds3, DS3_ID);
      waitUntiConnected(DS3_ID);
 
      // Send first changes to reach window and block DS2 writer queue. Writer will take them
      // from queue and block (no more changes removed from writer queue) after
      // having sent them to TCP receive queue of DS2.
      bw = new BrokerWriter(ds3, DS3_ID, false);
      bw.followAndPause(11);
 
      /*
       * DS3 sends changes (less than threshold): DS2 should still be in normal status
       * so no topo message should be sent (update topo message for telling status of DS2 changed)
       */
      int nChangesSent = 0;
      if (thresholdValue > 1)
      {
        nChangesSent = thresholdValue - 1;
        bw.followAndPause(nChangesSent);
        Thread.sleep(1000); // Be sure status analyzer has time to test
        ReplicationMsg msg = br3.getLastMsg();
        debugInfo(testCase + " Step 1: last message from writer: " + msg);
        assertNull(msg, (msg != null) ? msg.toString() : "null");
      }
 
      /*
       * DS3 sends changes to reach the threshold value,
       * DS3 should receive an update topo message with status of DS2: degraded status
       */
      bw.followAndPause(thresholdValue - nChangesSent);
      // wait for a status MSG status analyzer to broker 3
      waitForDegradedStatusOnBroker3();
 
      /*
       * DS3 sends 10 additional changes after threshold value,
       * DS2 should still be degraded so no topo message received.
       */
      bw.followAndPause(10);
      shutdown(bw);
      Thread.sleep(1000); // Be sure status analyzer has time to test
      ReplicationMsg lastMsg = br3.getLastMsg();
      ReplicationMsg msg = br3.getLastMsg();
      debugInfo(testCase + " Step 3: last message from writer: " + msg);
      assertNull(lastMsg);
 
      /*
       * DS2 replays every changes and should go back to normal status
       * (create a reader to emulate replay of messages (messages read from queue))
       */
      br2 = new BrokerReader(ds2, DS2_ID);
      // wait for a status MSG status analyzer to broker 3
      waitForDegradedStatusOnBroker3();
    } finally
    {
      endTest();
      shutdown(bw);
      shutdown(br3);
      shutdown(br2);
    }
  }
 
  private void waitForDegradedStatusOnBroker3() throws InterruptedException
  {
    for (int count = 0; count< 50; count++)
    {
      DSInfo dsInfo = ds3.getReplicaInfos().get(DS2_ID);
      if (dsInfo != null && dsInfo.getStatus() == ServerStatus.DEGRADED_STATUS)
      {
        break;
      }
 
      assertTrue(count < 50, "DS2 did not get degraded : " + dsInfo);
      Thread.sleep(200); // Be sure status analyzer has time to test
    }
  }
 
  /*
   * Note: the former testStateMachineFull test (a walk through all state
   * machine transitions) has been removed. It had been disabled forever and
   * turned out to be unfixable in its historical form:
   * - it relied on the DS entering the degraded status while replaying a
   *   change flood, which requires the replay to be durably slower than the
   *   publisher; on modern hardware both rates are comparable, making every
   *   degraded transition a race,
   * - the unbounded floods needed to force the degraded status exhaust the
   *   test JVM heap with real backend entries before the status analyzer
   *   (5 second period) reliably observes a non-empty queue with the
   *   degraded threshold of 1.
   * The degraded/normal transitions are still covered deterministically by
   * testStateMachineStatusAnalyzer above.
   */
 
  /**
   * Set up the environment.
   *
   * @throws Exception
   *           If the environment could not be set up.
   */
  @BeforeClass
  @Override
  public void setUp() throws Exception
  {
    super.setUp();
    EXAMPLE_DN_ = DN.valueOf(EXAMPLE_DN);
 
    // Note: this test does not use the memory test backend as for having a DS
    // going into degraded status, we need to send a lot of updates. This makes
    // the memory test backend crash with OutOfMemoryError. So we prefer here
    // a backend backed up with a file
    TestCaseUtils.clearBackend("userRoot");
  }
 
  /**
   * Clean up the environment.
   *
   * @throws Exception If the environment could not be set up.
   */
  @AfterClass
  @Override
  public void classCleanUp() throws Exception
  {
    callParanoiaCheck = false;
    super.classCleanUp();
 
    TestCaseUtils.clearBackend("userRoot");
 
    paranoiaCheck();
  }
 
 
 
  /** Thread for sending a lot of changes through a broker. */
  private class BrokerWriter extends Thread
  {
    private ReplicationBroker rb;
    private int serverId = -1;
    private long userId;
    private AtomicBoolean shutdown = new AtomicBoolean(false);
    /** The writer starts suspended. */
    private AtomicBoolean suspended = new AtomicBoolean(true);
    /**
     * Tells a sending session is finished. A session is sending messages
     * between the follow and the pause calls, or the time a followAndPause
     * method runs.
     */
    private AtomicBoolean sessionDone = new AtomicBoolean(true);
    private boolean careAboutAmountOfChanges;
    /** Number of sent changes. */
    private int nChangesSent;
    private int nChangesSentLimit;
    private CSNGenerator gen;
    private Object sleeper = new Object();
    /**
     * If the BrokerWriter is to be used for a lot of changes to send (which is
     * often the case), the reader thread should be enabled to make the window
     * subsystem work and allow the broker to send as much changes as he wants.
     * If not enabled, the user is responsible to call the receive method of
     * the broker himself.
     */
    private BrokerReader reader;
 
    /** Creates a broker writer. Also creates a reader according to request */
    public BrokerWriter(ReplicationBroker rb, int serverId,
      boolean createReader)
    {
      super("BrokerWriter for broker " + serverId);
      this.rb = rb;
      this.serverId = serverId;
      // Create a csn generator to generate new csns
      // when we need to send changes
      gen = new CSNGenerator(serverId, 0);
 
      // Start thread (is paused by default so will have to call follow anyway)
      start();
 
      // Also create reader ?
      if (createReader)
      {
        reader = new BrokerReader(rb, serverId);
      }
    }
 
    /**
     * Loops sending changes: add operations creating users with different ids
     * This starts paused and has to be resumed calling a follow method.
     */
    @Override
    public void run()
    {
      boolean dbg1Written = false, dbg2Written;
      // No stop msg when entering the loop (thread starts with paused writer)
      dbg2Written = true;
      while (!shutdown.get())
      {
        long startSessionTime = -1;
        boolean startedNewSession = false;
        // When not in pause, loop sending changes to RS
        while (!suspended.get())
        {
          startedNewSession = true;
          if (!dbg1Written)
          {
            startSessionTime = System.currentTimeMillis();
            debugInfo("Broker " + serverId +
              " writer starting sending changes session at: " + startSessionTime);
            dbg1Written = true;
            dbg2Written = false;
          }
          AddMsg addMsg = createNextAddMsg();
          rb.publish(addMsg);
          // End session if amount of changes sent has been requested
          if (careAboutAmountOfChanges)
          {
            nChangesSent++;
            if (nChangesSent == nChangesSentLimit)
            {
              // Requested number of changes to send sent, end session
              debugInfo("Broker " + serverId + " writer reached " +
                nChangesSent + " changes limit");
              suspended.set(true);
              break;
            }
          }
        }
        if (!dbg2Written)
        {
          long endSessionTime = System.currentTimeMillis();
          debugInfo("Broker " + serverId +
            " writer stopping sending changes session at: " + endSessionTime +
            " (duration: " + (endSessionTime - startSessionTime) + " ms)");
          dbg1Written = false;
          dbg2Written = true;
        }
        // Mark session is finished
        if (startedNewSession)
        {
          sessionDone.set(true);
        }
 
        try
        {
          // Writer in pause, sleep a while to let other threads work
          synchronized(sleeper)
          {
            sleeper.wait(1000);
          }
        } catch (InterruptedException ex)
        {
          /* Don't care */
        }
      }
      debugInfo("Broker " + serverId + " writer thread is dying");
    }
 
    /** Stops the writer thread. */
    public void shutdown()
    {
      suspended.set(true); // If were working
      shutdown.set(true);
      synchronized (sleeper)
      {
        sleeper.notify();
      }
      try
      {
        join();
      } catch (InterruptedException ex)
      {
        /* Don't care */
      }
 
      // Stop reader if any
      StateMachineTest.shutdown(reader);
    }
 
    /** Suspends the writer thread. */
    public void pause()
    {
      if (isPaused())
      {
        return; // Already suspended
      }
      suspended.set(true);
      // Wait for all messages sent
      while (!sessionDone.get())
      {
        TestCaseUtils.sleep(200);
      }
    }
 
    /** Test if the writer is suspended. */
    public boolean isPaused()
    {
      return sessionDone.get();
    }
 
    /** Resumes the writer thread until it is paused. */
    public void follow()
    {
      sessionDone.set(false);
      suspended.set(false);
    }
 
    /**
     * Resumes the writer and suspends it after a given amount of changes has been
     * sent. If the writer was working it will be paused anyway after the given
     * amount of changes, starting from the current call time.
     * -> blocking call
     */
    public void followAndPause(int nChanges)
    {
      debugInfo("Requested broker writer " + serverId + " to write " + nChanges + " change(s).");
      pause(); // If however we were already working
 
      // Initialize counter system variables
      nChangesSent = 0;
      nChangesSentLimit = nChanges;
      careAboutAmountOfChanges = true;
 
      // Start session
      sessionDone.set(false);
      suspended.set(false);
 
      // Wait for all messages sent
      while (!sessionDone.get())
      {
        TestCaseUtils.sleep(1000);
      }
      careAboutAmountOfChanges = false;
    }
 
    private AddMsg createNextAddMsg()
    {
      String userEntryUUID = "11111111-1111-1111-1111-111111111111";
      long curId =  userId++;
      String userdn = "uid=user" + curId + "," + EXAMPLE_DN;
      Entry personWithUUIDEntry = null;
      try
      {
        // @Formatter:off
        personWithUUIDEntry = TestCaseUtils.makeEntry(
            "dn: " + userdn,
            "objectClass: top",
            "objectClass: person",
            "objectClass: organizationalPerson",
            "objectClass: inetOrgPerson",
            "uid: user" + curId + "",
            "homePhone: 951-245-7634",
            "description: This is the description for Aaccf Amar.",
            "st: NC",
            "mobile: 027-085-0537",
            "postalAddress: Aaccf Amar$17984 Thirteenth Street$Rockford, NC  85762",
            "mail: user.1@example.com",
            "cn: Aaccf Amar",
            "l: Rockford",
            "pager: 508-763-4246",
            "street: 17984 Thirteenth Street",
            "telephoneNumber: 216-564-6748",
            "employeeNumber: 1",
            "sn: Amar",
            "givenName: Aaccf",
            "postalCode: 85762",
            "userPassword: password",
            "initials: AA",
            "entryUUID: " + userEntryUUID);
        // @Formatter:on
      } catch (Exception e)
      {
        throw new RuntimeException(e);
      }
 
      // Create an update message to add an entry.
      return new AddMsg(gen.newCSN(),
        personWithUUIDEntry.getName(),
        userEntryUUID,
        null,
        personWithUUIDEntry.getObjectClassAttribute(),
        personWithUUIDEntry.getAllAttributes(), null);
    }
  }
 
  /**
   * This simple reader just throws away the received
   * messages. It is used on a breaker we want to be able to send or read from some message
   * with (changes, entries (full update)...). Calling the receive method of the
   * broker allows to unblock the window mechanism and to send the desired messages.
   * Calling the updateWindowAfterReplay method allows to send when necessary the
   * window message to the RS to allow him send other messages he may want to send us.
   */
  private class BrokerReader extends Thread
  {
    private ReplicationBroker rb;
    private int serverId = -1;
    private boolean shutdown;
    private ReplicationMsg lastMsg;
 
    public BrokerReader(ReplicationBroker rb, int serverId)
    {
      super("BrokerReader for broker " + serverId);
      this.rb = rb;
      this.serverId = serverId;
      start();
    }
 
    /** Loop reading and throwing update messages. */
    @Override
    public void run()
    {
      while (!shutdown)
      {
        try
        {
          ReplicationMsg msg = rb.receive(); // Allow more messages to be sent by broker writer
          rb.updateWindowAfterReplay();  // Allow RS to send more messages to broker
          if (msg != null)
          {
            debugInfo("Broker " + serverId + " reader received: " + msg);
          }
          lastMsg = msg;
        } catch (SocketTimeoutException ex)
        {
          if (shutdown)
          {
            return;
          }
        }
      }
      debugInfo("Broker " + serverId + " reader thread is dying");
    }
 
    /** Returns last received message from reader When read, last value is cleared. */
    public ReplicationMsg getLastMsg()
    {
      ReplicationMsg toReturn = lastMsg;
      lastMsg = null;
      return toReturn;
    }
 
    /** Stops reader thread. */
    public void shutdown()
    {
      shutdown = true;
 
      try
      {
        join();
      } catch (InterruptedException ex)
      {
        /* Don't care */
      }
    }
  }
 
  /**
   * Waits until the domain status reaches the expected status.
   * @param domain The domain whose status we want to test
   * @param expectedStatus The expected domain status
   */
  private void waitUntilStatusEquals(final LDAPReplicationDomain domain, final ServerStatus expectedStatus)
      throws Exception
  {
    assertNotNull(domain);
    assertNotNull(expectedStatus);
 
    TestTimer timer = new TestTimer.Builder()
      .maxSleep(30, SECONDS)
      .sleepTimes(500, MILLISECONDS)
      .toTimer();
    timer.repeatUntilSuccess(new CallableVoid()
    {
      @Override
      public void call() throws Exception
      {
        assertEquals(domain.getStatus(), expectedStatus);
      }
    });
  }
}