Collect framework endpoints

appsec/tests/integration/build.gradle

@@ -324,6 +324,7 @@ def buildTracerTask = { String version, String variant ->
 }
 
 def buildAppSecTask = { String version, String variant ->
+    def buildType = variant.contains('debug') ? 'Debug' : 'RelWithDebInfo'
     buildRunInDockerTask(
             baseName: 'buildAppsec',
             baseTag: 'php',
@@ -346,17 +347,17 @@ def buildAppSecTask = { String version, String variant ->
             ],
             command: [
                     '-e', '-c',
-                    '''
+                    """
                     git config --global --add safe.directory '*'
                     cd /appsec
                     test -f CMakeCache.txt || \\
-                        cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo \\
+                        cmake -DCMAKE_BUILD_TYPE=$buildType \\
                               -DCMAKE_INSTALL_PREFIX=/appsec \\
                               -DDD_APPSEC_ENABLE_PATCHELF_LIBC=ON \\
                               -DDD_APPSEC_TESTING=ON /project/appsec
                     make -j extension ddappsec-helper && \\
                         touch ddappsec.so libddappsec-helper.so
-                '''
+                """
             ]
     )
 }

appsec/tests/integration/src/main/groovy/com/datadog/appsec/php/TelemetryHelpers.groovy

@@ -1,6 +1,10 @@
 package com.datadog.appsec.php
 
 import groovy.transform.Canonical
+import java.net.http.HttpRequest
+import java.net.http.HttpResponse
+import com.datadog.appsec.php.docker.AppSecContainer
+import static java.net.http.HttpResponse.BodyHandlers.ofString
 
 /**
  * @link https://github.com/DataDog/instrumentation-telemetry-api-docs/blob/main/GeneratedDocumentation/ApiDocs/v2/producing-telemetry.md
@@ -22,6 +26,29 @@ class TelemetryHelpers {
         }
     }
 
+    static class AppEndpoints {
+        static names = ['app-endpoints']
+        List<Endpoint> endpoints
+
+        AppEndpoints(Map m) {
+            endpoints = m.endpoints.collect { new Endpoint(it as Map) }
+        }
+    }
+
+    static class Endpoint {
+        String method
+        String operationName
+        String path
+        String resourceName
+
+        Endpoint(Map m) {
+            method = m.method
+            operationName = m.operation_name
+            path = m.path
+            resourceName = m.resource_name
+        }
+    }
+
     static class Metric {
         String namespace
         String name
@@ -137,4 +164,43 @@ class TelemetryHelpers {
             autoEnabled = m.autoEnabled
         }
     }
+
+    public static <T> List<T> waitForTelemetryData(AppSecContainer container, int timeoutSec, Closure<Boolean> cl, Class<T> cls, String path = '/hello.php') {
+        List<T> messages = []
+        def deadline = System.currentTimeSeconds() + timeoutSec
+        def lastHttpReq = System.currentTimeSeconds() - 6
+        while (System.currentTimeSeconds() < deadline) {
+            if (System.currentTimeSeconds() - lastHttpReq > 5) {
+                lastHttpReq = System.currentTimeSeconds()
+                // used to flush global (not request-bound) telemetry metrics
+                def request = container.buildReq(path).GET().build()
+                def trace = container.traceFromRequest(request, ofString()) { HttpResponse<String> resp ->
+                    assert resp.body().size() > 0
+                }
+            }
+            def telData = container.drainTelemetry(500)
+            messages.addAll(
+                    TelemetryHelpers.filterMessages(telData, cls))
+            if (cl.call(messages)) {
+                break
+            }
+        }
+        messages
+    }
+
+    public static List<AppEndpoints> waitForAppEndpoints(AppSecContainer container, int timeoutSec, Closure<Boolean> cl, String path = '/') {
+        waitForTelemetryData(container, timeoutSec, cl, AppEndpoints, path)
+    }
+
+    public static List<GenerateMetrics> waitForMetrics(AppSecContainer container, int timeoutSec, Closure<Boolean> cl) {
+        waitForTelemetryData(container, timeoutSec, cl, GenerateMetrics)
+    }
+
+    public static List<WithIntegrations> waitForIntegrations(AppSecContainer container, int timeoutSec, Closure<Boolean> cl) {
+        waitForTelemetryData(container, timeoutSec, cl, WithIntegrations)
+    }
+
+    public static List<Logs> waitForLogs(AppSecContainer container, int timeoutSec, Closure<Boolean> cl) {
+        waitForTelemetryData(container, timeoutSec, cl, Logs)
+    }
 }

appsec/tests/integration/src/test/groovy/com/datadog/appsec/php/integration/Laravel8xTests.groovy

@@ -15,6 +15,7 @@ import java.net.http.HttpResponse
 
 import static com.datadog.appsec.php.integration.TestParams.getPhpVersion
 import static com.datadog.appsec.php.integration.TestParams.getVariant
+import com.datadog.appsec.php.TelemetryHelpers
 import static java.net.http.HttpResponse.BodyHandlers.ofString
 
 @Testcontainers
@@ -103,4 +104,28 @@ class Laravel8xTests {
         assert span.meta."_dd.appsec.event_rules.version" != ''
         assert span.meta."appsec.blocked" == "true"
     }
+
+    @Test
+    void 'Endpoints are sended'() {
+        def trace = container.traceFromRequest('/') { HttpResponse<InputStream> resp ->
+            assert resp.statusCode() == 200
+        }
+
+        assert trace.traceId != null
+
+        List<TelemetryHelpers.Endpoint> endpoints
+
+        TelemetryHelpers.waitForAppEndpoints(container, 30, { List<TelemetryHelpers.Endpoint> messages ->
+            endpoints = messages.collectMany { it.endpoints }
+            endpoints.size() > 0
+        })
+
+        assert endpoints.size() == 6
+        assert endpoints.find { it.path == '/' && it.method == 'GET' && it.operationName == 'http.request' && it.resourceName == 'GET /' } != null
+        assert endpoints.find { it.path == 'authenticate' && it.method == 'GET' && it.operationName == 'http.request' && it.resourceName == 'GET authenticate' } != null
+        assert endpoints.find { it.path == 'register' && it.method == 'GET' && it.operationName == 'http.request' && it.resourceName == 'GET register' } != null
+        assert endpoints.find { it.path == 'dynamic-path/{param01}' && it.method == 'GET' && it.operationName == 'http.request' && it.resourceName == 'GET dynamic-path/{param01}' } != null
+        assert endpoints.find { it.path == 'sanctum/csrf-cookie' && it.method == 'GET' && it.operationName == 'http.request' && it.resourceName == 'GET sanctum/csrf-cookie' } != null
+        assert endpoints.find { it.path == 'api/user' && it.method == 'GET' && it.operationName == 'http.request' && it.resourceName == 'GET api/user' } != null
+    }
 }