summaryrefslogtreecommitdiff
path: root/src/mongo/db/wire_version_test.cpp
blob: 615f73734a0cb277b04c1bfe3b253c220f208b72 (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
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
/**
 *    Copyright (C) 2021-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    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
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    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 Server Side 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.
 */

#include <vector>

#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/db/wire_version.h"
#include "mongo/unittest/unittest.h"

namespace mongo {
namespace {

TEST(WireVersionTest, ParseWireVersionFromHelloReply) {
    std::vector<std::pair<WireVersion, WireVersion>> minMaxWireVersions{
        {WireVersion::RELEASE_2_4_AND_BEFORE, WireVersion::LATEST_WIRE_VERSION},
        {WireVersion::SUPPORTS_OP_MSG, WireVersion::LATEST_WIRE_VERSION},
        {WireVersion::LATEST_WIRE_VERSION, WireVersion::LATEST_WIRE_VERSION},
        {WireVersion::RELEASE_2_4_AND_BEFORE, WireVersion::LAST_CONT_WIRE_VERSION},
        {WireVersion::RELEASE_2_4_AND_BEFORE, WireVersion::LAST_LTS_WIRE_VERSION},
        {WireVersion::RELEASE_2_4_AND_BEFORE, WireVersion::SUPPORTS_OP_MSG},
        {WireVersion::RELEASE_2_4_AND_BEFORE, WireVersion::COMMANDS_ACCEPT_WRITE_CONCERN}};

    for (auto&& wireVersions : minMaxWireVersions) {
        auto helloCmdReply =
            BSON("maxWireVersion" << wireVersions.second << "minWireVersion" << wireVersions.first);
        auto parsedWireVersions =
            unittest::assertGet(wire_version::parseWireVersionFromHelloReply(helloCmdReply));
        ASSERT_EQ(parsedWireVersions.minWireVersion, wireVersions.first);
        ASSERT_EQ(parsedWireVersions.maxWireVersion, wireVersions.second);
    }
}

TEST(WireVersionTest, ParseWireVersionFromHelloReply24AndEarlier) {
    // MongoDB 2.4 and earlier do not have maxWireVersion/minWireVersion in their 'isMaster'
    // replies. The absence of a wire version is interpreted as the min and max wire versions both
    // being 0.
    BSONObj mongod24{};
    auto parsedWireVersions =
        unittest::assertGet(wire_version::parseWireVersionFromHelloReply(mongod24));
    ASSERT_EQ(parsedWireVersions.minWireVersion, WireVersion::RELEASE_2_4_AND_BEFORE);
    ASSERT_EQ(parsedWireVersions.maxWireVersion, WireVersion::RELEASE_2_4_AND_BEFORE);
}

TEST(WireVersionTest, ParseWireVersionFromHelloReplyErrorOnBadWireVersions) {
    std::vector<std::pair<long long, long long>> badWireVersions{
        {WireVersion::RELEASE_2_4_AND_BEFORE, -1},
        {-1, WireVersion::LATEST_WIRE_VERSION},
        {WireVersion::RELEASE_2_4_AND_BEFORE,
         static_cast<long long>(std::numeric_limits<int>::max()) + 1},
        {static_cast<long long>(std::numeric_limits<int>::max()) + 1,
         WireVersion::LATEST_WIRE_VERSION}};

    for (auto&& wireVersions : badWireVersions) {
        auto helloCmdReply =
            BSON("maxWireVersion" << wireVersions.second << "minWireVersion" << wireVersions.first);
        auto parsedWireVersions = wire_version::parseWireVersionFromHelloReply(helloCmdReply);
        ASSERT_EQ(parsedWireVersions.getStatus(), ErrorCodes::IncompatibleServerVersion);
    }
}

#define VALIDATE_WIRE_VERSION(macro, clientMin, clientMax, serverMin, serverMax)              \
    do {                                                                                      \
        auto msg = BSON("minWireVersion" << static_cast<int>(serverMin) << "maxWireVersion"   \
                                         << static_cast<int>(serverMax));                     \
        auto swReply = wire_version::parseWireVersionFromHelloReply(msg);                     \
        ASSERT_OK(swReply.getStatus());                                                       \
        macro(wire_version::validateWireVersion({clientMin, clientMax}, swReply.getValue())); \
    } while (0);

TEST(WireVersionTest, ValidateWireVersion) {
    // Min, max FCV version pairs representing valid WireVersion ranges for variable binary
    // versions used to communicate with the MongoD 'latest' binary version.

    // MongoD 'latest' binary
    std::vector<WireVersionInfo> mongoDLatestBinaryRanges = {
        // upgraded FCV
        {WireVersion::LATEST_WIRE_VERSION, WireVersion::LATEST_WIRE_VERSION},
        // downgraded 'last-cont' FCV
        {WireVersion::LAST_CONT_WIRE_VERSION, WireVersion::LATEST_WIRE_VERSION},
        // downgraded 'last-lts' FCV
        {WireVersion::LAST_LTS_WIRE_VERSION, WireVersion::LATEST_WIRE_VERSION}};

    // MongoS binary versions
    std::vector<WireVersionInfo> mongoSBinaryRanges = {
        // 'latest' binary
        {WireVersion::LATEST_WIRE_VERSION, WireVersion::LATEST_WIRE_VERSION},
        // 'last-cont' binary
        {WireVersion::LAST_CONT_WIRE_VERSION, WireVersion::LAST_CONT_WIRE_VERSION},
        // 'last-lts' binary
        {WireVersion::LAST_LTS_WIRE_VERSION, WireVersion::LAST_LTS_WIRE_VERSION}};

    /*
     * Test communication between:
     * MongoD 'latest' binary version <-> MongoD 'latest' binary version
     * 'latest' should always be able to communicate to 'latest' regardless of FCV.
     */

    for (const auto& clientRange : mongoDLatestBinaryRanges) {
        for (const auto& serverRange : mongoDLatestBinaryRanges) {
            // We don't need to test when FCV != 'latest' && client FCV != server FCV because we
            // don't expect users to be in this state when following our recommended
            // upgrade/downgrade procedure.
            if (clientRange.minWireVersion < WireVersion::LATEST_WIRE_VERSION &&
                serverRange.minWireVersion < WireVersion::LATEST_WIRE_VERSION &&
                clientRange.minWireVersion != serverRange.minWireVersion) {
                continue;
            }
            VALIDATE_WIRE_VERSION(ASSERT_OK,
                                  clientRange.minWireVersion,
                                  clientRange.maxWireVersion,
                                  serverRange.minWireVersion,
                                  serverRange.maxWireVersion);
        }
    }

    /*
     * Test communication between:
     * MongoD 'latest' binary version <-> 'last-cont' binary version with 'last-cont' FCV
     */

    // 'latest' binary with 'latest' FCV  -> 'last-cont' binary with 'last-cont' FCV
    VALIDATE_WIRE_VERSION(ASSERT_NOT_OK,
                          WireVersion::LATEST_WIRE_VERSION,
                          WireVersion::LATEST_WIRE_VERSION,
                          WireVersion::LAST_CONT_WIRE_VERSION,
                          WireVersion::LAST_CONT_WIRE_VERSION);

    // 'latest' binary with 'last-cont' FCV  -> 'last-cont' binary with 'last-cont' FCV
    VALIDATE_WIRE_VERSION(ASSERT_OK,
                          WireVersion::LAST_CONT_WIRE_VERSION,
                          WireVersion::LATEST_WIRE_VERSION,
                          WireVersion::LAST_CONT_WIRE_VERSION,
                          WireVersion::LAST_CONT_WIRE_VERSION);

    // 'last-cont' binary with 'last-cont' FCV -> 'latest' binary with 'latest' FCV
    VALIDATE_WIRE_VERSION(ASSERT_NOT_OK,
                          WireVersion::LAST_CONT_WIRE_VERSION,
                          WireVersion::LAST_CONT_WIRE_VERSION,
                          WireVersion::LATEST_WIRE_VERSION,
                          WireVersion::LATEST_WIRE_VERSION);

    // 'last-cont' binary with 'last-cont' FCV -> 'latest' binary with 'last-cont' FCV
    VALIDATE_WIRE_VERSION(ASSERT_OK,
                          WireVersion::LAST_CONT_WIRE_VERSION,
                          WireVersion::LAST_CONT_WIRE_VERSION,
                          WireVersion::LAST_CONT_WIRE_VERSION,
                          WireVersion::LATEST_WIRE_VERSION);

    /*
     * Test communication between:
     * MongoD 'latest' binary version <-> 'last-lts' binary version with 'last-lts' FCV
     */

    // 'latest' binary with 'latest' FCV  -> 'last-lts' binary with 'last-lts' FCV
    VALIDATE_WIRE_VERSION(ASSERT_NOT_OK,
                          WireVersion::LATEST_WIRE_VERSION,
                          WireVersion::LATEST_WIRE_VERSION,
                          WireVersion::LAST_LTS_WIRE_VERSION,
                          WireVersion::LAST_LTS_WIRE_VERSION);

    // 'latest' binary with 'last-cont' FCV  -> 'last-lts' binary with 'last-lts' FCV
    if (WireVersion::LAST_CONT_WIRE_VERSION != WireVersion::LAST_LTS_WIRE_VERSION) {
        VALIDATE_WIRE_VERSION(ASSERT_NOT_OK,
                              WireVersion::LAST_CONT_WIRE_VERSION,
                              WireVersion::LATEST_WIRE_VERSION,
                              WireVersion::LAST_LTS_WIRE_VERSION,
                              WireVersion::LAST_LTS_WIRE_VERSION);
    }

    // 'latest' binary with 'last-lts' FCV  -> 'last-lts' binary with 'last-lts' FCV
    VALIDATE_WIRE_VERSION(ASSERT_OK,
                          WireVersion::LAST_LTS_WIRE_VERSION,
                          WireVersion::LATEST_WIRE_VERSION,
                          WireVersion::LAST_CONT_WIRE_VERSION,
                          WireVersion::LAST_CONT_WIRE_VERSION);

    // 'last-lts' binary with 'last-lts' FCV -> 'latest' binary with 'latest' FCV
    VALIDATE_WIRE_VERSION(ASSERT_NOT_OK,
                          WireVersion::LAST_LTS_WIRE_VERSION,
                          WireVersion::LAST_LTS_WIRE_VERSION,
                          WireVersion::LATEST_WIRE_VERSION,
                          WireVersion::LATEST_WIRE_VERSION);

    // 'last-lts' binary with 'last-lts' FCV -> 'latest' binary with 'last-lts' FCV
    VALIDATE_WIRE_VERSION(ASSERT_OK,
                          WireVersion::LAST_LTS_WIRE_VERSION,
                          WireVersion::LAST_LTS_WIRE_VERSION,
                          WireVersion::LAST_LTS_WIRE_VERSION,
                          WireVersion::LATEST_WIRE_VERSION);

    /*
     * Test communication between:
     * variable MongoS binary version -> MongoD 'latest' binary version
     * Note that it is disallowed for MongoS to communicate with a lower binary server.
     */

    for (const auto& mongoSRange : mongoSBinaryRanges) {
        for (const auto& mongoDLatestRange : mongoDLatestBinaryRanges) {
            // MongoS 'latest' binary can communicate with all FCV versions.
            // MongoS 'last-cont' binary can only communicate with MongoD downgraded 'last-cont' and
            // 'last-lts' FCV.
            // MongoS 'last-lts' binary can only communicate with MongoD downgraded 'last-lts' FCV.
            if (mongoSRange.minWireVersion == WireVersion::LATEST_WIRE_VERSION ||
                (mongoSRange.minWireVersion == WireVersion::LAST_CONT_WIRE_VERSION &&
                 mongoDLatestRange.minWireVersion == WireVersion::LAST_CONT_WIRE_VERSION) ||
                (mongoSRange.minWireVersion == WireVersion::LAST_LTS_WIRE_VERSION &&
                 mongoDLatestRange.minWireVersion == WireVersion::LAST_LTS_WIRE_VERSION) ||
                (mongoSRange.minWireVersion == WireVersion::LAST_CONT_WIRE_VERSION &&
                 mongoDLatestRange.minWireVersion == WireVersion::LAST_LTS_WIRE_VERSION)) {
                VALIDATE_WIRE_VERSION(ASSERT_OK,
                                      mongoSRange.minWireVersion,
                                      mongoSRange.maxWireVersion,
                                      mongoDLatestRange.minWireVersion,
                                      mongoDLatestRange.maxWireVersion);
            } else {
                VALIDATE_WIRE_VERSION(ASSERT_NOT_OK,
                                      mongoSRange.minWireVersion,
                                      mongoSRange.maxWireVersion,
                                      mongoDLatestRange.minWireVersion,
                                      mongoDLatestRange.maxWireVersion);
            }
        }
    }
}

// A mongos is unable to communicate with a fully upgraded cluster with a higher wire version.
TEST(WireVersionTest, ValidateWireVersionFailsForUpgradedServerNode) {
    // Server is fully upgraded to the latest wire version.
    auto msg = BSON("minWireVersion" << static_cast<int>(WireVersion::LATEST_WIRE_VERSION)
                                     << "maxWireVersion"
                                     << static_cast<int>(WireVersion::LATEST_WIRE_VERSION));
    auto swReply = wire_version::parseWireVersionFromHelloReply(msg);
    ASSERT_OK(swReply.getStatus());

    // The client (this mongos server) only has the previous wire version.
    ASSERT_EQUALS(mongo::ErrorCodes::IncompatibleWithUpgradedServer,
                  wire_version::validateWireVersion(
                      {WireVersion::LATEST_WIRE_VERSION - 1, WireVersion::LATEST_WIRE_VERSION - 1},
                      swReply.getValue()));
}

}  // namespace
}  // namespace mongo