tree-sitter/script/test

#!/usr/bin/env bash

set -e

. script/lib.sh

function usage {
  cat <<-EOF
USAGE

  $0  [-dgGhv] [-f focus-string] [-s seed]

OPTIONS

  -h  print this message

  -b  run make under scan-build static analyzer

  -d  run tests in a debugger (either lldb or gdb)

  -g  run tests with valgrind's memcheck tool

  -G  run tests with valgrind's memcheck tool, including a full leak check

  -v  run tests with verbose output

  -f  run only tests whose description contain the given string

  -s  set the seed used to control random behavior

  -z  pipe tests' stderr to \`dot(1)\` to render an SVG log


EOF
}

profile=
leak_check=no
mode=normal
verbose=
args=()
target=tests
export BUILDTYPE=Test
cmd="out/${BUILDTYPE}/${target}"
run_scan_build=

while getopts "bdf:s:gGhpvS" option; do
  case ${option} in
    h)
      usage
      exit
      ;;
    d)
      mode=debug
      ;;
    g)
      mode=valgrind
      ;;
    G)
      mode=valgrind
      leak_check=full
      ;;
    p)
      profile=true
      ;;
    f)
      args+=("--only=${OPTARG}")
      ;;
    v)
      verbose=true
      ;;
    s)
      export TREE_SITTER_SEED=${OPTARG}
      ;;
    S)
      mode=SVG
      ;;
    b)
      run_scan_build=true
      ;;
  esac
done

if [[ -n $verbose ]]; then
  args+=("--reporter=spec")
else
  args+=("--reporter=singleline")
fi

if [[ ! -z "$run_scan_build" ]]; then
	scan_build make -j2 $target
else
	make -j2 $target
fi
args=${args:-""}

if [[ -n $profile ]]; then
  export CPUPROFILE=/tmp/${target}-$(date '+%s').prof
fi

case ${mode} in
  valgrind)
    valgrind                                     \
      --suppressions=./script/util/valgrind.supp \
      --dsymutil=yes                             \
      --leak-check=${leak_check}                 \
      $cmd "${args[@]}" 2>&1 |                   \
      grep --color -E '\w+_tests?.cc:\d+|$'
    ;;

  debug)
    if which -s lldb; then
      lldb $cmd -- "${args[@]}"
    elif which -s gdb; then
      gdb $cmd -- "${args[@]}"
    else
      echo "No debugger found"
      exit 1
    fi
    ;;

  SVG)
    echo "<!DOCTYPE html><style>svg { width: 100%; margin-bottom: 20px; }</style>" > index.html
    $cmd "${args[@]}" 2> >(grep -v 'Assertion failed' | dot -Tsvg >> index.html)
    echo "Wrote index.html"
    ;;

  normal)
    time $cmd "${args[@]}"
    ;;
esac

if [[ -n $profile ]]; then
  pprof $cmd $CPUPROFILE
fi
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`#!/usr/bin/env bash`

Make test script fail properly 2016-01-15 11:35:35 -08:00			`set -e`

Run scan-build during CI This bumps the travis-ci container image to Trusty so that we have a version of clang that includes proper support for C++14. 2017-06-14 13:28:03 -04:00			`. script/lib.sh`

Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`function usage {`
			`cat <<-EOF`
			`USAGE`

Add test script flag for piping stderr to dot to make an svg 2016-08-29 11:51:47 -07:00			`$0 [-dgGhv] [-f focus-string] [-s seed]`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00
			`OPTIONS`

			`-h print this message`

Run scan-build during CI This bumps the travis-ci container image to Trusty so that we have a version of clang that includes proper support for C++14. 2017-06-14 13:28:03 -04:00			`-b run make under scan-build static analyzer`

Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`-d run tests in a debugger (either lldb or gdb)`

Update help message for test script 2016-02-02 12:31:13 -08:00			`-g run tests with valgrind's memcheck tool`

			`-G run tests with valgrind's memcheck tool, including a full leak check`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00
			`-v run tests with verbose output`

			`-f run only tests whose description contain the given string`

Add test script flag for piping stderr to dot to make an svg 2016-08-29 11:51:47 -07:00			`-s set the seed used to control random behavior`

Remove logic for recovering from OOM 2016-11-04 09:18:38 -07:00			-z pipe tests' stderr to \`dot(1)\` to render an SVG log
Add test script flag for piping stderr to dot to make an svg 2016-08-29 11:51:47 -07:00
Run scan-build during CI This bumps the travis-ci container image to Trusty so that we have a version of clang that includes proper support for C++14. 2017-06-14 13:28:03 -04:00
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`EOF`
			`}`

			`profile=`
Test script - allow valgrind to be run w/o the leak check 2016-01-29 17:03:35 -08:00			`leak_check=no`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`mode=normal`
Upgrade bandit test framework 2016-11-18 13:47:31 -08:00			`verbose=`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`args=()`
			`target=tests`
