Adding hamcrest matchers to the crash tracking smoke test

I spent a day or so digging and understanding why crash tracking smoke test wasn't working locally for me.

Eventually, I tracked it down to the ancient version of bash being used on OS X.  That version of bash doesn't support all the necessary elements used by the bash scripts.

To debug the issue, I switched to using hamcrest matchers, so I could more easily see what was happening underneath.

I've also added comments to the test class, so hopefully, others don't lose time on this again in the future.

Author: dougqh

dd-smoke-tests/crashtracking/build.gradle

@@ -19,7 +19,9 @@ jar {
 dependencies {
   testImplementation project(':dd-smoke-tests')
   testImplementation project(':dd-java-agent:agent-profiling:profiling-testing')
+
   testImplementation libs.bundles.junit5
+  testImplementation group: 'org.hamcrest', name: 'hamcrest', version: '2.1'
   testImplementation libs.bundles.mockito
 }
 

dd-smoke-tests/crashtracking/src/test/java/datadog/smoketest/CrashtrackingSmokeTest.java

@@ -1,7 +1,8 @@
 package datadog.smoketest;
 
+import static org.hamcrest.CoreMatchers.containsString;
+import static org.hamcrest.MatcherAssert.assertThat;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assumptions.assumeFalse;
 
 import datadog.trace.api.Platform;
@@ -23,6 +24,10 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+/*
+ * NOTE: The current implementation of crash tracking doesn't work with ancient version of bash
+ * that ships with OS X by default.
+ */
 public class CrashtrackingSmokeTest {
   private MockWebServer tracingServer;
 
@@ -76,6 +81,10 @@ private static String getExtension() {
     return Platform.isWindows() ? "bat" : "sh";
   }
 
+  /*
+   * NOTE: The current implementation of crash tracking doesn't work with ancient version of bash
+   * that ships with OS X by default.
+   */
   @Test
   void testCrashTracking() throws Exception {
     Path script = tempDir.resolve("dd_crash_uploader." + getExtension());
@@ -140,14 +149,17 @@ void testCrashTracking() throws Exception {
 
     assertNotEquals(0, p.waitFor(), "Application should have crashed");
 
-    assertTrue(stdoutStr.toString().contains(" was uploaded successfully"));
-    assertTrue(
-        stderrStr
-            .toString()
-            .contains(
-                "com.datadog.crashtracking.CrashUploader - Successfully uploaded the crash files"));
+    assertThat(stdoutStr.toString(), containsString(" was uploaded successfully"));
+    assertThat(
+        stderrStr.toString(),
+        containsString(
+            "com.datadog.crashtracking.CrashUploader - Successfully uploaded the crash files"));
   }
 
+  /*
+   * NOTE: The current implementation of crash tracking doesn't work with ancient version of bash
+   * that ships with OS X by default.
+   */
   @Test
   void testCrashTrackingLegacy() throws Exception {
     Path script = tempDir.resolve("dd_crash_uploader." + getExtension());
@@ -212,14 +224,17 @@ void testCrashTrackingLegacy() throws Exception {
 
     assertNotEquals(0, p.waitFor(), "Application should have crashed");
 
-    assertTrue(stdoutStr.toString().contains(" was uploaded successfully"));
-    assertTrue(
-        stderrStr
-            .toString()
-            .contains(
-                "com.datadog.crashtracking.CrashUploader - Successfully uploaded the crash files"));
+    assertThat(stdoutStr.toString(), containsString(" was uploaded successfully"));
+    assertThat(
+        stderrStr.toString(),
+        containsString(
+            "com.datadog.crashtracking.CrashUploader - Successfully uploaded the crash files"));
   }
 
+  /*
+   * NOTE: The current implementation of crash tracking doesn't work with ancient version of bash
+   * that ships with OS X by default.
+   */
   @Test
   void testOomeTracking() throws Exception {
     Path script = tempDir.resolve("dd_oome_notifier." + getExtension());
@@ -281,9 +296,10 @@ void testOomeTracking() throws Exception {
 
     assertNotEquals(0, p.waitFor(), "Application should have crashed");
 
-    assertTrue(
-        stderrStr.toString().contains("com.datadog.crashtracking.OOMENotifier - OOME event sent"));
-    assertTrue(stdoutStr.toString().contains("OOME Event generated successfully"));
+    assertThat(
+        stderrStr.toString(),
+        containsString("com.datadog.crashtracking.OOMENotifier - OOME event sent"));
+    assertThat(stdoutStr.toString(), containsString("OOME Event generated successfully"));
   }
 
   @Test
@@ -352,16 +368,16 @@ void testCombineTracking() throws Exception {
     assertNotEquals(0, p.waitFor(), "Application should have crashed");
 
     // Crash uploader did get triggered
-    assertTrue(stdoutStr.toString().contains(" was uploaded successfully"));
-    assertTrue(
-        stderrStr
-            .toString()
-            .contains(
-                "com.datadog.crashtracking.CrashUploader - Successfully uploaded the crash files"));
+    assertThat(stdoutStr.toString(), containsString(" was uploaded successfully"));
+    assertThat(
+        stderrStr.toString(),
+        containsString(
+            "com.datadog.crashtracking.CrashUploader - Successfully uploaded the crash files"));
 
     // OOME notifier did get triggered
-    assertTrue(
-        stderrStr.toString().contains("com.datadog.crashtracking.OOMENotifier - OOME event sent"));
-    assertTrue(stdoutStr.toString().contains("OOME Event generated successfully"));
+    assertThat(
+        stderrStr.toString(),
+        containsString("com.datadog.crashtracking.OOMENotifier - OOME event sent"));
+    assertThat(stdoutStr.toString(), containsString("OOME Event generated successfully"));
   }
 }