#! /bin/sh

# Run the PCRE tests using the pcretest program. The appropriate tests are

# selected, depending on which build-time options were used.

#

# All tests are now run both with and without -s, to ensure that everything is

# tested with and without studying. However, there are some tests that produce

# different output after studying, typically when we are tracing the actual

# matching process (for example, using auto-callouts). In these few cases, the

# tests are duplicated in the files, one with /S to force studying always, and

# one with /SS to force *not* studying always. The use of -s doesn't then make

# any difference to their output. There is also one test which compiles invalid

# UTF-8 with the UTF-8 check turned off; for this, studying must also be

# disabled with /SS.

#

# When JIT support is available, all the tests are also run with -s+ to test

# (again, almost) everything with studying and the JIT option. There are also

# two tests for JIT-specific features, one to be run when JIT support is

# available, and one when it is not.

#

# Whichever of the 8-, 16- and 32-bit libraries exist are tested. It is also

# possible to select which to test by the arguments -8, -16 or -32.

#

# Other arguments for this script can be individual test numbers, or the word

# "valgrind", "valgrind-log" or "sim" followed by an argument to run cross-

# compiled executables under a simulator, for example:

#

# RunTest 3 sim "qemu-arm -s 8388608"

#

#

# There are two special cases where only one argument is allowed:

#

# If the first and only argument is "ebcdic", the script runs the special

# EBCDIC test that can be useful for checking certain EBCDIC features, even

# when run in an ASCII environment.

#

# If the script is obeyed as "RunTest list", a list of available tests is

# output, but none of them are run.

# Define test titles in variables so that they can be output as a list. Some

# of them are modified (e.g. with -8 or -16) when used in the actual tests.

title1="Test 1: Main functionality (Compatible with Perl >= 5.10)"

title2="Test 2: API, errors, internals, and non-Perl stuff"

title3="Test 3: Locale-specific features"

title4A="Test 4: UTF"

title4B=" support (Compatible with Perl >= 5.10)"

title5="Test 5: API, internals, and non-Perl stuff for UTF"

title6="Test 6: Unicode property support (Compatible with Perl >= 5.10)"

title7="Test 7: API, internals, and non-Perl stuff for Unicode property support"

title8="Test 8: DFA matching main functionality"

title9="Test 9: DFA matching with UTF"

title10="Test 10: DFA matching with Unicode properties"

title11="Test 11: Internal offsets and code size tests"

title12="Test 12: JIT-specific features (JIT available)"

title13="Test 13: JIT-specific features (JIT not available)"

title14="Test 14: Specials for the basic 8-bit library"

title15="Test 15: Specials for the 8-bit library with UTF-8 support"

title16="Test 16: Specials for the 8-bit library with Unicode propery support"

title17="Test 17: Specials for the basic 16/32-bit library"

title18="Test 18: Specials for the 16/32-bit library with UTF-16/32 support"

title19="Test 19: Specials for the 16/32-bit library with Unicode property support"

title20="Test 20: DFA specials for the basic 16/32-bit library"

title21="Test 21: Reloads for the basic 16/32-bit library"

title22="Test 22: Reloads for the 16/32-bit library with UTF-16/32 support"

title23="Test 23: Specials for the 16-bit library"

title24="Test 24: Specials for the 16-bit library with UTF-16 support"

title25="Test 25: Specials for the 32-bit library"

title26="Test 26: Specials for the 32-bit library with UTF-32 support"

