Rename LibraryVersion to ComponentVersion, and ComponentVersion.library to ComponentVersion.name (#4378)

Author: cbeauchesne

conftest.py

@@ -20,7 +20,7 @@
 from utils._context._scenarios import scenarios, Scenario
 from utils._logger import logger
 from utils.scripts.junit_report import junit_modifyreport
-from utils._context.library_version import LibraryVersion
+from utils._context.component_version import ComponentVersion
 from utils._decorators import released, configure as configure_decorators
 from utils.properties_serialization import SetupProperties
 
@@ -237,7 +237,7 @@ def _get_skip_reason_from_marker(marker: pytest.Mark) -> str | None:
 def pytest_pycollect_makemodule(module_path: Path, parent: pytest.Session) -> None | pytest.Module:
     # As now, declaration only works for tracers at module level
 
-    library = context.library.library
+    library = context.library.name
 
     manifests = load_manifests()
 
@@ -487,7 +487,9 @@ def pytest_sessionfinish(session: pytest.Session, exitstatus: int) -> None:
     if context.scenario.is_main_worker:
         with open(f"{context.scenario.host_log_folder}/known_versions.json", "w", encoding="utf-8") as f:
             json.dump(
-                {library: sorted(versions) for library, versions in LibraryVersion.known_versions.items()}, f, indent=2
+                {library: sorted(versions) for library, versions in ComponentVersion.known_versions.items()},
+                f,
+                indent=2,
             )
 
         data = session.config._json_report.report  # noqa: SLF001
@@ -510,7 +512,7 @@ def export_feature_parity_dashboard(session: pytest.Session, data: dict) -> None
         "runDate": data["created"],
         "environment": session.config.option.report_environment or "local",
         "testSource": "systemtests",
-        "language": context.library.library,
+        "language": context.library.name,
         "variant": context.weblog_variant,
         "testedDependencies": [
             {"name": name, "version": str(version)} for name, version in context.scenario.components.items()

docs/scenarios/docker_ssi.md

@@ -376,7 +376,7 @@ class TestDockerSSIFeatures:
 
     @features.ssi_guardrails
     def test_install_supported_runtime(self):
-        logger.info(f"Testing Docker SSI installation on supported lang runtime: {context.scenario.library.library}")
+        logger.info(f"Testing Docker SSI installation on supported lang runtime: {context.scenario.library.name}")
         assert self.r.status_code == 200, f"Failed to get response from {context.scenario.weblog_url}"
 
         # If the language version is supported there are traces related with the request

docs/weblog/README.md

@@ -811,7 +811,7 @@ Returns a JSON dict, with those values :
 {
   "status": "ok",
   "library": {
-    "language": "<language>", // one of cpp, dotnet, golang, java, nodejs, php, python, ruby
+    "name": "<library's name>", // one of cpp, cpp_nginx, cpp_httpd, dotnet, golang, java, nodejs, php, python, ruby
     "version": "1.2.3" // version of the library
   }
 }

tests/appsec/iast/sink/test_hardcoded_passwords.py

@@ -39,7 +39,7 @@ def test_hardcoded_passwords_exec(self):
         assert vuln["location"]["path"] == self._get_expectation(self.location_map)
 
     def _get_expectation(self, d):
-        expected = d.get(context.library.library)
+        expected = d.get(context.library.name)
         if isinstance(expected, dict):
             expected = expected.get(context.weblog_variant)
         return expected
@@ -75,5 +75,5 @@ def test_extended_location_data(self):
 
         assert all(field in location for field in ["path", "line"])
 
-        if context.library.library not in ("python", "nodejs"):
+        if context.library.name not in ("python", "nodejs"):
             assert all(field in location for field in ["class", "method"])

tests/appsec/iast/sink/test_hardcoded_secrets.py

@@ -12,7 +12,7 @@
 
 
 def get_expectation(d):
-    expected = d.get(context.library.library)
+    expected = d.get(context.library.name)
     if isinstance(expected, dict):
         expected = expected.get(context.weblog_variant)
     return expected
@@ -102,5 +102,5 @@ def test_extended_location_data(self):
 
         assert all(field in location for field in ["path", "line"])
 
-        if context.library.library not in ("python", "nodejs"):
+        if context.library.name not in ("python", "nodejs"):
             assert all(field in location for field in ["class", "method"])

tests/appsec/iast/sink/test_unvalidated_redirect.py

@@ -7,7 +7,7 @@
 
 
 def _expected_location():
-    if context.library.library == "java":
+    if context.library.name == "java":
         if context.weblog_variant.startswith("spring-boot"):
             return "com.datadoghq.system_tests.springboot.AppSecIast"
         if context.weblog_variant == "resteasy-netty3":
@@ -18,7 +18,7 @@ def _expected_location():
             return "com.datadoghq.vertx3.iast.routes.IastSinkRouteProvider"
         if context.weblog_variant == "vertx4":
             return "com.datadoghq.vertx4.iast.routes.IastSinkRouteProvider"
-    if context.library.library == "nodejs":
+    if context.library.name == "nodejs":
         if context.weblog_variant in ("express4", "express5"):
             return "iast/index.js"
         if context.weblog_variant == "express4-typescript":

tests/appsec/iast/sink/test_unvalidated_redirect_forward.py

@@ -7,7 +7,7 @@
 
 
 def _expected_location():
-    if context.library.library == "java":
+    if context.library.name == "java":
         if context.weblog_variant.startswith("spring-boot"):
             return "com.datadoghq.system_tests.springboot.AppSecIast"
         if context.weblog_variant == "vertx3":

tests/appsec/iast/sink/test_weak_hash.py

@@ -12,16 +12,16 @@
 
 
 def _expected_location() -> str | None:
-    if context.library.library == "java":
+    if context.library.name == "java":
         return "com.datadoghq.system_tests.iast.utils.CryptoExamples"
 
-    if context.library.library == "nodejs":
+    if context.library.name == "nodejs":
         if context.weblog_variant in ("express4", "express5"):
             return "iast/index.js"
         if context.weblog_variant == "express4-typescript":
             return "iast.ts"
 
-    if context.library.library == "python":
+    if context.library.name == "python":
         if context.library.version >= "1.12.0":
             return "iast.py"
         # old value: absolute path
@@ -33,7 +33,7 @@ def _expected_location() -> str | None:
 
 
 def _expected_evidence() -> str:
-    if context.library.library == "dotnet":
+    if context.library.name == "dotnet":
         return "MD5"
     else:
         return "md5"

tests/appsec/iast/source/test_header_name.py

@@ -10,7 +10,7 @@
 class TestHeaderName(BaseSourceTest):
     """Verify that request headers name are tainted"""
 
-    source_name = "User" if context.library.library == "python" else "user"
+    source_name = "User" if context.library.name == "python" else "user"
 
     endpoint = "/iast/source/headername/test"
     requests_kwargs = [{"method": "GET", "headers": {"user": "unused"}}]

tests/appsec/iast/source/test_header_value.py

@@ -11,7 +11,7 @@ class TestHeaderValue(BaseSourceTest):
     """Verify that request headers are tainted"""
 
     source_name = (
-        "HTTP_TABLE" if context.library.library == "python" and context.weblog_variant == "django-poc" else "table"
+        "HTTP_TABLE" if context.library.name == "python" and context.weblog_variant == "django-poc" else "table"
     )
 
     endpoint = "/iast/source/header/test"