OILS / soil / worker.sh View on Github | oilshell.org

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