OILS / soil / worker.sh View on Github | oils.pub

650 lines, 208 significant
1#!/usr/bin/env bash
2#
3# Run continuous build tasks.
4#
5# Usage:
6# soil/worker.sh <function name>
7
8set -o nounset
9set -o pipefail
10set -o errexit
11
12REPO_ROOT=$(cd "$(dirname $0)/.."; pwd) # tsv-lib.sh uses this
13readonly REPO_ROOT
14
15source soil/common.sh
16source test/tsv-lib.sh
17
18py-all-and-ninja() {
19 ### baseline for most tasks
20
21 build/py.sh all
22 ./NINJA-config.sh
23}
24
25ninja-config() {
26 ./NINJA-config.sh
27}
28
29dummy-tasks() {
30 ### Print tasks that execute quickly
31
32 # (task_name, script, action, result_html)
33 cat <<EOF
34os-info soil/diagnose.sh os-info -
35dump-env soil/diagnose.sh dump-env -
36EOF
37}
38
39raw-vm-tasks() {
40 # The perf tool depends on a specific version of a kernel, so run it outside
41 # a container.
42
43 # (task_name, script, action, result_html)
44 cat <<EOF
45os-info soil/diagnose.sh os-info -
46dump-env soil/diagnose.sh dump-env -
47perf-install benchmarks/perf.sh soil-install -
48wait-for-tarball soil/wait.sh for-cpp-tarball -
49test-install-tar devtools/release-native.sh test-install-tar -
50perf-profiles benchmarks/perf.sh soil-run _tmp/perf/index.html
51EOF
52}
53
54# Oh there is a large list of pre-installed software
55# https://github.com/actions/runner-images#available-images
56# https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2004-Readme.md
57# https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md
58#
59# 1. System deps for building wedges - ninja, cmake, libreadline-dev, etc.
60# 2. fetch wedges - re2c, cmark, python2, python3, MyPy, pyflakes
61# - Python 3.10 desired for "pea"
62# 3. build them
63# 4. build Oils with them
64
65dev-setup-for() {
66 local distro=$1
67 # (task_name, script, action, result_html)
68
69 cat <<EOF
70os-info soil/diagnose.sh os-info -
71dump-env soil/diagnose.sh dump-env -
72wedge-deps build/deps.sh wedge-deps-$distro -
73fetch build/deps.sh fetch -
74install-wedges build/deps.sh install-wedges-soil _build/wedge/logs/index.html
75py-all-and-ninja soil/worker.sh py-all-and-ninja -
76smoke-test build/dev-setup-test.sh smoke-test -
77wedge-report build/deps.sh wedge-report -
78EOF
79}
80
81spec-bin-for() {
82 local distro=$1
83 cat <<EOF
84os-info soil/diagnose.sh os-info -
85dump-env soil/diagnose.sh dump-env -
86wedge-deps build/deps.sh wedge-deps-$distro -
87fetch build/deps.sh fetch -
88spec-bin build/deps.sh install-spec-bin-fast _build/wedge/logs/index.html
89EOF
90}
91
92dev-setup-debian-tasks() {
93 # (task_name, script, action, result_html)
94
95 dev-setup-for debian
96}
97
98dev-setup-fedora-tasks() {
99 # (task_name, script, action, result_html)
100
101 dev-setup-for fedora
102}
103
104dev-setup-alpine-tasks() {
105 # (task_name, script, action, result_html)
106
107 dev-setup-for alpine
108}
109
110pea-tasks() {
111 ### Print tasks for the 'pea' build
112
113 # We need a later version of Python 3 / MyPy both to type check and
114 # to parse
115
116 # Run py-source so we can type check generated code
117 # We need to type check more than we translate
118
119 # (task_name, script, action, result_html)
120 cat <<EOF
121os-info soil/diagnose.sh os-info -
122dump-env soil/diagnose.sh dump-env -
123py-source build/py.sh py-source -
124typecheck pea/TEST.sh check-with-latest-mypy -
125parse-all pea/TEST.sh parse-all -
126EOF
127
128# Moved this to cpp-small, because it depends on py-all-and-ninja
129# run-tests pea/TEST.sh run-tests -
130}
131
132dev-minimal-tasks() {
133 ### Print tasks for the 'dev-minimal' build
134
135 # repo overview is suggested by README.md
136
137 # (task_name, script, action, result_html)
138 cat <<EOF
139os-info soil/diagnose.sh os-info -
140dump-env soil/diagnose.sh dump-env -
141build-minimal build/py.sh minimal -
142repo-overview metrics/source-code.sh overview -
143lint test/lint.sh soil-run -
144asdl-types asdl/TEST.sh check-types -
145oil-types devtools/types.sh soil-run -
146unit test/unit.sh minimal _test/py-unit/
147lossless test/lossless.sh soil-run -
148parse-errors test/parse-errors.sh soil-run-py -
149runtime-errors test/runtime-errors.sh soil-run-py -
150ysh-parse-errors test/ysh-parse-errors.sh soil-run-py -
151ysh-runtime-errors test/ysh-runtime-errors.sh soil-run-py -
152ysh-every-string test/ysh-every-string.sh soil-run-py -
153ysh-large ysh/run.sh soil-run -
154j8-errors data_lang/j8-errors.sh soil-run-py -
155error-catalog doc/error-catalog.sh soil-run-py -
156link-busybox-ash test/spec-bin.sh link-busybox-ash -
157osh-minimal test/spec-py.sh osh-minimal _tmp/spec/osh-minimal/index.html
158headless client/run.sh soil-run-py -
159stdlib-test stdlib/TEST.sh soil-run -
160EOF
161}
162
163interactive-tasks() {
164 ### Print tasks for the 'interactive' build
165
166 # TODO: also run interactive suite with osh-cpp
167
168# TODO: Why does the needs-terminal suite hang in Docker? It doesn't hang in an interactive Docker session.
169#
170# needs-terminal test/spec-py.sh needs-terminal-all _tmp/spec/needs-terminal-py/index.html
171#
172# https://oilshell.zulipchat.com/#narrow/stream/121539-oil-dev/topic/Spec.20Tests.20for.20Interactive.20Parsing
173
174 cat <<EOF
175os-info soil/diagnose.sh os-info -
176dump-env soil/diagnose.sh dump-env -
177py-all-and-ninja soil/worker.sh py-all-and-ninja -
178interactive-osh test/spec-py.sh interactive-osh _tmp/spec/interactive-osh/index.html
179nohup test/nohup.sh soil-run -
180process-table test/process-table.sh soil-run _tmp/process-table/index.html
181stateful test/stateful.sh soil-run _tmp/spec/stateful/index.html
182EOF
183
184}
185
186wild-tasks() {
187 ### Print tasks for the 'wild' build
188
189 # (task_name, script, action, result_html)
190 cat <<EOF
191os-info soil/diagnose.sh os-info -
192dump-env soil/diagnose.sh dump-env -
193wait-for-tarball soil/wait.sh for-cpp-tarball -
194test-tar devtools/release-native.sh test-tar -
195linecount metrics/tarball.sh linecount-oils-cpp -
196wild test/wild.sh soil-run _tmp/wild-www/index.html
197EOF
198}
199
200benchmarks-tasks() {
201 # (task_name, script, action, result_html)
202
203 cat <<EOF
204os-info soil/diagnose.sh os-info -
205dump-env soil/diagnose.sh dump-env -
206py-all-and-ninja soil/worker.sh py-all-and-ninja -
207dev-shell-test build/dev-shell-test.sh soil-run -
208id-test benchmarks/id-test.sh soil-run -
209osh-parser benchmarks/osh-parser.sh soil-run _tmp/osh-parser/index.html
210osh-runtime benchmarks/osh-runtime.sh soil-run _tmp/osh-runtime/index.html
211vm-baseline benchmarks/vm-baseline.sh soil-run _tmp/vm-baseline/index.html
212compute benchmarks/compute.sh soil-run _tmp/compute/index.html
213gc benchmarks/gc.sh soil-run _tmp/gc/index.html
214mycpp-benchmarks benchmarks/mycpp.sh soil-run _tmp/mycpp-examples/index.html
215EOF
216}
217
218bloaty-tasks() {
219 cat <<EOF
220os-info soil/diagnose.sh os-info -
221dump-env soil/diagnose.sh dump-env -
222wait-for-tarball soil/wait.sh for-cpp-tarball -
223test-tar devtools/release-native.sh test-tar -
224native-code metrics/native-code.sh oils-for-unix _tmp/metrics/oils-for-unix/
225EOF
226}
227
228benchmarks2-tasks() {
229 # Note: id-test doesn't run in 'other-tests' because 'gawk' isn't in that image
230 cat <<EOF
231os-info soil/diagnose.sh os-info -
232dump-env soil/diagnose.sh dump-env -
233wait-for-tarball soil/wait.sh for-cpp-tarball -
234test-tar devtools/release-native.sh test-tar -
235uftrace benchmarks/uftrace.sh soil-run _tmp/uftrace/index.html
236gc-cachegrind benchmarks/gc-cachegrind.sh soil-run _tmp/gc-cachegrind/index.html
237EOF
238}
239
240cpp-spec-tasks() {
241 # (task_name, script, action, result_html)
242
243 cat <<EOF
244os-info soil/diagnose.sh os-info -
245dump-env soil/diagnose.sh dump-env -
246py-all-and-ninja soil/worker.sh py-all-and-ninja -
247oils-cpp-smoke build/native.sh soil-run -
248osh-all test/spec-cpp.sh osh-all _tmp/spec/osh-cpp/compare.html
249ysh-all test/spec-cpp.sh ysh-all _tmp/spec/ysh-cpp/compare.html
250ysh-py test/spec-py.sh ysh-all-serial _tmp/spec/ysh-py/index.html
251EOF
252}
253
254cpp-tarball-tasks() {
255
256 # Note: build-times task requires _build/oils.sh
257 # It's a bit redundant with test-tar
258
259 cat <<EOF
260os-info soil/diagnose.sh os-info -
261dump-env soil/diagnose.sh dump-env -
262py-all-and-ninja soil/worker.sh py-all-and-ninja -
263oils-cpp-smoke build/native.sh soil-run -
264make-tar devtools/release-native.sh make-tar _release/oils-for-unix.tar
265xshar-hello devtools/xshar.sh soil-run-hello _release/hello-xshar.xshar
266xshar-test-oils devtools/xshar.sh soil-run-test-oils _release/test-oils.xshar
267build-times build/native.sh measure-build-times -
268EOF
269
270# build-times is a good enough test
271# test-tar devtools/release-native.sh test-tar -
272#
273# Note: tarball is deployed outside the container
274
275}
276
277cpp-small-tasks() {
278
279 # yaks could be moved to pea/ image once it has python2-dev
280 cat <<EOF
281os-info soil/diagnose.sh os-info -
282dump-env soil/diagnose.sh dump-env -
283py-all-and-ninja soil/worker.sh py-all-and-ninja -
284py-unit test/unit.sh all _test/py-unit/
285yaks yaks/TEST.sh soil-run -
286pea pea/TEST.sh run-tests -
287oils-cpp-smoke build/native.sh soil-run -
288cpp-unit test/cpp-unit.sh soil-run _test/-wwz-index
289headless client/run.sh soil-run-cpp -
290asan test/asan.sh soil-run -
291ltrace test/ltrace.sh soil-run -
292micro-syntax doctools/micro-syntax.sh soil-run -
293src-tree doctools/src-tree.sh soil-run _tmp/src-tree-www/index.html
294line-counts metrics/source-code.sh write-reports _tmp/metrics/line-counts/-wwz-index
295preprocessed metrics/source-code.sh preprocessed _tmp/metrics/preprocessed/-wwz-index
296mycpp-examples mycpp/TEST.sh soil-run _test/-wwz-index
297parse-errors test/parse-errors.sh soil-run-cpp -
298runtime-errors test/runtime-errors.sh soil-run-cpp -
299ysh-parse-errors test/ysh-parse-errors.sh soil-run-cpp -
300ysh-runtime-errors test/ysh-runtime-errors.sh soil-run-cpp -
301ysh-every-string test/ysh-every-string.sh soil-run-cpp -
302ysh-large ysh/run.sh soil-run-cpp -
303j8-errors data_lang/j8-errors.sh soil-run-cpp -
304error-catalog doc/error-catalog.sh soil-run-cpp -
305houston-fp demo/houston-fp/run.sh soil-run -
306souffle-smoke-test test/souffle-smoke.sh soil-run -
307EOF
308}
309
310cpp-coverage-tasks() {
311 # dep notes: hnode_asdl.h required by expr_asdl.h in mycpp/examples
312
313 # TODO: make this work
314#tar-compile benchmarks/ovm-build.sh soil-run -
315 cat <<EOF
316os-info soil/diagnose.sh os-info -
317dump-env soil/diagnose.sh dump-env -
318py-all-and-ninja soil/worker.sh py-all-and-ninja -
319extract-clang deps/from-binary.sh extract-clang-in-container -
320mycpp-unit-coverage mycpp/TEST.sh unit-test-coverage _test/clang-coverage/mycpp/html/index.html
321mycpp-examples-coverage mycpp/TEST.sh examples-coverage _test/clang-coverage/mycpp/examples/html/index.html
322cpp-coverage cpp/TEST.sh coverage _test/clang-coverage/cpp/html/index.html
323unified-coverage test/coverage.sh unified-report _test/clang-coverage/unified/html/index.html
324compare-gcc-clang metrics/native-code.sh compare-gcc-clang _tmp/metrics/compare-gcc-clang.txt
325EOF
326}
327
328ovm-tarball-tasks() {
329 ### Print tasks for the 'ovm-tarball' build
330
331 # notes:
332 # - py-all needed to crawl dependencies to make tarball.
333
334 # (task_name, script, action, result_html)
335 cat <<EOF
336os-info soil/diagnose.sh os-info -
337dump-env soil/diagnose.sh dump-env -
338py-all build/py.sh all -
339make-tarball devtools/release.sh py-tarball _release/oil.tar
340ysh-ovm-tarball test/spec-py.sh ysh-ovm-tarball _tmp/spec/ysh-py/index.html
341syscall test/syscall.sh soil-run _tmp/syscall/-wwz-index
342osh-spec test/spec-py.sh osh-all-serial _tmp/spec/osh-py/index.html
343gold test/gold.sh soil-run -
344osh-usage test/osh-usage.sh soil-run -
345tools-deps test/tools-deps.sh soil-run -
346docs build/doc.sh soil-run _release/VERSION/index.html
347doc-metrics echo no-op _release/VERSION/doc/metrics.txt
348EOF
349# doc-metrics is a no-op, just for the link. Because soil-run just runs the
350# release, which creates metrics.
351
352}
353
354# Reuse ovm-tarball container
355app-tests-tasks() {
356
357 cat <<EOF
358os-info soil/diagnose.sh os-info -
359dump-env soil/diagnose.sh dump-env -
360py-all build/py.sh all -
361ble-clone test/ble.sh clone -
362ble-build test/ble.sh build -
363ble-bash-suite test/ble.sh bash-suite -
364ble-test-osh-py test/ble.sh run-tests-osh-py -
365wait-for-tarball soil/wait.sh for-cpp-tarball -
366test-tar devtools/release-native.sh test-tar -
367ble-test-osh-cpp test/ble.sh run-tests-osh-cpp -
368EOF
369
370# This doesn't work
371# ble-test-osh-bash test/ble.sh run-tests-osh-bash -
372}
373
374# TODO: Most of these should be Ninja tasks.
375# Other tests:
376# find-test, xargs-test, pgen2-test, web/table/csv2html-test.sh
377# Probably should start using a shell test framework too.
378other-tests-tasks() {
379 cat <<EOF
380os-info soil/diagnose.sh os-info -
381dump-env soil/diagnose.sh dump-env -
382build-minimal build/py.sh minimal -
383configure-test ./configure-test.sh soil_run -
384time-test benchmarks/time-test.sh soil-run -
385tsv-lib-test test/tsv-lib-test.sh soil-run -
386ysh-ify test/ysh-ify.sh soil-run -
387R-test devtools/R-test.sh soil-run -
388xargs-test test/other.sh xargs-test -
389csv2html-test test/other.sh csv2html-test -
390oil-python-symbols metrics/source-code.sh oil-python-symbols -
391opyc test/opyc.sh soil-run -
392opy-count-lines opy/soil.sh count-lines -
393test-gold opy/soil.sh test-gold -
394build-oil-repo opy/soil.sh build-oil-repo -
395regtest-compile opy/soil.sh regtest-compile -
396EOF
397
398# TODO: add this back after fixing transitive test enumeration problem
399# We shouldn't use
400
401# web-remote-test soil/web-remote-test.sh soil-run -
402}
403
404tests-todo() {
405 ### More tests to add
406 find . -name '_*' -a -prune -o -name '*-test.sh' -a -print
407
408 # pgen2/pgen2-test.sh seems mostly broken
409}
410
411# Redefinition for quicker cloud debugging
412maybe-merge-tasks() {
413 cat <<EOF
414os-info soil/diagnose.sh os-info -
415dump-env soil/diagnose.sh dump-env -
416maybe-merge soil/maybe-merge.sh soil-run -
417EOF
418}
419
420run-tasks() {
421 ### Run the tasks on stdin and write _tmp/soil/INDEX.tsv.
422 local job_name=$1
423 local out_dir=$2 # should already exist
424 local tty=$3
425
426 mkdir -p $out_dir/logs
427
428 # So we can run benchmarks/time_.py.
429 # 2023-02-28: Images like soil-wild based off the new soil-common no longer
430 # have 'cc'. Instead they use a wedge.
431 if command -v cc > /dev/null; then
432 build/py.sh time-helper
433 else
434 echo 'test time-tsv3'
435 time-tsv3 -o /tmp/echo.tsv --append -- echo hi
436
437 echo '/tmp/echo.tsv:'
438 cat /tmp/echo.tsv
439 fi
440
441 # For the later deploy step to pick up
442 date +%s > $out_dir/task-run-start-time.txt
443
444 # This data can go on the dashboard index
445 local tsv=$out_dir/INDEX.tsv
446 rm -f $tsv
447
448 local status
449 local max_status=0
450
451 while read task_name script action result_html; do
452 log "--- task: $task_name ---"
453
454 local log_path=$out_dir/logs/$task_name.txt
455
456 # 15 minutes per task
457 # One of the longest tasks is test/spec-cpp, which takes around 420 seconds
458 # TODO: should have a configurable timeout
459 local -a timeout=(timeout 900)
460 local stdin_tty=''
461
462 case $script in
463 test/process-table.sh)
464 # Workaround for weird interaction, see
465 # $ test/process-table.sh timeout-issue
466 timeout=()
467 ;;
468 test/nohup.sh)
469 # Only run test/nohup.sh with TTY. For some reason build/py.sh all hangs
470 # with $tty?
471 stdin_tty=$tty
472 ;;
473 esac
474
475 local -a argv=(
476 time-tsv3 -o $tsv --append
477 --field $task_name --field $script --field $action
478 --field $result_html --
479 "${timeout[@]}" "$script" "$action"
480 )
481
482 # Run task and save status
483 set +o errexit
484 if test -n "$stdin_tty"; then
485 # explicitly connect TTY, e.g. for soil/interactive
486 "${argv[@]}" > $log_path 2>&1 < $stdin_tty
487 else
488 # Temporary fix: build/doc.sh soil-run reads from stdin!
489 "${argv[@]}" > $log_path 2>&1 < /dev/null
490 fi
491 status=$?
492 set -o errexit
493
494 if test "$status" -gt "$max_status"; then
495 max_status=$status
496 fi
497
498 # Show the last line
499 echo
500 tsv-row status elapsed task script action result_html
501 tail -n 1 $tsv
502 echo
503 log "status=$status max_status=$max_status"
504 done
505
506 log '--- done ---'
507 ls -l $out_dir
508 wc -l $out_dir/logs/*
509
510 # This suppressed the deployment of logs, which we don't want. So all our
511 # Travis builds succeed? But then we can't use their failure notifications
512 # (which might be OK).
513 if false; then
514 # exit with the maximum exit code.
515 awk '
516 BEGIN { max = 0 }
517 { if ($1 > max) { max = $1 } }
518 END { exit(max) }
519 ' $tsv
520 fi
521
522 # To fail later. Important: this dir persists across jobs; it's NOT removed
523 # by 'host-shim.sh job-reset'.
524 mkdir -p _soil-jobs
525
526 # Hack: Assign job_id and write it to the status file. Other jobs can poll
527 # for completion of this job and access its resources.
528
529 local job_id
530 job_id="$(date +%Y-%m-%d__%H-%M-%S)"
531
532 # e.g. _soil-jobs/dummy.status.txt
533 echo "$max_status $job_id" > _soil-jobs/$job_name.status.txt
534}
535
536save-metadata() {
537 ### Write metadata files to be saved as JSON
538
539 # NOTE: host-shim.sh also writes image-pull-time.txt
540
541 local job_name=$1
542 local meta_dir=$2
543
544 echo "$job_name" > $meta_dir/job-name.txt
545
546 # command to show current branch
547 # This does NOT work in detached HEAD! Travis puts the branch in an env
548 # variable, but sr.ht doesn't.
549 # git rev-parse --abbrev-ref HEAD > $meta_dir/git-branch.txt
550
551 git log -n 1 --pretty='format:%H' > $meta_dir/commit-hash.txt
552
553 # ISO 8601 format
554 # Note: this can get confused with rebases. Two different commits can have
555 # the same date.
556 git log -n 1 --pretty='format:%aI' > $meta_dir/commit-date.txt
557
558 git log -n 1 --pretty='format:%s' > $meta_dir/commit-line.txt # "subject"
559}
560
561disable-git-errors() {
562
563 # 2023-02: The build started failing because of the permissions we set in
564 # soil/host-shim.sh mount-perms.
565 #
566 # The issue is that the guest needs to be able to write to the Docker mount
567 # of the repo. I think it may have been related to podman vs. Docker.
568 # Should check if mount-perms is necessary in both places.
569 #
570 # git fails unless we have this workaround.
571
572 # https://stackoverflow.com/questions/72978485/git-submodule-update-failed-with-fatal-detected-dubious-ownership-in-repositor
573
574 # https://github.blog/2022-04-12-git-security-vulnerability-announced/
575
576 #git config --global --add safe.directory '*'
577
578 git config --global --add safe.directory /home/uke/oil
579}
580
581job-main() {
582 local job_name=$1
583
584 local out_dir=_tmp/soil
585
586 # Report for debugging
587 export EXTRA_MYCPP_ARGS='--stack-roots-warn 16'
588
589 log-context 'job-main'
590 mkdir -v -p $out_dir
591 ls -l -d $out_dir
592
593 disable-git-errors
594
595 save-metadata $job_name $out_dir
596
597 local captured
598
599 set +o errexit
600 captured=$(tty)
601 status=$?
602 set -o errexit
603
604 if test $status -eq 0; then
605 echo "TTY = $captured"
606 local tty=$captured
607 else
608 echo "captured = $captured"
609 local tty='' # clear the output
610 fi
611 echo
612
613 ${job_name}-tasks | run-tasks $job_name $out_dir "$tty"
614}
615
616JOB-dummy() { job-main 'dummy'; }
617JOB-raw-vm() { job-main 'raw-vm'; }
618JOB-dev-setup-debian() { job-main 'dev-setup-debian'; }
619JOB-dev-setup-fedora() { job-main 'dev-setup-fedora'; }
620JOB-dev-setup-alpine() { job-main 'dev-setup-alpine'; }
621
622JOB-dev-minimal() { job-main 'dev-minimal'; }
623JOB-interactive() { job-main 'interactive'; }
624
625JOB-other-tests() { job-main 'other-tests'; }
626
627JOB-pea() { job-main 'pea'; }
628
629JOB-ovm-tarball() { job-main 'ovm-tarball'; }
630JOB-app-tests() { job-main 'app-tests'; }
631
632JOB-cpp-coverage() { job-main 'cpp-coverage'; }
633JOB-cpp-small() { job-main 'cpp-small'; }
634JOB-cpp-tarball() { job-main 'cpp-tarball'; }
635JOB-cpp-spec() { job-main 'cpp-spec'; }
636
637JOB-bloaty() { job-main 'bloaty'; }
638JOB-benchmarks() { job-main 'benchmarks'; }
639JOB-benchmarks2() { job-main 'benchmarks2'; }
640
641JOB-wild() { job-main 'wild'; }
642
643JOB-maybe-merge() { job-main 'maybe-merge'; }
644
645list-jobs() {
646 # dev-setup-fedora for Fedora, disable
647 compgen -A function | grep -- '^JOB-' | sed 's/^JOB-//g' | egrep -v 'maybe-merge|dev-setup-fedora|dev-setup-alpine'
648}
649
650"$@"