From b21fa0e43371b8281b9aa8ea532088800bb37712 Mon Sep 17 00:00:00 2001
From: David Bremner <david@tethera.net>
Date: Sat, 12 Feb 2022 16:27:35 -0400
Subject: [PATCH] perf-test: allow running test_emacs from performance test
 suite.

test_require_external prereq has to move to test-lib-common.sh, and
the new shell functions print_emacs_header and time_emacs are provided.

The somewhat indirect way of printing the output is to avoid the extra
"" present on string values from emacsclient.
---
 performance-test/perf-test-lib.sh |  5 +++++
 test/test-lib-common.sh           | 14 ++++++++++++++
 test/test-lib-emacs.sh            |  8 ++++++++
 test/test-lib.el                  |  5 +++++
 test/test-lib.sh                  | 14 --------------
 5 files changed, 32 insertions(+), 14 deletions(-)

diff --git a/performance-test/perf-test-lib.sh b/performance-test/perf-test-lib.sh
index 0e4915e3..c34f8cd6 100644
--- a/performance-test/perf-test-lib.sh
+++ b/performance-test/perf-test-lib.sh
@@ -210,6 +210,11 @@ print_header ()
     printf "\t\t\tWall(s)\tUsr(s)\tSys(s)\tRes(K)\tIn/Out(512B)\n"
 }
 
+print_emacs_header ()
+{
+    printf "\t\t\tWall(s)\tGCs\tGC time(s)\n"
+}
+
 time_run ()
 {
     printf "  %-22s" "$1"
diff --git a/test/test-lib-common.sh b/test/test-lib-common.sh
index ebbf4cdf..18fa29c0 100644
--- a/test/test-lib-common.sh
+++ b/test/test-lib-common.sh
@@ -29,6 +29,20 @@ if [[ -z "$NOTMUCH_SRCDIR" ]] || [[ -z "$NOTMUCH_BUILDDIR" ]]; then
 	exit 1
 fi
 
+# Explicitly require external prerequisite.  Useful when binary is
+# called indirectly (e.g. from emacs).
+# Returns success if dependency is available, failure otherwise.
+test_require_external_prereq () {
+	local binary
+	binary="$1"
+	if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
+		# dependency is missing, call the replacement function to note it
+		eval "$binary"
+	else
+		true
+	fi
+}
+
 backup_database () {
     test_name=$(basename $0 .sh)
     rm -rf $TMP_DIRECTORY/notmuch-dir-backup."$test_name"
diff --git a/test/test-lib-emacs.sh b/test/test-lib-emacs.sh
index a298526d..ad4c4aeb 100644
--- a/test/test-lib-emacs.sh
+++ b/test/test-lib-emacs.sh
@@ -207,4 +207,12 @@ test_emacs () {
 	${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $*)"
 }
 
+time_emacs () {
+    rm -f MESSAGES
+    printf "%s" "$1"
+    shift
+    test_emacs "(test-time $*)" > emacs.out
+    tail -n 1 MESSAGES
+}
+
 emacs_generate_script
diff --git a/test/test-lib.el b/test/test-lib.el
index 6831b46f..79a9d4d6 100644
--- a/test/test-lib.el
+++ b/test/test-lib.el
@@ -186,6 +186,11 @@ running, quit if it terminated."
        (t (message "%s" err)))
      (with-current-buffer "*Messages*" (test-output "MESSAGES"))))
 
+(defmacro test-time (&rest body)
+  `(let ((results (mapcar (lambda (x) (/ x 5.0)) (benchmark-run 5 ,@body))))
+     (message "\t\t%0.2f\t%0.2f\t%0.2f" (nth 0 results) (nth 1 results) (nth 2 results))
+     (with-current-buffer "*Messages*" (test-output "MESSAGES"))))
+
 ;; For historical reasons, we hide deleted tags by default in the test
 ;; suite
 (setq notmuch-tag-deleted-formats
diff --git a/test/test-lib.sh b/test/test-lib.sh
index 89e5c6d8..59b6079d 100644
--- a/test/test-lib.sh
+++ b/test/test-lib.sh
@@ -603,20 +603,6 @@ $binary () {
 	fi
 }
 
-# Explicitly require external prerequisite.  Useful when binary is
-# called indirectly (e.g. from emacs).
-# Returns success if dependency is available, failure otherwise.
-test_require_external_prereq () {
-	local binary
-	binary="$1"
-	if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
-		# dependency is missing, call the replacement function to note it
-		eval "$binary"
-	else
-		true
-	fi
-}
-
 # You are not expected to call test_ok_ and test_failure_ directly, use
 # the text_expect_* functions instead.
 
-- 
2.43.0