cleanup uses_services plugin test names/comments

Author: cognifloyd

pants-plugins/uses_services/mongo_rules_test.py

@@ -94,7 +94,7 @@ def platform(
 
 
 # Warning this requires that mongo be running
-def test_is_running(rule_runner: RuleRunner) -> None:
+def test_mongo_is_running(rule_runner: RuleRunner) -> None:
     request = UsesMongoRequest()
     mock_platform = platform()
 
@@ -157,7 +157,7 @@ def test_is_running(rule_runner: RuleRunner) -> None:
         ),
     ),
 )
-def test_not_running(rule_runner: RuleRunner, mock_platform: Platform) -> None:
+def test_mongo_not_running(rule_runner: RuleRunner, mock_platform: Platform) -> None:
     request = UsesMongoRequest(
         db_host="127.100.20.7",
         db_port=10,  # unassigned port, unlikely to be used

pants-plugins/uses_services/scripts/is_mongo_running.py

@@ -17,12 +17,16 @@
 def _is_mongo_running(
     db_host: str, db_port: int, db_name: str, connection_timeout_ms: int
 ) -> bool:
+    """Connect to mongo with connection logic that mirrors the st2 code.
+
+    In particular, this is based on st2common.models.db.db_setup().
+    This should not import the st2 code as it should be self-contained.
+    """
     # late import so that __file__ can be imported in the pants plugin without these imports
     import mongoengine
     from pymongo.errors import ConnectionFailure
     from pymongo.errors import ServerSelectionTimeoutError
 
-    # cf st2common.models.db.setup()
     connection = mongoengine.connection.connect(
         db_name,
         host=db_host,
@@ -31,7 +35,7 @@ def _is_mongo_running(
         serverSelectionTimeoutMS=connection_timeout_ms,
     )
 
-    # connection.connect() is lazy. Make a command to test connection.
+    # connection.connect() is lazy. Make a command to test the connection.
     try:
         # The ismaster command is cheap and does not require auth
         connection.admin.command("ismaster")