summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/replication_executor_test_fixture.h
blob: a5a7ae6bf257ea186d9eb0d7371b2c4d97f96d4f (plain)
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
/**
 *    Copyright (C) 2015 MongoDB Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the GNU Affero General Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#pragma once

#include <boost/scoped_ptr.hpp>
#include <boost/thread/thread.hpp>

#include "mongo/unittest/unittest.h"

namespace mongo {

namespace executor {
    class NetworkInterfaceMock;
} // namespace executor

namespace repl {

    using std::unique_ptr;

    class ReplicationExecutor;
    class StorageInterfaceMock;

    /**
     * Test fixture for tests that require a ReplicationExecutor backed by
     * a NetworkInterfaceMock.
     */
    class ReplicationExecutorTest : public unittest::Test {
    protected:
        executor::NetworkInterfaceMock* getNet() { return _net; }
        ReplicationExecutor& getExecutor() { return *_executor; }
        /**
         * Runs ReplicationExecutor in background.
         */
        void launchExecutorThread();

        /**
         * Anything that needs to be done after launchExecutorThread should go in here.
         */
        virtual void postExecutorThreadLaunch();

        /**
         * Waits for background ReplicationExecutor to stop running.
         *
         * The executor should be shutdown prior to calling this function
         * or the test may block indefinitely.
         */
        void joinExecutorThread();

        /**
         * Initializes both the NetworkInterfaceMock and ReplicationExecutor but
         * does not run the executor in the background.
         *
         * To run the executor in the background, tests should invoke launchExecutorThread() or
         * override this function() to achieve the same effect.
         */
        virtual void setUp();

        /**
         * Destroys the replication executor.
         *
         * Shuts down running background executor.
         */
        virtual void tearDown();


    private:
        executor::NetworkInterfaceMock* _net;
        StorageInterfaceMock* _storage;
        unique_ptr<ReplicationExecutor> _executor;
        unique_ptr<boost::thread> _executorThread;
    };

}  // namespace repl
}  // namespace mongo