Merge pull request #114 Use common determine auth method algorithm

Author: rekby

CHANGELOG.md

@@ -1,3 +1,4 @@
+* Use anonymous credentials by default instead of iam metadata (use ydb.driver.credentials_from_env_variables for creds by env var)
 * Close grpc streams while closing readers/writers
 * Add control plane operations for topic api: create, drop
 

examples/reservations-bot-demo/cloud_function/utils.py

@@ -7,7 +7,7 @@ def make_driver_config(endpoint, database, path):
     return ydb.DriverConfig(
         endpoint,
         database,
-        credentials=ydb.construct_credentials_from_environ(),
+        credentials=ydb.credentials_from_env_variables(),
         root_certificates=ydb.load_ydb_root_certificate(),
     )
 

examples/secondary_indexes_builtin/secondary_indexes_builtin.py

@@ -245,7 +245,7 @@ def callee(session):
 
 def run(endpoint, database, path):
     driver_config = ydb.DriverConfig(
-        endpoint, database, credentials=ydb.construct_credentials_from_environ()
+        endpoint, database, credentials=ydb.credentials_from_env_variables()
     )
     with ydb.Driver(driver_config) as driver:
         try:

examples/time-series-serverless/database.py

@@ -14,7 +14,7 @@ def create_driver(self) -> ydb.Driver:
         driver_config = ydb.DriverConfig(
             self.config.endpoint,
             self.config.database,
-            credentials=ydb.construct_credentials_from_environ(),
+            credentials=ydb.credentials_from_env_variables(),
             root_certificates=ydb.load_ydb_root_certificate(),
         )
 

examples/ttl/ttl.py

@@ -307,7 +307,7 @@ def _run(driver, database, path):
 
 def run(endpoint, database, path):
     driver_config = ydb.DriverConfig(
-        endpoint, database, credentials=ydb.construct_credentials_from_environ()
+        endpoint, database, credentials=ydb.credentials_from_env_variables()
     )
     with ydb.Driver(driver_config) as driver:
         try:

examples/ttl_readtable/ttl.py

@@ -288,7 +288,7 @@ def _run(driver, session_pool, database, path):
 
 def run(endpoint, database, path):
     driver_config = ydb.DriverConfig(
-        endpoint, database, credentials=ydb.construct_credentials_from_environ()
+        endpoint, database, credentials=ydb.credentials_from_env_variables()
     )
     with ydb.Driver(driver_config) as driver:
         try:

tests/aio/test_connection_pool.py

@@ -11,8 +11,6 @@ async def test_async_call(endpoint, database):
     driver_config = ydb.DriverConfig(
         endpoint,
         database,
-        credentials=ydb.construct_credentials_from_environ(),
-        root_certificates=ydb.load_ydb_root_certificate(),
     )
 
     driver = Driver(driver_config=driver_config)
@@ -26,8 +24,6 @@ async def test_gzip_compression(endpoint, database):
     driver_config = ydb.DriverConfig(
         endpoint,
         database,
-        credentials=ydb.construct_credentials_from_environ(),
-        root_certificates=ydb.load_ydb_root_certificate(),
         compression=ydb.RPCCompression.Gzip,
     )
 
@@ -53,8 +49,6 @@ async def test_session(endpoint, database):
     driver_config = ydb.DriverConfig(
         endpoint,
         database,
-        credentials=ydb.construct_credentials_from_environ(),
-        root_certificates=ydb.load_ydb_root_certificate(),
     )
 
     driver = Driver(driver_config=driver_config)
@@ -98,8 +92,6 @@ async def test_raises_when_disconnect(endpoint, database, docker_project):
     driver_config = ydb.DriverConfig(
         endpoint,
         database,
-        credentials=ydb.construct_credentials_from_environ(),
-        root_certificates=ydb.load_ydb_root_certificate(),
     )
 
     driver = Driver(driver_config=driver_config)
@@ -124,8 +116,6 @@ async def test_disconnect_by_call(endpoint, database, docker_project):
     driver_config = ydb.DriverConfig(
         endpoint,
         database,
-        credentials=ydb.construct_credentials_from_environ(),
-        root_certificates=ydb.load_ydb_root_certificate(),
     )
 
     driver = Driver(driver_config=driver_config)

tests/conftest.py

@@ -1,18 +1,11 @@
 import os
-from unittest import mock
 
 import pytest
 import ydb
 import time
 from ydb import issues
 
 
