summaryrefslogtreecommitdiff
path: root/validate
blob: 56c354ee595ffda6859fe1bcf1ad3849efdf2672 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
#!/bin/sh

set -e

show_help () {
    cat <<EOF
Usage: $0 [FLAGS]...

Validate GHC source tree against testsuite; see
https://gitlab.haskell.org/ghc/ghc/wikis/testing-patches for more
information.

Flags:
  --no-clean        don't make clean first, just carry on from
                    a previous interrupted validation run
  --testsuite-only  don't build the compiler, just run the test suite
  --build-only      don't test the compiler, just build it
  --hpc             build stage2 with -fhpc, and see how much of the
                    compiler the test suite covers.
                    2008-07-01: 63% slower than the default.
                    HTML generated here: testsuite/hpc_output/hpc_index.html
  --fast            Omit binary distribution. Omit certain tests.
  --slow            Build stage2 with -DDEBUG. Run tests for all WAYS,
                    but skip those that call compiler_stats_num_field.
                    2008-07-01: 14% slower than the default.
  --quiet           More pretty build log.
                    See Note [Default build system verbosity].
  --hadrian         Build the compiler and run the tests through hadrian.
  --stack           Use Stack to build Hadrian and the Stage 1 compiler.
  --help            shows this usage help.

  validate runs 'make -j\$THREADS', where by default THREADS is the number of
  cpus your computer has +1. You can set the environment variable THREADS to
  override this. For a sequential build you would for example use

    THREADS=1 ./validate

  You can set the 'config_args' environment variable to pass flags to
  'configure'.

  You can also use environment variables to pass extra options to the
  testsuite. For example:

    TEST='read001 read002' ./validate --testsuite-only --fast

EOF
}

no_clean=0
testsuite_only=0
build_only=0
hpc=NO
speed=NORMAL
be_quiet=0
# Validate uses gzip compression for the binary distribution to avoid the rather
# heavy cost of xz, which is the typical default. The options are defined in
# mk/config.mk.in
tar_comp=gzip
use_hadrian=NO
use_stack=NO

while [ $# -gt 0 ]
do
    case "$1" in
    --no-clean)
        no_clean=1
        ;;
    --testsuite-only)
        testsuite_only=1
        ;;
    --build-only)
        build_only=1
        ;;
    --hpc)
        hpc=YES
        ;;
    --slow)
        speed=SLOW
        ;;
    --fast)
        speed=FAST
        ;;
    --normal) # for backward compat
        speed=NORMAL
        ;;
    --quiet)
        be_quiet=1
        ;;
    --hadrian)
	use_hadrian=YES
	hadrian_build_root=_validatebuild
	;;
    --stack)
	use_stack=YES
	;;
    --help)
        show_help
        exit 0;;
    *)
        echo "$0: unrecognized argument '$1'" >&2
        echo "Try '$0 --help' for more information." >&2
        exit 1;;
    esac
    shift
done

check_packages () {
    if [ "$bindistdir" = "" ]
    then
	if [ "$use_hadrian" = "YES" ]
	then
	    ghc_pkg=$hadrian_build_root/stage1/bin/ghc-pkg
	else
            ghc_pkg=inplace/bin/ghc-pkg
	fi
    else
        ghc_pkg="$bindistdir"/bin/ghc-pkg
    fi

    if [ $be_quiet -eq 1 ]
    then
        "$ghc_pkg" check
    else
        echo "== Start $1 package check"
        "$ghc_pkg" check -v
        echo "== End $1 package check"
    fi
}

CPUS=`mk/detect-cpu-count.sh`

if ! [ -d testsuite ]
then
    echo 'Could not find the testsuite for validation' >&2
    exit 1
fi

if [ "$THREADS" = "" ]; then
    threads=$(($CPUS + 1)) # `expr $CPUS + 1`
else
    threads="$THREADS"
fi

echo "using THREADS=${threads}" >&2

if [ "$use_hadrian" = "NO" ]
then
    make="gmake"
   if type gmake > /dev/null 2> /dev/null
   then
       make="gmake"
   else
       make="make"
   fi
   if [ $be_quiet -eq 1 ]; then
       # See Note [Default build system verbosity].
       make="$make -s"
   fi
   $make -C utils/checkUniques
else
    # Just build hadrian.
    if [ "$use_stack" = "NO" ]
    then
       hadrian/build.sh --help > /dev/null
       cd hadrian
       hadrian_cmd=$(cabal new-exec -- which hadrian)
    else
       if [ $no_clean -eq 0 ]; then
          rm -rf hadrian/.stack-work
       fi
       hadrian/build.stack.sh --help > /dev/null
       cd hadrian
       hadrian_cmd=$(stack exec -- which hadrian)
    fi
    cd ..
    # TODO: define a hadrian Flavour that mimics
    # mk/flavours/validate.mk and use it here
    # Until then, we're using the default flavour.
    hadrian="$hadrian_cmd -j$threads --build-root=$hadrian_build_root"
    if [ $be_quiet -eq 0 ]; then
	hadrian="$hadrian -V"
    fi
    echo "Hadrian command: $hadrian"
