chore(telemetry): report tested integration versions

.circleci/config.templ.yml

@@ -16,7 +16,7 @@ mongo_image: &mongo_image mongo:3.6@sha256:19c11a8f1064fd2bb713ef1270f79a742a184
 httpbin_image: &httpbin_image kennethreitz/httpbin@sha256:2c7abc4803080c22928265744410173b6fea3b898872c01c5fd0f0f9df4a59fb
 vertica_image: &vertica_image sumitchawla/vertica:latest
 rabbitmq_image: &rabbitmq_image rabbitmq:3.7-alpine
-testagent_image: &testagent_image ghcr.io/datadog/dd-apm-test-agent/ddapm-test-agent:v1.11.0
+testagent_image: &testagent_image ghcr.io/datadog/dd-apm-test-agent/ddapm-test-agent:v1.13.1
 
 parameters:
   coverage:
@@ -180,6 +180,28 @@ commands:
           path: test-results
       - store_artifacts:
           path: test-results
+      - run:
+          name: "Store Test Agent Supported Integrations Data"
+          command: |
+            if [[ -z "$(curl -s << parameters.trace_agent_url >>/test/integrations/tested_versions)" ]]; then
+              # No integrations were tested. Not saving any artifacts
+              echo "Response body is empty. Skipping saving integration artifacts."
+            else
+              # make temporary files to save response data to
+              response=$(mktemp) && headers=$(mktemp)
+              # create artifacts directory if it doesn't exist
+              [ -d "./artifacts" ] || mkdir -p "./artifacts"
+              # get tested integrations
+              curl -o "$response" -D "$headers" << parameters.trace_agent_url >>/test/integrations/tested_versions
+              # get filename representing the name of the tested integration from headers
+              filename=$(awk -F': ' '/file-name/{print $2}' "$headers" | tr -d '\r\n')
+              # copy data to final file and remove temp files
+              mv "$response" "artifacts/${filename}_supported_versions.csv"
+              rm "$headers"
+            fi
+      - store_artifacts:
+          path: artifacts
+          destination: supported-integrations
       - save_cache:
           key: lastsuccess-{{ .Environment.CIRCLE_BRANCH }}-<<parameters.pattern>>-{{ .Environment.CIRCLE_NODE_INDEX }}-{{ epoch }}
           paths:
@@ -472,6 +494,9 @@ jobs:
 
   test_logging:
     <<: *contrib_job
+    docker:
+      - image: *ddtrace_dev_image
+      - *testagent
     steps:
       - run_test:
           pattern: 'test_logging'
@@ -584,6 +609,9 @@ jobs:
 
   dogpile_cache:
     <<: *contrib_job
+    docker:
+      - image: *ddtrace_dev_image
+      - *testagent
     steps:
       - run_test:
           pattern: 'dogpile_cache'
@@ -770,6 +798,9 @@ jobs:
 
   pytest:
     <<: *contrib_job
+    docker:
+      - image: *ddtrace_dev_image
+      - *testagent
     steps:
       - run_test:
           pattern: 'pytest'

ddtrace/contrib/elasticsearch/patch.py

@@ -50,7 +50,9 @@ def _es_modules():
     )
     for module_name in module_names:
         try:
-            yield import_module(module_name)
+            module = import_module(module_name)
+            versions[module_name] = getattr(module, "__versionstr__", "")
+            yield module
         except ImportError:
             pass
 
@@ -59,8 +61,6 @@ def _es_modules():
 
 
 def get_version_tuple(elasticsearch):
-    if getattr(elasticsearch, "__name__", None):
-        versions[elasticsearch.__name__] = getattr(elasticsearch, "__versionstr__", "")
     return getattr(elasticsearch, "__version__", "")
 
 

ddtrace/contrib/flask_login/patch.py

@@ -20,7 +20,7 @@
 
 def get_version():
     # type: () -> str
-    return ""
+    return flask_login.__version__
 
 
 class _FlaskLoginUserInfoRetriever(_UserInfoRetriever):

ddtrace/contrib/psycopg/patch.py

@@ -96,7 +96,9 @@ def _psycopg_modules():
     )
     for module_name in module_names:
         try:
-            yield import_module(module_name)
+            module = import_module(module_name)
+            PATCHED_VERSIONS[module_name] = getattr(module, "__version__", "")
+            yield module
         except ImportError:
             pass
 
