tests/cavern.tst

   1 #!/bin/sh
   2 #
   3 # Survex test suite - cavern tests
   4 # Copyright (C) 1999-2024 Olly Betts
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19
  20 testdir=`echo $0 | sed 's!/[^/]*$!!' || echo '.'`
  21
  22 test -x "$testdir"/../src/cavern || testdir=.
  23
  24 # Make testdir absolute, so we can cd before running cavern to get a consistent
  25 # path in diagnostic messages.
  26 testdir=`cd "$testdir" && pwd`
  27
  28 # allow us to run tests standalone more easily
  29 : ${srcdir="$testdir"}
  30 if [ -z "$SURVEXLIB" ] ; then
  31   SURVEXLIB=`cd "$srcdir/../lib" && pwd`
  32   export SURVEXLIB
  33 fi
  34
  35 # force VERBOSE if we're run on a subset of tests
  36 test -n "$*" && VERBOSE=1
  37
  38 case `uname -a` in
  39   MINGW*)
  40     DIFF='diff --strip-trailing-cr'
  41     QUIET_DIFF='diff -q --strip-trailing-cr'
  42     ;;
  43   *)
  44     DIFF=diff
  45     # Use cmp when we can as a small optimisation.
  46     QUIET_DIFF='cmp -s'
  47     ;;
  48 esac
  49
  50 : ${CAVERN="$testdir"/../src/cavern}
  51 : ${DIFFPOS="$testdir"/../src/diffpos}
  52 : ${DUMP3D="$testdir"/../src/dump3d}
  53 : ${SURVEXPORT="$testdir"/../src/survexport}
  54
  55 : ${TESTS=${*:-"singlefix singlereffix oneleg midpoint noose cross firststn\
  56  deltastar deltastar2 bug3 calibrate_tape nosurvey2 cartesian cartesian2\
  57  lengthunits angleunits cmd_alias cmd_alias_bad cmd_truncate cmd_truncate_bad\
  58  cmd_case cmd_case_bad cmd_fix\
  59  cmd_solve cmd_entrance cmd_entrance_bad cmd_sd cmd_sd_bad cmd_fix_bad cmd_set\
  60  cmd_set_bad cmd_set_dot_in_name\
  61  beginroot revcomplist break_replace_pfx bug0 bug1 bug2 bug4 bug5\
  62  expobug require export export2 includecomment\
  63  self_loop self_eq_loop reenterwarn cmd_default cmd_default_bad\
  64  cmd_prefix cmd_prefix_bad\
  65  cmd_begin_bad cmd_equate_bad cmd_export_bad\
  66  singlefixerr singlereffixerr\
  67  begin_no_end end_no_begin end_no_begin_nest require_fail\
  68  exporterr1 exporterr2 exporterr3 exporterr4 exporterr5\
  69  exporterr1b exporterr2b exporterr3b exporterr6 exporterr6b\
  70  hanging_cpt badinc badinc2 badinc3 badinc4 badinc5.mak nonexistent_file ONELEG\
  71  stnsurvey1 stnsurvey2\
  72  tapelessthandepth longname chinabug chinabug2\
  73  multinormal multinormignall multidiving multicylpolar multicartesian\
  74  multinosurv multinormalbad multibug\
  75  cmd_title cmd_titlebad cmd_dummy cmd_infer cmd_date cmd_datebad cmd_datebad2\
  76  cartes diving cylpolar normal normal_bad normignall nosurv cmd_flags\
  77  bad_cmd_flags plumb unusedstation exportnakedbegin oldestyle bugdz\
  78  baddatacylpolar badnewline badquantities imgoffbyone infereqtopofil 3sdfixbug\
  79  omitclino back back2 bad_back\
  80  notentranceorexport inferunknown inferexports bad_units_factor\
  81  bad_units_qlist\
  82  percent_gradient dotinsurvey leandroclino lowsd revdir gettokennullderef\
  83  nosurveyhanging nosurveyhanging2\
  84  cmd_solve_nothing cmd_solve_nothing_implicit\
  85  cmd_cartesian cmd_cartesian_bad\
  86  cmd_calibrate cmd_declination cmd_declination_auto cmd_declination_auto_bad\
  87  cmd_declination_conv cmd_declination_conv_proj_bug\
  88  lech level 2fixbug dot17 3dcorner\
  89  unconnected-bug\
  90  backread.dat corrections.dat depthguage.dat flags.dat karstcompat.dat\
  91  lrud.dat nomeasure.dat noteam.dat\
  92  badmak.mak\
  93  fixfeet.mak utm.mak\
  94  clptest.dat clptest.clp\
  95  walls.srv\
  96  badopts.srv\
  97  wallsbaddatum.wpj\
  98  wallsdecl.wpj\
  99  passage hanging_lrud equatenosuchstn surveytypo\
 100  skipafterbadomit passagebad badreadingdotplus badcalibrate calibrate_clino\
 101  badunits badbegin anonstn anonstnbad anonstnrev doubleinc reenterlots\
 102  cs csbad csbadsdfix csfeet cslonglat omitfixaroundsolve repeatreading\
 103  mixedeols utf8bom nonewlineateof suspectreadings cmd_data_default\
 104  cmd_data_ignore\
 105  quadrant_bearing bad_quadrant_bearing\
 106  samename tabinhighlight legacytokens\
 107  component_count_bug component_count_bug2\
 108  3dexport \
 109  dxffullcoords dxfsurfequate\
 110  gpxexport hpglexport jsonexport kmlexport pltexport svgexport\
 111 "}}
 112
 113 # Test file stnsurvey3.svx missing: pos=fail # We exit before the error count.
 114
 115 LC_ALL=C
 116 export LC_ALL
 117 SURVEXLANG=en
 118 export SURVEXLANG
 119
 120 # Suppress checking for leaks on exit if we're build with lsan - we don't
 121 # generally waste effort to free all allocations as the OS will reclaim
 122 # memory on exit.
 123 LSAN_OPTIONS=leak_check_at_exit=0
 124 export LSAN_OPTIONS
 125
 126 # Allow datestamps in 3d files (we normalise the expected output for GPX
 127 # etc) to allow for the datestamp not being fixed, but under SOURCE_DATE_EPOCH
 128 # the datestamp is omitted entirely which would break those testcases.
 129 unset SOURCE_DATE_EPOCH
 130
 131 vg_error=123
 132 vg_log=$testdir/vg.log
 133 if [ -n "$VALGRIND" ] ; then
 134   rm -f "$vg_log"
 135   CAVERN="$VALGRIND --log-file=$vg_log --error-exitcode=$vg_error $CAVERN"
 136   DIFFPOS="$VALGRIND --log-file=$vg_log --error-exitcode=$vg_error $DIFFPOS"
 137   DUMP3D="$VALGRIND --log-file=$vg_log --error-exitcode=$vg_error $DUMP3D"
 138   SURVEXPORT="$VALGRIND --log-file=$vg_log --error-exitcode=$vg_error $SURVEXPORT"
 139 fi
 140
 141 for file in $TESTS ; do
 142   case $file in
 143     nonexistent_file*|ONELEG)
 144       # ONELEG tests that we don't apply special handling to command line
 145       # arguments, only those in *include.
 146       realfile= ;;
 147     *.*) realfile=$srcdir/$file ;;
 148     *) realfile=$srcdir/$file.svx ;;
 149   esac
 150
 151   if [ x"$file" = xONELEG ] && [ -f "ONELEG.SVX" ] ; then
 152     echo "Case insensitive filing system - skipping ONELEG testcase"
 153     continue
 154   fi
 155
 156   if [ -n "$realfile" ] && [ ! -r "$realfile" ] ; then
 157     echo "Don't know how to run test '$file'"
 158     exit 1
 159   fi
 160
 161   echo "$file"
 162
 163   # how many warnings to expect (or empty not to check)
 164   warn=
 165
 166   # how many errors to expect (or empty not to check)
 167   error=
 168
 169   # One of:
 170   # yes : diffpos 3D file output with <testcase_name>.pos
 171   # no : Check that a 3D file is produced, but not positions in it
 172   # fail : Check that a 3D file is NOT produced
 173   # 3d : Convert to 3D with survexport, compare dump3d to <testcase_name>.dump
 174   # dxf : Convert to DXF with survexport and compare with <testcase_name>.dxf
 175   # gpx : Convert to GPX with survexport and compare with <testcase_name>.gpx
 176   # json : Convert to JSON with survexport and compare with <testcase_name>.json
 177   # kml : Convert to KML with survexport and compare with <testcase_name>.kml
 178   # plt : Convert to PLT with survexport and compare with <testcase_name>.plt
 179   # svg : Convert to SVG with survexport and compare with <testcase_name>.svg
 180   pos=
 181
 182   case $file in
 183     backread.dat|clptest.dat|clptest.clp|depthguage.dat|karstcompat.dat)
 184       pos=dump
 185       warn=0
 186       ;;
 187     flags.dat)
 188       pos=dump
 189       warn=1
 190       ;;
 191     *.dat)
 192       # .dat files can't start with a comment.  All the other .dat tests
 193       # have the same settings.
 194       pos=yes
 195       warn=0
 196       ;;
 197     nonexistent_file*|ONELEG)
 198       # These testcase files don't exist (or for ONELEG exist with a different
 199       # case).  They all have the same settings.
 200       pos=fail
 201       ;;
 202     wallsbaddatum.wpj)
 203       # .wpj files can't start with a comment.
 204       pos=fail
 205       warn=0
 206       err=1
 207       ;;
 208     *.wpj)
 209       # .wpj files can't start with a comment.
 210       pos=dump
 211       warn=0
 212       ;;
 213     *)
 214       survexportopts=
 215       read header < "$realfile"
 216       set dummy $header
 217       while shift && [ -n "$1" ] ; do
 218         case $1 in
 219           pos=*) pos=`expr "$1" : 'pos=\(.*\)'` ;;
 220           warn=*) warn=`expr "$1" : 'warn=\(.*\)'` ;;
 221           error=*) error=`expr "$1" : 'error=\(.*\)'` ;;
 222           survexportopt=*)
 223             survexportopts="$survexportopts "`expr "$1" : 'survexportopt=\(.*\)'`
 224             ;;
 225         esac
 226       done
 227       ;;
 228   esac
 229
 230   basefile=$srcdir/$file
 231   case $file in
 232   *.*)
 233     input="./$file"
 234     basefile=`echo "$basefile"|sed 's/\.[^.]*$//'` ;;
 235   *)
 236     input="./$file.svx" ;;
 237   esac
 238   outfile=$basefile.out
 239   outfile2=$basefile.altout
 240   posfile=$basefile.pos
 241   rm -f tmp.*
 242   pwd=`pwd`
 243   cd "$srcdir"
 244   srcdir=. SOURCE_DATE_EPOCH=1 $CAVERN "$input" --output="$pwd/tmp" > "$pwd/tmp.out"
 245   exitcode=$?
 246   cd "$pwd"
 247   test -n "$VERBOSE" && cat tmp.out
 248   if [ -n "$VALGRIND" ] ; then
 249     if [ $exitcode = "$vg_error" ] ; then
 250       cat "$vg_log"
 251       rm "$vg_log"
 252       exit 1
 253     fi
 254     rm "$vg_log"
 255   fi
 256   if test fail = "$pos" ; then
 257     # success gives 0, signal (128 + <signal number>)
 258     test $exitcode = 1 || exit 1
 259   else
 260     test $exitcode = 0 || exit 1
 261   fi
 262   if test -n "$warn" ; then
 263     w=`sed '$!d;s/^There were \([0-9]*\).*/\1/p;d' tmp.out`
 264     if test x"${w:-0}" != x"$warn" ; then
 265       test -n "$VERBOSE" && echo "Got $w warnings, expected $warn"
 266       exit 1
 267     fi
 268   fi
 269   if test -n "$error" ; then
 270     e=`sed '$!d;s/^There were .* and \([0-9][0-9]*\).*/\1/p;d' tmp.out`
 271     if test x"${e:-0}" != x"$error" ; then
 272       test -n "$VERBOSE" && echo "Got $e errors, expected $error"
 273       exit 1
 274     fi
 275   fi
 276   # Fail if nan, NaN, etc in output (which might be followed by m for metres or
 277   # s for seconds).
 278   if egrep -q '(^|[^A-Za-z0-9])nan[ms]?($|[^A-Za-z0-9])' tmp.out ; then
 279     echo "Not-a-number appears in output"
 280     exit 1
 281   fi
 282
 283   case $pos in
 284   yes)
 285     if test -n "$VERBOSE" ; then
 286       $DIFFPOS "$posfile" tmp.3d
 287       exitcode=$?
 288     else
 289       $DIFFPOS "$posfile" tmp.3d > /dev/null
 290       exitcode=$?
 291     fi
 292     if [ -n "$VALGRIND" ] ; then
 293       if [ $exitcode = "$vg_error" ] ; then
 294         cat "$vg_log"
 295         rm "$vg_log"
 296         exit 1
 297       fi
 298       rm "$vg_log"
 299     fi
 300     [ "$exitcode" = 0 ] || exit 1
 301     ;;
 302   dump)
 303     expectedfile=$basefile.dump
 304     tmpfile=tmp.dump
 305     $DUMP3D --show-dates --legs tmp.3d > "$tmpfile"
 306     exitcode=$?
 307     if [ -n "$VALGRIND" ] ; then
 308       if [ $exitcode = "$vg_error" ] ; then
 309         cat "$vg_log"
 310         rm "$vg_log"
 311         exit 1
 312       fi
 313       rm "$vg_log"
 314     fi
 315     [ "$exitcode" = 0 ] || exit 1
 316
 317     if test -n "$VERBOSE" ; then
 318       $DIFF "$expectedfile" "$tmpfile" || exit 1
 319     else
 320       $QUIET_DIFF "$expectedfile" "$tmpfile" || exit 1
 321     fi
 322     ;;
 323   dxf|gpx|hpgl|json|kml|plt|svg)
 324     # $pos gives us the file extension here.
 325     expectedfile=$basefile.$pos
 326     tmpfile=tmp.$pos
 327     if test -n "$VERBOSE" ; then
 328       $SURVEXPORT --defaults$survexportopts tmp.3d "$tmpfile"
 329       exitcode=$?
 330     else
 331       $SURVEXPORT --defaults$survexportopts tmp.3d "$tmpfile" > /dev/null
 332       exitcode=$?
 333     fi
 334     if [ -n "$VALGRIND" ] ; then
 335       if [ $exitcode = "$vg_error" ] ; then
 336         cat "$vg_log"
 337         rm "$vg_log"
 338         exit 1
 339       fi
 340       rm "$vg_log"
 341     fi
 342     [ "$exitcode" = 0 ] || exit 1
 343
 344     # Normalise exported file if required.
 345     case $pos in
 346       dxf)
 347         # On x86 excess precision can result in -0.00 for some coordinates.
 348         sed 's/-0\.00\>/ 0.00/g' < "$tmpfile" > tmp.tmp
 349         mv tmp.tmp "$tmpfile"
 350         ;;
 351       json)
 352         # On x86 excess precision can result in -0.00 for some coordinates.
 353         sed 's/-0\.00\>/0.00/g' < "$tmpfile" > tmp.tmp
 354         mv tmp.tmp "$tmpfile"
 355         ;;
 356       gpx)
 357         sed 's,<time>[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]Z</time>,<time>REDACTED</time>,;s,survex [0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*,survex REDACTED,' < "$tmpfile" > tmp.tmp
 358         mv tmp.tmp "$tmpfile"
 359         ;;
 360     esac
 361
 362     if test -n "$VERBOSE" ; then
 363       $DIFF "$expectedfile" "$tmpfile" || exit 1
 364     else
 365       $QUIET_DIFF "$expectedfile" "$tmpfile" || exit 1
 366     fi
 367     ;;
 368   3d)
 369     expectedfile=$basefile.dump
 370     tmpfile=tmp.dump
 371     if test -n "$VERBOSE" ; then
 372       SOURCE_DATE_EPOCH=1 $SURVEXPORT --defaults$survexportopts tmp.3d "$tmpfile.3d"
 373       exitcode=$?
 374     else
 375       SOURCE_DATE_EPOCH=1 $SURVEXPORT --defaults$survexportopts tmp.3d "$tmpfile.3d" > /dev/null
 376       exitcode=$?
 377     fi
 378     $DUMP3D --show-dates --legs "$tmpfile.3d" > "$tmpfile"
 379     if [ -n "$VALGRIND" ] ; then
 380       if [ $exitcode = "$vg_error" ] ; then
 381         cat "$vg_log"
 382         rm "$vg_log"
 383         exit 1
 384       fi
 385       rm "$vg_log"
 386     fi
 387     [ "$exitcode" = 0 ] || exit 1
 388
 389     if test -n "$VERBOSE" ; then
 390       $DIFF "$expectedfile" "$tmpfile" || exit 1
 391     else
 392       $QUIET_DIFF "$expectedfile" "$tmpfile" || exit 1
 393     fi
 394     ;;
 395   no)
 396     test -f tmp.3d || exit 1 ;;
 397   fail)
 398     test -f tmp.3d && exit 1
 399     # Check that last line doesn't contains "Bug in program detected"
 400     case `tail -n 1 tmp.out` in
 401     *"Bug in program detected"*) exit 1 ;;
 402     esac ;;
 403   *)
 404     echo "Bad value for pos: '$pos'" ; exit 1 ;;
 405   esac
 406
 407   if test -f "$outfile" ; then
 408     # Version and time used info from output, working around Apple's stone-age
 409     # sed.
 410     sed '1,/^Copyright/d;/^\(CPU \)*[Tt]ime used  *[0-9][0-9.]*s$/d;s!.*/src/\(cavern: \)!\1!' tmp.out > tmp.out2
 411     mv tmp.out2 tmp.out
 412     # Check output is as expected.
 413     if $QUIET_DIFF "$outfile" tmp.out ; then
 414       : # Matches.
 415     elif [ -f "$outfile2" ] && $QUIET_DIFF "$outfile2" tmp.out ; then
 416       : # Matches alternative output (e.g. due to older PROJ).
 417     else
 418       test -z "$VERBOSE" || $DIFF "$outfile" tmp.out
 419       exit 1
 420     fi
 421   fi
 422   rm -f tmp.*
 423 done
 424 test -n "$VERBOSE" && echo "Test passed"
 425 exit 0