fi

if [ $testsuite_only -eq 0 ]; then

thisdir=`pwd`

if [ $no_clean -eq 0 ]; then
    if [ "$use_hadrian" = "NO" ]
    then
	$make maintainer-clean
    else
	$hadrian clean && rm -rf $hadrian_build_root
    fi

    INSTDIR="$thisdir/inst"

    python3 ./boot --validate
    ./configure --prefix="$INSTDIR" $config_args
fi

if [ "$use_hadrian" = "NO" ]
then
    echo "Validating=YES"       >  mk/are-validating.mk
    echo "ValidateSpeed=$speed" >> mk/are-validating.mk
    echo "ValidateHpc=$hpc"     >> mk/are-validating.mk

    # Note [Default build system verbosity].
    #
    # From https://gitlab.haskell.org/ghc/ghc/wikis/design/build-system:
    #
    #   "The build system should clearly report what it's doing (and sometimes
    #   why), without being too verbose. It should emit actual command lines as
    #   much as possible, so that they can be inspected and cut & pasted."
    #
    # That should be the default. Only suppress commands, by setting V=0 and using
    # `make -s`, when user explicitly asks for it with `./validate --quiet`.
    if [ $be_quiet -eq 1 ]; then
	# See Note [Default build system verbosity].
	echo "V=0"                  >> mk/are-validating.mk # Less gunk
    fi

    $make -j$threads
    # For a "debug make", add "--debug=b --debug=m"
else
    case $speed in
    SLOW)
      flavour=slow-validate ;;
    NORMAL)
      flavour=validate ;;
    FAST)
      flavour=validate ;;
    esac
    $hadrian --flavour=$flavour
fi

check_packages post-build

bindistdir="bindisttest/install   dir"
ghc="$bindistdir/bin/ghc"

# -----------------------------------------------------------------------------
# Build and test a binary distribution (not --fast)

if [ $speed != "FAST" ]; then
    if [ "$use_hadrian" = "NO" ]
    then
	$make binary-dist-prep TAR_COMP=$tar_comp
	$make test_bindist TEST_PREP=YES TAR_COMP=$tar_comp
    else
	$hadrian binary-dist --docs=no-sphinx
	cfgdir=$(find $hadrian_build_root/bindist/ -name 'configure' | head -1)
	dir=$(dirname $cfgdir)
	cd "$dir"
	./configure --prefix="$thisdir/$bindistdir" && make install
	cd $thisdir
	"$ghc" -e 'Data.Text.IO.putStrLn (Data.Text.pack "bindist test: OK")'
    fi

    check_packages post-install

    if [ "$use_hadrian" = "NO" ]
    then
	$make validate_build_xhtml BINDIST_PREFIX="$thisdir/$bindistdir"
    else
        cd libraries/xhtml
        dynamicGhc=$("../../$ghc" --info | grep "GHC Dynamic" | cut -d',' -f3 | cut -d'"' -f2)
        if [ "$dynamicGhc" = "NO" ]
        then
            libFlags="--enable-shared --disable-library-vanilla"
        else
            libFlags="--disable-shared --enable-library-vanilla"
        fi
        libFlags="$libFlags --disable-library-prof"

       "../../$ghc" --make Setup
       ./Setup configure \
            --with-ghc="$thisdir/$ghc" \
            --with-haddock="$thisdir/$bindistdir/bin/haddock" \
            $libFlags \
		    --global --builddir=dist-bindist \
		    --prefix="$thisdir/$bindistdir"
	    ./Setup build --builddir=dist-bindist
	    ./Setup haddock -v0 --ghc-options=-optP-P --builddir=dist-bindist
	    ./Setup install --builddir=dist-bindist
	    ./Setup clean --builddir=dist-bindist
	    rm -f Setup Setup.exe Setup.hi Setup.o
	    cd ../../
    fi

    check_packages post-xhtml
fi

fi # testsuite-only

# -----------------------------------------------------------------------------
# Run the testsuite

if [ "$build_only" -eq 1 ]; then
    cat <<EOF
-------------------------------------------------------------------
Congratulations!  This tree has compiled successfully.

You can now test your new compiler using ./validate --testsuite-only.
EOF
    exit 0
fi

if [ "$hpc" = YES ]
then
    # XXX With threads we'd need to give a different tix file to each thread
    #     and then sum them up at the end
    threads=1
    HPCTIXFILE=$thisdir/testsuite/hpc_output/ghc.tix
    export HPCTIXFILE
    rm -f $HPCTIXFILE
fi

