summaryrefslogtreecommitdiff
path: root/src/mongo/s/catalog/replset/catalog_manager_replica_set_test_fixture.h
blob: 05a5dcf4e1f45e72269db303c6cd430784dda575 (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
101
102
103
104
105
106
107
108
109
/**
 *    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 <functional>
#include <thread>
#include <vector>

#include "mongo/unittest/unittest.h"

namespace mongo {

    class BSONObj;
    class CatalogManagerReplicaSet;
    class DistLockManagerMock;
    struct RemoteCommandRequest;
    class RemoteCommandRunnerMock;
    class ShardRegistry;
    template<typename T> class StatusWith;

namespace executor {

    class NetworkInterfaceMock;

} // namespace executor

    /**
     * Sets up the mocked out objects for testing the replica-set backed catalog manager.
     */
    class CatalogManagerReplSetTestFixture : public mongo::unittest::Test {
    public:
        CatalogManagerReplSetTestFixture();
        ~CatalogManagerReplSetTestFixture();

    protected:
        /**
         * Shortcut function to be used for generating mock responses to network requests.
         *
         * @param dbName Name of the database for which this request came.
         * @param cmdObj Contents of the request.
         *
         * Return the BSON object representing the response(s) or an error, which will be passed
         * back on the network.
         */
        using OnCommandFunction =
            std::function<StatusWith<BSONObj>(const RemoteCommandRequest&)>;

        using OnFindCommandFunction =
            std::function<StatusWith<std::vector<BSONObj>>(const RemoteCommandRequest&)>;

        CatalogManagerReplicaSet* catalogManager() const;

        ShardRegistry* shardRegistry() const;

        RemoteCommandRunnerMock* commandRunner() const;

        executor::NetworkInterfaceMock* network() const;

        DistLockManagerMock* distLock() const;

        /**
         * Blocking methods, which receive one message from the network and respond using the
         * responses returned from the input function. This is a syntactic sugar for simple,
         * single request + response or find tests.
         */
        void onCommand(OnCommandFunction func);
        void onFindCommand(OnFindCommandFunction func);

    private:
        void setUp() override;

        void tearDown() override;

        // Mocked out network under the task executor. This pointer is owned by the executor on
        // the ShardRegistry, so it must not be accessed once the executor has been shut down.
        executor::NetworkInterfaceMock* _mockNetwork;

        // Thread used to execute the task executor's loop. This thread will be busy until the
        // shutdown is called on the shard registry's task executor.
        std::thread _executorThread;
    };

} // namespace mongo