Expand env vars in DSN aliases

Author: n8himmel

changelog.md

@@ -3,6 +3,7 @@ Upcoming (TBD)
 
 Bug Fixes
 ---------
+* Expand environment variables in configured DSN aliases.
 * Keep completion-menu Escape cancellation eager only in Vi mode so Emacs Alt-key bindings keep working while completions are open.
 
 

mycli/AUTHORS

@@ -117,6 +117,7 @@ Contributors:
   * yurenchen000
   * Linuxdazhao
   * Puneet Dixit
+  * n8himmel
 
 
 Created by:

mycli/cli_runner.py

@@ -152,6 +152,7 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
                 )
                 sys.exit(1)
         else:
+            dsn_uri = os.path.expandvars(dsn_uri)
             mycli.dsn_alias = cli_args.dsn
 
     if dsn_uri:

mycli/myclirc

@@ -395,6 +395,7 @@ matching-bracket.other = '#000000 bg:#aacccc'
 
 # Use the -d option to reference a DSN.
 # Special characters in passwords and other strings can be escaped with URL encoding.
+# Environment variables in the form $VAR or ${VAR} are expanded in alias DSNs.
 [alias_dsn]
 # example_dsn = mysql://[user[:password]@][host][:port][/dbname]
 

test/myclirc

@@ -398,6 +398,7 @@ global_limit = set sql_select_limit=9999
 
 # Use the -d option to reference a DSN.
 # Special characters in passwords and other strings can be escaped with URL encoding.
+# Environment variables in the form $VAR or ${VAR} are expanded in alias DSNs.
 [alias_dsn]
 # example_dsn = mysql://[user[:password]@][host][:port][/dbname]
 

test/pytests/test_main.py

@@ -982,6 +982,48 @@ def run_query(self, query, new_line=True):
         and MockMyCli.connect_args["database"] == "alias_dsn_database"
     )
 
+    monkeypatch.setenv("MYCLI_TEST_DSN_USER", "env_dsn_user")
+    monkeypatch.setenv("MYCLI_TEST_DSN_PASSWORD", "env_dsn_passwd")
+    monkeypatch.setenv("MYCLI_TEST_DSN_HOST", "env_dsn_host")
+    monkeypatch.setenv("MYCLI_TEST_DSN_PORT", "9")
+    monkeypatch.setenv("MYCLI_TEST_DSN_DATABASE", "env_dsn_database")
+    MockMyCli.config = {
+        "main": {},
+        "alias_dsn": {
+            "env_test": "mysql://$MYCLI_TEST_DSN_USER:${MYCLI_TEST_DSN_PASSWORD}@$MYCLI_TEST_DSN_HOST:${MYCLI_TEST_DSN_PORT}/${MYCLI_TEST_DSN_DATABASE}"
+        },
+        "connection": {
+            "default_keepalive_ticks": 0,
+        },
+    }
+    MockMyCli.connect_args = None
+
+    # When a DSN alias uses environment variables, expand those before parsing
+    # the URI.
+    result = runner.invoke(click_entrypoint, args=["--dsn", "env_test"])
+    assert result.exit_code == 0, result.output + " " + str(result.exception)
+    assert (
+        MockMyCli.connect_args["user"] == "env_dsn_user"
+        and MockMyCli.connect_args["passwd"] == "env_dsn_passwd"
+        and MockMyCli.connect_args["host"] == "env_dsn_host"
+        and MockMyCli.connect_args["port"] == 9
+        and MockMyCli.connect_args["database"] == "env_dsn_database"
+    )
+
+    MockMyCli.connect_args = None
+
+    # The same expansion applies when the alias is supplied as the positional
+    # database argument.
+    result = runner.invoke(click_entrypoint, args=["env_test"])
+    assert result.exit_code == 0, result.output + " " + str(result.exception)
+    assert (
+        MockMyCli.connect_args["user"] == "env_dsn_user"
+        and MockMyCli.connect_args["passwd"] == "env_dsn_passwd"
+        and MockMyCli.connect_args["host"] == "env_dsn_host"
+        and MockMyCli.connect_args["port"] == 9
+        and MockMyCli.connect_args["database"] == "env_dsn_database"
+    )
+
     MockMyCli.config = {
         "main": {},
         "alias_dsn": {"test": "mysql://alias_dsn_user:alias_dsn_passwd@alias_dsn_host:4/alias_dsn_database"},