case "$speed" in
SLOW)
        MAKE_TEST_TARGET=slowtest
        BINDIST="BINDIST=YES"
	HADRIAN_TEST_SPEED=slow
        ;;
NORMAL)
        MAKE_TEST_TARGET=test
        BINDIST="BINDIST=YES"
	HADRIAN_TEST_SPEED=normal
        ;;
FAST)
        MAKE_TEST_TARGET=fasttest
        BINDIST="BINDIST=NO"
	HADRIAN_TEST_SPEED=fast
        ;;
esac

if [ $be_quiet -eq 1 ] && [ -z $VERBOSE ]; then
    TEST_VERBOSITY="VERBOSE=1"
fi

# We need to be quite picky on Windows about which Python interpreter we use
# (#12554, #12661). Allow the user to override it.
if [ "z$PYTHON" != "z" ]; then
    PYTHON_ARG="PYTHON=$PYTHON"
fi

rm -f testsuite_summary.txt testsuite_summary_stage1.txt

if [ "$use_hadrian" = "NO" ]
then
    # Use LOCAL=0, see Note [Running tests in /tmp].
    $make -C testsuite/tests $BINDIST $PYTHON_ARG \
	  $MAKE_TEST_TARGET stage=2 LOCAL=0 $TEST_VERBOSITY THREADS=$threads \
	  NO_PRINT_SUMMARY=YES SUMMARY_FILE=../../testsuite_summary.txt \
	  JUNIT_FILE=../../testsuite.xml \
	  2>&1 | tee testlog

    # Run a few tests using the stage1 compiler.
    # See Note [Why is there no stage1 setup function?].
    # Don't use BINDIST=YES, as stage1 is not available in a bindist.
    $make -C testsuite/tests/stage1 $PYTHON_ARG \
	  $MAKE_TEST_TARGET stage=1 LOCAL=0 $TEST_VERBOSITY THREADS=$threads \
	  NO_PRINT_SUMMARY=YES SUMMARY_FILE=../../../testsuite_summary_stage1.txt \
	  JUNIT_FILE=../../../testsuite_stage1.xml \
	  2>&1 | tee testlog-stage1
else
    testghc="$thisdir/$ghc"
    arg="test --test-speed=$HADRIAN_TEST_SPEED \
              --test-compiler=\"$testghc\" \
              --summary=$thisdir/testsuite_summary.txt \
              --summary-junit=$thisdir/testsuite.xml"
    sh -c "$hadrian $arg"
    # TODO: Run testsuite/tests/stage1 using the stage 1 compiler when
    # BINDIST=NO.
fi

echo
echo '==== STAGE 1 TESTS ==== '
cat testsuite_summary_stage1.txt

echo '==== STAGE 2 TESTS ==== '
cat testsuite_summary.txt

check_packages post-testsuite

if [ "$hpc" = YES ]
then
    utils/hpc/hpc markup --hpcdir=. --srcdir=compiler --srcdir=testsuite/hpc_output --destdir=testsuite/hpc_output testsuite/hpc_output/ghc.tix
fi

if
    grep '\<0 caused framework failures' testsuite_summary.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected passes' testsuite_summary.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected failures' testsuite_summary.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected stat failures' testsuite_summary.txt >/dev/null 2>/dev/null &&

    grep '\<0 caused framework failures' testsuite_summary_stage1.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected passes' testsuite_summary_stage1.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected failures' testsuite_summary_stage1.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected stat failures' testsuite_summary_stage1.txt >/dev/null 2>/dev/null ; then

    if [ $testsuite_only -eq 0 ] && [ $no_clean -eq 0 ]
    then
        cat <<EOF
-------------------------------------------------------------------
Congratulations!  This tree has passed minimal testing.

NOTE: If you have made changes that may cause failures not tested for by
the minimal testing procedure, please do further testing as necessary.

When you are satisfied that you haven't broken anything, go ahead and
push/send your patches.
EOF
        if [ -f mk/validate.mk ] && grep -q "^[^#]" mk/validate.mk
        then
            cat <<EOF

WARNING: You seem to have things set in mk/validate.mk. Please check
that it is OK before pushing.
EOF
        fi
        cat <<EOF
-------------------------------------------------------------------
EOF
    else
        cat <<EOF
-------------------------------------------------------------------
I didn't find any problems, but this wasn't a complete validate run,
so be careful!

NOTE: If you have made changes that may cause failures not tested for by
the minimal testing procedure, please do further testing as necessary.
-------------------------------------------------------------------
EOF
   fi
else
    if [ $be_quiet -eq 0 ]
    then
       cat <<EOF
-------------------------------------------------------------------
Oops!  Looks like you have some unexpected test results or framework failures.
Please fix them before pushing/sending patches.
-------------------------------------------------------------------
EOF
    fi
    exit 1
fi