Add default freetds driver for Docker Agent (#6636)

sqlserver/datadog_checks/sqlserver/data/driver_config/odbcinst.ini

@@ -0,0 +1,5 @@
+[ODBC Drivers]
+FreeTDS=Installed
+
+[FreeTDS]
+Driver=/opt/datadog-agent/embedded/lib/libtdsodbc.so

sqlserver/datadog_checks/sqlserver/sqlserver.py

@@ -16,6 +16,8 @@
 from datadog_checks.base import AgentCheck
 from datadog_checks.base.config import is_affirmative
 
+from .utils import set_default_driver_conf
+
 try:
     import adodbapi
 except ImportError:
@@ -30,6 +32,8 @@
 if adodbapi is None and pyodbc is None:
     raise ImportError('adodbapi or pyodbc must be installed to use this check.')
 
+set_default_driver_conf()
+
 EVENT_TYPE = SOURCE_TYPE_NAME = 'sql server'
 ALL_INSTANCES = 'ALL'
 VALID_METRIC_TYPES = ('gauge', 'rate', 'histogram')

sqlserver/datadog_checks/sqlserver/utils.py

@@ -0,0 +1,16 @@
+# (C) Datadog, Inc. 2018-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+import os
+
+from datadog_checks.base.utils.platform import Platform
+
+CURRENT_DIR = os.path.dirname(os.path.abspath(__file__))
+DRIVER_CONFIG_DIR = os.path.join(CURRENT_DIR, 'data', 'driver_config')
+
+
+def set_default_driver_conf():
+    if Platform.is_containerized():
+        # Use default `./driver_config/odbcinst.ini` when Agent is running in docker.
+        # `freetds` is shipped with the Docker Agent.
+        os.environ.setdefault('ODBCSYSINI', DRIVER_CONFIG_DIR)

sqlserver/tests/common.py

@@ -2,8 +2,6 @@
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
-import os
-
 from datadog_checks.dev import get_docker_hostname, get_here
 from datadog_checks.dev.utils import ON_MACOS, ON_WINDOWS
 from datadog_checks.sqlserver import SQLServer
@@ -92,10 +90,3 @@ def get_local_driver():
 }
 
 FULL_E2E_CONFIG = {"init_config": INIT_CONFIG, "instances": [INSTANCE_E2E]}
-
-E2E_METADATA = {
-    'start_commands': ['apt-get update', 'apt-get install -y tdsodbc unixodbc-dev'],
-    'docker_volumes': [
-        '{}:/opt/datadog-agent/embedded/etc/odbcinst.ini'.format(os.path.join(HERE, 'odbc', 'odbcinst.ini'))
-    ],
-}

sqlserver/tests/conftest.py

@@ -11,7 +11,6 @@
 
 from .common import (
     DOCKER_SERVER,
-    E2E_METADATA,
     FULL_E2E_CONFIG,
     HERE,
     INIT_CONFIG,
@@ -67,4 +66,4 @@ def sqlserver():
         conditions=[WaitFor(sqlserver, wait=3, attempts=10)],
         mount_logs=True,
     ):
-        yield FULL_E2E_CONFIG, E2E_METADATA
+        yield FULL_E2E_CONFIG

sqlserver/tests/test_unit.py

@@ -1,10 +1,14 @@
 # (C) Datadog, Inc. 2018-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
+import os
+
 import pytest
 
+from datadog_checks.dev import EnvVars
 from datadog_checks.sqlserver import SQLServer
 from datadog_checks.sqlserver.sqlserver import SQLConnectionError
+from datadog_checks.sqlserver.utils import set_default_driver_conf
 
 # mark the whole module
 pytestmark = pytest.mark.unit
@@ -20,3 +24,24 @@ def test_get_cursor(instance_sql2017):
     check = SQLServer(CHECK_NAME, {}, [])
     with pytest.raises(SQLConnectionError):
         check.get_cursor(instance_sql2017, 'foo')
+
+
+def test_set_default_driver_conf():
+    # Docker Agent with ODBCSYSINI env var
+    # The only case where we set ODBCSYSINI to the the default odbcinst.ini folder
+    with EnvVars({'DOCKER_DD_AGENT': 'true'}, ignore=['ODBCSYSINI']):
+        set_default_driver_conf()
+        assert os.environ['ODBCSYSINI'].endswith(os.path.join('data', 'driver_config'))
+
+    # `set_default_driver_conf` have no effect on the cases below
+    with EnvVars({'ODBCSYSINI': 'ABC', 'DOCKER_DD_AGENT': 'true'}):
+        set_default_driver_conf()
+        assert os.environ['ODBCSYSINI'] == 'ABC'
+
+    with EnvVars({}, ignore=['ODBCSYSINI']):
+        set_default_driver_conf()
+        assert 'ODBCSYSINI' not in os.environ
+
+    with EnvVars({'ODBCSYSINI': 'ABC'}):
+        set_default_driver_conf()
+        assert os.environ['ODBCSYSINI'] == 'ABC'