sensu-plugins-mongodb-mrtrotl 1.4.0

data/lib/pymongo/client_options.py

@@ -0,0 +1,302 @@
+# Copyright 2014-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.
+
+"""Tools to parse mongo client options."""
+
+from typing import Optional
+
+from bson.codec_options import _parse_codec_options
+from pymongo import common
+from pymongo.auth import _build_credentials_tuple
+from pymongo.common import validate_boolean
+from pymongo.compression_support import CompressionSettings
+from pymongo.errors import ConfigurationError
+from pymongo.monitoring import _EventListeners
+from pymongo.pool import PoolOptions
+from pymongo.read_concern import ReadConcern
+from pymongo.read_preferences import make_read_preference, read_pref_mode_from_name
+from pymongo.server_selectors import any_server_selector
+from pymongo.ssl_support import get_ssl_context
+from pymongo.write_concern import WriteConcern
+
+
+def _parse_credentials(username, password, database, options):
+    """Parse authentication credentials."""
+    mechanism = options.get("authmechanism", "DEFAULT" if username else None)
+    source = options.get("authsource")
+    if username or mechanism:
+        return _build_credentials_tuple(mechanism, source, username, password, options, database)
+    return None
+
+
+def _parse_read_preference(options):
+    """Parse read preference options."""
+    if "read_preference" in options:
+        return options["read_preference"]
+
+    name = options.get("readpreference", "primary")
+    mode = read_pref_mode_from_name(name)
+    tags = options.get("readpreferencetags")
+    max_staleness = options.get("maxstalenessseconds", -1)
+    return make_read_preference(mode, tags, max_staleness)
+
+
+def _parse_write_concern(options):
+    """Parse write concern options."""
+    concern = options.get("w")
+    wtimeout = options.get("wtimeoutms")
+    j = options.get("journal")
+    fsync = options.get("fsync")
+    return WriteConcern(concern, wtimeout, j, fsync)
+
+
+def _parse_read_concern(options):
+    """Parse read concern options."""
+    concern = options.get("readconcernlevel")
+    return ReadConcern(concern)
+
+
+def _parse_ssl_options(options):
+    """Parse ssl options."""
+    use_tls = options.get("tls")
+    if use_tls is not None:
+        validate_boolean("tls", use_tls)
+
+    certfile = options.get("tlscertificatekeyfile")
+    passphrase = options.get("tlscertificatekeyfilepassword")
+    ca_certs = options.get("tlscafile")
+    crlfile = options.get("tlscrlfile")
+    allow_invalid_certificates = options.get("tlsallowinvalidcertificates", False)
+    allow_invalid_hostnames = options.get("tlsallowinvalidhostnames", False)
+    disable_ocsp_endpoint_check = options.get("tlsdisableocspendpointcheck", False)
+
+    enabled_tls_opts = []
+    for opt in (
+        "tlscertificatekeyfile",
+        "tlscertificatekeyfilepassword",
+        "tlscafile",
+        "tlscrlfile",
+    ):
+        # Any non-null value of these options implies tls=True.
+        if opt in options and options[opt]:
+            enabled_tls_opts.append(opt)
+    for opt in (
+        "tlsallowinvalidcertificates",
+        "tlsallowinvalidhostnames",
+        "tlsdisableocspendpointcheck",
+    ):
+        # A value of False for these options implies tls=True.
+        if opt in options and not options[opt]:
+            enabled_tls_opts.append(opt)
+
+    if enabled_tls_opts:
+        if use_tls is None:
+            # Implicitly enable TLS when one of the tls* options is set.
+            use_tls = True
+        elif not use_tls:
+            # Error since tls is explicitly disabled but a tls option is set.
+            raise ConfigurationError(
+                "TLS has not been enabled but the "
+                "following tls parameters have been set: "
+                "%s. Please set `tls=True` or remove." % ", ".join(enabled_tls_opts)
+            )
+
+    if use_tls:
+        ctx = get_ssl_context(
+            certfile,
+            passphrase,
+            ca_certs,
+            crlfile,
+            allow_invalid_certificates,
+            allow_invalid_hostnames,
+            disable_ocsp_endpoint_check,
+        )
+        return ctx, allow_invalid_hostnames
+    return None, allow_invalid_hostnames
+
+
+def _parse_pool_options(username, password, database, options):
+    """Parse connection pool options."""
+    credentials = _parse_credentials(username, password, database, options)
+    max_pool_size = options.get("maxpoolsize", common.MAX_POOL_SIZE)
+    min_pool_size = options.get("minpoolsize", common.MIN_POOL_SIZE)
+    max_idle_time_seconds = options.get("maxidletimems", common.MAX_IDLE_TIME_SEC)
+    if max_pool_size is not None and min_pool_size > max_pool_size:
+        raise ValueError("minPoolSize must be smaller or equal to maxPoolSize")
+    connect_timeout = options.get("connecttimeoutms", common.CONNECT_TIMEOUT)
+    socket_timeout = options.get("sockettimeoutms")
+    wait_queue_timeout = options.get("waitqueuetimeoutms", common.WAIT_QUEUE_TIMEOUT)
+    event_listeners = options.get("event_listeners")
+    appname = options.get("appname")
+    driver = options.get("driver")
+    server_api = options.get("server_api")
+    compression_settings = CompressionSettings(
+        options.get("compressors", []), options.get("zlibcompressionlevel", -1)
+    )
+    ssl_context, tls_allow_invalid_hostnames = _parse_ssl_options(options)
+    load_balanced = options.get("loadbalanced")
+    max_connecting = options.get("maxconnecting", common.MAX_CONNECTING)
+    return PoolOptions(
+        max_pool_size,
+        min_pool_size,
+        max_idle_time_seconds,
+        connect_timeout,
+        socket_timeout,
+        wait_queue_timeout,
+        ssl_context,
+        tls_allow_invalid_hostnames,
+        _EventListeners(event_listeners),
+        appname,
+        driver,
+        compression_settings,
+        max_connecting=max_connecting,
+        server_api=server_api,
+        load_balanced=load_balanced,
+        credentials=credentials,
+    )
+
+
+class ClientOptions(object):
+    """Read only configuration options for a MongoClient.
+
+    Should not be instantiated directly by application developers. Access
+    a client's options via :attr:`pymongo.mongo_client.MongoClient.options`
+    instead.
+    """
+
+    def __init__(self, username, password, database, options):
+        self.__options = options
+        self.__codec_options = _parse_codec_options(options)
+        self.__direct_connection = options.get("directconnection")
+        self.__local_threshold_ms = options.get("localthresholdms", common.LOCAL_THRESHOLD_MS)
+        # self.__server_selection_timeout is in seconds. Must use full name for
+        # common.SERVER_SELECTION_TIMEOUT because it is set directly by tests.
+        self.__server_selection_timeout = options.get(
+            "serverselectiontimeoutms", common.SERVER_SELECTION_TIMEOUT
+        )
+        self.__pool_options = _parse_pool_options(username, password, database, options)
+        self.__read_preference = _parse_read_preference(options)
+        self.__replica_set_name = options.get("replicaset")
+        self.__write_concern = _parse_write_concern(options)
+        self.__read_concern = _parse_read_concern(options)
+        self.__connect = options.get("connect")
+        self.__heartbeat_frequency = options.get("heartbeatfrequencyms", common.HEARTBEAT_FREQUENCY)
+        self.__retry_writes = options.get("retrywrites", common.RETRY_WRITES)
+        self.__retry_reads = options.get("retryreads", common.RETRY_READS)
+        self.__server_selector = options.get("server_selector", any_server_selector)
+        self.__auto_encryption_opts = options.get("auto_encryption_opts")
+        self.__load_balanced = options.get("loadbalanced")
+        self.__timeout = options.get("timeoutms")
+
+    @property
+    def _options(self):
+        """The original options used to create this ClientOptions."""
+        return self.__options
+
+    @property
+    def connect(self):
+        """Whether to begin discovering a MongoDB topology automatically."""
+        return self.__connect
+
+    @property
+    def codec_options(self):
+        """A :class:`~bson.codec_options.CodecOptions` instance."""
+        return self.__codec_options
+
+    @property
+    def direct_connection(self):
+        """Whether to connect to the deployment in 'Single' topology."""
+        return self.__direct_connection
+
+    @property
+    def local_threshold_ms(self):
+        """The local threshold for this instance."""
+        return self.__local_threshold_ms
+
+    @property
+    def server_selection_timeout(self):
+        """The server selection timeout for this instance in seconds."""
+        return self.__server_selection_timeout
+
+    @property
+    def server_selector(self):
+        return self.__server_selector
+
+    @property
+    def heartbeat_frequency(self):
+        """The monitoring frequency in seconds."""
+        return self.__heartbeat_frequency
+
+    @property
+    def pool_options(self):
+        """A :class:`~pymongo.pool.PoolOptions` instance."""
+        return self.__pool_options
+
+    @property
+    def read_preference(self):
+        """A read preference instance."""
+        return self.__read_preference
+
+    @property
+    def replica_set_name(self):
+        """Replica set name or None."""
+        return self.__replica_set_name
+
+    @property
+    def write_concern(self):
+        """A :class:`~pymongo.write_concern.WriteConcern` instance."""
+        return self.__write_concern
+
+    @property
+    def read_concern(self):
+        """A :class:`~pymongo.read_concern.ReadConcern` instance."""
+        return self.__read_concern
+
+    @property
+    def timeout(self) -> Optional[float]:
+        """The configured timeoutMS converted to seconds, or None.
+
+        ..versionadded: 4.2
+        """
+        return self.__timeout
+
+    @property
+    def retry_writes(self):
+        """If this instance should retry supported write operations."""
+        return self.__retry_writes
+
+    @property
+    def retry_reads(self):
+        """If this instance should retry supported read operations."""
+        return self.__retry_reads
+
+    @property
+    def auto_encryption_opts(self):
+        """A :class:`~pymongo.encryption.AutoEncryptionOpts` or None."""
+        return self.__auto_encryption_opts
+
+    @property
+    def load_balanced(self):
+        """True if the client was configured to connect to a load balancer."""
+        return self.__load_balanced
+
+    @property
+    def event_listeners(self):
+        """The event listeners registered for this client.
+
+        See :mod:`~pymongo.monitoring` for details.
+
+        .. versionadded:: 4.0
+        """
+        return self.__pool_options._event_listeners.event_listeners()