if [ $# -eq 1 -a "$1" = "list" ]; then

  echo $title1

  echo $title2 "(not UTF)"

  echo $title3

  echo $title4A $title4B

  echo $title5 support

  echo $title6

  echo $title7

  echo $title8

  echo $title9

  echo $title10

  echo $title11

  echo $title12

  echo $title13

  echo $title14

  echo $title15

  echo $title16

  echo $title17

  echo $title18

  echo $title19

  echo $title20

  echo $title21

  echo $title22

  echo $title23

  echo $title24

  echo $title25

  echo $title26

  exit 0

fi

# Set up a suitable "diff" command for comparison. Some systems

# have a diff that lacks a -u option. Try to deal with this.

cf="diff"

diff -u /dev/null /dev/null 2>/dev/null && cf="diff -u"

# Find the test data

if [ -n "$srcdir" -a -d "$srcdir" ] ; then

  testdata="$srcdir/testdata"

elif [ -d "./testdata" ] ; then

  testdata=./testdata

elif [ -d "../testdata" ] ; then

  testdata=../testdata

else

  echo "Cannot find the testdata directory"

  exit 1

fi

# ------ Special EBCDIC Test -------

if [ $# -eq 1 -a "$1" = "ebcdic" ]; then

  ./pcretest -C ebcdic >/dev/null

  ebcdic=$?

  if [ $ebcdic -ne 1 ] ; then

    echo "Cannot run EBCDIC tests: EBCDIC support not compiled"

    exit 1

  fi

  for opt in "" "-s" "-dfa" "-s -dfa"; do

    ./pcretest -q $opt $testdata/testinputEBC >testtry

    if [ $? = 0 ] ; then

      $cf $testdata/testoutputEBC testtry

      if [ $? != 0 ] ; then exit 1; fi

    else exit 1

    fi

    if [ "$opt" = "-s" ] ; then echo "  OK with study"

    elif [ "$opt" = "-dfa" ] ; then echo "  OK using DFA"

    elif [ "$opt" = "-s -dfa" ] ; then echo "  OK using DFA with study"

    else echo "  OK"

    fi

  done

exit 0

fi

# ------ Normal Tests ------

# Default values

valgrind=

sim=

arg8=

arg16=

arg32=

# This is in case the caller has set aliases (as I do - PH)

unset cp ls mv rm

# Select which tests to run; for those that are explicitly requested, check

# that the necessary optional facilities are available.

do1=no

do2=no

do3=no

do4=no

do5=no

do6=no

do7=no

do8=no

do9=no

do10=no

do11=no

do12=no

do13=no

do14=no

do15=no

do16=no

do17=no

do18=no

do19=no

do20=no

do21=no

do22=no

do23=no

do24=no

do25=no

do26=no

while [ $# -gt 0 ] ; do

  case $1 in

    1) do1=yes;;

    2) do2=yes;;

    3) do3=yes;;

    4) do4=yes;;

    5) do5=yes;;

    6) do6=yes;;

    7) do7=yes;;

    8) do8=yes;;

    9) do9=yes;;

   10) do10=yes;;

   11) do11=yes;;

   12) do12=yes;;

   13) do13=yes;;

   14) do14=yes;;

   15) do15=yes;;

   16) do16=yes;;

   17) do17=yes;;

   18) do18=yes;;

   19) do19=yes;;

   20) do20=yes;;

   21) do21=yes;;

   22) do22=yes;;

   23) do23=yes;;

   24) do24=yes;;

   25) do25=yes;;

   26) do26=yes;;

   -8) arg8=yes;;

  -16) arg16=yes;;

  -32) arg32=yes;;

   valgrind) valgrind="valgrind --tool=memcheck -q --smc-check=all";;

   valgrind-log) valgrind="valgrind --tool=memcheck --num-callers=30 --leak-check=no --error-limit=no --smc-check=all --log-file=report.%p ";;

   sim) shift; sim=$1;;

    *) echo "Unknown test number '$1'"; exit 1;;

  esac

  shift

done

# Find which optional facilities are available.

$sim ./pcretest -C linksize >/dev/null

link_size=$?

if [ $link_size -lt 2 ] ; then

  echo "Failed to find internal link size"

  exit 1

fi

if [ $link_size -gt 4 ] ; then

  echo "Failed to find internal link size"

  exit 1

fi

# All of 8-bit, 16-bit, and 32-bit character strings may be supported, but only

# one need be.

$sim ./pcretest -C pcre8 >/dev/null

support8=$?

$sim ./pcretest -C pcre16 >/dev/null

support16=$?

$sim ./pcretest -C pcre32 >/dev/null

support32=$?

# Initialize all bitsizes skipped

test8=skip

test16=skip

test32=skip

# If no bitsize arguments, select all that are available

if [ "$arg8$arg16$arg32" = "" ] ; then

  if [ $support8 -ne 0 ] ; then

    test8=

  fi

  if [ $support16 -ne 0 ] ; then

    test16=-16

  fi

  if [ $support32 -ne 0 ] ; then

    test32=-32

  fi

# Select requested bit sizes

else

  if [ "$arg8" = yes ] ; then

    if [ $support8 -eq 0 ] ; then

      echo "Cannot run 8-bit library tests: 8-bit library not compiled"

      exit 1

    fi

    test8=

  fi

  if [ "$arg16" = yes ] ; then

    if [ $support16 -eq 0 ] ; then

      echo "Cannot run 16-bit library tests: 16-bit library not compiled"

      exit 1

    fi

    test16=-16

  fi

  if [ "$arg32" = yes ] ; then

    if [ $support32 -eq 0 ] ; then

      echo "Cannot run 32-bit library tests: 32-bit library not compiled"

      exit 1

    fi

    test32=-32

  fi

fi

# UTF support always applies to all bit sizes if both are supported; we can't

# have UTF-8 support without UTF-16 support (for example).

$sim ./pcretest -C utf >/dev/null

utf=$?

$sim ./pcretest -C ucp >/dev/null

ucp=$?

jitopt=

$sim ./pcretest -C jit >/dev/null

jit=$?

