Merge pull request #49005 from makortel/cmsTraceFunctionSegfault

Add tests for `cmsTraceFunction` for various failures of the traced program

Author: cmsbuild

Utilities/ReleaseScripts/test/BuildFile.xml

@@ -7,6 +7,9 @@
 <test name="test-cmsTraceFunction-setenv" command="gdb/test-cmsTraceFunction-setenv.sh">
   <use name="gdb"/>
 </test>
+<test name="test-cmsTraceFunction-failure" command="gdb/test-cmsTraceFunction-failure.sh">
+  <use name="gdb"/>
+</test>
 <test name="test-clang-tidy" command="test-clang-tidy.sh">
   <use name="llvm"/>
 </test>

Utilities/ReleaseScripts/test/gdb/test-cmsTraceFunction-assert.cpp

@@ -0,0 +1,27 @@
+#include <iostream>
+#include <cassert>
+#include <cstdlib>
+
+class ScheduleItems {
+public:
+  ScheduleItems() {}
+  void initMisc();
+};
+
+void ScheduleItems::initMisc() { std::cout << "ScheduleItems::initMisc() called" << std::endl; }
+
+void my_assert() { assert(false && "Intentional assert failure"); }
+
+int main(int argc, char** argv) {
+  if (argc > 1) {
+    std::string_view opt{argv[1]};
+    if (opt == "before") {
+      my_assert();
+    } else if (opt == "after") {
+      ScheduleItems obj;
+      obj.initMisc();
+      my_assert();
+    }
+  }
+  return 0;
+}

Utilities/ReleaseScripts/test/gdb/test-cmsTraceFunction-failure.sh

@@ -0,0 +1,66 @@
+#!/bin/bash -ex
+
+TRACE="cmsTraceFunction --startAfterFunction ScheduleItems::initMisc setenv"
+
+check_failure() {
+  local test_name="$1"
+  local check_func="$2"
+  local exe_name="test-cmsTraceFunction-${test_name}"
+  local src_name="${exe_name}.cpp"
+
+  g++ -o "$exe_name" "$(dirname $0)/$src_name"
+
+  for when in before after; do
+    local log="${test_name}_${when}.log"
+    set +e
+    $TRACE ./$exe_name $when 2>&1 > "$log"
+    local ret=$?
+    set -e
+
+    if [ ${ret} = 0 ]; then
+      echo "cmsTraceFunction for ${test_name} ${when} exited with exit code 0, expected non-zero exit code"
+      exit 1
+    fi
+
+    if [ -n "${check_func}" ]; then
+      ${check_func} ${log}
+    fi
+  done
+
+  log_after="${test_name}_after.log"
+  if ! grep -q "ScheduleItems::initMisc() called" ${log_after}; then
+    echo "Did not find expected ScheduleItems::initMisc call in ${log_after}"
+    exit 1
+  fi
+}
+
+# Non-zero exit code
+check_failure "nonzero"
+
+# Assertion failure
+check_assert_log() {
+  local logfile="$1"
+  if ! grep -q "signal SIGABRT" ${logfile}; then
+    echo "Did not find signal message in ${logfile}"
+    exit 1
+  fi
+  if ! grep -q "in my_assert" ${logfile}; then
+    echo "Did not find my_assert function stack trace in ${logfile}"
+    exit 1
+  fi
+}
+check_failure "assert" check_assert_log
+
+# Segfault
+check_segfault_log() {
+  local logfile="$1"
+  if ! grep -q "signal SIGSEGV" ${logfile}; then
+    echo "Did not find signal message in ${logfile}"
+    exit 1
+  fi
+  if ! grep -q "in my_segfault" ${logfile}; then
+    echo "Did not find my_segfault function in stack trace in ${logfile}"
+    exit 1
+  fi
+}
+check_failure "segfault"

Utilities/ReleaseScripts/test/gdb/test-cmsTraceFunction-nonzero.cpp

@@ -0,0 +1,24 @@
+#include <iostream>
+#include <cstdlib>
+
+class ScheduleItems {
+public:
+  ScheduleItems() {}
+  void initMisc();
+};
+
+void ScheduleItems::initMisc() { std::cout << "ScheduleItems::initMisc() called" << std::endl; }
+
+int main(int argc, char** argv) {
+  if (argc > 1) {
+    std::string_view opt{argv[1]};
+    if (opt == "before") {
+      return 1;
+    } else if (opt == "after") {
+      ScheduleItems obj;
+      obj.initMisc();
+      return 1;
+    }
+  }
+  return 0;
+}

Utilities/ReleaseScripts/test/gdb/test-cmsTraceFunction-segfault.cpp

@@ -0,0 +1,28 @@
+#include <iostream>
+#include <cassert>
+#include <cstdlib>
+#include <csignal>
+
+class ScheduleItems {
+public:
+  ScheduleItems() {}
+  void initMisc();
+};
+
+void ScheduleItems::initMisc() { std::cout << "ScheduleItems::initMisc() called" << std::endl; }
+
+void my_segfault() { raise(SIGSEGV); }
+
+int main(int argc, char** argv) {
+  if (argc > 1) {
+    std::string_view opt{argv[1]};
+    if (opt == "before") {
+      my_segfault();
+    } else if (opt == "after") {
+      ScheduleItems obj;
+      obj.initMisc();
+      my_segfault();
+    }
+  }
+  return 0;
+}