From a3cf72005dedeaf14f2ad1d2b4f1a6691a9e99f2 Mon Sep 17 00:00:00 2001
From: Wayne Werner <wwerner@vmware.com>
Date: Thu, 17 Feb 2022 11:18:24 -0600
Subject: [PATCH] Add ssl argument to MongoClient for mongo future returner

---
 salt/returners/mongo_future_return.py         |  4 +-
 .../returners/test_mongo_future_return.py     | 79 +++++++++++++++++--
 2 files changed, 74 insertions(+), 9 deletions(-)

diff --git a/salt/returners/mongo_future_return.py b/salt/returners/mongo_future_return.py
index d45b05784f4..8c241c09be2 100644
--- a/salt/returners/mongo_future_return.py
+++ b/salt/returners/mongo_future_return.py
@@ -137,6 +137,7 @@ def _get_options(ret=None):
     attrs = {
         "host": "host",
         "port": "port",
+        "ssl": "ssl",
         "db": "db",
         "user": "user",
         "password": "password",
@@ -158,6 +159,7 @@ def _get_conn(ret):
 
     host = _options.get("host")
     port = _options.get("port")
+    ssl = _options.get("ssl") or False
     uri = _options.get("uri")
     db_ = _options.get("db")
     user = _options.get("user")
@@ -178,7 +180,7 @@ def _get_conn(ret):
         mdb = conn.get_database()
     else:
         if PYMONGO_VERSION > Version("2.3"):
-            conn = pymongo.MongoClient(host, port, username=user, password=password)
+            conn = pymongo.MongoClient(host, port, username=user, password=password, ssl=ssl)
         else:
             if uri:
                 raise salt.exceptions.SaltConfigurationError(
diff --git a/tests/pytests/unit/returners/test_mongo_future_return.py b/tests/pytests/unit/returners/test_mongo_future_return.py
index 1f59ed4b988..88ebc6b0c63 100644
--- a/tests/pytests/unit/returners/test_mongo_future_return.py
+++ b/tests/pytests/unit/returners/test_mongo_future_return.py
@@ -1,19 +1,18 @@
 import pytest
 
 import salt.exceptions
-import salt.returners.mongo_future_return as mongo
+import salt.returners.mongo_future_return as mongo_future_return
 from salt.utils.versions import Version
 from tests.support.mock import patch
 
 
 @pytest.fixture
 def configure_loader_modules():
-
+    fake_opts = {"mongo.host": "fnord", "mongo.port": "fnordport"}
     return {
-        mongo: {
-            "__opts__": {
-                "mongo.uri": "mongodb://root:pass@localhost27017/salt?authSource=admin"
-            }
+        mongo_future_return: {
+            "__opts__": fake_opts,
+            "__salt__": {"config.option": fake_opts.get},
         }
     }
 
@@ -30,6 +29,70 @@ def test_config_exception():
         "salt.returners.mongo_future_return.PYMONGO_VERSION",
         Version("4.3.2"),
         create=True,
-    ), patch.dict(mongo.__opts__, opts):
+    ), patch.dict(mongo_future_return.__opts__, opts):
         with pytest.raises(salt.exceptions.SaltConfigurationError):
-            mongo.returner({})
+            mongo_future_return.returner({})
+
+@pytest.mark.parametrize(
+    "expected_ssl, use_ssl",
+    [
+        (True, {"fnord.mongo.ssl": True}),
+        (False, {"fnord.mongo.ssl": False}),
+        (False, {"fnord.mongo.ssl": None}),
+        (False, {}),
+    ],
+)
+def test_mongo_future_returner_should_correctly_pass_ssl_to_MongoClient_when_ret_is_set(
+    expected_ssl, use_ssl
+):
+    with patch(
+        "salt.returners.mongo_future_return.pymongo", create=True
+    ) as fake_mongo, patch.object(
+        mongo_future_return,
+        "PYMONGO_VERSION",
+        mongo_future_return.Version("99999"),
+        create=True,
+    ), patch.dict(
+        "salt.returners.mongo_future_return.__opts__",
+        {
+            **use_ssl,
+            **{"fnord.mongo.host": "fnordfnord", "fnord.mongo.port": "fnordfnordport"},
+        },
+    ):
+        mongo_future_return._get_conn(ret={"ret_config": "fnord"})
+        fake_mongo.MongoClient.assert_called_with(
+            host="fnordfnord", port="fnordfnordport", ssl=expected_ssl
+        )
+
+
+@pytest.mark.parametrize(
+    "expected_ssl, use_ssl",
+    [
+        (True, {"mongo.ssl": True}),
+        (False, {"mongo.ssl": False}),
+        (False, {"mongo.ssl": None}),
+        (False, {}),
+    ],
+)
+def test_mongo_future_returner_should_correctly_pass_ssl_to_MongoClient(
+    expected_ssl, use_ssl
+):
+    # Here these fnord.X.Y config options should be ignored
+    with patch(
+        "salt.returners.mongo_future_return.pymongo", create=True
+    ) as fake_mongo, patch.object(
+        mongo_future_return,
+        "PYMONGO_VERSION",
+        mongo_future_return.Version("99999"),
+        create=True,
+    ), patch.dict(
+        "salt.returners.mongo_future_return.__opts__",
+        {
+            **use_ssl,
+            **{"fnord.mongo.host": "fnordfnord", "fnord.mongo.port": "fnordfnordport"},
+        },
+    ):
+        mongo_future_return._get_conn(ret=None)
+        fake_mongo.MongoClient.assert_called_with(
+            host="fnord", port="fnordport", ssl=expected_ssl
+        )