if [ $jit -ne 0 ] ; then

  jitopt=-s+

fi

if [ $utf -eq 0 ] ; then

  if [ $do4 = yes ] ; then

    echo "Can't run test 4 because UTF support is not configured"

    exit 1

  fi

  if [ $do5 = yes ] ; then

    echo "Can't run test 5 because UTF support is not configured"

    exit 1

  fi

  if [ $do9 = yes ] ; then

    echo "Can't run test 8 because UTF support is not configured"

    exit 1

  fi

  if [ $do15 = yes ] ; then

    echo "Can't run test 15 because UTF support is not configured"

    exit 1

  fi

  if [ $do18 = yes ] ; then

    echo "Can't run test 18 because UTF support is not configured"

  fi

  if [ $do22 = yes ] ; then

    echo "Can't run test 22 because UTF support is not configured"

  fi

fi

if [ $ucp -eq 0 ] ; then

  if [ $do6 = yes ] ; then

    echo "Can't run test 6 because Unicode property support is not configured"

    exit 1

  fi

  if [ $do7 = yes ] ; then

    echo "Can't run test 7 because Unicode property support is not configured"

    exit 1

  fi

  if [ $do10 = yes ] ; then

    echo "Can't run test 10 because Unicode property support is not configured"

    exit 1

  fi

  if [ $do16 = yes ] ; then

    echo "Can't run test 16 because Unicode property support is not configured"

    exit 1

  fi

  if [ $do19 = yes ] ; then

    echo "Can't run test 19 because Unicode property support is not configured"

    exit 1

  fi

fi

if [ $link_size -ne 2 ] ; then

  if [ $do11 = yes ] ; then

    echo "Can't run test 11 because the link size ($link_size) is not 2"

    exit 1

  fi

fi

if [ $jit -eq 0 ] ; then

  if [ $do12 = "yes" ] ; then

    echo "Can't run test 12 because JIT support is not configured"

    exit 1

  fi

else

  if [ $do13 = "yes" ] ; then

    echo "Can't run test 13 because JIT support is configured"

    exit 1

  fi

fi

# If no specific tests were requested, select all. Those that are not

# relevant will be skipped.

if [ $do1  = no -a $do2  = no -a $do3  = no -a $do4  = no -a \

     $do5  = no -a $do6  = no -a $do7  = no -a $do8  = no -a \

     $do9  = no -a $do10 = no -a $do11 = no -a $do12 = no -a \

     $do13 = no -a $do14 = no -a $do15 = no -a $do16 = no -a \

     $do17 = no -a $do18 = no -a $do19 = no -a $do20 = no -a \

     $do21 = no -a $do22 = no -a $do23 = no -a $do24 = no -a \

     $do25 = no -a $do26 = no ] ; then

  do1=yes

  do2=yes

  do3=yes

  do4=yes

  do5=yes

  do6=yes

  do7=yes

  do8=yes

  do9=yes

  do10=yes

  do11=yes

  do12=yes

  do13=yes

  do14=yes

  do15=yes

  do16=yes

  do17=yes

  do18=yes

  do19=yes

  do20=yes

  do21=yes

  do22=yes

  do23=yes

  do24=yes

  do25=yes

  do26=yes

fi

# Show which release and which test data

echo ""

echo PCRE C library tests using test data from $testdata

$sim ./pcretest /dev/null

for bmode in "$test8" "$test16" "$test32"; do

  case "$bmode" in

    skip) continue;;

    -16)  if [ "$test8$test32" != "skipskip" ] ; then echo ""; fi

          bits=16; echo "---- Testing 16-bit library ----"; echo "";;

    -32)  if [ "$test8$test16" != "skipskip" ] ; then echo ""; fi

          bits=32; echo "---- Testing 32-bit library ----"; echo "";;

    *)    bits=8; echo "---- Testing 8-bit library ----"; echo "";;

  esac

# Primary test, compatible with JIT and all versions of Perl >= 5.8

if [ $do1 = yes ] ; then

  echo $title1

  for opt in "" "-s" $jitopt; do

    $sim $valgrind ./pcretest -q $bmode $opt $testdata/testinput1 testtry

    if [ $? = 0 ] ; then

      $cf $testdata/testoutput1 testtry

      if [ $? != 0 ] ; then exit 1; fi

    else exit 1

    fi

    if [ "$opt" = "-s" ] ; then echo "  OK with study"

    elif [ "$opt" = "-s+" ] ; then echo "  OK with JIT study"

    else echo "  OK"

    fi

  done

fi

# PCRE tests that are not JIT or Perl-compatible: API, errors, internals

