DDSaas: Sonatype Nexus v1.0.1: Added support of Sonatype Nexus version 3.79.0 (#20045)

avaid-crest · Wyrine · dkirov-dd · web-flow · commit bfe0e2258f41 · 2025-04-15T09:13:28.000Z
* Pinned sonatype nexus docker image version

* Resolved ci failure

* Added changelog entry

* Renamed the changelog.d file

* Modified Changelogs

* Modified md file related to changelog

* Added changes as per review comments

* Adding formatting changes

* Removed extra vertical spacing

* Rename 20045.added.md to 20045.added

* Update sonatype_nexus/CHANGELOG.md

The CHANGELOG.md gets updated automatically upon release

* Apply suggestions from code review

---------

Co-authored-by: Kirolos Shahat &lt;kashahat@gmail.com&gt;
Co-authored-by: dkirov-dd &lt;166512750+dkirov-dd@users.noreply.github.com&gt;
diff --git a/sonatype_nexus/changelog.d/20045.added b/sonatype_nexus/changelog.d/20045.added
@@ -0,0 +1 @@
+Added support for Sonatype Nexus version 3.79.0
diff --git a/sonatype_nexus/datadog_checks/sonatype_nexus/check.py b/sonatype_nexus/datadog_checks/sonatype_nexus/check.py
@@ -85,19 +85,21 @@ def create_metric_for_configs(self, metric_data: dict, metric_name: str):
                 tag_list = []
                 for tag_key in config["tag_key"]:
                     tag_list.append(f"{tag_key}:{item[tag_key]}")
-                self.gauge(metric_name, int(item[config["value_key"]]), base_tags + tag_list, hostname=None)
+                self.gauge(metric_name, int(item.get(config["value_key"], 0)), base_tags + tag_list, hostname=None)
         elif isinstance(value, int):
             self.gauge(metric_name, int(value), base_tags, hostname=None)
         elif isinstance(value, dict):
-            self.gauge(metric_name, int(value[config["value_key"]]), base_tags, hostname=None)
+            self.gauge(metric_name, int(value.get(config["value_key"], 0)), base_tags, hostname=None)
 
     def create_metric_for_configs_by_format_type(self, metric_data, metric_name, metric_info):
         base_tags = [f"sonatype_host:{self.extract_ip_from_url()}"] + (self.custom_tags if self.custom_tags else [])
 
         if isinstance(metric_data, list):
             for item in metric_data:
                 for format_type, data in item.items():
-                    self.ingest_metric(base_tags, format_type, metric_info, metric_name, data[metric_info["value_key"]])
+                    self.ingest_metric(
+                        base_tags, format_type, metric_info, metric_name, data.get(metric_info["value_key"], 0)
+                    )
         elif isinstance(metric_data, dict):
             for format_type, metric_value in metric_data.items():
                 self.ingest_metric(base_tags, format_type, metric_info, metric_name, metric_value)
diff --git a/sonatype_nexus/tests/compose/docker-compose.yaml b/sonatype_nexus/tests/compose/docker-compose.yaml
@@ -1,6 +1,6 @@
 services:
   nexus:
-    image: sonatype/nexus3:3.75.1
+    image: sonatype/nexus3:3.79.0
     container_name: nexus
     ports:
       - "8081:8081"
diff --git a/sonatype_nexus/tests/conftest.py b/sonatype_nexus/tests/conftest.py
@@ -2,14 +2,84 @@
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 import os
+import time
 from copy import deepcopy
 
 import pytest
 
-from datadog_checks.dev import docker_run
+from datadog_checks.dev import docker_run, run_command
 
 from .common import COMPOSE, INSTANCE
 
+instance = {
+    "username": "test_username",
+    "password": "test_password",
+    "min_collection_interval": 400,
+    "server_url": "https://example.com",
+}
+
+
+def get_nexus_password(max_retries=5, retry_interval=10, password_wait_retries=30, password_wait_interval=10):
+    try:
+        run_command("docker run -d -p 8081:8081 --name sonatype_nexus_38 sonatype/nexus3:3.79.0")
+    except Exception as e:
+        print(f"Note: {e}")
+
+    container_id = None
+    for attempt in range(max_retries):
+        try:
+            container_id = run_command(
+                "docker ps --filter 'ancestor=sonatype/nexus3:3.79.0' --format '{{.ID}}'", capture=True
+            ).stdout.strip()
+
+            if container_id:
+                print(f"Found Nexus container with ID: {container_id}")
+                break
+
+            print(f"Waiting for Nexus container to start... (attempt {attempt + 1}/{max_retries})")
+            time.sleep(retry_interval)
+
+        except Exception as e:
+            print(f"Error checking container status: {e}")
+            time.sleep(retry_interval)
+
+    if not container_id:
+        print("Error: No running Nexus container found after maximum retry attempts.")
+        exit(1)
+
+    password = None
+    for attempt in range(password_wait_retries):
+        try:
+            file_check = run_command(
+                f"docker exec {container_id} sh -c '"
+                "[ -f /opt/sonatype/sonatype-work/nexus3/admin.password ] "
+                "&& echo \"exists\" || echo \"not exists\"'",
+                capture=True,
+            ).stdout.strip()
+
+            if file_check == "exists":
+                password = run_command(
+                    f"docker exec {container_id} sh -c 'cat /opt/sonatype/sonatype-work/nexus3/admin.password'",
+                    capture=True,
+                ).stdout.strip()
+
+                if password:
+                    print(f"Successfully retrieved password after {attempt + 1} attempts")
+                    break
+
+            print(f"Password file not ready yet (attempt {attempt + 1}/{password_wait_retries})")
+            time.sleep(password_wait_interval)
+
+        except Exception as e:
+            print(f"Error checking password file (attempt {attempt + 1}/{password_wait_retries}): {e}")
+            time.sleep(password_wait_interval)
+
+    if not password:
+        print("Error: Could not retrieve Nexus password after maximum retry attempts.")
+        exit(1)
+
+    return password
+
 
 @pytest.fixture(scope='session')
 def dd_environment():
@@ -20,9 +90,7 @@ def dd_environment():
         build=True,
         sleep=30,
     ):
