Test troubleshooting

Author: cataphract

.gitlab/generate-appsec.php

@@ -145,6 +145,7 @@
   after_script:
     - mkdir -p "${CI_PROJECT_DIR}/artifacts"
     - find appsec/tests/integration/build/test-results -name "*.xml" -exec cp --parents '{}' "${CI_PROJECT_DIR}/artifacts/" \;
+    - cp -r appsec/tests/integration/build/test-logs "${CI_PROJECT_DIR}/artifacts/" 2>/dev/null || true
     - .gitlab/upload-junit-to-datadog.sh "test.source.file:appsec"
   artifacts:
     reports:

appsec/tests/integration/build.gradle

@@ -36,9 +36,10 @@ dependencies {
     implementation 'org.msgpack:msgpack-core:0.9.9'
     implementation 'io.javalin:javalin:6.7.0'
 
-    implementation platform('org.testcontainers:testcontainers-bom:1.21.3')
-    implementation 'org.testcontainers:mysql'
-    implementation "org.testcontainers:junit-jupiter"
+    implementation platform('org.testcontainers:testcontainers-bom:2.0.3')
+    implementation 'org.testcontainers:testcontainers-mysql'
+    implementation "org.testcontainers:testcontainers-junit-jupiter"
+    implementation 'org.hamcrest:hamcrest:2.2'
     implementation 'com.flipkart.zjsonpatch:zjsonpatch:0.4.16'
     implementation 'org.junit.jupiter:junit-jupiter-engine:5.12.2'
     implementation 'org.junit.jupiter:junit-jupiter-params:5.12.2'
@@ -93,6 +94,11 @@ def creationDateOf(String image) {
     Date volumeDate = Date.from(OffsetDateTime.parse(imageModifiedStr).toInstant())
     volumeDate.time
 }
+def libddwafCommit() {
+    def proc = ['git', '-C', "${projectDir}/../../third_party/libddwaf", 'rev-parse', 'HEAD'].execute()
+    proc.waitForOrKill(5_000)
+    proc.text.trim()
+}
 
 def createVolumeTask = { String volumeName ->
     String taskName = "createVolume-$volumeName"
@@ -346,17 +352,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 \\
                               -DCMAKE_INSTALL_PREFIX=/appsec \\
                               -DDD_APPSEC_ENABLE_PATCHELF_LIBC=ON \\
+                              -DGIT_COMMIT=${libddwafCommit()} \\
                               -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/docker/AppSecContainer.groovy

@@ -44,8 +44,10 @@ import java.util.function.Supplier
 class AppSecContainer<SELF extends AppSecContainer<SELF>> extends GenericContainer<SELF> {
     private final static Logger DOCKER_OUTPUT_LOGGER = LoggerFactory.getLogger('docker')
     private String imageName
-    private Slf4jLogConsumer logConsumer
+    private Consumer<OutputFrame> logConsumer
     private File logsDir
+    // Set to true to include sidecar.log in stdout (very verbose)
+    private static final boolean TAIL_SIDECAR_LOG = false
     private String wwwDir
     private String wwwSrcDir
     public final HttpClient httpClient = HttpClient.newBuilder()
@@ -89,7 +91,7 @@ class AppSecContainer<SELF extends AppSecContainer<SELF>> extends GenericContain
         withEnv 'DD_TRACE_GIT_METADATA_ENABLED', '0'
         withEnv 'DD_INSTRUMENTATION_TELEMETRY_ENABLED', '1'
         // very verbose:
-        // withEnv '_DD_DEBUG_SIDECAR_LOG_METHOD', 'file:///tmp/logs/sidecar.log'
+        withEnv '_DD_DEBUG_SIDECAR_LOG_METHOD', 'file:///tmp/logs/sidecar.log'
         withEnv 'DD_SPAWN_WORKER_USE_EXEC', '1' // gdb fails following child with fdexec
         withEnv 'DD_TELEMETRY_HEARTBEAT_INTERVAL', '10'
         withEnv 'DD_TELEMETRY_EXTENDED_HEARTBEAT_INTERVAL', '10'
@@ -104,12 +106,53 @@ class AppSecContainer<SELF extends AppSecContainer<SELF>> extends GenericContain
     @Override
     protected void doStart() {
         super.doStart()
-        this.logConsumer = new Slf4jLogConsumer(DOCKER_OUTPUT_LOGGER)
+        this.logConsumer = createLogConsumer()
         followOutput(logConsumer)
         overlayWww()
         runInitialize()
     }
 
+    private Consumer<OutputFrame> createLogConsumer() {
+        Slf4jLogConsumer baseConsumer = new Slf4jLogConsumer(DOCKER_OUTPUT_LOGGER)
+        if (TAIL_SIDECAR_LOG) {
+            return baseConsumer
+        }
+        // Filter out sidecar.log content from stdout
+        // tail -F outputs "==> /path/to/file <==" when switching files
+        new SidecarLogFilteringConsumer(baseConsumer)
+    }
+
+    @CompileStatic
+    private static class SidecarLogFilteringConsumer implements Consumer<OutputFrame> {
+        private final Consumer<OutputFrame> delegate
+        private volatile boolean inSidecarLog = false
+
+        SidecarLogFilteringConsumer(Consumer<OutputFrame> delegate) {
+            this.delegate = delegate
+        }
+
+        @Override
+        void accept(OutputFrame frame) {
+            String text = frame.utf8String
+            if (text == null) {
+                delegate.accept(frame)
+                return
+            }
+
+            // Check for tail -F file header
+            if (text.contains('==>') && text.contains('<==')) {
+                inSidecarLog = text.contains('sidecar.log')
+                if (inSidecarLog) {
+                    return // Skip the sidecar.log header line
+                }
+            }
+
+            if (!inSidecarLog) {
+                delegate.accept(frame)
+            }
+        }
+    }
+
     Object nextCapturedTrace() {
         mockDatadogAgent.nextTrace(15000)
     }