-@pytest.fixture(autouse=True, scope="session")
-def mock_settings_env_vars():
-    with mock.patch.dict(os.environ, {"YDB_ANONYMOUS_CREDENTIALS": "1"}):
-        yield
-
-
 @pytest.fixture(scope="module")
 def docker_compose_file(pytestconfig):
     return os.path.join(str(pytestconfig.rootdir), "docker-compose.yml")
@@ -87,8 +80,6 @@ async def driver(endpoint, database, event_loop):
     driver_config = ydb.DriverConfig(
         endpoint,
         database,
-        credentials=ydb.construct_credentials_from_environ(),
-        root_certificates=ydb.load_ydb_root_certificate(),
     )
 
     driver = ydb.aio.Driver(driver_config=driver_config)
@@ -104,8 +95,6 @@ async def driver_sync(endpoint, database, event_loop):
     driver_config = ydb.DriverConfig(
         endpoint,
         database,
-        credentials=ydb.construct_credentials_from_environ(),
-        root_certificates=ydb.load_ydb_root_certificate(),
     )
 
     driver = ydb.Driver(driver_config=driver_config)

ydb/aio/driver.py

@@ -1,43 +1,7 @@
-import os
-
 from . import pool, scheme, table
 import ydb
 from .. import _utilities
-from ydb.driver import get_config
-
-
-def default_credentials(credentials=None):
-    if credentials is not None:
-        return credentials
-
-    service_account_key_file = os.getenv("YDB_SERVICE_ACCOUNT_KEY_FILE_CREDENTIALS")
-    if service_account_key_file is not None:
-        from .iam import ServiceAccountCredentials
-
-        return ServiceAccountCredentials.from_file(service_account_key_file)
-
-    anonymous_credetials = os.getenv("YDB_ANONYMOUS_CREDENTIALS", "0") == "1"
-    if anonymous_credetials:
-        return ydb.credentials.AnonymousCredentials()
-
-    metadata_credentials = os.getenv("YDB_METADATA_CREDENTIALS", "0") == "1"
-    if metadata_credentials:
-        from .iam import MetadataUrlCredentials
-
-        return MetadataUrlCredentials()
-
-    access_token = os.getenv("YDB_ACCESS_TOKEN_CREDENTIALS")
-    if access_token is not None:
-        return ydb.credentials.AccessTokenCredentials(access_token)
-
-    # (legacy instantiation)
-    creds = ydb.auth_helpers.construct_credentials_from_environ()
-    if creds is not None:
-        return creds
-
-    from .iam import MetadataUrlCredentials
-
-    return MetadataUrlCredentials()
+from ydb.driver import get_config, default_credentials
 
 
 class DriverConfig(ydb.DriverConfig):

ydb/auth_helpers.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 import os
 
-from . import credentials, tracing
-import warnings
-
 
 def read_bytes(f):
     with open(f, "rb") as fr:
@@ -15,43 +12,3 @@ def load_ydb_root_certificate():
     if path is not None and os.path.exists(path):
         return read_bytes(path)
     return None
-
-
-def construct_credentials_from_environ(tracer=None):
-    tracer = tracer if tracer is not None else tracing.Tracer(None)
-    warnings.warn(
-        "using construct_credentials_from_environ method for credentials instantiation is deprecated and will be "
-        "removed in the future major releases. Please instantialize credentials by default or provide correct credentials "
-        "instance to the Driver."
-    )
-
-    # dynamically import required authentication libraries
-    if (
-        os.getenv("USE_METADATA_CREDENTIALS") is not None
-        and int(os.getenv("USE_METADATA_CREDENTIALS")) == 1
-    ):
-        import ydb.iam
-
-        tracing.trace(tracer, {"credentials.metadata": True})
-        return ydb.iam.MetadataUrlCredentials()
-
-    if os.getenv("YDB_TOKEN") is not None:
-        tracing.trace(tracer, {"credentials.access_token": True})
-        return credentials.AuthTokenCredentials(os.getenv("YDB_TOKEN"))
-
-    if os.getenv("SA_KEY_FILE") is not None:
-
-        import ydb.iam
-
-        tracing.trace(tracer, {"credentials.sa_key_file": True})
-        root_certificates_file = os.getenv("SSL_ROOT_CERTIFICATES_FILE", None)
-        iam_channel_credentials = {}
-        if root_certificates_file is not None:
-            iam_channel_credentials = {
-                "root_certificates": read_bytes(root_certificates_file)
-            }
-        return ydb.iam.ServiceAccountCredentials.from_file(
-            os.getenv("SA_KEY_FILE"),
-            iam_channel_credentials=iam_channel_credentials,
-            iam_endpoint=os.getenv("IAM_ENDPOINT", "iam.api.cloud.yandex.net:443"),
-        )