-        yield deepcopy(INSTANCE)
-
-
-@pytest.fixture
-def instance():
-    return deepcopy(INSTANCE)
+        password = get_nexus_password()
+        modified_instance = deepcopy(INSTANCE)
+        modified_instance["password"] = password
+        yield modified_instance
diff --git a/sonatype_nexus/tests/test_check.py b/sonatype_nexus/tests/test_check.py
@@ -9,6 +9,8 @@
 from datadog_checks.sonatype_nexus.check import SonatypeNexusCheck
 from datadog_checks.sonatype_nexus.errors import EmptyResponseError
 
+from .conftest import instance
+
 
 @pytest.fixture
 def mock_http_response(mocker):
@@ -26,19 +28,50 @@ def test_successful_metrics_collection(dd_run_check, mock_http_response, aggrega
         json_data=status_metrics_response_data.update({"gauges": {"jvm.memory.heap.used": {"value": 123456789}}}),
     )
 
-    instance = {
-        "username": "test_username",
-        "password": "test_password",
-        "min_collection_interval": 400,
-        "server_url": "https://example.com",
-    }
     check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
     dd_run_check(check)
 
     aggregator.assert_all_metrics_covered()
     aggregator.assert_metrics_using_metadata(get_metadata_metrics())
 
 
+def test_create_metric_for_configs_int(mocker, aggregator):
+    check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
+    metric_data = {"value": 100}
+    metric_name = "analytics.total_memory"
+
+    check.create_metric_for_configs(metric_data, metric_name)
+
+    aggregator.assert_metric(
+        "sonatype_nexus.analytics.total_memory",
+    )
+
+
+def test_create_metric_for_configs_dict(mocker, aggregator):
+    check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
+    metric_data = {"value": {"total_count": 200}}
+    metric_name = "analytics.malicious_risk_on_disk"
+
+    check.create_metric_for_configs(metric_data, metric_name)
+
+    aggregator.assert_metric(
+        "sonatype_nexus.analytics.malicious_risk_on_disk",
+    )
+
+
+def test_create_metric_for_configs_by_format_type_list(mocker, aggregator):
+    check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
+    metric_data = [{"maven": {"bytes_uploaded": 100}}]
+    metric_name = "analytics.uploaded_bytes_by_format"
+    metric_info = constants.METRIC_CONFIGS_BY_FORMAT_TYPE[metric_name]
+
+    check.create_metric_for_configs_by_format_type(metric_data, metric_name, metric_info)
+
+    aggregator.assert_metric(
+        f"sonatype_nexus.{metric_name}",
+    )
+
+
 def test_empty_instance(dd_run_check):
     with pytest.raises(
         Exception,
@@ -75,13 +108,6 @@ def test_bad_request_error(dd_run_check, mock_http_response):
         json_data={"error": "Bad request"},
     )
 
-    instance = {
-        "username": "test_user",
-        "password": "test_password",
-        "min_collection_interval": 400,
-        "server_url": "https://example.com",
-    }
-
     with pytest.raises(Exception) as excinfo:
         check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
         dd_run_check(check)
@@ -95,13 +121,6 @@ def test_license_expired_error(dd_run_check, mock_http_response):
         json_data={"error": "License expired"},
     )
 