if [ $do2 = yes ] ; then

  echo $title2 "(not UTF-$bits)"

  for opt in "" "-s" $jitopt; do

    $sim $valgrind ./pcretest -q $bmode $opt $testdata/testinput2 testtry

    if [ $? = 0 ] ; then

      $cf $testdata/testoutput2 testtry

      if [ $? != 0 ] ; then exit 1; fi

    else

      echo " "

      echo "** Test 2 requires a lot of stack. If it has crashed with a"

      echo "** segmentation fault, it may be that you do not have enough"

      echo "** stack available by default. Please see the 'pcrestack' man"

      echo "** page for a discussion of PCRE's stack usage."

      echo " "

      exit 1

    fi

    if [ "$opt" = "-s" ] ; then echo "  OK with study"

    elif [ "$opt" = "-s+" ] ; then echo "  OK with JIT study"

    else echo "  OK"

    fi

  done

fi

# Locale-specific tests, provided that either the "fr_FR" or the "french"

# locale is available. The former is the Unix-like standard; the latter is

# for Windows. Another possibility is "fr", which needs to be run against

# the Windows-specific input and output files.

if [ $do3 = yes ] ; then

  locale -a | grep '^fr_FR$' >/dev/null

  if [ $? -eq 0 ] ; then

    locale=fr_FR

    infile=$testdata/testinput3

    outfile=$testdata/testoutput3

  else

    infile=test3input

    outfile=test3output

    locale -a | grep '^french$' >/dev/null

    if [ $? -eq 0 ] ; then

      locale=french

      sed 's/fr_FR/french/' $testdata/testinput3 >test3input

      sed 's/fr_FR/french/' $testdata/testoutput3 >test3output

    else

      locale -a | grep '^fr$' >/dev/null

      if [ $? -eq 0 ] ; then

        locale=fr

        sed 's/fr_FR/fr/' $testdata/wintestinput3 >test3input

        sed 's/fr_FR/fr/' $testdata/wintestoutput3 >test3output

      else

        locale=

      fi

    fi

  fi

  if [ "$locale" != "" ] ; then

    echo $title3 "(using '$locale' locale)"

    for opt in "" "-s" $jitopt; do

      $sim $valgrind ./pcretest -q $bmode $opt $infile testtry

      if [ $? = 0 ] ; then

        $cf $outfile testtry

        if [ $? != 0 ] ; then

          echo " "

          echo "Locale test did not run entirely successfully."

          echo "This usually means that there is a problem with the locale"

          echo "settings rather than a bug in PCRE."

          break;

        else

          if [ "$opt" = "-s" ] ; then echo "  OK with study"

          elif [ "$opt" = "-s+" ] ; then echo "  OK with JIT study"

          else echo "  OK"

          fi

        fi

      else exit 1

      fi

    done

  else

    echo "Cannot test locale-specific features - none of the 'fr_FR', 'fr' or"

    echo "'french' locales exist, or the \"locale\" command is not available"

    echo "to check for them."

    echo " "

  fi

fi

# Additional tests for UTF support

if [ $do4 = yes ] ; then

  echo ${title4A}-${bits}${title4B}

  if [ $utf -eq 0 ] ; then

    echo "  Skipped because UTF-$bits support is not available"

  else

    for opt in "" "-s" $jitopt; do

      $sim $valgrind ./pcretest -q $bmode $opt $testdata/testinput4 testtry

      if [ $? = 0 ] ; then

        $cf $testdata/testoutput4 testtry

        if [ $? != 0 ] ; then exit 1; fi

      else exit 1

      fi

      if [ "$opt" = "-s" ] ; then echo "  OK with study"

      elif [ "$opt" = "-s+" ] ; then echo "  OK with JIT study"

      else echo "  OK"

      fi

    done

  fi

fi

if [ $do5 = yes ] ; then

  echo ${title5}-${bits} support

  if [ $utf -eq 0 ] ; then

    echo "  Skipped because UTF-$bits support is not available"

  else

    for opt in "" "-s" $jitopt; do

      $sim $valgrind ./pcretest -q $bmode $opt $testdata/testinput5 testtry

      if [ $? = 0 ] ; then

        $cf $testdata/testoutput5 testtry

        if [ $? != 0 ] ; then exit 1; fi

      else exit 1

      fi

      if [ "$opt" = "-s" ] ; then echo "  OK with study"

      elif [ "$opt" = "-s+" ] ; then echo "  OK with JIT study"

      else echo "  OK"

      fi

    done

  fi

fi

if [ $do6 = yes ] ; then

  echo $title6

  if [ $utf -eq 0 -o $ucp -eq 0 ] ; then

    echo "  Skipped because Unicode property support is not available"

  else

    for opt in "" "-s" $jitopt; do

      $sim $valgrind ./pcretest -q $bmode $opt $testdata/testinput6 testtry

      if [ $? = 0 ] ; then

        $cf $testdata/testoutput6 testtry

        if [ $? != 0 ] ; then exit 1; fi