fix(conf): allow type coercion for configuration options (#84)

* Adds type coercion option for a configuration * Coerces `mongod_port` to `int`, `ignore_cache` to `bool`, and `use_local_mongod` to `bool`. * Removes unnecessary warning log for user set MongoD port since the value is advertised with context.
kaizendorks · Sep 9, 2023 · 4bc43df · 4bc43df
1 parent b2eec60
commit 4bc43df
Show file tree

Hide file tree

Showing 14 changed files with 649 additions and 602 deletions.
diff --git a/.github/workflows/pypi-publish.yml b/.github/workflows/pypi-publish.yml
@@ -9,10 +9,10 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python 3.7
+      - name: Set up Python 3.9
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: 3.9
       - name: Install and configure Poetry
         run: |
           curl -sSL https://install.python-poetry.org | python3 -

diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -7,10 +7,10 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python 3.7
+      - name: Set up Python 3.9
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: 3.9
       - name: Install and configure Poetry
         run: |
           curl -sSL https://install.python-poetry.org | python3 -

diff --git a/.python-version b/.python-version
@@ -1 +1 @@
-3.7.16
+3.9
diff --git a/examples/able_to_connect.py b/examples/able_to_connect.py
@@ -10,9 +10,7 @@
     with MongoClient() as client:
         db = client["test-db"]
         collection = db["my-collection"]
-        data = {
-            "some": "data"
-        }
+        data = {"some": "data"}
         inserted_id = collection.insert_one(data).inserted_id
         mongo_dump = bson.decode(client.pim_mongodump("test-db", "my-collection"))
         assert mongo_dump["some"] == "data"

diff --git a/examples/several_clients.py b/examples/several_clients.py
@@ -13,9 +13,7 @@
             db2 = client2["test-db"]
             collection1 = db1["my-collection"]
             collection2 = db2["my-collection"]
-            data = {
-                "some": "data"
-            }
+            data = {"some": "data"}
             inserted_id1 = collection1.insert_one(data).inserted_id
             inserted_id2 = collection2.insert_one(data).inserted_id
             mongo_dump1 = bson.decode(client1.pim_mongodump("test-db", "my-collection"))

diff --git a/poetry.lock b/poetry.lock
diff --git a/pymongo_inmemory/context.py b/pymongo_inmemory/context.py
@@ -18,6 +18,13 @@ class OperatingSystemNotFound(ValueError):
     pass
 
 
+def _coercion(constructor, value):
+    if constructor == bool:
+        return value == "True"
+    else:
+        return constructor(value)
+
+
 def _check_environment_vars(option, fallback=None):
     "Check if `option` is defined in environment variables"
     return os.environ.get("PYMONGOIM__{}".format(str(option).upper()), default=fallback)
@@ -30,7 +37,7 @@ def _check_cfg(option, filename, fallback=None):
     return parser.get("pymongo_inmemory", option, fallback=fallback, raw=True)
 
 
-def conf(option, fallback=None, optional=True):
+def conf(option, fallback=None, optional=True, coerce_with=str):
     """Retrieve asked `option` if possible. There are number of places that are checked.
     In the order of precedence,
     1. Environment variables
@@ -65,13 +72,25 @@ def conf(option, fallback=None, optional=True):
         ),
     )
 
-    if value is None and not optional:
-        raise ValueError(
-            (
-                "Can't determine the value of {} "
-                "and it is not an optional parameter."
-            ).format(option)
-        )
+    if value is None:
+        if not optional:
+            raise ValueError(
+                (
+                    "Can't determine the value of {} "
+                    "and it is not an optional parameter."
+                ).format(option)
+            )
+    else:
+        try:
+            value = _coercion(coerce_with, value)
+        except ValueError:
+            value = None
+        except Exception:
+            raise ValueError(
+                ("Can't coerce the value of {} to type {}").format(
+                    option, coerce_with.__qualname__
+                )
+            )
 
     logger.debug("Value for {}=={}".format(option, value))
 
@@ -83,7 +102,7 @@ def __init__(
         self, os_name=None, version=None, os_ver=None, ignore_cache=False
     ) -> None:
         self.mongo_version = conf("mongo_version", version)
-        self.mongod_port = conf("mongod_port", None)
+        self.mongod_port = conf("mongod_port", None, coerce_with=int)
 
         self.operating_system = self._build_operating_system_info(os_name)
         self.os_version = conf("os_version", os_ver)
@@ -94,8 +113,8 @@ def __init__(
 
         self.url_hash = hashlib.sha256(bytes(self.download_url, "utf-8")).hexdigest()
 
-        self.ignore_cache = bool(conf("ignore_cache", ignore_cache))
-        self.use_local_mongod = conf("use_local_mongod", None)
+        self.ignore_cache = conf("ignore_cache", ignore_cache, coerce_with=bool)
+        self.use_local_mongod = conf("use_local_mongod", False, coerce_with=bool)
 
         self.download_folder = conf(
             "download_folder", mkdir_ifnot_exist(CACHE_FOLDER, "download")

diff --git a/pymongo_inmemory/mongod.py b/pymongo_inmemory/mongod.py
@@ -59,7 +59,6 @@ def port(self):
         if set_port is None:
             return str(find_open_port(range(27017, 28000)))
         else:
-            logger.warning("Using Mongod port set by user: {}".format(set_port))
             return set_port
 
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pymongo_inmemory"
-version = "0.3.0"
+version = "0.3.1"
 description = "A mongo mocking library with an ephemeral MongoDB running in memory."
 authors = ["Kaizen Dorks <[email protected]>"]
 maintainers = [
@@ -31,14 +31,13 @@ include = ["LICENSE"]
 "Bug Reports" = "https://github.com/kaizendorks/pymongo_inmemory/issues"
 
 [tool.poetry.dependencies]
-python = "^3.7"
+python = "^3.9"
 pymongo = "*"
 
 [tool.poetry.dev-dependencies]
 flake8 = "*"
 mypy = "*"
 pytest = "*"
-pytest-pythonpath = "*"
 twine = "*"
 wheel = "*"
 setuptools = "*"
@@ -51,3 +50,6 @@ black = "^23.3.0"
 [build-system]
 requires = ["poetry>=0.12"]
 build-backend = "poetry.masonry.api"
+
+[tool.pytest.ini_options]
+pythonpath = "."
diff --git a/setup.cfg b/setup.cfg
@@ -1,7 +1,3 @@
 [flake8]
 max-line-length = 89
 exclude = .git,__pycache__,.venv
-
-[tool:pytest]
-python_paths = .
-
diff --git a/tests/functional/test_open_ports_socket.py b/tests/functional/test_open_ports_socket.py
@@ -12,6 +12,7 @@ def server(request):
     # Add finalizer at the point of least possible failure
     def fin():
         server.close()
+
     request.addfinalizer(fin)
 
     server.setblocking(0)

diff --git a/tests/unit/test_async.py b/tests/unit/test_async.py
@@ -4,10 +4,11 @@
 
 
 def test_init_module_in_loop():
-    sys.modules.pop('pymongo_inmemory.mongod', None)
+    sys.modules.pop("pymongo_inmemory.mongod", None)
 
     async def main():
         import pymongo_inmemory.mongod  # noqa F401
+
         return True
 
     loop = asyncio.new_event_loop()

diff --git a/tests/unit/test_context.py b/tests/unit/test_context.py
@@ -44,3 +44,23 @@ def test_download_url_setting(monkeypatch):
     pim_context = context.Context()
     assert pim_context.download_url == provided_url
     assert pim_context.url_hash == expected_hash
+
+
+def test_expected_type_coercion(monkeypatch):
+    monkeypatch.setenv("PYMONGOIM__MONGOD_PORT", "42")
+    monkeypatch.setenv("PYMONGOIM__IGNORE_CACHE", "True")
+    monkeypatch.setenv("PYMONGOIM__USE_LOCAL_MONGOD", "True")
+    pim_context = context.Context()
+    assert pim_context.ignore_cache
+    assert pim_context.use_local_mongod
+    assert pim_context.mongod_port == 42
+
+
+def test_type_coercion_uncoercible_values(monkeypatch):
+    monkeypatch.setenv("PYMONGOIM__MONGOD_PORT", "something")
+    monkeypatch.setenv("PYMONGOIM__IGNORE_CACHE", "true")
+    monkeypatch.setenv("PYMONGOIM__USE_LOCAL_MONGOD", "false")
+    pim_context = context.Context()
+    assert not pim_context.ignore_cache
+    assert not pim_context.use_local_mongod
+    assert pim_context.mongod_port is None
diff --git a/tests/unit/test_urls.py b/tests/unit/test_urls.py
@@ -4,30 +4,64 @@
 
 import pymongo_inmemory.downloader._urls as utools
 
+
 def test_best_url():
     """
     - Given `major.minor.patch` version:
         - Starting from `major` to `patch`
         - If there is an exact match it should take it
         - If there isn't, it should take the highest and go on with the highest
     """
-    assert utools.best_url("linux") == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-4.0.28.tgz", "4.0.28"), "Should find latest MongoDB for Linux:Generic"
-    assert utools.best_url("linux", "3") == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-3.6.23.tgz", "3.6.23"), "Should find latest MongoDB 3 for Linux:Generic"
-    assert utools.best_url("linux", "3.4") == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-3.4.24.tgz", "3.4.24"), "Should find latest MongoDB 3.4 for Linux:Generic"
-    assert utools.best_url("linux", "2.6.11") == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-2.6.11.tgz", "2.6.11"), "Should find exact MongoDB 2.6.11 for Linux:Generic"
+    assert utools.best_url("linux") == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-4.0.28.tgz",
+        "4.0.28",
+    ), "Should find latest MongoDB for Linux:Generic"
+    assert utools.best_url("linux", "3") == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-3.6.23.tgz",
+        "3.6.23",
+    ), "Should find latest MongoDB 3 for Linux:Generic"
+    assert utools.best_url("linux", "3.4") == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-3.4.24.tgz",
+        "3.4.24",
+    ), "Should find latest MongoDB 3.4 for Linux:Generic"
+    assert utools.best_url("linux", "2.6.11") == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-2.6.11.tgz",
+        "2.6.11",
+    ), "Should find exact MongoDB 2.6.11 for Linux:Generic"
 
-    assert utools.best_url("linux", "4.4.4") == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-4.0.28.tgz", "4.0.28"), "Linux:Generic support ends at 4.0.28, higher versions default to this."
+    assert utools.best_url("linux", "4.4.4") == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-4.0.28.tgz",
+        "4.0.28",
+    ), "Linux:Generic support ends at 4.0.28, higher versions default to this."
 
-    assert utools.best_url("ubuntu") == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu2004-6.0.6.tgz", "6.0.6"), "Should find latest MongoDB for latest Ubuntu"
-    assert utools.best_url("ubuntu", os_ver=18) == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1804-6.0.6.tgz", "6.0.6"), "Should find latest MongoDB for Ubuntu 18"
-    assert utools.best_url("ubuntu", os_ver="14", version="3.0.3") == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1404-3.0.3.tgz", "3.0.3"), "Should find MongoDB 3.0.3 for Ubuntu 14"
+    assert utools.best_url("ubuntu") == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu2004-6.0.6.tgz",
+        "6.0.6",
+    ), "Should find latest MongoDB for latest Ubuntu"
+    assert utools.best_url("ubuntu", os_ver=18) == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1804-6.0.6.tgz",
+        "6.0.6",
+    ), "Should find latest MongoDB for Ubuntu 18"
+    assert utools.best_url("ubuntu", os_ver="14", version="3.0.3") == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1404-3.0.3.tgz",
+        "3.0.3",
+    ), "Should find MongoDB 3.0.3 for Ubuntu 14"
 
     with pytest.raises(utools.OperatingSystemNameNotFound):
         utools.best_url("xubuntu", os_ver="14", version="3.0.3")
 
     with pytest.raises(utools.OperatingSystemVersionNotFound):
         utools.best_url("ubuntu", os_ver="10", version="3.0.3")
 
-    assert utools.best_url("ubuntu", os_ver="14", version="1.4.4") == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1404-4.0.28.tgz", "4.0.28"), "If major version is not there should find latest major version of MongoDB for Ubuntu 14"
-    assert utools.best_url("ubuntu", os_ver="14", version="3.8.4") == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1404-3.6.23.tgz", "3.6.23"), "If minor version is not there should find latest minor version of MongoDB for given major version, for Ubuntu 14"
-    assert utools.best_url("ubuntu", os_ver="14", version="3.4.22") == ("https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1404-3.4.24.tgz", "3.4.24"), "If patch version is not there should find latest patch version of MongoDB for given major.minor version, for Ubuntu 14"
+    assert utools.best_url("ubuntu", os_ver="14", version="1.4.4") == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1404-4.0.28.tgz",
+        "4.0.28",
+    ), "If major version is not there should find latest major version of MongoDB for Ubuntu 14"
+    assert utools.best_url("ubuntu", os_ver="14", version="3.8.4") == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1404-3.6.23.tgz",
+        "3.6.23",
+    ), "If minor version is not there should find latest minor version of MongoDB for given major version, for Ubuntu 14"
+    assert utools.best_url("ubuntu", os_ver="14", version="3.4.22") == (
+        "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1404-3.4.24.tgz",
+        "3.4.24",
+    ), "If patch version is not there should find latest patch version of MongoDB for given major.minor version, for Ubuntu 14"