@@ -114,8 +116,6 @@ def _patch(psycopg_module):
         return
     psycopg_module._datadog_patch = True
 
-    PATCHED_VERSIONS[psycopg_module.__name__] = getattr(psycopg_module, "__version__", "")
-
     Pin(_config=config.psycopg).onto(psycopg_module)
 
     if psycopg_module.__name__ == "psycopg2":

ddtrace/contrib/sqlite3/__init__.py

@@ -53,8 +53,14 @@
     cursor = db.cursor()
     cursor.execute("select * from users where id = 1")
 """
-from .patch import get_version
-from .patch import patch
+from ...internal.utils.importlib import require_modules
 
 
-__all__ = ["patch", "get_version"]
+required_modules = ["sqlite3"]
+
+with require_modules(required_modules) as missing_modules:
+    if not missing_modules:
+        from .patch import get_version
+        from .patch import patch
+
+        __all__ = ["patch", "get_version"]

ddtrace/contrib/unittest/__init__.py

@@ -34,9 +34,15 @@
 
    Default: ``True``
 """
+from ...internal.utils.importlib import require_modules
 from .patch import get_version
 from .patch import patch
 from .patch import unpatch
 
 
-__all__ = ["patch", "unpatch", "get_version"]
+required_modules = ["unittest"]
+
+with require_modules(required_modules) as missing_modules:
+    if not missing_modules:
+
+        __all__ = ["patch", "unpatch", "get_version"]

docker-compose.yml

@@ -131,7 +131,7 @@ services:
         volumes:
           - ddagent:/tmp/ddagent:rw
     testagent:
-        image: ghcr.io/datadog/dd-apm-test-agent/ddapm-test-agent:v1.11.0
+        image: ghcr.io/datadog/dd-apm-test-agent/ddapm-test-agent:v1.13.1
         ports:
             - "127.0.0.1:9126:8126"
         volumes:

riotfile.py

