From 9a556dee81cc83faa563fc49ed94ff4924d7a4bd Mon Sep 17 00:00:00 2001
From: teor <teor@torproject.org>
Date: Tue, 3 Dec 2019 14:53:33 +1000
Subject: [PATCH] cocci: Require spatch >= 1.0.4 to run checks

No changes file required: not in any released version of tor.

Fixes bug 32663.
---
 scripts/coccinelle/check_cocci_parse.sh | 47 +++++++++++++++++++++++--
 1 file changed, 44 insertions(+), 3 deletions(-)

diff --git a/scripts/coccinelle/check_cocci_parse.sh b/scripts/coccinelle/check_cocci_parse.sh
index 220b405940..aebfac70f2 100755
--- a/scripts/coccinelle/check_cocci_parse.sh
+++ b/scripts/coccinelle/check_cocci_parse.sh
@@ -21,8 +21,49 @@ exitcode=0
 
 export TOR_COCCI_EXCEPTIONS_FILE="${TOR_COCCI_EXCEPTIONS_FILE:-$scripts_cocci/exceptions.txt}"
 
-if ! command -v spatch; then
-    echo "Install coccinelle's spatch to check cocci C parsing!"
+PURPOSE="cocci C parsing"
+
+echo "Checking spatch:"
+
+if ! command -v spatch ; then
+    echo "Install coccinelle's spatch to check $PURPOSE."
+    exit "$exitcode"
+fi
+
+# Returns true if $1 is greater than or equal to $2
+version_ge()
+{
+    if test "$1" = "$2" ; then
+        # return true
+        return 0
+    fi
+    LOWER_VERSION="$(printf '%s\n' "$1" "$2" | $SORT_V | head -n 1)"
+    # implicit return
+    test "$LOWER_VERSION" != "$1"
+}
+
+# 'sort -V' is a gnu extension
+SORT_V="sort -V"
+# Use 'sort -n' if 'sort -V' doesn't work
+if ! version_ge "1" "0" ; then
+    echo "Your 'sort -V' command appears broken. Falling back to 'sort -n'."
+    echo "Some spatch version checks may give the wrong result."
+    SORT_V="sort -n"
+fi
+
+# Print the full spatch version, for diagnostics
+spatch --version
+
+MIN_SPATCH_V="1.0.4"
+# This pattern needs to handle version strings like:
+# spatch version 1.0.0-rc19
+# spatch version 1.0.6 compiled with OCaml version 4.05.0
+SPATCH_V=$(spatch --version | head -1 | \
+               sed 's/spatch version \([0-9][^ ]*\).*/\1/')
+
+if ! version_ge "$SPATCH_V" "$MIN_SPATCH_V" ; then
+    echo "Tor requires coccinelle spatch >= $MIN_SPATCH_V to check $PURPOSE."
+    echo "But you have $SPATCH_V. Please install a newer version."
     exit "$exitcode"
 fi
 
@@ -44,7 +85,7 @@ else
 fi
 
 if test "$exitcode" != 0 ; then
-    echo "Please fix these cocci parsing errors in the above files"
+    echo "Please fix these $PURPOSE errors in the above files"
     echo "Set VERBOSE=1 for more details"
     echo "Try running test-operator-cleanup or 'make autostyle-operators'"
     echo "As a last resort, you can modify scripts/coccinelle/exceptions.txt"