INTPYTHON-509 add a helpful error message when database name is missing

Author: timgraham

django_mongodb_backend/utils.py

@@ -45,6 +45,12 @@ def parse_uri(uri, conn_max_age=0, test=None):
             host, port = nodelist[0]
         elif len(nodelist) > 1:
             host = ",".join([f"{host}:{port}" for host, port in nodelist])
+    if not uri["database"]:
+        raise ImproperlyConfigured(
+            "You must include the name of your database to the connection "
+            "string passed to parse_uri(), e.g. "
+            "mongodb://cluster0.example.mongodb.net/db_name?retryWrites=true&w=majority."
+        )
     settings_dict = {
         "ENGINE": "django_mongodb_backend",
         "NAME": uri["database"],

tests/backend_/utils/test_parse_uri.py

@@ -1,6 +1,7 @@
 from unittest.mock import patch
 
 import pymongo
+from django.core.exceptions import ImproperlyConfigured
 from django.test import SimpleTestCase
 
 from django_mongodb_backend import parse_uri
@@ -14,9 +15,13 @@ def test_simple_uri(self):
         self.assertEqual(settings_dict["HOST"], "cluster0.example.mongodb.net")
 
     def test_no_database(self):
-        settings_dict = parse_uri("mongodb://cluster0.example.mongodb.net")
-        self.assertIsNone(settings_dict["NAME"])
-        self.assertEqual(settings_dict["HOST"], "cluster0.example.mongodb.net")
+        msg = (
+            "You must include the name of your database to the connection "
+            "string passed to parse_uri(), e.g. "
+            "mongodb://cluster0.example.mongodb.net/db_name?retryWrites=true&w=majority."
+        )
+        with self.assertRaisesMessage(ImproperlyConfigured, msg):
+            parse_uri("mongodb://cluster0.example.mongodb.net")
 
     def test_srv_uri_with_options(self):
         uri = "mongodb+srv://my_user:[email protected]/my_database?retryWrites=true&w=majority"
@@ -34,31 +39,31 @@ def test_srv_uri_with_options(self):
         )
 
     def test_localhost(self):
-        settings_dict = parse_uri("mongodb://localhost")
+        settings_dict = parse_uri("mongodb://localhost/db")
         self.assertEqual(settings_dict["HOST"], "localhost")
         self.assertEqual(settings_dict["PORT"], 27017)
 
     def test_localhost_with_port(self):
-        settings_dict = parse_uri("mongodb://localhost:27018")
+        settings_dict = parse_uri("mongodb://localhost:27018/db")
         self.assertEqual(settings_dict["HOST"], "localhost")
         self.assertEqual(settings_dict["PORT"], 27018)
 
     def test_hosts_with_ports(self):
-        settings_dict = parse_uri("mongodb://localhost:27017,localhost:27018")
+        settings_dict = parse_uri("mongodb://localhost:27017,localhost:27018/db")
         self.assertEqual(settings_dict["HOST"], "localhost:27017,localhost:27018")
         self.assertEqual(settings_dict["PORT"], None)
 
     def test_hosts_without_ports(self):
-        settings_dict = parse_uri("mongodb://host1.net,host2.net")
+        settings_dict = parse_uri("mongodb://host1.net,host2.net/db")
         self.assertEqual(settings_dict["HOST"], "host1.net:27017,host2.net:27017")
         self.assertEqual(settings_dict["PORT"], None)
 
     def test_conn_max_age(self):
-        settings_dict = parse_uri("mongodb://localhost", conn_max_age=600)
+        settings_dict = parse_uri("mongodb://localhost/db", conn_max_age=600)
         self.assertEqual(settings_dict["CONN_MAX_AGE"], 600)
 
     def test_test_kwarg(self):
-        settings_dict = parse_uri("mongodb://localhost", test={"NAME": "test_db"})
+        settings_dict = parse_uri("mongodb://localhost/db", test={"NAME": "test_db"})
         self.assertEqual(settings_dict["TEST"], {"NAME": "test_db"})
 
     def test_invalid_credentials(self):