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
// Copyright (C) 2023-2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Kea Hooks Basic
// Commercial End User License Agreement v2.0. See COPYING file in the premium/
// directory.

#include <config.h>

#include <asiolink/asio_wrapper.h>
#include <asiolink/interval_timer.h>
#include <asiolink/testutils/test_tls.h>
#include <cc/data.h>
#include <cc/command_interpreter.h>
#include <dhcp/testutils/iface_mgr_test_config.h>
#include <dhcpsrv/cfgmgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
#include <blq_service.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <mt_lease_query_mgr.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <lease_query_test_client.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <util/multi_threading_mgr.h>
#include <blq4_utils.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <testutils/gtest_utils.h>

#include <gtest/gtest.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.

#include <thread><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <list><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <sstream><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.

using namespace isc;
using namespace isc::asiolink;
using namespace isc::asiolink::test;
using namespace isc::config;
using namespace isc::data;
using namespace boost::asio::ip;
using namespace isc::tcp;
using namespace isc::util;
using namespace isc::lease_query::test;

namespace ph = std::placeholders;

namespace {

/// @brief IP address to which TCP service is bound.
const std::string SERVER_ADDRESS = "127.0.0.1";

/// @brief Port number to which TCP service is bound.
const unsigned short SERVER_PORT = 18123;

/// @brief Test timeout (ms).
const long TEST_TIMEOUT = 10000;

/// @brief Test fixture class for @ref MtLeaseQueryListenerMgr.
class MtLeaseQueryListenerMgrTest4 : public BlqPacketTest4 {
public:
    /// @brief Constructor.
    ///
    /// Starts test timer which detects timeouts, and enables multi-threading mode.
    MtLeaseQueryListenerMgrTest4()
        : mt_listener_mgr_(), io_service_(new IOService()), test_timer_(io_service_),
          run_io_service_timer_(io_service_), clients_(), num_threads_(),
          num_clients_(), num_in_progress_(0), num_finished_(0),
          chunk_size_(0), pause_cnt_(0) {
        test_timer_.setup(std::bind(&MtLeaseQueryListenerMgrTest4::timeoutHandler,
                                    this, true),
                          TEST_TIMEOUT, IntervalTimer::ONE_SHOT);
        CfgMgr::instance().clear();
    }

    /// @brief Setup.
    virtual void SetUp() {
        BlqPacketTest4::SetUp();
        LeaseMgrFactory::destroy();
        LeaseMgrFactory::create("type=memfile persist=false universe=4");

        // Enable multi-threading.
        MultiThreadingMgr::instance().setMode(true);
        ElementPtr mt_config = Element::createMap();
        mt_config->set("enable-multi-threading", Element::create(true));
        mt_config->set("thread-pool-size", Element::create(4));
        mt_config->set("queue-size", Element::create(16));
        CfgMgr::instance().getStagingCfg()->setDHCPMultiThreading(mt_config);
        CfgMgr::instance().commit();

        // Enable bulk service.
        ElementPtr cfg = Element::createMap();
        cfg->set("requesters", Element::fromJSON("[ \"127.0.0.1\" ]"));
        ElementPtr advanced = Element::createMap();
        cfg->set("advanced", advanced);
        LeaseQueryImplPtr impl_;
        ASSERT_NO_THROW(impl_.reset(new LeaseQueryImpl4(cfg)));
        EXPECT_TRUE(BulkLeaseQueryService::instance());
    }

    /// @brief Convenience method for getting a timeout struct
    ///
    /// @param timeout value in seconds for the timeout
    ///
    /// @return a IdleTimeout struct with the given value.
    static const TcpListener::IdleTimeout makeIdleTimeout(const long timeout
                                                          = TCP_IDLE_CONNECTION_TIMEOUT) {
        return(TcpListener::IdleTimeout(timeout));
    }

    /// @brief Destructor.
    ///
    /// Removes TCP clients and disables MT.
    virtual ~MtLeaseQueryListenerMgrTest4() {
        // Wipe out the listener manager.
        mt_listener_mgr_.reset();

        // Destroy all remaining clients.
        for (auto const& client : clients_) {
            client->close();
        }

        BulkLeaseQueryService::reset();
        LeaseMgrFactory::destroy();
        CfgMgr::instance().clear();

        test_timer_.cancel();
        io_service_->stop();
        io_service_->restart();
        try {
            io_service_->poll();
        } catch (...) {
        }

        // Disable multi-threading.
        MultiThreadingMgr::instance().setMode(false);
    }

    /// @brief Replaces the test's listener with a new listener.
    ///
    /// @param num_threads Number of threads the  listener should use.
    void createMtLeaseQueryListenerMgr(size_t num_threads) {
        // Create a listener with prescribed number of threads.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_.reset(new MtLeaseQueryListenerMgr(
            IOAddress(SERVER_ADDRESS), SERVER_PORT, AF_INET, makeIdleTimeout(),
            num_threads)));

        ASSERT_TRUE(mt_listener_mgr_);
    }

    /// @brief Callback function each client invokes when done.
    ///
    /// It stops the IO service.
    ///
    /// @param fail_on_timeout Specifies if test failure should be reported.
    void clientDone() {
        // They're all done or dead. Stop the service.
       io_service_->stop();
    }

    /// @brief Initiates a command via a new TCP client.
    ///
    /// This method creates a TcpTestClient instance, adds the
    /// client to the list of clients, and starts a request.
    /// The client will run on the main thread and be driven by
    /// the test's IOService instance.
    ///
    /// @param request_str String containing the request to be sent.
    void startRequest(BlqQueryPtr request) {
        // Instantiate the client.
        LeaseQueryTestClientPtr client(
            new LeaseQueryTestClient(io_service_,
                                     std::bind(&MtLeaseQueryListenerMgrTest4::clientDone, this),
                                     AF_INET, SERVER_ADDRESS, SERVER_PORT));

        // Add it to the list of clients.
        clients_.push_back(client);

        // Start the request.  Note, nothing happens until the IOService runs.
        client->startRequest(request);
    }

    /// @brief Callback function invoke upon test timeout.
    ///
    /// It stops the IO service and reports test timeout.
    ///
    /// @param fail_on_timeout Specifies if test failure should be reported.
    void timeoutHandler(const bool fail_on_timeout) {
        if (fail_on_timeout) {
            ADD_FAILURE() << "Timeout occurred while running the test!";
        }
        io_service_->stop();
    }

    /// @brief Runs IO service with optional timeout.
    ///
    /// We iterate over calls to asio::io_service.run(), until
    /// all the clients have completed their requests.  We do it this way
    /// because the test clients stop the io_service when they're
    /// through with a request.
    ///
    /// @param request_limit Desired number of requests the function should wait
    /// to be processed before returning.
    void runIOService(size_t request_limit = 0) {
        if (!request_limit) {
            request_limit = clients_.size();
        }

        // Loop until the clients are done, an error occurs, or the time runs out.
        size_t num_done = 0;
        while (num_done != request_limit) {
            io_service_->stop();
            io_service_->restart();

            // Run until a client stops the service.
            io_service_->run();

            // If all the clients are done receiving, the test is done.
            num_done = 0;
            for (auto const& client : clients_) {
                if (client->receiveDone() || client->expectedEof()) {
                    ++num_done;
                }
            }
        }
    }

    /// Verifies the construction, starting, stopping, pausing, resuming,
    /// and destruction of MtLeaseQueryListener.
    void testBasicOperation() {
        // Make sure multi-threading is off.
        MultiThreadingMgr::instance().setMode(false);
        IOAddress address(SERVER_ADDRESS);
        uint16_t port = SERVER_PORT;

        // Make sure we can create one.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_.reset(
            new MtLeaseQueryListenerMgr(address, port, AF_INET,
                                        makeIdleTimeout(789))));

        ASSERT_TRUE(mt_listener_mgr_);

        // Verify the getters do what we expect.
        EXPECT_EQ(mt_listener_mgr_->getAddress(), address);
        EXPECT_EQ(mt_listener_mgr_->getPort(), port);
        EXPECT_EQ(mt_listener_mgr_->getThreadPoolSize(), 1);
        EXPECT_FALSE(mt_listener_mgr_->getTlsContext());

        // It should not have an IOService, should not be listening and
        // should have no threads.
        ASSERT_FALSE(mt_listener_mgr_->getThreadIOService());
        EXPECT_TRUE(mt_listener_mgr_->isStopped());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 0);

        // Verify that we cannot start it when multi-threading is disabled.
        ASSERT_FALSE(MultiThreadingMgr::instance().getMode());
        ASSERT_THROW_MSG(mt_listener_mgr_->start(), InvalidOperation,
                         "MtTcpListenerMgr cannot be started"
                         " when multi-threading is disabled");

        // It should still not be listening and have no threads.
        EXPECT_TRUE(mt_listener_mgr_->isStopped());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 0);

        // Enable multi-threading.
        MultiThreadingMgr::instance().setMode(true);

        // Make sure we can start it and it's listening with 1 thread.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->start());
        ASSERT_TRUE(mt_listener_mgr_->isRunning());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 1);
        ASSERT_TRUE(mt_listener_mgr_->getThreadIOService());
        EXPECT_FALSE(mt_listener_mgr_->getThreadIOService()->stopped());

        // TcpListener should exist and timeout should be set.
        ASSERT_TRUE(mt_listener_mgr_->getTcpListener());
        EXPECT_EQ(789, mt_listener_mgr_->getTcpListener()->getIdleTimeout());

        // Trying to start it again should fail.
        ASSERT_THROW_MSG(mt_listener_mgr_->start(), InvalidOperation,
                         "MtTcpListenerMgr already started!");

        // Stop it and verify we're no longer listening.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->stop());
        ASSERT_TRUE(mt_listener_mgr_->isStopped());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 0);
        ASSERT_FALSE(mt_listener_mgr_->getThreadIOService());

        // Make sure we can call stop again without problems.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->stop());

        // We should be able to restart it.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->start());
        ASSERT_TRUE(mt_listener_mgr_->isRunning());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 1);
        ASSERT_TRUE(mt_listener_mgr_->getThreadIOService());
        EXPECT_FALSE(mt_listener_mgr_->getThreadIOService()->stopped());

        // Destroying it should also stop it.
        // If the test timeouts we know it didn't!
        ASSERT_NO_THROW_LOG(mt_listener_mgr_.reset());

        // Verify we can construct with more than one thread.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_.reset(
            new MtLeaseQueryListenerMgr(address, port, AF_INET,
                                        makeIdleTimeout(), 4)));

        ASSERT_NO_THROW_LOG(mt_listener_mgr_->start());
        EXPECT_EQ(mt_listener_mgr_->getAddress(), address);
        EXPECT_EQ(mt_listener_mgr_->getPort(), port);
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 4);
        EXPECT_EQ(mt_listener_mgr_->getThreadPoolSize(), 4);
        ASSERT_TRUE(mt_listener_mgr_->isRunning());
        ASSERT_TRUE(mt_listener_mgr_->getThreadIOService());
        EXPECT_FALSE(mt_listener_mgr_->getThreadIOService()->stopped());

        // Verify we can pause it.  We should still be listening,
        // threads intact, IOService stopped, state set to PAUSED.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->pause());
        ASSERT_TRUE(mt_listener_mgr_->isPaused());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 4);
        EXPECT_EQ(mt_listener_mgr_->getThreadPoolSize(), 4);
        ASSERT_TRUE(mt_listener_mgr_->getThreadIOService());
        EXPECT_TRUE(mt_listener_mgr_->getThreadIOService()->stopped());

        // Verify we can resume it.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->resume());
        ASSERT_TRUE(mt_listener_mgr_->isRunning());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 4);
        EXPECT_EQ(mt_listener_mgr_->getThreadPoolSize(), 4);
        ASSERT_TRUE(mt_listener_mgr_->getThreadIOService());
        EXPECT_FALSE(mt_listener_mgr_->getThreadIOService()->stopped());

        // Stop it and verify we're no longer listening.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->stop());
        ASSERT_TRUE(mt_listener_mgr_->isStopped());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 0);
        EXPECT_EQ(mt_listener_mgr_->getThreadPoolSize(), 4);
        ASSERT_FALSE(mt_listener_mgr_->getThreadIOService());
        EXPECT_TRUE(mt_listener_mgr_->isStopped());
    }

    // Verifies listener can be created with a TLS context.
    void testTlsContext() {
        IOAddress address(SERVER_ADDRESS);
        uint16_t port = SERVER_PORT;
        TlsContextPtr context;
        configServer(context);

        // Make sure we can create the listener with a context.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_.reset(
            new MtLeaseQueryListenerMgr(address, port, AF_INET,
                                        makeIdleTimeout(), 1, context));
        );

        EXPECT_EQ(mt_listener_mgr_->getAddress(), address);
        EXPECT_EQ(mt_listener_mgr_->getPort(), port);
        EXPECT_EQ(mt_listener_mgr_->getThreadPoolSize(), 1);
        EXPECT_EQ(mt_listener_mgr_->getTlsContext(), context);
        EXPECT_TRUE(mt_listener_mgr_->isStopped());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 0);

        // Make sure we can start it and it's listening with 1 thread.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->start());
        ASSERT_TRUE(mt_listener_mgr_->isRunning());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 1);
        ASSERT_TRUE(mt_listener_mgr_->getThreadIOService());
        EXPECT_FALSE(mt_listener_mgr_->getThreadIOService()->stopped());

        // Stop it.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->stop());
        ASSERT_TRUE(mt_listener_mgr_->isStopped());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 0);
        EXPECT_EQ(mt_listener_mgr_->getThreadPoolSize(), 1);
        ASSERT_FALSE(mt_listener_mgr_->getThreadIOService());
        EXPECT_TRUE(mt_listener_mgr_->isStopped());
    }

    // Verifies idle timeout can be set.
    void testIdleTimeout() {
        // Create an  MtLeaseQueryListenerMgr.
        createMtLeaseQueryListenerMgr(1);

        // Verify the default timeout value.
        EXPECT_EQ(TCP_IDLE_CONNECTION_TIMEOUT,
                  mt_listener_mgr_->getIdleTimeout());

        // Set a new timeout value.
        mt_listener_mgr_->setIdleTimeout(200);
        EXPECT_EQ(200, mt_listener_mgr_->getIdleTimeout());

        // Start the listener, which should instantiate the internal listener.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->start());
        ASSERT_TRUE(mt_listener_mgr_->isRunning());

        // Verify the internal listener's timeout value.
        auto tcp_listener = mt_listener_mgr_->getTcpListener();
        ASSERT_TRUE(tcp_listener);
        EXPECT_EQ(200, tcp_listener->getIdleTimeout());
    }

    /// @brief Constructs a DHCPv4 bulk query by client id.
    ///
    /// @param qry_client_id Client id to query for.
    /// @return An BlqQuery containing the query packet.
    BlqQueryPtr makeBlqQueryByClientId(const ClientIdPtr& qry_client_id) {
        PktPtr lq = makeQueryByClientId(qry_client_id);
        return (BlqQueryPtr(new BlqQuery(lq)));
    }

    /// @brief Submits one or more thread commands to a MtLeaseQueryListener.
    ///
    /// This function command will create a MtLeaseQueryListener
    /// with the given number of threads, initiates the given
    /// number of clients, each requesting a query, and then iteratively
    /// runs the test's IOService until all the clients have received their
    /// responses or an error occurs.
    ///
    /// It requires that the number of clients, when greater than the
    /// number of threads, be a multiple of the number of threads.  The
    /// thread command handler is structured in such a way as to ensure
    /// (we hope) that each thread handles the same number of commands.
    ///
    /// @param num_threads - the number of threads the MtLeaseQueryListener
    /// should use. Must be greater than 0.
    /// @param num_clients - the number of clients that should issue the
    /// thread command.  Each client is used to carry out a single thread
    /// command request.  Must be greater than 0 and a multiple of num_threads
    /// if it is greater than num_threads.
    void threadListenAndRespond(size_t num_threads, size_t num_clients) {
        // First we makes sure the parameter rules apply.
        ASSERT_TRUE(num_threads);
        ASSERT_TRUE(num_clients);

        num_threads_ = num_threads;
        num_clients_ = num_clients;

        // Create an  MtLeaseQueryListenerMgr with prescribed number of threads.
        createMtLeaseQueryListenerMgr(num_threads);

        // Start it and verify it is running.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->start());
        ASSERT_TRUE(mt_listener_mgr_->isRunning());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), num_threads);

        // Maps the number of clients served by a given thread-id.
        std::map<std::string, int> clients_per_thread;

        // Initiate the prescribed number of command requests.
        ClientIdPtr cid(new ClientId(vector<uint8_t>{ 1, 2, 3, 4 }));
        num_in_progress_ = 0;
        while (clients_.size() < num_clients) {
            BlqQueryPtr request = makeBlqQueryByClientId(cid);
            ASSERT_NO_THROW_LOG(startRequest(request));
        }

        // Now we run the client-side IOService until all requests are done,
        // errors occur or the test times out.
        ASSERT_NO_FATAL_FAILURE(runIOService());

        // Stop the listener and then verify it has stopped.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->stop());
        ASSERT_TRUE(mt_listener_mgr_->isStopped());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 0);

        // Iterate over the clients, checking their outcomes.
        for (auto const& client : clients_) {
            ASSERT_TRUE(client->receiveDone());
            ASSERT_FALSE(client->expectedEof());

            // Client should have completed its receive successfully.
            client->checkResponses();
        }
    }

    /// @brief Pauses and resumes a MtLeaseQueryListener while it
    /// processes command requests.
    ///
    /// This function command will create a MtLeaseQueryListenerMgr
    /// with the given number of threads, initiates the given
    /// number of clients, each requesting the "thread" command,
    /// and then iteratively runs the test's IOService until all
    /// the clients have received their responses or an error occurs.
    /// It will pause and resume the listener at intervals governed
    /// by the given number of pauses.
    ///
    /// @param num_threads - the number of threads the MtLeaseQueryListener
    /// should use. Must be greater than 0.
    /// @param num_clients - the number of clients that should issue the
    /// thread command.  Each client is used to carry out a single thread
    /// command request.  Must be greater than 0.
    /// @param num_pauses Desired number of times the listener should be
    /// paused during the test. Must be greater than 0.
    void workPauseAndResume(size_t num_threads, size_t num_clients,
                            size_t num_pauses) {
        // First we makes sure the parameter rules apply.
        ASSERT_TRUE(num_threads);
        ASSERT_TRUE(num_clients);
        ASSERT_TRUE(num_pauses);
        num_threads_ = num_threads;
        num_clients_ = num_clients;

        // Create an MtLeaseQueryListenerMgr with prescribed number of
        // threads and the simple handler.
        createMtLeaseQueryListenerMgr(num_threads);

        ASSERT_TRUE(mt_listener_mgr_);

        // Start it and verify it is running.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->start());
        ASSERT_TRUE(mt_listener_mgr_->isRunning());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), num_threads);

        // Initiate the prescribed number of command requests.
        ClientIdPtr cid(new ClientId(vector<uint8_t>{ 1, 2, 3, 4 }));
        num_in_progress_ = 0;
        while (clients_.size() < num_clients) {
            BlqQueryPtr request = makeBlqQueryByClientId(cid);
            ASSERT_NO_THROW_LOG(startRequest(request));
        }

        // Now we run the client-side IOService until all requests are done,
        // errors occur or the test times out.  We'll pause and resume the
        // number of times given by num_pauses.
        size_t num_done = 0;
        size_t total_requests = clients_.size();
        while (num_done < total_requests) {
            // Calculate how many more requests to process before we
            // pause again.  We divide the number of outstanding
            // requests by the number of pauses and stop after we've
            // done at least that many more requests.
            size_t request_limit = (pause_cnt_ < num_pauses ?
                                    (num_done + ((total_requests - num_done) / num_pauses))
                                     : total_requests);

            // Run test IOService until we hit the limit.
            runIOService(request_limit);

            // If we've done all our pauses we should be through.
            if (pause_cnt_ == num_pauses) {
                break;
            }

            // Pause the client.
            ASSERT_NO_THROW(mt_listener_mgr_->pause());
            ASSERT_TRUE(mt_listener_mgr_->isPaused());
            ++pause_cnt_;

            // Check our progress.
            num_done = 0;
            for (auto const& client : clients_) {
                if (client->receiveDone()) {
                    ++num_done;
                }
            }

            // We should completed at least as many as our target limit.
            ASSERT_GE(num_done, request_limit);

            // Resume the listener.
            ASSERT_NO_THROW(mt_listener_mgr_->resume());
            ASSERT_TRUE(mt_listener_mgr_->isRunning());
        }

        // Stop the listener and then verify it has stopped.
        ASSERT_NO_THROW_LOG(mt_listener_mgr_->stop());
        ASSERT_TRUE(mt_listener_mgr_->isStopped());
        EXPECT_EQ(mt_listener_mgr_->getThreadCount(), 0);

        // We should have had the expected number of pauses.
        if (!num_pauses) {
            ASSERT_EQ(pause_cnt_, 0);
        } else {
            // We allow a range on pauses of +-1.
            ASSERT_TRUE((num_pauses - 1) <= pause_cnt_ &&
                        (pause_cnt_ <= (num_pauses + 1)))
                << " num_pauses: " << num_pauses
                << ", pause_cnt_" << pause_cnt_;
        }

        // Iterate over the clients, checking their outcomes.
        for (auto const& client : clients_) {
            ASSERT_TRUE(client->receiveDone());
            ASSERT_FALSE(client->expectedEof());

            // Client should have completed its receive successfully.
            client->checkResponses();
        }
    }

    /// @brief MtLeaseQueryListenerMgr instance under test.
    MtLeaseQueryListenerMgrPtr mt_listener_mgr_;

    /// @brief IO service used in drive the test and test clients.
    IOServicePtr io_service_;

    /// @brief Asynchronous timer service to detect timeouts.
    IntervalTimer test_timer_;

    /// @brief Asynchronous timer for running IO service for a specified amount
    /// of time.
    IntervalTimer run_io_service_timer_;

    /// @brief List of client connections.
    std::list<LeaseQueryTestClientPtr> clients_;

    /// @brief Number of threads the listener should use for the test.
    size_t num_threads_;

    /// @brief Number of client requests to make during the test.
    size_t num_clients_;

    /// @brief Number of requests currently in progress.
    size_t num_in_progress_;

    /// @brief Number of requests that have finished.
    size_t num_finished_;

    /// @brief Chunk size of requests that need to be processed in parallel.
    ///
    /// This can either be the number of threads (if the number of requests is
    /// greater than the number of threads) or the number of requests (if the
    /// number of threads is greater than the number of requests).
    size_t chunk_size_;

    /// @brief Mutex used to lock during thread coordination.
    std::mutex mutex_;

    /// @brief Condition variable used to coordinate threads.
    std::condition_variable cv_;

    /// @brief Number of times client has been paused during the test.
    size_t pause_cnt_;

    /// @brief Number of clients that have completed their assignment or
    /// failed
    size_t clients_done_;
};

