fixing configmanager test warnings (#1962)

* fixing configmanager test warnings

* more warning fixes

Author: sfc-gh-mkeller

test/integ/test_connection.py

@@ -10,6 +10,7 @@
 import os
 import pathlib
 import queue
+import stat
 import threading
 import warnings
 import weakref
@@ -1264,6 +1265,7 @@ def test_connection_name_loading(monkeypatch, db_parameters, tmp_path, mode):
             else:
                 tmp_connections_file = tmp_path / "connections.toml"
                 tmp_connections_file.write_text(tomlkit.dumps(doc))
+                tmp_connections_file.chmod(stat.S_IRUSR | stat.S_IWUSR)
             with snowflake.connector.connect(
                 connection_name="default",
                 connections_file_path=tmp_connections_file,

test/integ/test_easy_logging.py

@@ -2,6 +2,7 @@
 # Copyright (c) 2012-2023 Snowflake Computing Inc. All rights reserved.
 #
 
+import stat
 from test.integ.conftest import create_connection
 
 import pytest
@@ -28,7 +29,11 @@ def log_directory(tmp_path_factory):
 
 @pytest.fixture(scope="function")
 def temp_config_file(tmp_path_factory):
-    return tmp_path_factory.mktemp("config_file_path") / "config.toml"
+    config_file = tmp_path_factory.mktemp("config_file_path") / "config.toml"
+    # Pre-create config file and setup correct permissions on it
+    config_file.touch()
+    config_file.chmod(stat.S_IRUSR | stat.S_IWUSR)
+    return config_file
 
 
 @pytest.fixture(scope="function")

test/unit/test_configmanager.py

@@ -58,6 +58,11 @@ def tmp_files_helper(cwd: Path, to_create: files) -> None:
 def tmp_files(tmp_path: Path) -> Callable[[files], Path]:
     def create_tmp_files(to_create: files) -> Path:
         tmp_files_helper(tmp_path, to_create)
+        # Automatically fix file permissions
+        if "config.toml" in to_create:
+            (tmp_path / "config.toml").chmod(stat.S_IRUSR | stat.S_IWUSR)
+        if "connections.toml" in to_create:
+            (tmp_path / "connections.toml").chmod(stat.S_IRUSR | stat.S_IWUSR)
         return tmp_path
 
     return create_tmp_files
@@ -117,7 +122,7 @@ def test_simple_config_read(tmp_files):
         name="output_format",
         choices=("json", "yaml", "toml"),
     )
-    TEST_PARSER.add_subparser(settings_parser)
+    TEST_PARSER.add_submanager(settings_parser)
     assert TEST_PARSER["connections"] == {
         "snowflake": {
             "account": "snowflake",
@@ -170,7 +175,7 @@ def test_simple_config_read_sliced(tmp_files):
         name="output_format",
         choices=("json", "yaml", "toml"),
     )
-    TEST_PARSER.add_subparser(settings_parser)
+    TEST_PARSER.add_submanager(settings_parser)
     assert TEST_PARSER["connections"] == {
         "snowflake": {
             "account": "snowflake",
@@ -209,7 +214,7 @@ def test_missing_value(tmp_files):
         name="output_format",
         choices=("json", "yaml", "toml"),
     )
-    TEST_PARSER.add_subparser(settings_parser)
+    TEST_PARSER.add_submanager(settings_parser)
     assert TEST_PARSER["connections"] == {
         "snowflake": {
             "account": "snowflake",
@@ -266,7 +271,7 @@ def test_missing_value_sliced(tmp_files):
         name="output_format",
         choices=("json", "yaml", "toml"),
     )
-    TEST_PARSER.add_subparser(settings_parser)
+    TEST_PARSER.add_submanager(settings_parser)
     assert TEST_PARSER["connections"] == {
         "snowflake": {
             "account": "snowflake",
@@ -322,7 +327,7 @@ def test_only_in_slice(tmp_files):
         name="output_format",
         choices=("json", "yaml", "toml"),
     )
-    TEST_PARSER.add_subparser(settings_parser)
+    TEST_PARSER.add_submanager(settings_parser)
     with pytest.raises(
         ConfigSourceError,
         match="Configuration option 'connections' is not defined.*",
@@ -335,8 +340,8 @@ def test_simple_nesting(monkeypatch, tmp_path):
     c2 = ConfigManager(name="sb")
     c3 = ConfigManager(name="sb")
     c3.add_option(name="b", parse_str=lambda e: e.lower() == "true")
-    c2.add_subparser(c3)
-    c1.add_subparser(c2)
+    c2.add_submanager(c3)
+    c1.add_submanager(c2)
     with monkeypatch.context() as m:
         m.setenv("SNOWFLAKE_SB_SB_B", "TrUe")
         assert c1["sb"]["sb"]["b"] is True
@@ -347,7 +352,7 @@ def test_complicated_nesting(monkeypatch, tmp_path):
     c1 = ConfigManager(file_path=c_file, name="root_parser")
     c2 = ConfigManager(file_path=tmp_path / "config2.toml", name="sp")
     c2.add_option(name="b", parse_str=lambda e: e.lower() == "true")
-    c1.add_subparser(c2)
+    c1.add_submanager(c2)
     c_file.write_text(
         dedent(
             """\
@@ -361,6 +366,7 @@ def test_complicated_nesting(monkeypatch, tmp_path):
             """
         )
     )
+    c_file.chmod(stat.S_IRUSR | stat.S_IWUSR)
     assert c1["sp"]["b"] is True
 
 
@@ -381,6 +387,7 @@ def test_error_invalid_toml(tmp_path):
             """
         )
     )
+    c_file.chmod(stat.S_IRUSR | stat.S_IWUSR)
     with pytest.raises(
         ConfigSourceError,
         match=re.escape(f"An unknown error happened while loading '{str(c_file)}'"),
@@ -393,7 +400,7 @@ def test_error_invalid_toml(tmp_path):
 
 def test_error_child_conflict():
     cp = ConfigManager(name="test_parser")
-    cp.add_subparser(ConfigManager(name="b"))
+    cp.add_submanager(ConfigManager(name="b"))
     with pytest.raises(
         ConfigManagerError,
         match="'b' sub-manager, or option conflicts with a child element of 'test_parser'",
@@ -654,7 +661,8 @@ def test_deprecationwarning_config_parser():
         str(w[-1].message)
         == "CONFIG_PARSER has been deprecated, use CONFIG_MANAGER instead"
     )
-    assert config_manager.CONFIG_MANAGER is config_manager.CONFIG_PARSER
+    with warnings.catch_warnings(record=True) as w:
+        assert config_manager.CONFIG_MANAGER is config_manager.CONFIG_PARSER
 
 
 def test_configoption_default_value(tmp_path, monkeypatch):
@@ -702,6 +710,7 @@ def test_defaultconnectionname(tmp_path, monkeypatch):
                 """
             )
         )
+        c_file.chmod(stat.S_IRUSR | stat.S_IWUSR)
         # re-cache config file from disk
         CONFIG_MANAGER.file_path = c_file
         CONFIG_MANAGER.conf_file_cache = None

test/unit/test_connection.py

@@ -7,6 +7,7 @@
 
 import json
 import os
+import stat
 import sys
 from pathlib import Path
 from secrets import token_urlsafe
@@ -256,6 +257,7 @@ def test_missing_default_connection_conf_file(monkeypatch, tmp_path):
             """
         )
     )
+    config_file.chmod(stat.S_IRUSR | stat.S_IWUSR)
     with monkeypatch.context() as m:
         m.delenv("SNOWFLAKE_DEFAULT_CONNECTION_NAME", raising=False)
         m.delenv("SNOWFLAKE_CONNECTIONS", raising=False)
@@ -282,6 +284,7 @@ def test_missing_default_connection_conn_file(monkeypatch, tmp_path):
             """
         )
     )
+    connections_file.chmod(stat.S_IRUSR | stat.S_IWUSR)
     with monkeypatch.context() as m:
         m.delenv("SNOWFLAKE_DEFAULT_CONNECTION_NAME", raising=False)
         m.delenv("SNOWFLAKE_CONNECTIONS", raising=False)
@@ -306,6 +309,7 @@ def test_missing_default_connection_conf_conn_file(monkeypatch, tmp_path):
             """
         )
     )
+    config_file.chmod(stat.S_IRUSR | stat.S_IWUSR)
     connections_file.write_text(
         dedent(
             """\
@@ -316,6 +320,7 @@ def test_missing_default_connection_conf_conn_file(monkeypatch, tmp_path):
             """
         )
     )
+    connections_file.chmod(stat.S_IRUSR | stat.S_IWUSR)
     with monkeypatch.context() as m:
         m.delenv("SNOWFLAKE_DEFAULT_CONNECTION_NAME", raising=False)
         m.delenv("SNOWFLAKE_CONNECTIONS", raising=False)

test/unit/test_easy_logging.py

@@ -1,6 +1,8 @@
 #
 # Copyright (c) 2012-2023 Snowflake Computing Inc. All rights reserved.
 #
+import stat
+
 import pytest
 
 pytestmark = pytest.mark.skipolddriver
@@ -26,7 +28,11 @@
 
 @pytest.fixture(scope="function")
 def temp_config_file(tmp_path_factory):
-    return tmp_path_factory.mktemp("config_file_path") / "config.toml"
+    config_file = tmp_path_factory.mktemp("config_file_path") / "config.toml"
+    # Pre-create config file and setup correct permissions on it
+    config_file.touch()
+    config_file.chmod(stat.S_IRUSR | stat.S_IWUSR)
+    return config_file
 
 
 @pytest.fixture(scope="function")