ci: run FreeBSD on a VM in github ci, instead of on the Cirrus service (which stopped working today) (#23692)

spytheman · web-flow · commit b5d6f406af28 · 2025-02-11T17:35:04.000+02:00
diff --git a/.cirrus.yml b/.cirrus.yml
diff --git a/.github/workflows/freebsd_ci.yml b/.github/workflows/freebsd_ci.yml
@@ -0,0 +1,69 @@
+name: CI FreeBSD
+
+on:
+  workflow_dispatch:
+  push:
+    paths-ignore:
+      - '**.md'
+      - '**.yml'
+      - 'cmd/tools/**'
+      - '!**/freebsd_ci.yml'
+      - '!ci/freebsd_ci.vsh'
+      - '!cmd/tools/builders/**.v'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**.yml'
+      - 'cmd/tools/**'
+      - '!**/freebsd_ci.yml'
+      - '!ci/freebsd_ci.vsh'
+      - '!cmd/tools/builders/**.v'
+
+### See https://github.com/vmactions/freebsd-vm
+### for a description of the used fields here
+
+jobs:
+  test-on-freebsd-14-2-x86:
+    runs-on: ubuntu-latest
+    name: Run a FreeBSD 14.2 x86 VM
+    steps:
+      - uses: actions/checkout@v4
+      - name: Test in FreeBSD
+        id: test-freebsd-14-2-runs-in-vm
+        uses: vmactions/freebsd-vm@v1
+        with:
+          release: '14.2'
+          mem: 4096
+          usesh: true
+          copyback: false
+          prepare: pkg install -y git sqlite3 bash
+          run: |
+            git config --global --add safe.directory /home/runner/work/v/v
+            make CFLAGS=
+            ./v symlink
+            ./v run ci/freebsd_ci.vsh all
+
+##### Run a FreeBSD 14 x86 VM:
+##### [ 2/25] C:   808.5 ms, R:     3.835 ms vlib/math/big/array_ops_test.v
+##### Run a FreeBSD 15 ARM VM
+##### [ 1/25] C: 15992.4 ms, R:   146.582 ms vlib/math/big/array_ops_test.v
+##### => the overhead is too much to be practical for the full test suite.
+##### It is still nice, that it works at all though ...
+##  test-on-freebsd-15-aarch64:
+##    runs-on: ubuntu-latest
+##    name: Run a FreeBSD 15 ARM VM
+##    steps:
+##      - uses: actions/checkout@v4
+##      - name: Test in FreeBSD
+##        id: test-freebsd-15-runs-in-vm
+##        uses: vmactions/freebsd-vm@v1
+##        with:
+##          release: "15.0"
+##          arch: aarch64
+##          ## cpu: 3
+##          mem: 4096
+##          usesh: true
+##          copyback: false
+##          prepare: pkg install -y git sqlite3 bash
+##          run: |
+##            ./.github/workflows/freebsd_ci.sh
diff --git a/ci/common/runner.v b/ci/common/runner.v
@@ -14,6 +14,9 @@ pub fn exec(command string) {
 	}
 }
 
+const self_command = 'v ' +
+	os.real_path(os.executable()).replace_once(os.real_path(@VROOT), '').trim_left('/\\') + '.vsh'
+
 pub const is_github_job = os.getenv('GITHUB_JOB') != ''
 
 pub type Fn = fn ()
@@ -24,12 +27,14 @@ pub mut:
 	label string
 }
 