/// Verifies the construction, starting, stopping, pausing, resuming,
/// and destruction of MtLeaseQueryListener.
TEST_F(MtLeaseQueryListenerMgrTest4, basics) {<--- syntax error
    testBasicOperation();
}

// Now we'll run some permutations of the number of listener threads
// and the number of client requests.

// One thread, one client.
TEST_F(MtLeaseQueryListenerMgrTest4, oneByOne) {
    size_t num_threads = 1;
    size_t num_clients = 1;
    threadListenAndRespond(num_threads, num_clients);
}

// One thread, four clients.
TEST_F(MtLeaseQueryListenerMgrTest4, oneByFour) {
    size_t num_threads = 1;
    size_t num_clients = 4;
    threadListenAndRespond(num_threads, num_clients);
}

// Four threads, one clients.
TEST_F(MtLeaseQueryListenerMgrTest4, fourByOne) {
    size_t num_threads = 4;
    size_t num_clients = 1;
    threadListenAndRespond(num_threads, num_clients);
}

// Four threads, four clients.
TEST_F(MtLeaseQueryListenerMgrTest4, fourByFour) {
    size_t num_threads = 4;
    size_t num_clients = 4;
    threadListenAndRespond(num_threads, num_clients);
}

// Four threads, eight clients.
TEST_F(MtLeaseQueryListenerMgrTest4, fourByEight) {
    size_t num_threads = 4;
    size_t num_clients = 8;
    threadListenAndRespond(num_threads, num_clients);
}

// Six threads, eighteen clients.
TEST_F(MtLeaseQueryListenerMgrTest4, sixByEighteen) {
    size_t num_threads = 6;
    size_t num_clients = 18;
    threadListenAndRespond(num_threads, num_clients);
}

// Pauses and resumes the listener while it is processing
// requests.
TEST_F(MtLeaseQueryListenerMgrTest4, pauseAndResume) {
    size_t num_threads = 6;
    size_t num_clients = 18;
    size_t num_pauses = 3;
    workPauseAndResume(num_threads, num_clients, num_pauses);
}

// Check if a TLS listener can be created.
TEST_F(MtLeaseQueryListenerMgrTest4, tls) {
    testTlsContext();
}

/// Verifies that idle timeout can be passed down to the internal listener.
TEST_F(MtLeaseQueryListenerMgrTest4, idleTimeout) {
    testIdleTimeout();
}

} // end of anonymous namespace