Handle allocation failures when instantiating documents 2016-01-18 10:44:49 -08:00			`export BUILDTYPE=Test`
			`cmd="out/${BUILDTYPE}/${target}"`
Run scan-build during CI This bumps the travis-ci container image to Trusty so that we have a version of clang that includes proper support for C++14. 2017-06-14 13:28:03 -04:00			`run_scan_build=`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00
Run scan-build during CI This bumps the travis-ci container image to Trusty so that we have a version of clang that includes proper support for C++14. 2017-06-14 13:28:03 -04:00			`while getopts "bdf:s:gGhpvS" option; do`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`case ${option} in`
			`h)`
			`usage`
			`exit`
			`;;`
			`d)`
			`mode=debug`
			`;;`
			`g)`
			`mode=valgrind`
			`;;`
Test script - allow valgrind to be run w/o the leak check 2016-01-29 17:03:35 -08:00			`G)`
			`mode=valgrind`
			`leak_check=full`
			`;;`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`p)`
			`profile=true`
			`;;`
			`f)`
			`args+=("--only=${OPTARG}")`
			`;;`
			`v)`
Upgrade bandit test framework 2016-11-18 13:47:31 -08:00			`verbose=true`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`;;`
			`s)`
			`export TREE_SITTER_SEED=${OPTARG}`
			`;;`
Add test script flag for piping stderr to dot to make an svg 2016-08-29 11:51:47 -07:00			`S)`
			`mode=SVG`
			`;;`
Run scan-build during CI This bumps the travis-ci container image to Trusty so that we have a version of clang that includes proper support for C++14. 2017-06-14 13:28:03 -04:00			`b)`
			`run_scan_build=true`
			`;;`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`esac`
			`done`

Upgrade bandit test framework 2016-11-18 13:47:31 -08:00			`if [[ -n $verbose ]]; then`
			`args+=("--reporter=spec")`
			`else`
			`args+=("--reporter=singleline")`
			`fi`

Run scan-build during CI This bumps the travis-ci container image to Trusty so that we have a version of clang that includes proper support for C++14. 2017-06-14 13:28:03 -04:00			`if [[ ! -z "$run_scan_build" ]]; then`
Use -j2 on the CI boxes The travis-ci trusty container has two cores. 2017-06-16 15:05:14 -04:00			`scan_build make -j2 $target`
Run scan-build during CI This bumps the travis-ci container image to Trusty so that we have a version of clang that includes proper support for C++14. 2017-06-14 13:28:03 -04:00			`else`
Use -j2 on the CI boxes The travis-ci trusty container has two cores. 2017-06-16 15:05:14 -04:00			`make -j2 $target`
Run scan-build during CI This bumps the travis-ci container image to Trusty so that we have a version of clang that includes proper support for C++14. 2017-06-14 13:28:03 -04:00			`fi`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`args=${args:-""}`

			`if [[ -n $profile ]]; then`
			`export CPUPROFILE=/tmp/${target}-$(date '+%s').prof`
			`fi`

			`case ${mode} in`
			`valgrind)`
Run valgrind with full leak check 2016-01-28 21:18:41 -08:00			`valgrind \`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`--suppressions=./script/util/valgrind.supp \`
Run valgrind with full leak check 2016-01-28 21:18:41 -08:00			`--dsymutil=yes \`
Test script - allow valgrind to be run w/o the leak check 2016-01-29 17:03:35 -08:00			`--leak-check=${leak_check} \`
Run valgrind with full leak check 2016-01-28 21:18:41 -08:00			`$cmd "${args[@]}" 2>&1 \| \`
Rename spec -> test 'Test' is a lot more straightforward of a name. 2017-03-09 20:40:01 -08:00			`grep --color -E '\w+_tests?.cc:\d+\|$'`
Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`;;`

			`debug)`
			`if which -s lldb; then`
			`lldb $cmd -- "${args[@]}"`
			`elif which -s gdb; then`
			`gdb $cmd -- "${args[@]}"`
			`else`
			`echo "No debugger found"`
			`exit 1`
			`fi`
			`;;`

Add test script flag for piping stderr to dot to make an svg 2016-08-29 11:51:47 -07:00			`SVG)`
In script/test, style SVG graphs for readability 2016-08-30 13:02:27 -07:00			`echo "<!DOCTYPE html><style>svg { width: 100%; margin-bottom: 20px; }</style>" > index.html`
			`$cmd "${args[@]}" 2> >(grep -v 'Assertion failed' \| dot -Tsvg >> index.html)`
Add test script flag for piping stderr to dot to make an svg 2016-08-29 11:51:47 -07:00			`echo "Wrote index.html"`
			`;;`

Unify test targets, use externally defined languages as fixtures 2016-01-15 11:19:24 -08:00			`normal)`
			`time $cmd "${args[@]}"`
			`;;`
			`esac`

			`if [[ -n $profile ]]; then`
			`pprof $cmd $CPUPROFILE`
			`fi`