SNOW-1013595: Add support token_file_path in connection parameters (#1938)

Author: sfc-gh-jdu

DESCRIPTION.md

@@ -8,6 +8,10 @@ Source code is also available at: https://github.com/snowflakedb/snowflake-conne
 
 # Release Notes
 
+- v3.11.0(TBD)
+
+  - Added support for `token_file_path` connection parameter to read an OAuth token from a file when connecting to Snowflake.
+
 - v3.10.0(April 29,2024)
 
   - Added support for structured types to fetch_pandas_all.

src/snowflake/connector/connection.py

@@ -359,6 +359,7 @@ class SnowflakeConnection:
           This parameter is only effective when the result format is JSON.
         server_session_keep_alive: When true, the connector does not destroy the session on the Snowflake server side
           before the connector shuts down. Default value is false.
+        token_file_path: The file path of the token file. If both token and token_file_path are provided, the token in token_file_path will be used.
     """
 
     OCSP_ENV_LOCK = Lock()
@@ -1182,6 +1183,12 @@ def __config(self, **kwargs):
             ]:
                 self._authenticator = auth_tmp
 
+        # read OAuth token from
+        token_file_path = kwargs.get("token_file_path")
+        if token_file_path:
+            with open(token_file_path) as f:
+                self._token = f.read()
+
         if not (self._master_token and self._session_token):
             if not self.user and self._authenticator != OAUTH_AUTHENTICATOR:
                 # OAuth Authentication does not require a username

test/integ/test_connection.py

@@ -1350,3 +1350,16 @@ def test_connection_atexit_close(conn_cnx):
     with conn_cnx() as conn:
         conn._close_at_exit()
         assert conn.is_closed()
+
+
+@pytest.mark.skipolddriver
+def test_token_file_path(tmp_path, db_parameters):
+    fake_token = "some token"
+    token_file_path = tmp_path / "token"
+    with open(token_file_path, "w") as f:
+        f.write(fake_token)
+
+    conn = snowflake.connector.connect(**db_parameters, token=fake_token)
+    assert conn._token == fake_token
+    conn = snowflake.connector.connect(**db_parameters, token_file_path=token_file_path)
+    assert conn._token == fake_token