Make an effort to install and use GNU-style utils [EFForg#1504]

Andrew Lorente · Andrew Lorente · commit 983206ff7d78 · 2015-05-16T11:45:06.000-07:00
The BSD versions of readlink and mktemp have totally different behavior
from their GNU counterparts. It's possible that, at every site where we
use them, there's a way to get what we need from the BSD version, but it
seems more straightforward to install &amp; use the GNU versions (especially
since install-dev-dependencies.sh already installs gnu-sed).
diff --git a/install-dev-dependencies.sh b/install-dev-dependencies.sh
@@ -7,6 +7,7 @@ if type apt-get >/dev/null ; then
     firefox chromium-browser zip sqlite3 python-pip libcurl4-openssl-dev
 elif type brew >/dev/null ; then
   brew list python &>/dev/null || brew install python
+  brew list coreutils &>/dev/null || brew install coreutils
   brew install libxml2 gnu-sed
   if ! echo $PATH | grep -ql /usr/local/bin ; then
     echo '/usr/local/bin not found in $PATH, please add it.'
diff --git a/locate-gnu-utils.sh b/locate-gnu-utils.sh
@@ -0,0 +1,31 @@
+#!/bin/bash -ex
+
+# BSD readlink and mktemp have different APIs from their GNU counterparts. On
+# OSX systems we'll have g-prefixed GNU versions installed by Homebrew. Real
+# BSD systems are still left in the cold.
+
+READLINK=$(which readlink 2>/dev/null)
+GREADLINK=$(which greadlink 2>/dev/null)
+if [ -x "$GREADLINK" ]; then
+  READLINK="$GREADLINK"
+fi
+
+MKTEMP=$(which mktemp 2>/dev/null)
+GMKTEMP=$(which gmktemp 2>/dev/null)
+if [ -x "$GMKTEMP" ]; then
+  MKTEMP="$GMKTEMP"
+fi
+
+check_for_gnu_version() {
+  gnu_available=$("$1" --version 2>&1 | grep GNU)
+  if [ ! "$gnu_available" ]; then
+    echo "Could not locate a GNU version of ${2}. This may mean you're using "\
+         "a non-OSX BSD system, which these scripts don't know how to handle. "
+    echo "If you are indeed using OSX, something may have gone wrong running "\
+         "install-dev-dependencies.sh. Look for errors related to coreutils."
+    exit 1
+  fi
+}
+
+check_for_gnu_version "$MKTEMP" "mktemp"
+check_for_gnu_version "$READLINK" "readlink"
diff --git a/run-chromium.sh b/run-chromium.sh
@@ -3,9 +3,11 @@
 # Build the extension and run a chromium extension with it installed.
 #
 set -o errexit -o xtrace
+
 cd $(dirname $0)
+source locate-gnu-utils.sh
 source makecrx.sh
-PROFILE_DIRECTORY="$(mktemp -d)"
+PROFILE_DIRECTORY="$("$MKTEMP" -d)"
 trap 'rm -r "$PROFILE_DIRECTORY"' EXIT
 chromium-browser \
   --user-data-dir="$PROFILE_DIRECTORY" \
diff --git a/test-ruleset-coverage.sh b/test-ruleset-coverage.sh
@@ -3,8 +3,10 @@
 # Test that all rulesets modified after a certain date have sufficient test
 # coverage, according to the ruleset checker.
 #
+
 cd $(dirname $0)
-TMP=`mktemp`
+source locate-gnu-utils.sh
+TMP=`"$MKTEMP"`
 trap 'rm "$TMP"' EXIT
 if ! [ -d https-everywhere-checker ] ; then
   echo "Submodule https-everywhere-checker is missing. Run"
diff --git a/test.sh b/test.sh
@@ -1,15 +1,17 @@
 #!/bin/bash -ex
 # Run tests for HTTPS Everywhere
 
+source locate-gnu-utils.sh
+
 # We have to change to the right directory because this is sometimes invoked
 # through a symlink in .git/hooks/pre-push.
-cd $(dirname $(readlink -f $0))
+cd $(dirname $("$READLINK" -f $0))
 
 # dummy Jetpack addon that contains tests
 TEST_ADDON_PATH=./https-everywhere-tests/
 
 # We'll create a Firefox profile here and install HTTPS Everywhere into it.
-PROFILE_DIRECTORY="$(mktemp -d)"
+PROFILE_DIRECTORY="$("$MKTEMP" -d)"
 trap 'rm -r "$PROFILE_DIRECTORY"' EXIT
 HTTPSE_INSTALL_DIRECTORY=$PROFILE_DIRECTORY/extensions/https-everywhere@eff.org
 
