]> git.ipfire.org Git - thirdparty/cups.git/blob - test/run-stp-tests.sh
9a1bb748ffc7c9072171f16b1c267d4a51d599e0
[thirdparty/cups.git] / test / run-stp-tests.sh
1 #!/bin/sh
2 #
3 # Perform the complete set of IPP compliance tests specified in the
4 # CUPS Software Test Plan.
5 #
6 # Copyright © 2020-2025 by OpenPrinting
7 # Copyright © 2007-2021 by Apple Inc.
8 # Copyright © 1997-2007 by Easy Software Products, all rights reserved.
9 #
10 # Licensed under Apache License v2.0. See the file "LICENSE" for more
11 # information.
12 #
13
14 argcount=$#
15
16 #
17 # Don't allow "make check" or "make test" to be run by root...
18 #
19
20 if test "x`id -u`" = x0; then
21 echo Please run this as a normal user. Not supported when run as root.
22 exit 1
23 fi
24
25 #
26 # Force the permissions of the files we create...
27 #
28
29 umask 022
30
31 #
32 # Solaris has a non-POSIX grep in /bin...
33 #
34
35 if test -x /usr/xpg4/bin/grep; then
36 GREP=/usr/xpg4/bin/grep
37 else
38 GREP=grep
39 fi
40
41 #
42 # Figure out the proper echo options...
43 #
44
45 if (echo "testing\c"; echo 1,2,3) | $GREP c >/dev/null; then
46 ac_n=-n
47 ac_c=
48 else
49 ac_n=
50 ac_c='\c'
51 fi
52
53 #
54 # Greet the tester...
55 #
56
57 echo "Welcome to the CUPS Automated Test Script."
58 echo ""
59 echo "Before we begin, it is important that you understand that the larger"
60 echo "tests require significant amounts of RAM and disk space. If you"
61 echo "attempt to run one of the big tests on a system that lacks sufficient"
62 echo "disk and virtual memory, the UNIX kernel might decide to kill one or"
63 echo "more system processes that you've grown attached to, like the X"
64 echo "server. The question you may want to ask yourself before running a"
65 echo "large test is: Do you feel lucky?"
66 echo ""
67 echo "OK, now that we have the Dirty Harry quote out of the way, please"
68 echo "choose the type of test you wish to perform:"
69 echo ""
70 echo "0 - No testing, keep the scheduler running for me (all systems)"
71 echo "1 - Basic conformance test, no load testing (all systems)"
72 echo "2 - Basic conformance test, some load testing (minimum 256MB VM, 50MB disk)"
73 echo "3 - Basic conformance test, extreme load testing (minimum 1GB VM, 500MB disk)"
74 echo "4 - Basic conformance test, torture load testing (minimum 2GB VM, 1GB disk)"
75 echo ""
76 echo $ac_n "Enter the number of the test you wish to perform: [1] $ac_c"
77
78 if test $# -gt 0; then
79 testtype=$1
80 shift
81 else
82 read testtype
83 fi
84 echo ""
85
86 case "$testtype" in
87 0)
88 echo "Running in test mode (0)"
89 nprinters=0
90 pjobs=0
91 pprinters=0
92 loglevel="debug2"
93 ;;
94 2)
95 echo "Running the medium tests (2)"
96 nprinters=20
97 pjobs=20
98 pprinters=10
99 loglevel="debug"
100 ;;
101 3)
102 echo "Running the extreme tests (3)"
103 nprinters=1000
104 pjobs=100
105 pprinters=50
106 loglevel="debug"
107 ;;
108 4)
109 echo "Running the torture tests (4)"
110 nprinters=20000
111 pjobs=200
112 pprinters=100
113 loglevel="debug"
114 ;;
115 *)
116 echo "Running the timid tests (1)"
117 nprinters=0
118 pjobs=2
119 pprinters=0
120 loglevel="debug2"
121 testtype="1"
122 ;;
123 esac
124
125 #
126 # See if we want to do SSL testing...
127 #
128
129 echo ""
130 echo "Now you can choose whether to create a SSL/TLS encryption key and"
131 echo "certificate for testing:"
132 echo ""
133 echo "0 - Do not do SSL/TLS encryption tests"
134 echo "1 - Test but do not require encryption"
135 echo "2 - Test and require encryption"
136 echo ""
137 echo $ac_n "Enter the number of the SSL/TLS tests to perform: [0] $ac_c"
138
139 if test $# -gt 0; then
140 ssltype=$1
141 shift
142 else
143 read ssltype
144 fi
145 echo ""
146
147 case "$ssltype" in
148 1)
149 echo "Will test but not require encryption (1)"
150 ;;
151 2)
152 echo "Will test and require encryption (2)"
153 ;;
154 *)
155 echo "Not using SSL/TLS (0)"
156 ssltype=0
157 ;;
158 esac
159
160 #
161 # Information for the server/tests...
162 #
163
164 user="$USER"
165 if test -z "$user"; then
166 if test -x /usr/ucb/whoami; then
167 user=`/usr/ucb/whoami`
168 else
169 user=`whoami`
170 fi
171
172 if test -z "$user"; then
173 user="unknown"
174 fi
175 fi
176
177 port="${CUPS_TESTPORT:=8631}"
178 cwd=`pwd`
179 root=`dirname $cwd`
180 CUPS_TESTROOT="$root"; export CUPS_TESTROOT
181
182 BASE="${CUPS_TESTBASE:=}"
183 if test -z "$BASE"; then
184 if test -d /private/tmp; then
185 BASE=/private/tmp/cups-$user
186 else
187 BASE=/tmp/cups-$user
188 fi
189 fi
190 export BASE
191
192 #
193 # Make sure that the LPDEST and PRINTER environment variables are
194 # not included in the environment that is passed to the tests. These
195 # will usually cause tests to fail erroneously...
196 #
197
198 unset LPDEST
199 unset PRINTER
200
201 #
202 # See if we want to use valgrind...
203 #
204
205 echo ""
206 echo "This test script can use the Valgrind software from:"
207 echo ""
208 echo " http://developer.kde.org/~sewardj/"
209 echo ""
210 echo $ac_n "Enter Y to use Valgrind or N to not use Valgrind: [N] $ac_c"
211
212 if test $# -gt 0; then
213 usevalgrind=$1
214 shift
215 else
216 read usevalgrind
217 fi
218 echo ""
219
220 case "$usevalgrind" in
221 Y* | y*)
222 VALGRIND="valgrind --tool=memcheck --log-file=$BASE/log/valgrind.%p --error-limit=no --leak-check=yes --trace-children=yes"
223 if test `uname` = Darwin; then
224 VALGRIND="$VALGRIND --dsymutil=yes"
225 fi
226 export VALGRIND
227 echo "Using Valgrind; log files can be found in $BASE/log..."
228 ;;
229
230 *)
231 VALGRIND=""
232 export VALGRIND
233 ;;
234 esac
235
236 #
237 # See if we want to do debug logging of the libraries...
238 #
239
240 echo ""
241 echo "If CUPS was built with the --enable-debug-printfs configure option, you"
242 echo "can enable debug logging of the libraries."
243 echo ""
244 echo $ac_n "Enter Y or a number from 0 to 9 to enable debug logging or N to not: [N] $ac_c"
245
246 if test $# -gt 0; then
247 usedebugprintfs=$1
248 shift
249 else
250 read usedebugprintfs
251 fi
252 echo ""
253
254 case "$usedebugprintfs" in
255 Y* | y*)
256 echo "Enabling debug printfs (level 5); log files can be found in $BASE/log..."
257 CUPS_DEBUG_LOG="$BASE/log/debug_printfs.%d"; export CUPS_DEBUG_LOG
258 CUPS_DEBUG_LEVEL=5; export CUPS_DEBUG_LEVEL
259 CUPS_DEBUG_FILTER='^(http|_http|ipp|_ipp|cupsCreate|cups.*Request|cupsGetResponse|cupsSend).*$'; export CUPS_DEBUG_FILTER
260 ;;
261
262 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9)
263 echo "Enabling debug printfs (level $usedebugprintfs); log files can be found in $BASE/log..."
264 CUPS_DEBUG_LOG="$BASE/log/debug_printfs.%d"; export CUPS_DEBUG_LOG
265 CUPS_DEBUG_LEVEL="$usedebugprintfs"; export CUPS_DEBUG_LEVEL
266 CUPS_DEBUG_FILTER='^(http|_http|ipp|_ipp|cupsCreate|cups.*Request|cupsGetResponse|cupsSend).*$'; export CUPS_DEBUG_FILTER
267 ;;
268
269 *)
270 ;;
271 esac
272
273 #
274 # Start by creating temporary directories for the tests...
275 #
276
277 echo "Creating directories for test..."
278
279 rm -rf $BASE
280 mkdir $BASE
281 mkdir $BASE/bin
282 mkdir $BASE/bin/backend
283 mkdir $BASE/bin/driver
284 mkdir $BASE/bin/filter
285 mkdir $BASE/certs
286 mkdir $BASE/share
287 mkdir $BASE/share/banners
288 mkdir $BASE/share/drv
289 mkdir $BASE/share/locale
290 for file in ../locale/cups_*.po; do
291 loc=`basename $file .po | cut -c 6-`
292 mkdir $BASE/share/locale/$loc
293 ln -s $root/locale/cups_$loc.po $BASE/share/locale/$loc
294 done
295 mkdir $BASE/share/locale/en
296 ln -s $root/locale/cups.pot $BASE/share/locale/en/cups_en.po
297 mkdir $BASE/share/mime
298 mkdir $BASE/share/model
299 mkdir $BASE/share/ppdc
300 mkdir $BASE/interfaces
301 mkdir $BASE/log
302 mkdir $BASE/ppd
303 mkdir $BASE/spool
304 mkdir $BASE/spool/temp
305 mkdir $BASE/ssl
306
307 ln -s $root/backend/dnssd $BASE/bin/backend
308 ln -s $root/backend/http $BASE/bin/backend
309 ln -s $root/backend/ipp $BASE/bin/backend
310 ln -s ipp $BASE/bin/backend/ipps
311 ln -s $root/backend/lpd $BASE/bin/backend
312 ln -s $root/backend/mdns $BASE/bin/backend
313 ln -s $root/backend/pseudo $BASE/bin/backend
314 ln -s $root/backend/snmp $BASE/bin/backend
315 ln -s $root/backend/socket $BASE/bin/backend
316 ln -s $root/backend/usb $BASE/bin/backend
317 ln -s $root/cgi-bin $BASE/bin
318 ln -s $root/monitor $BASE/bin
319 ln -s $root/notifier $BASE/bin
320 ln -s $root/scheduler $BASE/bin/daemon
321 ln -s $root/filter/commandtops $BASE/bin/filter
322 ln -s $root/filter/gziptoany $BASE/bin/filter
323 ln -s $root/filter/pstops $BASE/bin/filter
324 ln -s $root/filter/rastertoepson $BASE/bin/filter
325 ln -s $root/filter/rastertohp $BASE/bin/filter
326 ln -s $root/filter/rastertolabel $BASE/bin/filter
327 ln -s $root/filter/rastertopwg $BASE/bin/filter
328 cat >$BASE/share/banners/standard <<EOF
329 ==== Cover Page ====
330
331
332 Job: {?printer-name}-{?job-id}
333 Owner: {?job-originating-user-name}
334 Name: {?job-name}
335 Pages: {?job-impressions}
336
337
338 ==== Cover Page ====
339 EOF
340 cat >$BASE/share/banners/classified <<EOF
341 ==== Classified - Do Not Disclose ====
342
343
344 Job: {?printer-name}-{?job-id}
345 Owner: {?job-originating-user-name}
346 Name: {?job-name}
347 Pages: {?job-impressions}
348
349
350 ==== Classified - Do Not Disclose ====
351 EOF
352 ln -s $root/data $BASE/share
353 ln -s $root/ppdc/sample.drv $BASE/share/drv
354 ln -s $root/conf/cgi.types $BASE/share/mime
355 ln -s $root/conf/mime.types $BASE/share/mime
356 ln -s $root/conf/mime.convs $BASE/share/mime
357 ln -s $root/data/*.h $BASE/share/ppdc
358 ln -s $root/data/*.defs $BASE/share/ppdc
359 ln -s $root/templates $BASE/share
360
361 #
362 # Local filters and configuration files...
363 #
364
365 instfilter() {
366 # instfilter src dst format
367 #
368 # Create a dummy script for the specified format.
369 #
370 src="$1"
371 dst="$2"
372 format="$3"
373
374 case $format in
375 passthru)
376 ln -s gziptoany "$BASE/bin/filter/$dst"
377 ;;
378 pdf)
379 cat >"$BASE/bin/filter/$dst" <<EOF
380 #!/bin/sh
381 trap "" TERM
382 trap "" PIPE
383 gziptoany "$1" "$2" "$3" "$4" "$5" \$6 >/dev/null
384 case "\$5" in
385 *media=a4* | *media=iso_a4* | *PageSize=A4*)
386 gziptoany "$1" "$2" "$3" "$4" "$5" "$root/examples/onepage-a4.pdf"
387 ;;
388 *)
389 gziptoany "$1" "$2" "$3" "$4" "$5" "$root/examples/onepage-letter.pdf"
390 ;;
391 esac
392 EOF
393 chmod +x "$BASE/bin/filter/$dst"
394 ;;
395 ps)
396 cat >"$BASE/bin/filter/$dst" <<EOF
397 #!/bin/sh
398 trap "" TERM
399 trap "" PIPE
400 gziptoany "$1" "$2" "$3" "$4" "$5" \$6 >/dev/null
401 case "\$5" in
402 *media=a4* | *media=iso_a4* | *PageSize=A4*)
403 gziptoany "$1" "$2" "$3" "$4" "$5" "$root/examples/onepage-a4.ps"
404 ;;
405 *)
406 gziptoany "$1" "$2" "$3" "$4" "$5" "$root/examples/onepage-letter.ps"
407 ;;
408 esac
409 EOF
410 chmod +x "$BASE/bin/filter/$dst"
411 ;;
412 raster)
413 cat >"$BASE/bin/filter/$dst" <<EOF
414 #!/bin/sh
415 trap "" TERM
416 trap "" PIPE
417 gziptoany "$1" "$2" "$3" "$4" "$5" \$6 >/dev/null
418 case "\$5" in
419 *media=a4* | *media=iso_a4* | *PageSize=A4*)
420 gziptoany "$1" "$2" "$3" "$4" "$5" "$root/examples/onepage-a4-300-black-1.pwg"
421 ;;
422 *)
423 gziptoany "$1" "$2" "$3" "$4" "$5" "$root/examples/onepage-letter-300-black-1.pwg"
424 ;;
425 esac
426 EOF
427 chmod +x "$BASE/bin/filter/$dst"
428 ;;
429 esac
430 }
431
432 ln -s $root/test/test.convs $BASE/share/mime
433
434 if test `uname` = Darwin; then
435 instfilter cgimagetopdf imagetopdf pdf
436 instfilter cgpdftopdf pdftopdf passthru
437 instfilter cgpdftops pdftops ps
438 instfilter cgpdftoraster pdftoraster raster
439 instfilter cgtexttopdf texttopdf pdf
440 instfilter pstocupsraster pstoraster raster
441 else
442 instfilter imagetopdf imagetopdf pdf
443 instfilter pdftopdf pdftopdf passthru
444 instfilter pdftops pdftops ps
445 instfilter pdftoraster pdftoraster raster
446 instfilter pstoraster pstoraster raster
447 instfilter texttopdf texttopdf pdf
448
449 if test -d /usr/share/cups/charsets; then
450 ln -s /usr/share/cups/charsets $BASE/share
451 fi
452 fi
453
454 #
455 # Then create the necessary config files...
456 #
457
458 echo "Creating cupsd.conf for test..."
459
460 if test $ssltype = 2; then
461 encryption="Encryption Required"
462 else
463 encryption=""
464 fi
465
466 if test $testtype = 0; then
467 jobhistory="30m"
468 jobfiles="5m"
469 else
470 jobhistory="30"
471 jobfiles="Off"
472 fi
473
474 cat >$BASE/cupsd.conf <<EOF
475 StrictConformance Yes
476 Browsing Off
477 Listen localhost:$port
478 Listen $BASE/sock
479 MaxSubscriptions 3
480 MaxLogSize 0
481 AccessLogLevel actions
482 LogLevel $loglevel
483 LogTimeFormat usecs
484 PreserveJobHistory $jobhistory
485 PreserveJobFiles $jobfiles
486 <Policy default>
487 <Limit All>
488 Order Allow,Deny
489 $encryption
490 </Limit>
491 </Policy>
492 EOF
493
494 if test $testtype = 0; then
495 echo WebInterface yes >>$BASE/cupsd.conf
496 fi
497
498 cat >$BASE/cups-files.conf <<EOF
499 FileDevice yes
500 Printcap
501 User $user
502 ServerRoot $BASE
503 StateDir $BASE
504 ServerBin $BASE/bin
505 CacheDir $BASE/share
506 DataDir $BASE/share
507 DocumentRoot $root/doc
508 RequestRoot $BASE/spool
509 TempDir $BASE/spool/temp
510 AccessLog $BASE/log/access_log
511 ErrorLog $BASE/log/error_log
512 PageLog $BASE/log/page_log
513
514 PassEnv DYLD_INSERT_LIBRARIES
515 PassEnv DYLD_LIBRARY_PATH
516 PassEnv LD_LIBRARY_PATH
517 PassEnv LD_PRELOAD
518 PassEnv LOCALEDIR
519 PassEnv ASAN_OPTIONS
520
521 Sandboxing Off
522 EOF
523
524 #
525 # Setup lots of test queues with PPD files...
526 #
527
528 echo "Creating printers.conf for test..."
529
530 i=1
531 while test $i -le $nprinters; do
532 cat >>$BASE/printers.conf <<EOF
533 <Printer test-$i>
534 Accepting Yes
535 DeviceURI file:/dev/null
536 Info Test PS printer $i
537 JobSheets none none
538 Location CUPS test suite
539 State Idle
540 StateMessage Printer $1 is idle.
541 </Printer>
542 EOF
543
544 cp testps.ppd $BASE/ppd/test-$i.ppd
545
546 i=`expr $i + 1`
547 done
548
549 if test -f $BASE/printers.conf; then
550 cp $BASE/printers.conf $BASE/printers.conf.orig
551 else
552 touch $BASE/printers.conf.orig
553 fi
554
555 #
556 # Create a helper script to run programs with...
557 #
558
559 echo "Setting up environment variables for test..."
560
561 if test "x$ASAN_OPTIONS" = x; then
562 # AddressSanitizer on Linux reports memory leaks from the main function
563 # which is basically useless - in general, programs do not need to free
564 # every object before exit since the OS will recover the process's
565 # memory.
566 ASAN_OPTIONS="detect_leaks=false"
567 export ASAN_OPTIONS
568 fi
569
570 if test -f "$root/cups/libcups.so.2"; then
571 if test "x$LD_LIBRARY_PATH" = x; then
572 LD_LIBRARY_PATH="$root/cups"
573 else
574 LD_LIBRARY_PATH="$root/cups:$LD_LIBRARY_PATH"
575 fi
576
577 LD_PRELOAD="$root/cups/libcups.so.2:$root/cups/libcupsimage.so.2"
578 if test `uname` = SunOS -a -r /usr/lib/libCrun.so.1; then
579 LD_PRELOAD="/usr/lib/libCrun.so.1:$LD_PRELOAD"
580 fi
581 fi
582
583 if test -f "$root/cups/libcups.2.dylib"; then
584 if test "x$DYLD_INSERT_LIBRARIES" = x; then
585 DYLD_INSERT_LIBRARIES="$root/cups/libcups.2.dylib:$root/cups/libcupsimage.2.dylib"
586 else
587 DYLD_INSERT_LIBRARIES="$root/cups/libcups.2.dylib:$root/cups/libcupsimage.2.dylib:$DYLD_INSERT_LIBRARIES"
588 fi
589
590 if test "x$DYLD_LIBRARY_PATH" = x; then
591 DYLD_LIBRARY_PATH="$root/cups"
592 else
593 DYLD_LIBRARY_PATH="$root/cups:$DYLD_LIBRARY_PATH"
594 fi
595 fi
596
597 # These get exported because they don't have side-effects...
598 CUPS_DISABLE_APPLE_DEFAULT=yes; export CUPS_DISABLE_APPLE_DEFAULT
599 CUPS_SERVER=localhost:$port; export CUPS_SERVER
600 CUPS_SERVERROOT=$BASE; export CUPS_SERVERROOT
601 CUPS_STATEDIR=$BASE; export CUPS_STATEDIR
602 CUPS_DATADIR=$BASE/share; export CUPS_DATADIR
603 IPP_PORT=$port; export IPP_PORT
604 LOCALEDIR=$BASE/share/locale; export LOCALEDIR
605
606 echo "Creating wrapper script..."
607
608 runcups="$BASE/runcups"; export runcups
609
610 echo "#!/bin/sh" >$runcups
611 echo "# Helper script for running CUPS test instance." >>$runcups
612 echo "" >>$runcups
613 echo "# Set required environment variables..." >>$runcups
614 echo "CUPS_DATADIR=\"$CUPS_DATADIR\"; export CUPS_DATADIR" >>$runcups
615 echo "CUPS_SERVER=\"$CUPS_SERVER\"; export CUPS_SERVER" >>$runcups
616 echo "CUPS_SERVERROOT=\"$CUPS_SERVERROOT\"; export CUPS_SERVERROOT" >>$runcups
617 echo "CUPS_STATEDIR=\"$CUPS_STATEDIR\"; export CUPS_STATEDIR" >>$runcups
618 echo "DYLD_INSERT_LIBRARIES=\"$DYLD_INSERT_LIBRARIES\"; export DYLD_INSERT_LIBRARIES" >>$runcups
619 echo "DYLD_LIBRARY_PATH=\"$DYLD_LIBRARY_PATH\"; export DYLD_LIBRARY_PATH" >>$runcups
620 # IPP_PORT=$port; export IPP_PORT
621 echo "LD_LIBRARY_PATH=\"$LD_LIBRARY_PATH\"; export LD_LIBRARY_PATH" >>$runcups
622 echo "LD_PRELOAD=\"$LD_PRELOAD\"; export LD_PRELOAD" >>$runcups
623 echo "LOCALEDIR=\"$LOCALEDIR\"; export LOCALEDIR" >>$runcups
624 if test "x$CUPS_DEBUG_LEVEL" != x; then
625 echo "CUPS_DEBUG_FILTER='$CUPS_DEBUG_FILTER'; export CUPS_DEBUG_FILTER" >>$runcups
626 echo "CUPS_DEBUG_LEVEL=$CUPS_DEBUG_LEVEL; export CUPS_DEBUG_LEVEL" >>$runcups
627 echo "CUPS_DEBUG_LOG='$CUPS_DEBUG_LOG'; export CUPS_DEBUG_LOG" >>$runcups
628 fi
629 echo "" >>$runcups
630 echo "# Run command..." >>$runcups
631 echo "exec \"\$@\"" >>$runcups
632
633 chmod +x $runcups
634
635 #
636 # Set a new home directory to avoid getting user options mixed in...
637 #
638
639 HOME=$BASE
640 export HOME
641
642 #
643 # Force POSIX locale for tests...
644 #
645
646 LANG=C
647 export LANG
648
649 LC_MESSAGES=C
650 export LC_MESSAGES
651
652 #
653 # Start the server; run as foreground daemon in the background...
654 #
655
656 echo "Starting scheduler:"
657 echo " $runcups $VALGRIND ../scheduler/cupsd -c $BASE/cupsd.conf -f >$BASE/log/debug_log 2>&1 &"
658 echo ""
659
660 $runcups $VALGRIND ../scheduler/cupsd -c $BASE/cupsd.conf -f >$BASE/log/debug_log 2>&1 &
661
662 cupsd=$!
663
664 if test "x$testtype" = x0; then
665 # Not running tests...
666 echo "Scheduler is PID $cupsd and is listening on port $port."
667 echo ""
668
669 echo "The $runcups helper script can be used to test programs"
670 echo "with the server."
671 exit 0
672 fi
673
674 if test $argcount -eq 0; then
675 echo "Scheduler is PID $cupsd; run debugger now if you need to."
676 echo ""
677 echo $ac_n "Press ENTER to continue... $ac_c"
678 read junk
679 else
680 echo "Scheduler is PID $cupsd."
681 sleep 2
682 fi
683
684 tries=0
685 while test $tries -lt 30; do
686 running=`$runcups ../systemv/lpstat -r 2>/dev/null`
687 if test "x$running" = "xscheduler is running"; then
688 break
689 fi
690
691 echo "Waiting for scheduler to become ready..."
692 sleep 10
693
694 tries=`expr $tries + 1`
695 done
696
697 #
698 # Create the test report source file...
699 #
700
701 date=`date "+%Y-%m-%d"`
702
703 strfile=$BASE/cups-str-$date-$user.html
704
705 rm -f $strfile
706 cat str-header.html >$strfile
707
708 #
709 # Run the IPP tests...
710 #
711
712 echo ""
713 echo "Running IPP compliance tests..."
714
715 echo " <h1><a name='IPP'>1 - IPP Compliance Tests</a></h1>" >>$strfile
716 echo " <p>This section provides the results to the IPP compliance tests" >>$strfile
717 echo " outlined in the CUPS Software Test Plan. These tests were run on" >>$strfile
718 echo " $date by $user on `hostname`." >>$strfile
719 echo " <pre>" >>$strfile
720
721 fail=0
722 for file in 4*.test ../examples/ipp-2.1.test; do
723 echo $ac_n "Performing `basename $file`: $ac_c"
724 echo "" >>$strfile
725
726 if test $file = ../examples/ipp-2.1.test; then
727 uri="ipp://localhost:$port/printers/Test1"
728 options="-V 2.1 -d NOPRINT=1 -f testfile.ps"
729 else
730 uri="ipp://localhost:$port/printers"
731 options=""
732 fi
733 echo "$(date '+[%d/%b/%Y:%H:%M:%S %z]') ../tools/ipptool -tI $options $uri $file" >>$strfile
734 $runcups $VALGRIND ../tools/ipptool -tI $options $uri $file >> $strfile
735 status=$?
736
737 if test $status != 0; then
738 echo FAIL
739 fail=`expr $fail + 1`
740 else
741 echo PASS
742 fi
743 done
744
745 echo " </pre>" >>$strfile
746
747 #
748 # Run the command tests...
749 #
750
751 echo ""
752 echo "Running command tests..."
753
754 echo " <h1><a name='COMMAND'>2 - Command Tests</a></h1>" >>$strfile
755 echo " <p>This section provides the results to the command tests" >>$strfile
756 echo " outlined in the CUPS Software Test Plan. These tests were run on" >>$strfile
757 echo " $date by $user on `hostname`." >>$strfile
758 echo " <pre>" >>$strfile
759
760 for file in 5*.sh; do
761 # Wait for jobs from the previous test to complete before running the
762 # next test...
763 if test $file != 5.1-lpadmin.sh; then
764 ./waitjobs.sh 1800
765 fi
766
767 # Run the test...
768 echo $ac_n "Performing $file: $ac_c"
769 echo "" >>$strfile
770 echo "`date '+[%d/%b/%Y:%H:%M:%S %z]'` \"$file\":" >>$strfile
771
772 sh $file $pjobs $pprinters >> $strfile
773 status=$?
774
775 if test $status != 0; then
776 echo FAIL
777 fail=`expr $fail + 1`
778 else
779 echo PASS
780 fi
781 done
782
783 #
784 # Restart the server...
785 #
786
787 echo $ac_n "Performing restart test: $ac_c"
788 echo "" >>$strfile
789 echo "`date '+[%d/%b/%Y:%H:%M:%S %z]'` \"5.10-restart\":" >>$strfile
790
791 kill -HUP $cupsd
792
793 while true; do
794 sleep 10
795
796 running=`$runcups ../systemv/lpstat -r 2>/dev/null`
797 if test "x$running" = "xscheduler is running"; then
798 break
799 fi
800 done
801
802 description="`$runcups ../systemv/lpstat -l -p Test1 | grep Description | sed -e '1,$s/^[^:]*: //g'`"
803 if test "x$description" != "xTest Printer 1"; then
804 echo "Failed, printer-info for Test1 is '$description', expected 'Test Printer 1'." >>$strfile
805 echo "FAIL (got '$description', expected 'Test Printer 1')"
806 fail=`expr $fail + 1`
807 else
808 echo "Passed." >>$strfile
809 echo PASS
810 fi
811
812
813 #
814 # Perform job history test...
815 #
816
817 echo $ac_n "Starting history test: $ac_c"
818 echo "" >>$strfile
819 echo "`date '+[%d/%b/%Y:%H:%M:%S %z]'` \"5.11-history\":" >>$strfile
820
821 echo " lp -d Test1 testfile.jpg" >>$strfile
822
823 $runcups ../systemv/lp -d Test1 ../examples/testfile.jpg 2>&1 >>$strfile
824 if test $? != 0; then
825 echo "FAIL (unable to queue test job)"
826 echo " FAILED" >>$strfile
827 fail=`expr $fail + 1`
828 else
829 echo "PASS"
830 echo " PASSED" >>$strfile
831
832 sleep 5
833 ./waitjobs.sh >>$strfile
834
835 echo $ac_n "Verifying that history still exists: $ac_c"
836
837 echo " ls -l $BASE/spool" >>$strfile
838 count=`ls -1 $BASE/spool | wc -l`
839 if test $count = 1; then
840 echo "FAIL (job control files not present)"
841 ls -l $BASE/spool
842 echo " FAILED (job control files not present)" >>$strfile
843 ls -l $BASE/spool >>$strfile
844 fail=`expr $fail + 1`
845 else
846 echo "PASS"
847 echo " PASSED" >>$strfile
848
849 echo $ac_n "Waiting for job history to expire: $ac_c"
850 echo "" >>$strfile
851 echo " sleep 35" >>$strfile
852 sleep 35
853
854 echo " lpstat" >>$strfile
855 $runcups ../systemv/lpstat 2>&1 >>$strfile
856
857 echo " ls -l $BASE/spool" >>$strfile
858 count=`ls -1 $BASE/spool | wc -l`
859 if test $count != 1; then
860 echo "FAIL (job control files still present)"
861 ls -l $BASE/spool
862 echo " FAILED (job control files still present)" >>$strfile
863 ls -l $BASE/spool >>$strfile
864 fail=`expr $fail + 1`
865 else
866 echo "PASS"
867 echo " PASSED" >>$strfile
868 fi
869 fi
870 fi
871
872
873 #
874 # Perform job history test with cupsd restart...
875 #
876
877 echo $ac_n "Starting history test with cupsd restart: $ac_c"
878 echo "" >>$strfile
879 echo "`date '+[%d/%b/%Y:%H:%M:%S %z]'` \"5.11-history-cupsd-restart\":" >>$strfile
880
881 echo " lp -d Test1 testfile.jpg" >>$strfile
882
883 $runcups ../systemv/lp -d Test1 ../examples/testfile.jpg 2>&1 >>$strfile
884 if test $? != 0; then
885 echo "FAIL (unable to queue test job)"
886 echo " FAILED" >>$strfile
887 fail=`expr $fail + 1`
888 else
889 echo "PASS"
890 echo " PASSED" >>$strfile
891
892 sleep 5
893 ./waitjobs.sh >>$strfile
894
895 echo $ac_n "Verifying that history still exists: $ac_c"
896
897 echo " ls -l $BASE/spool" >>$strfile
898 count=`ls -1 $BASE/spool | wc -l`
899 if test $count = 1; then
900 echo "FAIL (job control files not present)"
901 ls -l $BASE/spool
902 echo " FAILED (job control files not present)" >>$strfile
903 ls -l $BASE/spool >>$strfile
904 fail=`expr $fail + 1`
905 else
906 echo "PASS"
907 echo " PASSED" >>$strfile
908
909 echo "Restarting cupsd:"
910 echo "" >>$strfile
911 kill $cupsd
912 wait $cupsd
913
914 echo " $runcups $VALGRIND ../scheduler/cupsd -c $BASE/cupsd.conf -f >>$BASE/log/debug_log 2>&1 &"
915 echo ""
916
917 $runcups $VALGRIND ../scheduler/cupsd -c $BASE/cupsd.conf -f >>$BASE/log/debug_log 2>&1 &
918
919 cupsd=$!
920
921 echo $ac_n "Waiting for job history to expire: $ac_c"
922 echo "" >>$strfile
923 echo " sleep 35" >>$strfile
924 sleep 35
925
926 echo " ls -l $BASE/spool" >>$strfile
927 count=`ls -1 $BASE/spool | wc -l`
928 if test $count != 1; then
929 echo "FAIL (job control files still present)"
930 ls -l $BASE/spool
931 echo " FAILED (job control files still present)" >>$strfile
932 ls -l $BASE/spool >>$strfile
933 fail=`expr $fail + 1`
934 else
935 echo "PASS"
936 echo " PASSED" >>$strfile
937 fi
938 fi
939 fi
940
941
942 #
943 # Stop the server...
944 #
945
946 echo " </pre>" >>$strfile
947
948 kill $cupsd
949 wait $cupsd
950 cupsdstatus=$?
951
952 #
953 # Verify counts...
954 #
955
956 echo "Test Summary"
957 echo ""
958 echo " <h1><a name='SUMMARY'>3 - Test Summary</a></h1>" >>$strfile
959
960 if test $cupsdstatus != 0; then
961 echo "FAIL: cupsd failed with exit status $cupsdstatus."
962 echo " <p>FAIL: cupsd failed with exit status $cupsdstatus.</p>" >>$strfile
963 fail=`expr $fail + 1`
964 else
965 echo "PASS: cupsd exited with no errors."
966 echo " <p>PASS: cupsd exited with no errors.</p>" >>$strfile
967 fi
968
969 # Job control files
970 count=`ls -1 $BASE/spool | wc -l`
971 count=`expr $count - 1`
972 if test $count != 0; then
973 echo "FAIL: $count job control files were not purged."
974 echo " <p>FAIL: $count job control files were not purged.</p>" >>$strfile
975 fail=`expr $fail + 1`
976 else
977 echo "PASS: All job control files purged."
978 echo " <p>PASS: All job control files purged.</p>" >>$strfile
979 fi
980
981 # Pages printed on Test1 (within 1 page for timing-dependent cancel issues)
982 count=`$GREP '^Test1 ' $BASE/log/page_log | awk 'BEGIN{count=0}{count=count+$7}END{print count}'`
983 # expected numbers of pages from page ranges tests:
984 # - 5 pages for the job with a lower limit undefined (-5)
985 # - 4 pages for the job with a upper limit undefined (5-)
986 expected=`expr $pjobs \* 2 + 34 + 5 + 4`
987 expected2=`expr $expected + 2`
988 if test $count -lt $expected -a $count -gt $expected2; then
989 echo "FAIL: Printer 'Test1' produced $count page(s), expected $expected."
990 echo " <p>FAIL: Printer 'Test1' produced $count page(s), expected $expected.</p>" >>$strfile
991 fail=`expr $fail + 1`
992 else
993 echo "PASS: Printer 'Test1' correctly produced $count page(s)."
994 echo " <p>PASS: Printer 'Test1' correctly produced $count page(s).</p>" >>$strfile
995 fi
996
997 # Paged printed on Test2
998 count=`$GREP '^Test2 ' $BASE/log/page_log | awk 'BEGIN{count=0}{count=count+$7}END{print count}'`
999 expected=`expr $pjobs \* 2 + 3`
1000 if test $count != $expected; then
1001 echo "FAIL: Printer 'Test2' produced $count page(s), expected $expected."
1002 echo " <p>FAIL: Printer 'Test2' produced $count page(s), expected $expected.</p>" >>$strfile
1003 fail=`expr $fail + 1`
1004 else
1005 echo "PASS: Printer 'Test2' correctly produced $count page(s)."
1006 echo " <p>PASS: Printer 'Test2' correctly produced $count page(s).</p>" >>$strfile
1007 fi
1008
1009 # Paged printed on Test3
1010 count=`$GREP '^Test3 ' $BASE/log/page_log | awk 'BEGIN{count=0}{count=count+$7}END{print count}'`
1011 expected=2
1012 if test $count != $expected; then
1013 echo "FAIL: Printer 'Test3' produced $count page(s), expected $expected."
1014 echo " <p>FAIL: Printer 'Test3' produced $count page(s), expected $expected.</p>" >>$strfile
1015 fail=`expr $fail + 1`
1016 else
1017 echo "PASS: Printer 'Test3' correctly produced $count page(s)."
1018 echo " <p>PASS: Printer 'Test3' correctly produced $count page(s).</p>" >>$strfile
1019 fi
1020
1021 # Number of requests from 5.1-lpadmin.sh: cupsSNMP/IPPSupplies tests - total 5 in 'expected':
1022 # - 2 requests for creating a queue - CUPS-Get-PPD and CUPS-Add-Modify-Printer
1023 # - 1 request for setting cupsSNMP/IPPSupplies to True - CUPS-Add-Modify-Printer
1024 # - 1 request for setting cupsSNMP/IPPSupplies to False - CUPS-Add-Modify-Printer
1025 # - 1 request for deleting the queue - CUPS-Delete-Printer
1026
1027 # Number of requests related to undefined page range limits - total 4 in 'expected'
1028 # 2 requests (Create-Job, Send-Document) * number of jobs (2 - one for undefined
1029 # low limit, one for undefined upper limit)
1030
1031 # Requests logged
1032 count=`wc -l $BASE/log/access_log | awk '{print $1}'`
1033 expected=`expr 35 + 18 + 30 + $pjobs \* 8 + $pprinters \* $pjobs \* 4 + 2 + 2 + 5 + 4`
1034 if test $count != $expected; then
1035 echo "FAIL: $count requests logged, expected $expected."
1036 echo " <p>FAIL: $count requests logged, expected $expected.</p>" >>$strfile
1037 fail=`expr $fail + 1`
1038 else
1039 echo "PASS: $count requests logged."
1040 echo " <p>PASS: $count requests logged.</p>" >>$strfile
1041 fi
1042
1043 # Did CUPS-Get-Default get logged?
1044 if $GREP -q CUPS-Get-Default $BASE/log/access_log; then
1045 echo "FAIL: CUPS-Get-Default logged with 'AccessLogLevel actions'"
1046 echo " <p>FAIL: CUPS-Get-Default logged with 'AccessLogLevel actions'</p>" >>$strfile
1047 echo " <pre>" >>$strfile
1048 $GREP CUPS-Get-Default $BASE/log/access_log | sed -e '1,$s/&/&amp;/g' -e '1,$s/</&lt;/g' >>$strfile
1049 echo " </pre>" >>$strfile
1050 fail=`expr $fail + 1`
1051 else
1052 echo "PASS: CUPS-Get-Default not logged."
1053 echo " <p>PASS: CUPS-Get-Default not logged.</p>" >>$strfile
1054 fi
1055
1056 # Emergency log messages
1057 count=`$GREP '^X ' $BASE/log/error_log | wc -l | awk '{print $1}'`
1058 if test $count != 0; then
1059 echo "FAIL: $count emergency messages, expected 0."
1060 $GREP '^X ' $BASE/log/error_log
1061 echo " <p>FAIL: $count emergency messages, expected 0.</p>" >>$strfile
1062 echo " <pre>" >>$strfile
1063 $GREP '^X ' $BASE/log/error_log | sed -e '1,$s/&/&amp;/g' -e '1,$s/</&lt;/g' >>$strfile
1064 echo " </pre>" >>$strfile
1065 fail=`expr $fail + 1`
1066 else
1067 echo "PASS: $count emergency messages."
1068 echo " <p>PASS: $count emergency messages.</p>" >>$strfile
1069 fi
1070
1071 # Alert log messages
1072 count=`$GREP '^A ' $BASE/log/error_log | wc -l | awk '{print $1}'`
1073 if test $count != 0; then
1074 echo "FAIL: $count alert messages, expected 0."
1075 $GREP '^A ' $BASE/log/error_log
1076 echo " <p>FAIL: $count alert messages, expected 0.</p>" >>$strfile
1077 echo " <pre>" >>$strfile
1078 $GREP '^A ' $BASE/log/error_log | sed -e '1,$s/&/&amp;/g' -e '1,$s/</&lt;/g' >>$strfile
1079 echo " </pre>" >>$strfile
1080 fail=`expr $fail + 1`
1081 else
1082 echo "PASS: $count alert messages."
1083 echo " <p>PASS: $count alert messages.</p>" >>$strfile
1084 fi
1085
1086 # Critical log messages
1087 count=`$GREP '^C ' $BASE/log/error_log | wc -l | awk '{print $1}'`
1088 if test $count != 0; then
1089 echo "FAIL: $count critical messages, expected 0."
1090 $GREP '^C ' $BASE/log/error_log
1091 echo " <p>FAIL: $count critical messages, expected 0.</p>" >>$strfile
1092 echo " <pre>" >>$strfile
1093 $GREP '^C ' $BASE/log/error_log | sed -e '1,$s/&/&amp;/g' -e '1,$s/</&lt;/g' >>$strfile
1094 echo " </pre>" >>$strfile
1095 fail=`expr $fail + 1`
1096 else
1097 echo "PASS: $count critical messages."
1098 echo " <p>PASS: $count critical messages.</p>" >>$strfile
1099 fi
1100
1101 # Error log messages
1102 count=`$GREP '^E ' $BASE/log/error_log | $GREP -v 'Unknown default SystemGroup' | wc -l | awk '{print $1}'`
1103 if test $count != 33; then
1104 echo "FAIL: $count error messages, expected 33."
1105 $GREP '^E ' $BASE/log/error_log
1106 echo " <p>FAIL: $count error messages, expected 33.</p>" >>$strfile
1107 echo " <pre>" >>$strfile
1108 $GREP '^E ' $BASE/log/error_log | sed -e '1,$s/&/&amp;/g' -e '1,$s/</&lt;/g' >>$strfile
1109 echo " </pre>" >>$strfile
1110 fail=`expr $fail + 1`
1111 else
1112 echo "PASS: $count error messages."
1113 echo " <p>PASS: $count error messages.</p>" >>$strfile
1114 fi
1115
1116 # Warning log messages
1117 count=`$GREP '^W ' $BASE/log/error_log | $GREP -v CreateProfile | $GREP -v 'libusb error' | $GREP -v ColorManager | $GREP -v 'Avahi client failed' | wc -l | awk '{print $1}'`
1118 if test $count != 14; then
1119 echo "FAIL: $count warning messages, expected 14."
1120 $GREP '^W ' $BASE/log/error_log
1121 echo " <p>FAIL: $count warning messages, expected 14.</p>" >>$strfile
1122 echo " <pre>" >>$strfile
1123 $GREP '^W ' $BASE/log/error_log | sed -e '1,$s/&/&amp;/g' -e '1,$s/</&lt;/g' >>$strfile
1124 echo " </pre>" >>$strfile
1125 fail=`expr $fail + 1`
1126 else
1127 echo "PASS: $count warning messages."
1128 echo " <p>PASS: $count warning messages.</p>" >>$strfile
1129 fi
1130
1131 # Notice log messages
1132 count=`$GREP '^N ' $BASE/log/error_log | wc -l | awk '{print $1}'`
1133 if test $count != 0; then
1134 echo "FAIL: $count notice messages, expected 0."
1135 $GREP '^N ' $BASE/log/error_log
1136 echo " <p>FAIL: $count notice messages, expected 0.</p>" >>$strfile
1137 echo " <pre>" >>$strfile
1138 $GREP '^N ' $BASE/log/error_log | sed -e '1,$s/&/&amp;/g' -e '1,$s/</&lt;/g' >>$strfile
1139 echo " </pre>" >>$strfile
1140 fail=`expr $fail + 1`
1141 else
1142 echo "PASS: $count notice messages."
1143 echo " <p>PASS: $count notice messages.</p>" >>$strfile
1144 fi
1145
1146 # Info log messages
1147 count=`$GREP '^I ' $BASE/log/error_log | wc -l | awk '{print $1}'`
1148 if test $count = 0; then
1149 echo "FAIL: $count info messages, expected more than 0."
1150 echo " <p>FAIL: $count info messages, expected more than 0.</p>" >>$strfile
1151 fail=`expr $fail + 1`
1152 else
1153 echo "PASS: $count info messages."
1154 echo " <p>PASS: $count info messages.</p>" >>$strfile
1155 fi
1156
1157 # Debug log messages
1158 count=`$GREP '^D ' $BASE/log/error_log | wc -l | awk '{print $1}'`
1159 if test $count = 0; then
1160 echo "FAIL: $count debug messages, expected more than 0."
1161 echo " <p>FAIL: $count debug messages, expected more than 0.</p>" >>$strfile
1162 fail=`expr $fail + 1`
1163 else
1164 echo "PASS: $count debug messages."
1165 echo " <p>PASS: $count debug messages.</p>" >>$strfile
1166 fi
1167
1168 # Debug2 log messages
1169 count=`$GREP '^d ' $BASE/log/error_log | wc -l | awk '{print $1}'`
1170 if test $count = 0 -a $loglevel = debug2; then
1171 echo "FAIL: $count debug2 messages, expected more than 0."
1172 echo " <p>FAIL: $count debug2 messages, expected more than 0.</p>" >>$strfile
1173 fail=`expr $fail + 1`
1174 elif test $count != 0 -a $loglevel = debug; then
1175 echo "FAIL: $count debug2 messages, expected 0."
1176 echo " <p>FAIL: $count debug2 messages, expected 0.</p>" >>$strfile
1177 fail=`expr $fail + 1`
1178 else
1179 echo "PASS: $count debug2 messages."
1180 echo " <p>PASS: $count debug2 messages.</p>" >>$strfile
1181 fi
1182
1183 #
1184 # Log files...
1185 #
1186
1187 echo " <h1><a name='LOGS'>4 - Log Files</a></h1>" >>$strfile
1188
1189 for file in $BASE/log/*_log; do
1190 baselog=`basename $file`
1191
1192 echo " <h2><a name=\"$baselog\">$baselog</a></h2>" >>$strfile
1193 case $baselog in
1194 error_log)
1195 echo " <blockquote>Note: debug2 messages have been filtered out of the HTML report.</blockquote>" >>$strfile
1196 echo " <pre>" >>$strfile
1197 $GREP -v '^d' $BASE/log/error_log | sed -e '1,$s/&/&amp;/g' -e '1,$s/</&lt;/g' >>$strfile
1198 echo " </pre>" >>$strfile
1199 ;;
1200
1201 *)
1202 echo " <pre>" >>$strfile
1203 sed -e '1,$s/&/&amp;/g' -e '1,$s/</&lt;/g' $file >>$strfile
1204 echo " </pre>" >>$strfile
1205 ;;
1206 esac
1207 done
1208
1209 #
1210 # Format the reports and tell the user where to find them...
1211 #
1212
1213 cat str-trailer.html >>$strfile
1214
1215 echo ""
1216 for file in $BASE/log/*_log; do
1217 baselog=`basename $file`
1218 cp $file $baselog-$date-$user
1219 echo "Copied log file \"$baselog-$date-$user\" to test directory."
1220 done
1221 cp $strfile .
1222 echo "Copied report file \"cups-str-$date-$user.html\" to test directory."
1223
1224 # Clean out old failure log files after 1 week...
1225 find . -name \*_log-\*-$user -a -mtime +7 -print -exec rm -f '{}' \; | awk '{print "Removed old log file \"" substr($1,3) "\" from test directory."}'
1226 find . -name cups-str-\*-$user.html -a -mtime +7 -print -exec rm -f '{}' \; | awk '{print "Removed old report file \"" $1 "\" from test directory."}'
1227
1228 echo ""
1229
1230 if test $fail != 0; then
1231 echo "$fail tests failed."
1232 exit 1
1233 else
1234 echo "All tests were successful."
1235 fi