tests/run_tests.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2003, 2004, 2005, 2006, 2007, 2009, 2010, 2017 Dan McMahill
   4
   5 #  This program is free software; you can redistribute it and/or modify
   6 #  it under the terms of version 2 of the GNU General Public License as
   7 #  published by the Free Software Foundation
   8 #
   9 #  This program is distributed in the hope that it will be useful,
  10 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 #  GNU General Public License for more details.
  13 #
  14 #  You should have received a copy of the GNU General Public License
  15 #  along with this program; if not, write to the Free Software
  16 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  17 #  MA 02110-1301 USA.
  18 #
  19 # All rights reserved.
  20 #
  21 # This code was derived from code written by Dan McMahill as part of the
  22 # latex-mk testsuite.  The original code was covered by a BSD license
  23 # but the copyright holder (Dan McMahill) has re-released the code under
  24 # the GPL.
  25
  26 magic_test_skip=${PCB_MAGIC_TEST_SKIP:-no}
  27
  28 if test "x${magic_test_skip}" = "xyes" ; then
  29         cat << EOF
  30
  31 The environment variable PCB_MAGIC_TEST_SKIP is set to yes.
  32 This causes the testsuite to skip all tests and report no errors.
  33 This is used for certain debugging *only*.  The primary use is to
  34 allow testing of the 'distcheck' target without including the effects
  35 of the testsuite. The reason this is useful is that due to minor differences
  36 in library versions and perhaps roundoff in different CPU's, the testsuite
  37 may falsely report failures on some systems.  These reported failures
  38 prevent using 'distcheck' for verifying the rest of the build system.
  39 These comments only apply to the tests which try to compare image files
  40 like PNG files.
  41
  42 EOF
  43
  44         exit 0
  45 fi
  46
  47 regen=no
  48
  49 usage() {
  50 cat <<EOF
  51
  52 $0 -- Run pcb regression tests
  53
  54 $0 -h|--help
  55 $0 [-d | --debug] [-g | --golden dir] [-r|--regen] [testname1 [testname2[ ...]]]
  56
  57 OVERVIEW
  58
  59 The $0 script is used both for running the pcb regression testsuite
  60 as well as maintaining it.  The way the test suite works is a number
  61 of different layouts are exported using the various export HID's.
  62
  63 The resulting output files are examined in various ways to make sure
  64 they are correct.  The exact details of how they are compared varies.
  65 For example, the PNG outputs are compared using tools from the ImageMagick
  66 suite while the ASCII centroid and bill of materials files are normalized
  67 with awk and then compared with the standard diff utility.  The normalization
  68 removes things like a comment line which contains the creation date.
  69
  70 OPTIONS
  71
  72 -d | --debug              Enables extra debug output
  73
  74 -g | --golden <dir>    :  Specifies that <dir> should be used for the
  75                           reference files.
  76
  77 -r | --regen           :  Specifies that the results should be taken as new
  78                           reference files instead of comparing them to the
  79                           existing ones.
  80
  81 LIMITATIONS
  82
  83 - The GUI interface is not checked via the regression testsuite.
  84
  85 EOF
  86 }
  87
  88 show_sep() {
  89     echo "----------------------------------------------------------------------"
  90 }
  91
  92 ##########################################################################
  93 #
  94 # debug print out
  95 #
  96
  97 do_debug=no
  98 debug() {
  99     if test $do_debug = yes ; then
 100         cat <<EOF
 101 $*
 102 EOF
 103     fi
 104 }
 105
 106 ##########################################################################
 107 #
 108 # command line processing
 109 #
 110
 111
 112 all_tests=""
 113 while test -n "$1"
 114   do
 115   case "$1"
 116       in
 117
 118       -d|--debug)
 119           do_debug=yes
 120           shift
 121           ;;
 122
 123       -h|--help)
 124           usage
 125           exit 0
 126           ;;
 127
 128       -g|--golden)
 129         # set the 'golden' directory.
 130           REFDIR="$2"
 131           shift 2
 132           ;;
 133
 134       -r|--regen)
 135         # regenerate the 'golden' output files.  Use this with caution.
 136         # In particular, all differences should be noted and understood.
 137           regen=yes
 138           shift
 139           ;;
 140
 141       -*)
 142           echo "unknown option: $1"
 143           exit 1
 144           ;;
 145
 146       *)
 147           break
 148           ;;
 149
 150   esac
 151 done
 152
 153 if test "X$regen" = "Xyes" && test $# -ne 1; then
 154     echo "Please regenerate only one test at a time."
 155     echo "This limitation is a safety measure."
 156     exit 1
 157 fi
 158
 159 ##########################################################################
 160 #
 161 # set up various tools
 162 #
 163
 164
 165 all_tests="$*"
 166
 167 # Source directory
 168 srcdir=${srcdir:-.}
 169 top_srcdir=${top_srcdir:-.}
 170
 171 # The pcb wrapper script we want to test
 172 #
 173 # by default we will be running it from $(srcdir)/runs/testname
 174 # so we need to look 3 levels up and then down to src
 175 if test "X${WIN32}" = "Xyes" ; then
 176         PCB=${PCB:-../../../src/pcbtest.bat}
 177 else
 178         PCB=${PCB:-../../../src/pcbtest.sh}
 179 fi
 180
 181 # The gerbv executible
 182 GERBV=${GERBV:-gerbv}
 183 GERBV_DEFAULT_FLAGS=${GERBV_DEFAULT_FLAGS:---export=png --window=640x480}
 184
 185 # various ImageMagick tools
 186 IM_ANIMATE=${IM_ANIMATE:-animate}
 187 IM_COMPARE=${IM_COMPARE:-compare}
 188 IM_COMPOSITE=${IM_COMPOSITE:-composite}
 189 IM_CONVERT=${IM_CONVERT:-convert}
 190 IM_DISPLAY=${IM_DISPLAY:-display}
 191 IM_MONTAGE=${IM_MONTAGE:-montage}
 192
 193 # xhost program to check for a working display
 194 XHOST=${XHOST:-xhost}
 195
 196 # golden directories
 197 INDIR=${INDIR:-${srcdir}/inputs}
 198 OUTDIR=outputs
 199 REFDIR=${REFDIR:-${srcdir}/golden}
 200
 201 # some system tools
 202 AWK=${AWK:-awk}
 203
 204 # the list of tests to run
 205 TESTLIST=${srcdir}/tests.list
 206
 207 if test "X$regen" = "Xyes" ; then
 208     OUTDIR="${REFDIR}"
 209 fi
 210
 211 # create output directory
 212 if test ! -d $OUTDIR ; then
 213     mkdir -p $OUTDIR
 214     if test $? -ne 0 ; then
 215         echo "Failed to create output directory ${OUTDIR}"
 216         exit 1
 217     fi
 218 fi
 219
 220 if test ! -f ${TESTLIST} ; then
 221   echo "ERROR: ($0)  Test list $TESTLIST does not exist"
 222   exit 1
 223 fi
 224
 225 # Read the file, and remove any escaped newlines.
 226 # Here's the low down on this sed program:
 227 #   :x             create a label "x"
 228 #   /\\\\$/        match a "\" at the end of a line
 229 #   N              add the next line to the buffer
 230 #   s/\\\\\n/ /g   replace the escaped newlines with spaces
 231 #   bx             jump back to label "x"
 232 #
 233 TESTFILESTRING=`sed -e':x
 234                  /\\\\$/ { N
 235                            s/\\\\\n/ /g
 236                            bx
 237                          }'  $TESTLIST`
 238
 239 if test -z "$all_tests" ; then
 240     all_tests=`echo "${TESTFILESTRING}" \
 241                | ${AWK} 'BEGIN{FS="|"} /^#/{next} {print $1}'\
 242                | sed 's; ;;g'`
 243 fi
 244
 245 if test -z "${all_tests}" ; then
 246     echo "$0:  No tests specified"
 247     exit 0
 248 else
 249     echo "Tests to be executed: ${all_tests}"
 250 fi
 251
 252
 253 # check if we have a working display.  Without it we will
 254 # fail the action script checks unless pcb was built as
 255 # batch HID.   I'm open to suggestions on improving
 256 # the robustness of this check
 257
 258 echo "Checking for working X display"
 259 ${XHOST} >/dev/null 2>&1
 260 rc=$?
 261 if test $rc -eq 0 ; then
 262         have_display=yes
 263         echo "yes"
 264 else
 265         have_display=no
 266         echo "no.  Certain tests will be skipped."
 267 fi
 268
 269 # fail/pass/total counts
 270 fail=0
 271 pass=0
 272 skip=0
 273 tot=0
 274
 275 ##########################################################################
 276 #
 277 # config summary
 278 #
 279
 280
 281 cat << EOF
 282
 283 srcdir                ${srcdir}
 284 top_srcdir            ${top_srcdir}
 285
 286 AWK                   ${AWK}
 287 PCB                   ${PCB}
 288 INDIR                 ${INDIR}
 289 OUTDIR                ${OUTDIR}
 290 REFDIR                ${REFDIR}
 291 TESTLIST              ${TESTLIST}
 292
 293 Gerbv:
 294
 295 GERBV                 ${GERBV}
 296 GERBV_DEFAULT_FLAGS   ${GERBV_DEFAULT_FLAGS}
 297
 298 ImageMagick Tools:
 299
 300 IM_ANIMATE               ${IM_ANIMATE}
 301 IM_COMPARE               ${IM_COMPARE}
 302 IM_COMPOSITE             ${IM_COMPOSITE}
 303 IM_CONVERT               ${IM_CONVERT}
 304 IM_DISPLAY               ${IM_DISPLAY}
 305 IM_MONTAGE               ${IM_MONTAGE}
 306
 307 Working Display (for Action tests):
 308
 309 have_display             ${have_display}
 310
 311 EOF
 312
 313 tmpd=/tmp/pcb_tests.$$
 314 mkdir -p -m 0700 $tmpd
 315 rc=$?
 316 if test $rc -ne 0 ; then
 317     echo "$0:  ERROR:  could not create $tmpd"
 318     exit 1
 319 fi
 320
 321 ##########################################################################
 322 #
 323 # utility functions for comparison
 324 #
 325
 326 # Usage:
 327 #  compare_check "test_name" "file1" "file2"
 328 #
 329 # Makes sure that file1 and file2 both exist.  If not, mark the current
 330 # test as skipped and give an error message
 331 #
 332 compare_check() {
 333     local fn="$1"
 334     local f1="$2"
 335     local f2="$3"
 336
 337     debug "checking for $f1"
 338     if test ! -f "$f1" ; then
 339         echo "$0:  ${fn}(): $f1 does not exist"
 340         test_skipped=yes
 341         return 1
 342     fi
 343
 344     debug "checking for $f2"
 345     if test ! -f "$f2" ; then
 346         echo "$0:  ${fn}(): $f2 does not exist"
 347         test_skipped=yes
 348         return 1
 349     fi
 350     return 0
 351 }
 352
 353 ##########################################################################
 354 #
 355 # ASCII file comparison routines
 356 #
 357
 358 # Usage:
 359 #   run_diff "file1" "file2"
 360 #
 361 run_diff() {
 362     local f1="$1"
 363     local f2="$2"
 364     diff -U 2 $f1 $f2
 365     if test $? -ne 0 ; then return 1 ; fi
 366     return 0
 367 }
 368
 369
 370 compare_ascii() {
 371     local f1="$1"
 372     local f2="$2"
 373     compare_check "compare_ascii" "$f1" "$f2" || return 1
 374     run_diff $f1 $f2 || test_failed=yes
 375 }
 376
 377 ##########################################################################
 378 #
 379 # BOM comparison routines
 380 #
 381
 382 # used to remove things like creation date from BOM files
 383 normalize_bom() {
 384     local f1="$1"
 385     local f2="$2"
 386     $AWK '
 387         /^# Date:/ {print "# Date: today"; next}
 388         /^# Author:/ {print "# Author: PCB"; next}
 389         {print}' \
 390         $f1 > $f2
 391 }
 392
 393 # top level function to compare BOM output
 394 compare_bom() {
 395     local f1="$1"
 396     local f2="$2"
 397     compare_check "compare_bom" "$f1" "$f2" || return 1
 398
 399     # an example BOM file is:
 400
 401     #  # PcbBOM Version 1.0
 402     #  # Date: Wed Jun 17 14:41:43 2009 UTC
 403     #  # Author: Dan McMahill
 404     #  # Title: Basic BOM/XY Test - PCB BOM
 405     #  # Quantity, Description, Value, RefDes
 406     #  # --------------------------------------------
 407     #  8,"Standard SMT resistor, capacitor etc","RESC3216N",R90_TOP R180_TOP R270_TOP R0_TOP R270_BOT R180_BOT R90_BOT R0_BOT
 408     #  8,"Dual in-line package, narrow (300 mil)","DIP8",UDIP90_TOP UDIP180_TOP UDIP270_TOP UDIP0_TOP UDIP270_BOT UDIP180_BOT UDIP90_BOT UDIP0_BOT
 409     #  8,"Small outline package, narrow (150mil)","SO8",USO90_TOP USO180_TOP USO270_TOP USO0_TOP USO270_BOT USO180_BOT USO90_BOT USO0_BOT
 410
 411     #  For comparison, we need to ignore changes in the Date and Author lines.
 412     local cf1=${tmpd}/`basename $f1`-ref
 413     local cf2=${tmpd}/`basename $f2`-out
 414
 415     normalize_bom $f1 $cf1
 416     normalize_bom $f2 $cf2
 417     run_diff $cf1 $cf2 || test_failed=yes
 418 }
 419
 420 ##########################################################################
 421 #
 422 # X-Y (centroid) comparison routines
 423 #
 424
 425 # used to remove things like creation date from BOM files
 426 normalize_xy() {
 427     local f1="$1"
 428     local f2="$2"
 429     $AWK '
 430         /^# Date:/ {print "# Date: today"; next}
 431         /^# Author:/ {print "# Author: PCB"; next}
 432         {print}' \
 433         $f1 > $f2
 434 }
 435
 436 compare_xy() {
 437     local f1="$1"
 438     local f2="$2"
 439     compare_check "compare_xy" "$f1" "$f2" || return 1
 440
 441     local cf1=${tmpd}/`basename $f1`-ref
 442     local cf2=${tmpd}/`basename $f2`-out
 443     normalize_xy "$f1" "$cf1"
 444     normalize_xy "$f2" "$cf2"
 445     run_diff "$cf1" "$cf2" || test_failed=yes
 446 }
 447
 448 ##########################################################################
 449 #
 450 # BOM_MD comparison routines
 451 #
 452
 453 # used to remove things like creation date from BOM_MD files
 454 normalize_bom_md() {
 455     local f1="$1"
 456     local f2="$2"
 457     $AWK '
 458         /^Date:/ {print "Date: today"; next}
 459         /^Author:/ {print "Author: PCB"; next}
 460         {print}' \
 461         $f1 > $f2
 462 }
 463
 464 # top level function to compare BOM_MD output
 465 compare_bom_md() {
 466     local f1="$1"
 467     local f2="$2"
 468     compare_check "compare_bom_md" "$f1" "$f2" || return 1
 469
 470     # an example BOM_MD file is:
 471
 472     #  # PCB Bill Of Materials MarkDown Version 1.0
 473
 474     #  Date: zo 28 feb 2021 12:13:41 GMT UTC
 475
 476     #  Author: Bert Timmerman
 477
 478     #  Title: Basic BOM/XY Test
 479
 480     #  | Quantity | Description | Value | RefDes |
 481     #  |----------|-------------|-------|--------|
 482     #  | 8 | Standard SMT resistor, capacitor etc | RESC3216N | R0_BOT R90_BOT R180_BOT R270_BOT R0_TOP R270_TOP R180_TOP R90_TOP |
 483     #  | 8 | Small outline package, narrow (150mil) | SO8 | USO0_BOT USO90_BOT USO180_BOT USO270_BOT USO0_TOP USO270_TOP USO180_TOP USO90_TOP |
 484     #  | 8 | Dual in-line package, narrow (300 mil) | DIP8 | UDIP0_BOT UDIP90_BOT UDIP180_BOT UDIP270_BOT UDIP0_TOP UDIP270_TOP UDIP180_TOP UDIP90_TOP |
 485
 486     #  For comparison, we need to ignore changes in the Date and Author lines.
 487     local cf1=${tmpd}/`basename $f1`-ref
 488     local cf2=${tmpd}/`basename $f2`-out
 489
 490     normalize_bom_md $f1 $cf1
 491     normalize_bom_md $f2 $cf2
 492     run_diff $cf1 $cf2 || test_failed=yes
 493 }
 494
 495 ##########################################################################
 496 #
 497 # GCODE comparison routines
 498 #
 499
 500 # used to remove things like creation date from gcode files
 501 normalize_gcode() {
 502     local f1="$1"
 503     local f2="$2"
 504     # matches string such as '( Tue Mar  9 17:45:43 2010 )'
 505     $AWK  '/^\( *[A-Z][a-z][a-z] [A-Z][a-z][a-z] [0123 ][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9][0-9][0-9][0-9] *\)$/ {print "( Date String )"; next}
 506         {print}' \
 507         $f1 > $f2
 508 }
 509
 510 compare_gcode() {
 511     local f1="$1"
 512     local f2="$2"
 513     compare_check "compare_gcode" "$f1" "$f2" || return 1
 514
 515     #  For comparison, we need to ignore changes in the Date and Author lines.
 516     local cf1=${tmpd}/`basename $f1`-ref
 517     local cf2=${tmpd}/`basename $f2`-out
 518
 519     normalize_gcode $f1 $cf1
 520     normalize_gcode $f2 $cf2
 521
 522     run_diff "$cf1" "$cf2" || test_failed=yes
 523 }
 524
 525 ##########################################################################
 526 #
 527 # RS274-X and Excellon comparison
 528 #
 529
 530 compare_rs274x() {
 531     local f1="$1"
 532     local f2="$2"
 533     compare_check "compare_rs274x" "$f1" "$f2" || return 1
 534
 535     # use gerbv to export our reference RS274-X file and our generated
 536     # RS274-X file to png.  Then we'll use ImageMagick to see
 537     # if there are any differences in the resulting files
 538     pngdir=${rundir}/png
 539     mkdir -p ${pngdir}
 540     nb=`basename $f1`
 541     png1=${pngdir}/${nb}-ref.png
 542     png2=${pngdir}/${nb}-out.png
 543
 544     debug "${GERBV} ${GERBV_DEFAULT_FLAGS} --output=${png1} ${f1}"
 545     ${GERBV} ${GERBV_DEFAULT_FLAGS} --output=${png1} ${f1}
 546
 547     debug "${GERBV} ${GERBV_DEFAULT_FLAGS} --output=${png2} ${f2}"
 548     ${GERBV} ${GERBV_DEFAULT_FLAGS} --output=${png2} ${f2}
 549
 550     compare_image ${png1} ${png2}
 551
 552 }
 553
 554 compare_cnc() {
 555     compare_rs274x $*
 556 }
 557
 558 ##########################################################################
 559 #
 560 # gsvit comparison
 561 #
 562
 563 # used to remove things like job name and creation date from gsvit files
 564 normalize_xem() {
 565     local f1="$1"
 566     local f2="$2"
 567     $AWK '
 568         /<genTime>.*<\/genTime>/ {print "<genTime>today</genTime>"; next}
 569         {print}' \
 570         $f1 > $f2
 571 }
 572
 573 # top level function to compare gsvit output (*.xem)
 574 compare_gsvit() {
 575     local f1="$1"
 576     local f2="$2"
 577     compare_check "compare_gsvit" "$f1" "$f2" || return 1
 578
 579     #  For comparison, we need to ignore changes in the Date line.
 580     local cf1=${tmpd}/`basename $f1`-ref
 581     local cf2=${tmpd}/`basename $f2`-out
 582
 583     normalize_xem $f1 $cf1
 584     normalize_xem $f2 $cf2
 585     run_diff $cf1 $cf2 || test_failed=yes
 586 }
 587
 588 ##########################################################################
 589 #
 590 # IPC-D-356 netlist comparison
 591 #
 592
 593 # used to remove things like job name and creation date from IPC-D-356
 594 # netlist files
 595 normalize_ipcd356() {
 596     local f1="$1"
 597     local f2="$2"
 598     $AWK '
 599         /^C  IPC-D-356 Netlist generated by gEDA/ {print "C  IPC-D-356 Netlist generated by gEDA PCB"; next}
 600         /^C  File created on/ {print "C  File created on today"; next}
 601         /^P  JOB/ {print "P  JOB PCB"; next}
 602         {print}' \
 603         $f1 > $f2
 604 }
 605
 606 # top level function to compare IPC-D-356 netlist output
 607 compare_ipcd356() {
 608     local f1="$1"
 609     local f2="$2"
 610     compare_check "compare_ipcd356" "$f1" "$f2" || return 1
 611
 612 #       An example IPC-D-356 netlist file header is:
 613
 614 #       C  IPC-D-356 Netlist generated by gEDA PCB 1.99z
 615 #       C
 616 #       C  File created on Thu 01 Sep 2016 05:53:02 PM GMT UTC
 617 #       C
 618 #       P  JOB   /home/bert/workspace/git/pcb/tests/inputs/ipcd356_board.pcb
 619 #       P  CODE  00
 620 #       P  UNITS CUST 0
 621 #       P  DIM   N
 622 #       P  VER   IPC-D-356
 623 #       P  IMAGE PRIMARY
 624 #       C
 625
 626     #  For comparison, we need to ignore changes in the Date and Job lines.
 627     local cf1=${tmpd}/`basename $f1`-ref
 628     local cf2=${tmpd}/`basename $f2`-out
 629
 630     normalize_ipcd356 $f1 $cf1
 631     normalize_ipcd356 $f2 $cf2
 632     run_diff $cf1 $cf2 || test_failed=yes
 633 }
 634
 635 ##########################################################################
 636 #
 637 # nelma comparison
 638 #
 639
 640 # used to remove things like job name and creation date from nelma files
 641 normalize_em() {
 642     local f1="$1"
 643     local f2="$2"
 644     # an example .em header has:
 645     # /* Made with PCB Nelma export HID *//* Wed Apr 11 12:25:23 2018
 646     $AWK '
 647         /Made with PCB Nelma export HID/ {print"/* PCB Nelma Export *//* today"; next}
 648         {print}' \
 649         $f1 > $f2
 650 }
 651
 652 # top level function to compare gsvit output (*.xem)
 653 compare_nelma() {
 654     local f1="$1"
 655     local f2="$2"
 656     compare_check "compare_gsvit" "$f1" "$f2" || return 1
 657
 658     #  For comparison, we need to ignore changes in the Date line.
 659     local cf1=${tmpd}/`basename $f1`-ref
 660     local cf2=${tmpd}/`basename $f2`-out
 661
 662     normalize_em $f1 $cf1
 663     normalize_em $f2 $cf2
 664     run_diff $cf1 $cf2 || test_failed=yes
 665 }
 666
 667 ##########################################################################
 668 #
 669 # PostScript comparison
 670 #
 671
 672 compare_ps() {
 673     local f1="$1"
 674     local f2="$2"
 675     compare_check "compare_ps" "$f1" "$f2" || return 1
 676
 677     # PostScript output is difficult to compare, because the last page
 678     # ( = fab page) contains a date stamp written not as text, but drawn
 679     # with lines. For now we only check whether the file contains valid
 680     # PostScript and whether the page count matches.
 681     TEMP_FILE=`mktemp`
 682     echo "%!"                                      > ${TEMP_FILE}
 683     echo "currentpagedevice /PageCount get"       >> ${TEMP_FILE}
 684     echo " == flush"                              >> ${TEMP_FILE}
 685
 686     ORG_COUNT=`gs -q -dNODISPLAY -dBATCH -dNOPAUSE "$f1" ${TEMP_FILE}`
 687     NEW_COUNT=`gs -q -dNODISPLAY -dBATCH -dNOPAUSE "$f2" ${TEMP_FILE}`
 688     RESULT=$?
 689
 690     rm -f ${TEMP_FILE}
 691
 692     if test ${RESULT} -ne 0; then
 693         echo "Invalid PostScript generated."
 694         test_failed=yes
 695     else if test "${ORG_COUNT}" != "${NEW_COUNT}"; then
 696         echo -n "Page count of generated PostScript is ${NEW_COUNT} "
 697         echo    "instead of expected ${OLD_COUNT}."
 698         test_failed=yes
 699     fi; fi
 700
 701     unset ORG_COUNT NEW_COUNT RESULT
 702 }
 703
 704 ##########################################################################
 705 #
 706 # GIF/JPEG/PNG comparison routines
 707 #
 708
 709 compare_image() {
 710     local f1="$1"
 711     local f2="$2"
 712     compare_check "compare_image" "$f1" "$f2" || return 1
 713
 714     # now see if the image files are the same
 715     debug "${IM_COMPARE} -metric MAE ${f1} ${f2}  null:"
 716     same=`${IM_COMPARE} -metric MAE ${f1} ${f2}  null: 2>&1 | \
 717           ${AWK} '{if($1 == 0){print "yes"} else {print "no"}}'`
 718     debug "compare_image():  same = $same"
 719
 720     if test "$same" != yes ; then
 721         test_failed=yes
 722         echo "FAILED:  See ${errdir}"
 723         mkdir -p ${errdir}
 724         ${IM_COMPARE} ${f1} ${f2} ${errdir}/compare.png
 725         ${IM_COMPOSITE} ${f1} ${f2} -compose difference ${errdir}/composite.png
 726         ${IM_CONVERT} ${f1} ${f2} -compose difference -composite  -colorspace gray   ${errdir}/gray.png
 727         cat > ${errdir}/animate.sh << EOF
 728 #!/bin/sh
 729 ${IM_CONVERT} -label "%f" ${f1} ${f2} miff:- | \
 730 ${IM_MONTAGE} - -geometry +0+0 -tile 1x1 miff:- | \
 731 ${IM_ANIMATE} -delay 0.5 -loop 0 -
 732 EOF
 733         chmod a+x ${errdir}/animate.sh
 734     fi
 735 }
 736
 737 ##########################################################################
 738 #
 739 # PCB (layout) comparison routines
 740 #
 741 # used to remove things like creation date from BOM files
 742 normalize_pcb() {
 743     local f1="$1"
 744     local f2="$2"
 745     sed -e 's/#.*$//' -e '/^$/d' $f1 > $f2
 746 }
 747
 748
 749 compare_pcb() {
 750     local f1="$1"
 751     local f2="$2"
 752
 753     compare_check "compare_pcb" "$f1" "$f2" || return 1
 754
 755     #  For comparison, we need to ignore changes in the Date and Author lines.
 756     local cf1=${tmpd}/`basename $f1`-ref
 757     local cf2=${tmpd}/`basename $f2`-out
 758
 759     normalize_pcb $f1 $cf1
 760     normalize_pcb $f2 $cf2
 761
 762
 763     run_diff "$cf1" "$cf2" || test_failed=yes
 764 }
 765
 766 ##########################################################################
 767 #
 768 # The main program loop
 769 #
 770
 771 for t in $all_tests ; do
 772     show_sep
 773     echo "Test:  $t"
 774
 775     tot=`expr $tot + 1`
 776
 777     ######################################################################
 778     #
 779     # extract the details for the test
 780     #
 781
 782     pcb_flags="${PCB_DEFAULT_FLAGS}"
 783
 784     rundir="${OUTDIR}/${t}"
 785     refdir="${REFDIR}/${t}"
 786     errdir=${rundir}/mismatch
 787
 788     # test_name | layout file(s) | [export hid name] | [optional arguments to pcb] |  [mismatch]
 789     # | output files
 790     # This string contains the line from the file with the fields for this test
 791     TSTR=`echo "${TESTFILESTRING}" | grep "^[ \t]*${t}[ \t]*|"`
 792
 793     echo ${TSTR}
 794     name=`echo ${TSTR} | $AWK 'BEGIN{FS="|"} {print $1}'`
 795     files=`echo ${TSTR} | $AWK 'BEGIN{FS="|"} {print $2}'`
 796     hid=`echo ${TSTR} | $AWK 'BEGIN{FS="|"} {gsub(/[ \t]*/, ""); print $3}'`
 797     args=`echo ${TSTR} | $AWK 'BEGIN{FS="|"} {print $4}'`
 798     mismatch=`echo ${TSTR} | $AWK 'BEGIN{FS="|"} {if($5 == "mismatch"){print "yes"}else{print "no"}}'`
 799     out_files=`echo ${TSTR} | $AWK 'BEGIN{FS="|"} {print $6}'`
 800
 801     # strip whitespace from single file names
 802     while test "X${files# }" != "X${files#}" ; do
 803         files="${files# }"
 804     done
 805     while test "X${files% }" != "X${files%}" ; do
 806         files="${files% }"
 807     done
 808
 809     if test "X${name}" = "X" ; then
 810         echo "ERROR:  Specified test ${t} does not appear to exist"
 811         skip=`expr $skip + 1`
 812         continue
 813     fi
 814
 815     if test "X${args}" != "X" ; then
 816         pcb_flags="${args}"
 817     fi
 818
 819     if test "X${hid}" = "Xgerber" ; then
 820         pcb_flags="--fab-author Fab_Author ${pcb_flags}"
 821     fi
 822
 823     if test "X${hid}" = "Xaction" ; then
 824         if test "X${have_display}" = "Xno" ; then
 825                 echo "Skipping action test because there is currently no X display available"
 826                 skip=`expr $skip + 1`
 827                 continue
 828         fi
 829     else
 830         # hidden here, still in effect for all HID tests
 831         pcb_flags="-x ${hid} ${pcb_flags}"
 832     fi
 833
 834     ######################################################################
 835     #
 836     # Set up the run directory
 837     #
 838
 839     test -d ${rundir} && rm -fr ${rundir}
 840     mkdir -p ${rundir}
 841     if test $? -ne 0 ; then
 842         echo "$0:  Could not create run directory ${rundir}"
 843         skip=`expr $skip + 1`
 844         continue
 845     fi
 846
 847
 848     ######################################################################
 849     #
 850     # check to see if the files we need exist and copy them to the run
 851     # directory
 852     #
 853
 854     missing_files=no
 855     path_files=""
 856     for f in $files ; do
 857         if test ! -f ${INDIR}/${f} ; then
 858             echo "ERROR:  File $f specified as part of the $t test does not exist"
 859             missing_files=yes
 860         else
 861             path_files="${path_files} ${INDIR}/${f}"
 862             cp "${INDIR}/${f}" "${rundir}"
 863             chmod u+w "${rundir}/${f}"
 864         fi
 865     done
 866
 867     if test "$missing_files" = "yes" ; then
 868         echo "${t} had missing input files.  Skipping test"
 869         skip=`expr $skip + 1`
 870         continue
 871     fi
 872
 873     ######################################################################
 874     #
 875     # run PCB
 876     #
 877     pcb_files=""
 878     for f in ${files} ; do
 879       case $f in
 880         *.script)
 881           pcb_flags="${pcb_flags} --action-script ${f}"
 882           ;;
 883         *.pcb)
 884           pcb_files="${pcb_files} ${f}"
 885           ;;
 886         *.attrs)
 887           continue
 888           ;;
 889         *)
 890           echo "\"$f\" is not a supported input file"
 891           exit 1
 892           ;;
 893       esac
 894     done
 895
 896     echo "(cd ${rundir} && ${PCB} ${pcb_flags} ${pcb_files})"
 897     (cd ${rundir} && ${PCB} ${pcb_flags} ${pcb_files} 2> run_tests.err.log)
 898     pcb_rc=$?
 899
 900     if test $pcb_rc -ne 0 ; then
 901         echo "${PCB} returned ${pcb_rc}.  This is a failure."
 902         fail=`expr $fail + 1`
 903         continue
 904     fi
 905
 906     ######################################################################
 907     #
 908     # check the result
 909     #
 910
 911     if test "X$regen" = "Xyes" ; then
 912         echo "Regenerated ${t}"
 913     else
 914         # compare the result to our reference file
 915         test_failed=no
 916         test_skipped=no
 917         for f in $out_files ; do
 918             debug "processing $f"
 919             # break apart type:fn into the type and file name
 920             type=`echo $f | sed 's;:.*;;g'`
 921             fn=`echo $f | sed 's;.*:;;g'`
 922
 923             case $type in
 924         ascii)
 925             compare_ascii ${refdir}/${fn} ${rundir}/${fn}
 926             ;;
 927         diff)
 928             fn1=`echo ${fn} | sed 's/;.*//g'`
 929             fn2=`echo ${fn} | sed 's/.*;//g'`
 930             compare_ascii ${rundir}/${fn1} ${rundir}/${fn2}
 931             ;;
 932
 933                 # BOM HID
 934                 bom)
 935                     compare_bom ${refdir}/${fn} ${rundir}/${fn}
 936                     ;;
 937
 938                 xy)
 939                     compare_xy ${refdir}/${fn} ${rundir}/${fn}
 940                     ;;
 941
 942                 # BOM_MD HID
 943                 md)
 944                     compare_bom_md ${refdir}/${fn} ${rundir}/${fn}
 945                     ;;
 946
 947                 # GCODE HID
 948                 gcode)
 949                     compare_gcode ${refdir}/${fn} ${rundir}/${fn}
 950                     ;;
 951
 952                 # GERBER HID
 953                 cnc)
 954                     compare_cnc ${refdir}/${fn} ${rundir}/${fn}
 955                     ;;
 956
 957                 gbx)
 958                     compare_rs274x ${refdir}/${fn} ${rundir}/${fn}
 959                     ;;
 960
 961                 # NELMA HID
 962                 em)
 963                     compare_nelma ${refdir}/${fn} ${rundir}/${fn}
 964                     ;;
 965
 966                 # GSVIT HID
 967                 xem)
 968                     compare_gsvit ${refdir}/${fn} ${rundir}/${fn}
 969                     ;;
 970
 971                 # IPC-D-356 HID
 972                 net)
 973                     compare_ipcd356 ${refdir}/${fn} ${rundir}/${fn}
 974                     ;;
 975
 976                 # PS HID
 977                 ps)
 978                     compare_ps ${refdir}/${fn} ${rundir}/${fn}
 979                     ;;
 980
 981                 # PNG HID
 982                 gif)
 983                     compare_image ${refdir}/${fn} ${rundir}/${fn}
 984                     ;;
 985
 986                 jpg)
 987                     compare_image ${refdir}/${fn} ${rundir}/${fn}
 988                     ;;
 989
 990                 png)
 991                     compare_image ${refdir}/${fn} ${rundir}/${fn}
 992                     ;;
 993
 994                 # actions
 995                 pcb)
 996                     compare_pcb ${refdir}/${fn} ${rundir}/${fn}
 997                     ;;
 998
 999                 # unknown
1000                 *)
1001                     echo "internal error:  $type is not a known file type"
1002                     exit 1
1003                     ;;
1004             esac
1005
1006         done
1007
1008         if test "X${hid}" != "Xaction" ; then
1009             # clean up the input files we'd copied over
1010             for f in $files ; do
1011                 rm -f ${rundir}/${f}
1012             done
1013         fi
1014
1015         if test $test_failed = yes ; then
1016             echo "FAIL"
1017             fail=`expr $fail + 1`
1018         elif test $test_skipped = yes ; then
1019             echo "SKIPPED"
1020             skip=`expr $skip + 1`
1021         else
1022             echo "PASSED"
1023             pass=`expr $pass + 1`
1024         fi
1025
1026     fi
1027
1028 done
1029
1030 show_sep
1031 echo "Passed $pass, failed $fail, skipped $skip out of $tot tests."
1032
1033 rc=0
1034 if test $fail -ne 0 ; then
1035     rc=1
1036 fi
1037
1038 exit $rc
1039