@@ -1205,7 +1205,7 @@ def select_pys(min_version=MIN_PYTHON_VERSION, max_version=MAX_PYTHON_VERSION):
         ),
         Venv(
             name="pyramid",
-            command="pytest {cmdargs} tests/contrib/pyramid/test_pyramid.py",
+            command="pytest {cmdargs} tests/contrib/pyramid",
             pkgs={
                 "requests": [latest],
                 "webtest": [latest],

scripts/contrib-patch-tests.py

@@ -36,7 +36,7 @@ def generate_patch_test_source(contrib):
     if not required_modules_node:
         print(
             f"WARNING: failed to generate patch test for {contrib},"
-            " required_modules not found in ddtrace.contrib.{contrib}.__init__"
+            f" required_modules not found in ddtrace.contrib.{contrib}.__init__"
         )
         return
 
@@ -45,7 +45,7 @@ def generate_patch_test_source(contrib):
     if not required_modules:
         print(
             f"WARNING: failed to generate patch test for {contrib},"
-            " ddtrace.contrib.{contrib}.required_modules could not be parsed"
+            f" ddtrace.contrib.{contrib}.required_modules could not be parsed"
         )
         return
 
@@ -76,6 +76,7 @@ class Test{contrib.title()}Patch(PatchTestCase.Base):
                 __module_name__ = "{module}"
                 __patch_func__ = patch
                 __unpatch_func__ = unpatch
+                __get_version__ = get_version
 
                 def assert_module_patched(self, {module.replace(".", "_")}):
                     pass
@@ -85,11 +86,6 @@ def assert_not_module_patched(self, {module.replace(".", "_")}):
 
                 def assert_not_module_double_patched(self, {module.replace(".", "_")}):
                     pass
-
-                def assert_module_implements_get_version(self):
-                    version = get_version()
-                    assert type(version) == str
-                    assert version != ''
             """
         ).lstrip()
     )

tests/contrib/aiobotocore/test_aiobotocore_patch_generated.py → tests/contrib/aiobotocore/test_aiobotocore_patch.py

@@ -19,6 +19,7 @@ class TestAiobotocorePatch(PatchTestCase.Base):
     __module_name__ = "aiobotocore.client"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, aiobotocore_client):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, aiobotocore_client):
 
     def assert_not_module_double_patched(self, aiobotocore_client):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""

tests/contrib/aiohttp/test_aiohttp_patch_generated.py → tests/contrib/aiohttp/test_aiohttp_patch.py

@@ -19,6 +19,7 @@ class TestAiohttpPatch(PatchTestCase.Base):
     __module_name__ = "aiohttp"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, aiohttp):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, aiohttp):
 
     def assert_not_module_double_patched(self, aiohttp):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""

tests/contrib/aiohttp_jinja2/test_aiohttp_jinja2_patch_generated.py → tests/contrib/aiohttp_jinja2/test_aiohttp_jinja2_patch.py

@@ -19,6 +19,7 @@ class TestAiohttp_Jinja2Patch(PatchTestCase.Base):
     __module_name__ = "aiohttp_jinja2"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, aiohttp_jinja2):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, aiohttp_jinja2):
 
     def assert_not_module_double_patched(self, aiohttp_jinja2):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""

tests/contrib/aiomysql/test_aiomysql_patch_generated.py → tests/contrib/aiomysql/test_aiomysql_patch.py

@@ -19,6 +19,7 @@ class TestAiomysqlPatch(PatchTestCase.Base):
     __module_name__ = "aiomysql"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, aiomysql):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, aiomysql):
 
     def assert_not_module_double_patched(self, aiomysql):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""

tests/contrib/aiopg/test_aiopg_patch_generated.py → tests/contrib/aiopg/test_aiopg_patch.py

@@ -19,6 +19,7 @@ class TestAiopgPatch(PatchTestCase.Base):
     __module_name__ = "aiopg"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, aiopg):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, aiopg):
 
     def assert_not_module_double_patched(self, aiopg):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""

tests/contrib/aioredis/test_aioredis_patch_generated.py → tests/contrib/aioredis/test_aioredis_patch.py

@@ -19,6 +19,7 @@ class TestAioredisPatch(PatchTestCase.Base):
     __module_name__ = "aioredis"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, aioredis):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, aioredis):
 
     def assert_not_module_double_patched(self, aioredis):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""

tests/contrib/algoliasearch/test_algoliasearch_patch_generated.py → tests/contrib/algoliasearch/test_algoliasearch_patch.py

@@ -19,6 +19,7 @@ class TestAlgoliasearchPatch(PatchTestCase.Base):
     __module_name__ = "algoliasearch"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, algoliasearch):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, algoliasearch):
 
     def assert_not_module_double_patched(self, algoliasearch):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""

tests/contrib/aredis/test_aredis_patch_generated.py → tests/contrib/aredis/test_aredis_patch.py

@@ -19,6 +19,7 @@ class TestAredisPatch(PatchTestCase.Base):
     __module_name__ = "aredis"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, aredis):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, aredis):
 
     def assert_not_module_double_patched(self, aredis):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""

tests/contrib/asyncpg/test_asyncpg_patch_generated.py → tests/contrib/asyncpg/test_asyncpg_patch.py

@@ -19,6 +19,7 @@ class TestAsyncpgPatch(PatchTestCase.Base):
     __module_name__ = "asyncpg"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, asyncpg):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, asyncpg):
 
     def assert_not_module_double_patched(self, asyncpg):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""

tests/contrib/boto/test_boto_patch_generated.py → tests/contrib/boto/test_boto_patch.py

@@ -19,6 +19,7 @@ class TestBotoPatch(PatchTestCase.Base):
     __module_name__ = "boto.connection"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, boto_connection):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, boto_connection):
 
     def assert_not_module_double_patched(self, boto_connection):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""

tests/contrib/botocore/test_botocore_patch_generated.py → tests/contrib/botocore/test_botocore_patch.py

@@ -19,6 +19,7 @@ class TestBotocorePatch(PatchTestCase.Base):
     __module_name__ = "botocore.client"
     __patch_func__ = patch
     __unpatch_func__ = unpatch
+    __get_version__ = get_version
 
     def assert_module_patched(self, botocore_client):
         pass
@@ -28,8 +29,3 @@ def assert_not_module_patched(self, botocore_client):
 
     def assert_not_module_double_patched(self, botocore_client):
         pass
-
-    def assert_module_implements_get_version(self):
-        version = get_version()
-        assert type(version) == str
-        assert version != ""