#!/bin/bash
#
# Runs toybox tests, making sure to build the required binaries.

set -o nounset
set -o pipefail
set -o errexit

usage() {
  cat <<EOF
Runs toybox tests, making sure to build the required binaries.

Usage:
  ./test.sh all [OPTION]                # Run all tests
  ./test.sh single [OPTION] COMMAND...  # Run tests for the given commands

Options:
 -asan   Run under AddressSanitizer
 -msan   Run under MemorySanitizer
 -ubsan  Run under UndefinedBehaviorSanitizer
 -sancov Run under SanitizerCoverage

See http://clang.llvm.org/docs/index.html for details on these tools.

Environment variables:
  TEST_HOST:
    Test the command on the host instead of toybox.  Respected by
    scripts/test.sh.
  VERBOSE=1, VERBOSE=fail, DEBUG:
    Show more test output.  Respected by scripts/runtest.sh.
  CLANG_DIR:
    Directory of Clang pre-built binaries, available at
    http://llvm.org/releases/download.html.  You should set CLANG_DIR when
    running with the sanitizers; otherwise it will use 'clang' in your PATH
    (which is often old).

Example:
  $ export CLANG_DIR=~/install/clang+llvm-3.8.0-x86_64-linux-gnu-ubuntu-14.04
  $ ./test.sh all                    # Run all tests normally
  $ ./test.sh single -asan grep sed  # Run grep and sed tests under ASAN

EOF
  exit
}

readonly TOPDIR=${TOPDIR:-$PWD}
readonly CLANG_DIR=${CLANG_DIR:-}

if [ -n "$CLANG_DIR" ]
then
  # These are needed to show line numbers in stack traces.
  sym=$CLANG_DIR/bin/llvm-symbolizer
	export ASAN_SYMBOLIZER_PATH=$sym
	export MSAN_SYMBOLIZER_PATH=$sym
	export UBSAN_SYMBOLIZER_PATH=$sym
fi

die() { echo "$@"; exit 1; }

TOYBOX_BIN=toybox
SAN_FLAG=  # Are we running under any Sanitizer?

# Set globals if the arg looks like a flag.
process_flag()
{
  local flag=$1
  local ret=0
  case $flag in
    -asan)
      TOYBOX_BIN=toybox_asan
      SAN_FLAG=$flag
      ;;
    -msan)
      TOYBOX_BIN=toybox_msan
      SAN_FLAG=$flag
      ;;
    -ubsan)
      TOYBOX_BIN=toybox_ubsan
      SAN_FLAG=$flag
      export UBSAN_OPTIONS='print_stacktrace=1'
      ;;
    -sancov)
      TOYBOX_BIN=toybox_sancov_func
      SAN_FLAG=$flag

      local cov_dir=/tmp/sancov
      mkdir -p $cov_dir
      export MSAN_OPTIONS="coverage=1:coverage_dir=$cov_dir"
      echo $MSAN_OPTIONS
      #export ASAN_OPTIONS='coverage=1'
      ;;
    -*)
      die "Invalid flag $flag"
      ;;
    *)
      ret=1  # doesn't look like a flag
  esac
  return $ret
}

# Print the toys that should be in the test environment.
#
# TODO: This is a variant of logic in scripts/genconfig.sh, which has another
# variant in scripts/make.sh.  scripts/genconfig.sh should probably ouput a
# simple text file of commands that everyone can use.
toys_to_link()
{
  grep 'TOY(.*)' toys/*/*.c | grep -v TOYFLAG_NOFORK | grep -v "0))" | \
    sed -rn 's/([^:]*):.*(OLD|NEW)TOY\( *([a-zA-Z][^,]*) *,.*/\3/p' | sort
}

# Make a dir, linking every binary to the toybox binary.
make_toybox_tree()
{
  local tree_dir=$1
  local toybox_bin=$2

  # Make there aren't old commands lying around.
  rm -rf $tree_dir
  mkdir -p $tree_dir
  toys_to_link | xargs -I {} -- ln -s $toybox_bin $tree_dir/{}
}

all()
{
  if [ $# -gt 0 ]
  then
    process_flag $1 && shift  # set globals if it's a flag
  fi
  make $TOYBOX_BIN
  local tree_dir=generated/tree/all$SAN_FLAG
  make_toybox_tree $tree_dir ../../../$TOYBOX_BIN  # 3 levels up
  TOYBOX_TREE_DIR=$TOPDIR/$tree_dir scripts/test.sh all
}

single()
{
  [ $# -eq 0 ] && die "At least one command is required."
  process_flag $1 && shift  # set globals if it's a flag
  make $TOYBOX_BIN

  for cmd in "$@"
  do
    local tree_dir
    [ -z "$SAN_FLAG" ] && 
      tree_dir=generated/tree/$cmd || tree_dir=generated/tree/all$SAN_FLAG

    make_toybox_tree $tree_dir ../../../$TOYBOX_BIN

    # Make the 'single' binary, and copy it over the symlink to toybox in the
    # tree.
    if [ -z "$SAN_FLAG" ]
    then
      make generated/single/$cmd
      cp -v -f generated/single/$cmd $tree_dir
    fi
    TOYBOX_TREE_DIR=$TOPDIR/$tree_dir scripts/test.sh single $cmd
  done
}

[ $# -eq 0 ] && usage

case $1 in
  single|all)
    "$@"
    ;;
  *)
    usage
    ;;
esac