summaryrefslogtreecommitdiff
path: root/src/mongo/transport/service_entry_point_test_suite.h
blob: 7c31e38f5b034614c8f6366f38d7f566b60ec8f3 (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
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
/**
 *    Copyright (C) 2016 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.
 */

#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kDefault

#include <memory>

#include "mongo/transport/mock_session.h"
#include "mongo/transport/mock_ticket.h"
#include "mongo/transport/transport_layer.h"
#include "mongo/unittest/unittest.h"
#include "mongo/util/net/message.h"
#include "mongo/util/time_support.h"

namespace mongo {

class ServiceEntryPoint;
struct SSLPeerInfo;

/**
 * Test class. Uses a mock TransportLayer to test that the ServiceEntryPoint
 * calls the expected methods on the TransportLayer in the expected order,
 * and with the expected parameters.
 *
 * Usage:
 *
 * TEST_F(ServiceEntryPointTestSuite, ServiceEntryPointImplTest) {
 *    // Set up our ServiceEntryPoint
 *    auto sepFactory = [](TransportLayer* tl){
 *       return stdx::make_unique<ServiceEntryPointImpl>(tl);
 *    };
 *
 *    setServiceEntryPoint(sepFactory);
 *
 *    // Run some tests
 *    fullLifeCycleTest();
 * }
 */
class ServiceEntryPointTestSuite : public mongo::unittest::Test {
public:
    // Need a function that takes a TransportLayer* and returns a new
    // ServiceEntryPoint
    using ServiceEntryPointFactory =
        stdx::function<std::unique_ptr<ServiceEntryPoint>(transport::TransportLayer*)>;

    void setUp() override;

    void setServiceEntryPoint(ServiceEntryPointFactory factory);

    // Lifecycle Tests
    void noLifeCycleTest();
    void halfLifeCycleTest();
    void fullLifeCycleTest();

    // Concurrent Session Tests
    void interruptingSessionTest();

    // Stress Tests
    void burstStressTest(int numSessions = 1000,
                         int numCycles = 1,
                         Milliseconds delay = Milliseconds(0));
    void longSessionStressTest();

    class SEPTestSession;
    using SEPTestSessionHandle = std::shared_ptr<SEPTestSession>;

    /**
     * This class mocks the TransportLayer and allows us to insert hooks beneath
     * its methods.
     */
    class MockTLHarness : public transport::TransportLayer {
    public:
        friend class SEPTestSession;

        MockTLHarness();

        transport::Ticket sourceMessage(
            const transport::SessionHandle& session,
            Message* message,
            Date_t expiration = transport::Ticket::kNoExpirationDate) override;
        transport::Ticket sinkMessage(
            const transport::SessionHandle& session,
            const Message& message,
            Date_t expiration = transport::Ticket::kNoExpirationDate) override;
        Status wait(transport::Ticket&& ticket) override;
        void asyncWait(transport::Ticket&& ticket, TicketCallback callback) override;

        Stats sessionStats() override;
        void end(const transport::SessionHandle& session) override;
        Status setup() override;
        Status start() override;
        void shutdown() override;

        transport::MockTicket* getMockTicket(const transport::Ticket& ticket);

        // Mocked method hooks
        stdx::function<transport::Ticket(const transport::SessionHandle&, Message*, Date_t)>
            _sourceMessage;
        stdx::function<transport::Ticket(const transport::SessionHandle&, const Message&, Date_t)>
            _sinkMessage;
        stdx::function<Status(transport::Ticket)> _wait;
        stdx::function<void(transport::Ticket, TicketCallback)> _asyncWait;
        stdx::function<void(const transport::SessionHandle&)> _end;
        stdx::function<void(SEPTestSession& session)> _destroy_hook;
        stdx::function<Status(void)> _start = [] { return Status::OK(); };
        stdx::function<void(void)> _shutdown = [] {};

        // Pre-set hook methods
        transport::Ticket _defaultSource(const transport::SessionHandle& s, Message* m, Date_t d);
        transport::Ticket _defaultSink(const transport::SessionHandle& s, const Message&, Date_t d);
        transport::Ticket _sinkThenErrorOnWait(const transport::SessionHandle& s,
                                               const Message& m,
                                               Date_t d);

        Status _defaultWait(transport::Ticket ticket);
        Status _waitError(transport::Ticket ticket);
        Status _waitOnceThenError(transport::Ticket ticket);

        // Reset all hooks to their defaults
        void _resetHooks();

    private:
        void _destroy(SEPTestSession& session);
    };

    /**
     * A light wrapper around the mock session class, to handle our destroy logic.
     */
    class SEPTestSession : public transport::MockSession {
        MockTLHarness* _mockTL;

    public:
        static std::shared_ptr<SEPTestSession> create(MockTLHarness* tl) {
            std::shared_ptr<SEPTestSession> handle(new SEPTestSession(tl));
            return handle;
        }

        ~SEPTestSession() {
            _mockTL->_destroy(*this);
        }

    private:
        explicit SEPTestSession(MockTLHarness* tl) : transport::MockSession(tl), _mockTL(tl) {}
    };

private:
    std::unique_ptr<MockTLHarness> _tl;
    std::unique_ptr<ServiceEntryPoint> _sep;
};

}  // namespace mongo