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
|
# Copyright 2018-present MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import copy
import itertools
import unittest
from test import PyMongoTestCase
from typing import Any
import pytest
try:
from mockupdb import CommandBase, MockupDB, going
_HAVE_MOCKUPDB = True
except ImportError:
_HAVE_MOCKUPDB = False
from operations import operations # type: ignore[import]
from pymongo import ReadPreference
from pymongo.common import MIN_SUPPORTED_WIRE_VERSION
from pymongo.read_preferences import (
_MONGOS_MODES,
make_read_preference,
read_pref_mode_from_name,
)
pytestmark = pytest.mark.mockupdb
class OpMsgReadPrefBase(PyMongoTestCase):
single_mongod = False
primary: MockupDB
secondary: MockupDB
@classmethod
def setUpClass(cls):
super().setUpClass()
@classmethod
def add_test(cls, mode, test_name, test):
setattr(cls, test_name, test)
def setup_client(self, read_preference):
client = self.simple_client(self.primary.uri, read_preference=read_preference)
return client
class TestOpMsgMongos(OpMsgReadPrefBase):
@classmethod
def setUpClass(cls):
super().setUpClass()
auto_ismaster = {
"ismaster": True,
"msg": "isdbgrid", # Mongos.
"minWireVersion": 2,
"maxWireVersion": MIN_SUPPORTED_WIRE_VERSION,
}
cls.primary = MockupDB(auto_ismaster=auto_ismaster)
cls.primary.run()
cls.secondary = cls.primary
@classmethod
def tearDownClass(cls):
cls.primary.stop()
super().tearDownClass()
class TestOpMsgReplicaSet(OpMsgReadPrefBase):
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.primary, cls.secondary = MockupDB(), MockupDB()
for server in cls.primary, cls.secondary:
server.run()
hosts = [server.address_string for server in (cls.primary, cls.secondary)]
primary_ismaster = {
"ismaster": True,
"setName": "rs",
"hosts": hosts,
"minWireVersion": 2,
"maxWireVersion": MIN_SUPPORTED_WIRE_VERSION,
}
cls.primary.autoresponds(CommandBase("ismaster"), primary_ismaster)
secondary_ismaster = copy.copy(primary_ismaster)
secondary_ismaster["ismaster"] = False
secondary_ismaster["secondary"] = True
cls.secondary.autoresponds(CommandBase("ismaster"), secondary_ismaster)
@classmethod
def tearDownClass(cls):
for server in cls.primary, cls.secondary:
server.stop()
super().tearDownClass()
@classmethod
def add_test(cls, mode, test_name, test):
# Skip nearest tests since we don't know if we will select the primary
# or secondary.
if mode != "nearest":
setattr(cls, test_name, test)
def setup_client(self, read_preference):
client = self.simple_client(
self.primary.uri, replicaSet="rs", read_preference=read_preference
)
# Run a command on a secondary to discover the topology. This ensures
# that secondaryPreferred commands will select the secondary.
client.admin.command("ismaster", read_preference=ReadPreference.SECONDARY)
return client
class TestOpMsgSingle(OpMsgReadPrefBase):
single_mongod = True
@classmethod
def setUpClass(cls):
super().setUpClass()
auto_ismaster = {
"ismaster": True,
"minWireVersion": 2,
"maxWireVersion": MIN_SUPPORTED_WIRE_VERSION,
}
cls.primary = MockupDB(auto_ismaster=auto_ismaster)
cls.primary.run()
cls.secondary = cls.primary
@classmethod
def tearDownClass(cls):
cls.primary.stop()
super().tearDownClass()
def create_op_msg_read_mode_test(mode, operation):
def test(self):
pref = make_read_preference(read_pref_mode_from_name(mode), tag_sets=None)
client = self.setup_client(read_preference=pref)
expected_pref: Any
if operation.op_type == "always-use-secondary":
expected_server = self.secondary
expected_pref = ReadPreference.SECONDARY
elif operation.op_type == "must-use-primary":
expected_server = self.primary
expected_pref = None
elif operation.op_type == "may-use-secondary":
if mode == "primary":
expected_server = self.primary
expected_pref = None
elif mode == "primaryPreferred":
expected_server = self.primary
expected_pref = pref
else:
expected_server = self.secondary
expected_pref = pref
else:
self.fail("unrecognized op_type %r" % operation.op_type)
# For single mongod we omit the read preference.
if self.single_mongod:
expected_pref = None
with going(operation.function, client):
request = expected_server.receive()
request.reply(operation.reply)
actual_pref = request.doc.get("$readPreference")
if expected_pref:
self.assertEqual(expected_pref.document, actual_pref)
else:
self.assertIsNone(actual_pref)
self.assertNotIn("$query", request.doc)
return test
def generate_op_msg_read_mode_tests():
matrix = itertools.product(_MONGOS_MODES, operations)
for entry in matrix:
mode, operation = entry
test = create_op_msg_read_mode_test(mode, operation)
test_name = "test_{}_with_mode_{}".format(operation.name.replace(" ", "_"), mode)
test.__name__ = test_name
for cls in TestOpMsgMongos, TestOpMsgReplicaSet, TestOpMsgSingle:
cls.add_test(mode, test_name, test)
generate_op_msg_read_mode_tests()
if __name__ == "__main__":
unittest.main()
|