-    instance = {
-        "username": "test_user",
-        "password": "test_password",
-        "min_collection_interval": 400,
-        "server_url": "https://example.com",
-    }
-
     with pytest.raises(Exception) as excinfo:
         check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
         dd_run_check(check)
@@ -115,13 +134,6 @@ def test_insufficient_permission_error(dd_run_check, mock_http_response):
         json_data={"error": "Insufficient permissions"},
     )
 
-    instance = {
-        "username": "test_user",
-        "password": "test_password",
-        "min_collection_interval": 400,
-        "server_url": "https://example.com",
-    }
-
     with pytest.raises(Exception) as excinfo:
         check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
         dd_run_check(check)
@@ -135,13 +147,6 @@ def test_not_found_error(dd_run_check, mock_http_response):
         json_data={"error": "Resource not found"},
     )
 
-    instance = {
-        "username": "test_user",
-        "password": "test_password",
-        "min_collection_interval": 400,
-        "server_url": "https://example.com",
-    }
-
     with pytest.raises(Exception) as excinfo:
         check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
         dd_run_check(check)
@@ -155,13 +160,6 @@ def test_server_error(dd_run_check, mock_http_response):
         json_data={"error": "Internal server error"},
     )
 
-    instance = {
-        "username": "test_user",
-        "password": "test_password",
-        "min_collection_interval": 400,
-        "server_url": "https://example.com",
-    }
-
     with pytest.raises(Exception) as excinfo:
         check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
         dd_run_check(check)
@@ -175,13 +173,6 @@ def test_timeout_error(dd_run_check, mock_http_response):
         json_data={"error": "TimeoutError"},
     )
 
-    instance = {
-        "username": "test_user",
-        "password": "test_password",
-        "min_collection_interval": 400,
-        "server_url": "https://example.com",
-    }
-
     with pytest.raises(Exception) as excinfo:
         check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
         dd_run_check(check)
@@ -196,13 +187,6 @@ def test_empty_response_error(dd_run_check, mocker):
         side_effect=EmptyResponseError(),
     )
 
-    instance = {
-        "username": "test_user",
-        "password": "test_password",
-        "min_collection_interval": 400,
-        "server_url": "https://example.com",
-    }
-
     with pytest.raises(Exception) as excinfo:
         check = SonatypeNexusCheck("sonatype_nexus", {}, [instance])
         dd_run_check(check)
diff --git a/sonatype_nexus/tests/test_e2e.py b/sonatype_nexus/tests/test_e2e.py
@@ -1,66 +1,10 @@
 # (C) Datadog, Inc. 2025-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
-import time
-
 import pytest
 
-from datadog_checks.dev import run_command
-
-
-def get_nexus_password(max_retries=5, retry_interval=10):
-    try:
-        run_command("docker run -d -p 8081:8081 --name sonatype_nexus_3 sonatype/nexus3")
-    except Exception as e:
-        print(f"Note: {e}")
-
-    container_id = None
-    for attempt in range(max_retries):
-        try:
-            container_id = run_command(
-                "docker ps --filter 'ancestor=sonatype/nexus3' --format '{{.ID}}'", capture=True
-            ).stdout.strip()
-
-            if container_id:
-                print(f"Found Nexus container with ID: {container_id}")
-                break
-
-            print(f"Waiting for Nexus container to start... (attempt {attempt+1}/{max_retries})")
-            time.sleep(retry_interval)
-
-        except Exception as e:
-            print(f"Error checking container status: {e}")
-            time.sleep(retry_interval)
-
-    if not container_id:
-        print("Error: No running Nexus container found after maximum retry attempts.")
-        exit(1)
-
-    password = None
-    time.sleep(45)
-    for attempt in range(max_retries):
-        try:
-            password_file = "/opt/sonatype/sonatype-work/nexus3/admin.password"
-            password = run_command(
-                f"docker exec {container_id} sh -c 'cat {password_file}'", capture=True
-            ).stdout.strip()
-
-            if password:
-                break
-
-        except Exception as e:
-            print(f"Password file not ready yet (attempt {attempt+1}/{max_retries}): {e}")
-            time.sleep(retry_interval)
-
-    if not password:
-        print("Error: Could not retrieve Nexus password after maximum retry attempts.")
-        exit(1)
-
-    return password
-
 
 @pytest.mark.e2e
-def test_e2e(dd_agent_check, instance, aggregator):
-    instance["password"] = get_nexus_password()
-    aggregator = dd_agent_check(instance)
+def test_e2e(dd_agent_check, aggregator):
+    aggregator = dd_agent_check()
     aggregator.assert_metric('sonatype_nexus.status.available_cpus_health', value=1)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Added support for Sonatype Nexus version 3.79.0`