-pub fn (t Task) run() {
-	log.info(term.colorize(term.yellow, t.label))
+pub fn (t Task) run(tname string) {
+	cmd := '${self_command} ${tname}'
+	log.info('Start ${term.colorize(term.yellow, t.label)}, cmd: `${cmd}`')
 	start := time.now()
 	t.f()
 	dt := time.now() - start
-	log.info('Finished ${term.colorize(term.yellow, t.label)} in ${dt.milliseconds()} ms')
+	log.info('Finished ${term.colorize(term.yellow, t.label)} in ${dt.milliseconds()} ms, cmd: `${cmd}`')
+	println('')
 }
 
 pub fn run(all_tasks map[string]Task) {
@@ -43,14 +48,14 @@ pub fn run(all_tasks map[string]Task) {
 	task_name := os.args[1]
 	if task_name == 'all' {
 		log.info(term.colorize(term.green, 'Run everything...'))
-		for _, t in all_tasks {
-			t.run()
+		for tname, t in all_tasks {
+			t.run(tname)
 		}
 		exit(0)
 	}
 	t := all_tasks[task_name] or {
-		eprintln('Unknown task: ${task_name}')
+		eprintln('Unknown task with name: `${task_name}`')
 		exit(1)
 	}
-	t.run()
+	t.run(task_name)
 }
diff --git a/ci/freebsd_ci.vsh b/ci/freebsd_ci.vsh
@@ -0,0 +1,59 @@
+import os
+import common { Task, exec }
+
+fn v_doctor() {
+	dump(os.getenv('PATH'))
+	exec('v doctor')
+	if common.is_github_job {
+		exec('freebsd-version')
+		exec('sysctl hw.model')
+		exec('sysctl hw.ncpu')
+		exec('sysctl hw.physmem')
+		exec('sysctl hw.usermem')
+		exec('whoami')
+		exec('pwd')
+		exec('ls -la')
+		exec('git log -n1')
+		exec('cc --version')
+	}
+}
+
+fn verify_v_test_works() {
+	exec('echo \$VFLAGS')
+	exec('v cmd/tools/test_if_v_test_system_works.v')
+	exec('./cmd/tools/test_if_v_test_system_works')
+}
+
+fn build_fast_script() {
+	exec('cd cmd/tools/fast && v fast.v')
+}
+
+fn check_math() {
+	exec('v test vlib/math')
+	println('Test the math module, using only the pure V versions,')
+	println('                          without the .c.v overrides.')
+	exec('v -exclude @vlib/math/*.c.v test vlib/math')
+}
+
+fn check_compress() {
+	exec('v test vlib/compress')
+}
+
+fn run_essential_tests() {
+	if common.is_github_job {
+		exec('VTEST_JUST_ESSENTIAL=1 v test-self')
+	} else {
+		exec('VTEST_JUST_ESSENTIAL=1 v -progress test-self')
+	}
+}
+
+const all_tasks = {
+	'v_doctor':            Task{v_doctor, 'Run v doctor'}
+	'verify_v_test_works': Task{verify_v_test_works, 'Verify that v test works'}
+	'build_fast_script':   Task{build_fast_script, 'Check that building fast.v works'}
+	'check_math':          Task{check_math, 'Check the `math` module works'}
+	'check_compress':      Task{check_compress, 'Check the `compress` module works'}
+	'run_essential_tests': Task{run_essential_tests, 'Run only the essential tests'}
+}
+
+common.run(all_tasks)
diff --git a/ci/linux_ci.vsh b/ci/linux_ci.vsh
@@ -50,8 +50,8 @@ fn v_doctor() {
 //
 
 fn build_v_with_prealloc() {
-	exec('v -d debug_malloc -d debug_realloc -o v cmd/v')
-	exec('v -cg -cstrict -o v cmd/v')
+	exec('v -d debug_malloc -d debug_realloc -o vdebug1 cmd/v')
+	exec('v -cg -cstrict -o vstrict1 cmd/v')
 	exec('v -o vrealloc -prealloc cmd/v && ./vrealloc -o v3 cmd/v && ./v3 -o v4 cmd/v')
 }
 
@@ -68,7 +68,7 @@ fn install_dependencies_for_examples_and_tools_tcc() {
 
 fn test_v_to_c_tcc() {
 	exec('thirdparty/tcc/tcc.exe -version')
-	exec('v -cg -o v cmd/v') // ensure vtcc can build itself twice
+	exec('v -cg -o vtcc cmd/v') // ensure vtcc can build itself twice
 }
 
 fn v_self_compilation_tcc() {
@@ -175,7 +175,7 @@ fn install_dependencies_for_examples_and_tools_gcc() {
 }
 
 fn recompile_v_with_cstrict_gcc() {
-	exec('v -cc gcc -cg -cstrict -o v cmd/v')
+	exec('v -cc gcc -cg -cstrict -o vstrict cmd/v')
 }
 
 fn valgrind_v_c_gcc() {
@@ -292,7 +292,7 @@ fn install_dependencies_for_examples_and_tools_clang() {
 }
 
 fn recompile_v_with_cstrict_clang() {
-	exec('v -cc clang -cg -cstrict -o v cmd/v')
+	exec('v -cc clang -cg -cstrict -o vstrict cmd/v')
 }
 
 fn valgrind_clang() {
diff --git a/ci/macos_ci.vsh b/ci/macos_ci.vsh
@@ -10,7 +10,7 @@ fn test_cross_compilation() {
 }
 
 fn build_with_cstrict() {
-	exec('v -cg -cstrict -o v cmd/v')
+	exec('v -cg -cstrict -o vstrict1 cmd/v')
 }
 
 fn all_code_is_formatted() {

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,9 @@ pub fn exec(command string) {`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`
	`17`	`+const self_command = 'v ' +`
	`18`	`+ os.real_path(os.executable()).replace_once(os.real_path(@VROOT), '').trim_left('/\\') + '.vsh'`
	`19`	`+`
`17`	`20`	`pub const is_github_job = os.getenv('GITHUB_JOB') != ''`
`18`	`21`
`19`	`22`	`pub type Fn = fn ()`
`@@ -24,12 +27,14 @@ pub mut:`
`24`	`27`	`label string`
`25`	`28`	`}`
`26`	`29`
`27`		`-pub fn (t Task) run() {`
`28`		`- log.info(term.colorize(term.yellow, t.label))`
	`30`	`+pub fn (t Task) run(tname string) {`
	`31`	`+ cmd := '${self_command} ${tname}'`
	`32`	+ log.info('Start ${term.colorize(term.yellow, t.label)}, cmd: `${cmd}`')
`29`	`33`	`start := time.now()`
`30`	`34`	`t.f()`
`31`	`35`	`dt := time.now() - start`
`32`		`- log.info('Finished ${term.colorize(term.yellow, t.label)} in ${dt.milliseconds()} ms')`
	`36`	+ log.info('Finished ${term.colorize(term.yellow, t.label)} in ${dt.milliseconds()} ms, cmd: `${cmd}`')
	`37`	`+ println('')`
`33`	`38`	`}`
`34`	`39`
`35`	`40`	`pub fn run(all_tasks map[string]Task) {`
`@@ -43,14 +48,14 @@ pub fn run(all_tasks map[string]Task) {`
`43`	`48`	`task_name := os.args[1]`
`44`	`49`	`if task_name == 'all' {`
`45`	`50`	`log.info(term.colorize(term.green, 'Run everything...'))`
`46`		`- for _, t in all_tasks {`
`47`		`- t.run()`
	`51`	`+ for tname, t in all_tasks {`
	`52`	`+ t.run(tname)`
`48`	`53`	`}`
`49`	`54`	`exit(0)`
`50`	`55`	`}`
`51`	`56`	`t := all_tasks[task_name] or {`
`52`		`- eprintln('Unknown task: ${task_name}')`
	`57`	+ eprintln('Unknown task with name: `${task_name}`')
`53`	`58`	`exit(1)`
`54`	`59`	`}`
`55`		`- t.run()`
	`60`	`+ t.run(task_name)`
`56`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,8 +50,8 @@ fn v_doctor() {`
`50`	`50`	`//`
`51`	`51`
`52`	`52`	`fn build_v_with_prealloc() {`
`53`		`- exec('v -d debug_malloc -d debug_realloc -o v cmd/v')`
`54`		`- exec('v -cg -cstrict -o v cmd/v')`
	`53`	`+ exec('v -d debug_malloc -d debug_realloc -o vdebug1 cmd/v')`
	`54`	`+ exec('v -cg -cstrict -o vstrict1 cmd/v')`
`55`	`55`	`exec('v -o vrealloc -prealloc cmd/v && ./vrealloc -o v3 cmd/v && ./v3 -o v4 cmd/v')`
`56`	`56`	`}`
`57`	`57`
`@@ -68,7 +68,7 @@ fn install_dependencies_for_examples_and_tools_tcc() {`
`68`	`68`
`69`	`69`	`fn test_v_to_c_tcc() {`
`70`	`70`	`exec('thirdparty/tcc/tcc.exe -version')`
`71`		`- exec('v -cg -o v cmd/v') // ensure vtcc can build itself twice`
	`71`	`+ exec('v -cg -o vtcc cmd/v') // ensure vtcc can build itself twice`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`fn v_self_compilation_tcc() {`
`@@ -175,7 +175,7 @@ fn install_dependencies_for_examples_and_tools_gcc() {`
`175`	`175`	`}`
`176`	`176`
`177`	`177`	`fn recompile_v_with_cstrict_gcc() {`
`178`		`- exec('v -cc gcc -cg -cstrict -o v cmd/v')`
	`178`	`+ exec('v -cc gcc -cg -cstrict -o vstrict cmd/v')`
`179`	`179`	`}`
`180`	`180`
`181`	`181`	`fn valgrind_v_c_gcc() {`
`@@ -292,7 +292,7 @@ fn install_dependencies_for_examples_and_tools_clang() {`
`292`	`292`	`}`
`293`	`293`
`294`	`294`	`fn recompile_v_with_cstrict_clang() {`
`295`		`- exec('v -cc clang -cg -cstrict -o v cmd/v')`
	`295`	`+ exec('v -cc clang -cg -cstrict -o vstrict cmd/v')`
`296`	`296`	`}`
`297`	`297`
`298`	`298`	`fn valgrind_clang() {`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ fn test_cross_compilation() {`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`fn build_with_cstrict() {`
`13`		`- exec('v -cg -cstrict -o v cmd/v')`
	`13`	`+ exec('v -cg -cstrict -o vstrict1 cmd/v')`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`fn all_code_is_formatted() {`