ORM configuration Options is missing (postgreSQL) #98

peeringdb · Aug 13, 2024 · 21cce69 · 21cce69
1 parent 5fbb8c6
commit 21cce69
Show file tree

Hide file tree

Showing 4 changed files with 85 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 ## Unreleased
 ### Added
 - help text for info_traffic
+- ORM configuration options exposed
 ### Fixed
 - missing migrations
 ### Changed

diff --git a/CHANGELOG.yaml b/CHANGELOG.yaml
@@ -1,6 +1,7 @@
 Unreleased:
   added:
   - help text for info_traffic
+  - ORM configuration options exposed
   fixed:
   - missing migrations
   changed:

diff --git a/src/django_peeringdb/client_adaptor/load.py b/src/django_peeringdb/client_adaptor/load.py
@@ -5,6 +5,7 @@
     "PORT",
     "USER",
     "PASSWORD",
+    "OPTIONS",
 )
 
 
@@ -16,6 +17,11 @@ def database_settings(db_config):
             db[k] = v
 
     db["ENGINE"] = "django.db.backends." + db["ENGINE"]
+
+    # Check if the ENGINE is not PostgreSQL, remove OPTIONS if it's present
+    if db["ENGINE"] != "django.db.backends.postgresql":
+        db.pop("OPTIONS", None)
+
     return db
 
 

diff --git a/tests/test_client_adaptor.py b/tests/test_client_adaptor.py
@@ -46,6 +46,83 @@ def test_database_settings():
     assert db_config == expected
 
 
+def test_database_settings_postgresql():
+    db_config = database_settings(
+        {
+            "engine": "postgresql",
+            "name": "test_db",
+            "host": "localhost",
+            "port": 5432,
+            "user": "test_user",
+            "password": "test_password",
+            "options": {"options": "-c search_path=peeringdb_schema"},
+        }
+    )
+
+    expected = {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": "test_db",
+        "HOST": "localhost",
+        "PORT": 5432,
+        "USER": "test_user",
+        "PASSWORD": "test_password",
+        "OPTIONS": {"options": "-c search_path=peeringdb_schema"},
+    }
+
+    assert db_config == expected
+    assert "OPTIONS" in db_config
+
+
+def test_database_settings_mysql():
+    db_config = database_settings(
+        {
+            "engine": "mysql",
+            "name": "test_db",
+            "host": "localhost",
+            "port": 3306,
+            "user": "test_user",
+            "password": "test_password",
+        }
+    )
+
+    expected = {
+        "ENGINE": "django.db.backends.mysql",
+        "NAME": "test_db",
+        "HOST": "localhost",
+        "PORT": 3306,
+        "USER": "test_user",
+        "PASSWORD": "test_password",
+    }
+
+    assert db_config == expected
+
+
+def test_database_settings_mysql_no_options():
+    db_config = database_settings(
+        {
+            "engine": "mysql",
+            "name": "test_db",
+            "host": "localhost",
+            "port": 3306,
+            "user": "test_user",
+            "password": "test_password",
+            "options": {"options": "-c some_option"},
+        }
+    )
+
+    expected = {
+        "ENGINE": "django.db.backends.mysql",
+        "NAME": "test_db",
+        "HOST": "localhost",
+        "PORT": 3306,
+        "USER": "test_user",
+        "PASSWORD": "test_password",
+    }
+
+    assert db_config == expected
+    assert "OPTIONS" not in db_config
+
+
 def test_backend_setup():
     Backend.setup()
     for model in models.all_models: