os: deprecate os.exec (returning ?os.Result), in favour of os.execute, which returns os.Result (vlang#8974)

Author: spytheman

.github/workflows/ci.yml

@@ -1015,5 +1015,5 @@ jobs:
         run: git clone --depth 1 https://github.com/vlang/vab
       - name: Build vab
         run: cd vab; ../v ./vab.v ; cd ..
-      - name: Build vab with -prod
-        run: cd vab; ../v -prod ./vab.v ; cd ..
+      - name: Build vab with
+        run: cd vab; ../v ./vab.v ; cd ..

CHANGELOG.md

@@ -29,6 +29,7 @@ from local variables.
 - Support for compile time environment variables via `$env('ENV_VAR')`.
 - Allow method declaration of `==` and `<` operators and auto generate `!=`, `>`, `<=` and `>=`.
 - support `dump(expr)`, i.e. tracing of both the location, name and value of an expression
+- deprecate os.exec in favour of os.executable() which does *NOT* return an option, when the command was not found
 
 ## V 0.2.1
 *30 Dec 2020*

cmd/tools/fast/fast.v

@@ -50,7 +50,7 @@ fn main() {
 	date := time.unix(commit_date.int())
 	mut out := os.create('table.html') ?
 	// Place the new row on top
-	table =
+	table = 
 		'<tr>
 		<td>$date.format()</td>
 		<td><a target=_blank href="https://github.com/vlang/v/commit/$commit">$commit</a></td>
@@ -81,7 +81,7 @@ fn main() {
 }
 
 fn exec(s string) string {
-	e := os.exec(s) or { panic(err) }
+	e := os.execute_or_panic(s)
 	return e.output.trim_right('\r\n')
 }
 
@@ -111,7 +111,7 @@ fn measure(cmd string, description string) int {
 }
 
 fn measure_steps(vdir string) (int, int, int) {
-	resp := os.exec('$vdir/vprod -o v.c -show-timings $vdir/cmd/v') or { panic(err) }
+	resp := os.execute_or_panic('$vdir/vprod -o v.c -show-timings $vdir/cmd/v')
 	lines := resp.output.split_into_lines()
 	if lines.len != 3 {
 		return 0, 0, 0

cmd/tools/fast/fast_job.v

@@ -17,20 +17,22 @@ fn main() {
 		return
 	}
 	for {
-		os.exec('git pull --rebase') or {
+		res_pull := os.execute('git pull --rebase')
+		if res_pull.exit_code != 0 {
 			println('failed to git pull. uncommitted changes?')
 			return
 		}
 		// println('running fast')
-		resp := os.exec('./fast') or {
-			println(err)
+		resp := os.execute('./fast')
+		if resp.exit_code < 0 {
+			println(resp.output)
 			return
 		}
 		if resp.exit_code != 0 {
 			println('resp != 0, skipping')
 		} else {
 			os.chdir('website')
-			os.exec('git checkout gh-pages') ?
+			os.execute_or_panic('git checkout gh-pages')
 			os.cp('../index.html', 'index.html') ?
 			os.system('git commit -am "update benchmark"')
 			os.system('git push origin gh-pages')

cmd/tools/gen_vc.v

@@ -43,13 +43,13 @@ const (
 	// version
 	app_version          = '0.1.2'
 	// description
-	app_description      = "This tool regenerates V\'s bootstrap .c files every time the V master branch is updated."
+	app_description      = "This tool regenerates V's bootstrap .c files every time the V master branch is updated."
 	// assume something went wrong if file size less than this
 	too_short_file_limit = 5000
 	// create a .c file for these os's
 	vc_build_oses        = [
 		'nix',
-		/* all nix based os */
+		// all nix based os
 		'windows',
 	]
 )
@@ -188,8 +188,8 @@ fn parse_flags(mut fp flag.FlagParser) FlagOptions {
 		work_dir: fp.string('work-dir', 0, work_dir, 'gen_vc working directory')
 		purge: fp.bool('purge', 0, false, 'force purge the local repositories')
 		port: fp.int('port', 0, server_port, 'port for web server to listen on')
-		log_to: fp.string('log-to', 0, log_to, "log to is \'file\' or \'terminal\'")
-		log_file: fp.string('log-file', 0, log_file, "log file to use when log-to is \'file\'")
+		log_to: fp.string('log-to', 0, log_to, "log to is 'file' or 'terminal'")
+		log_file: fp.string('log-file', 0, log_file, "log file to use when log-to is 'file'")
 		dry_run: fp.bool('dry-run', 0, dry_run, 'when specified dont push anything to remote repo')
 		force: fp.bool('force', 0, false, 'force update even if already up to date')
 	}
@@ -318,9 +318,10 @@ fn (mut gen_vc GenVC) command_execute(cmd string, dry bool) string {
 		return gen_vc.command_execute_dry(cmd)
 	}
 	gen_vc.logger.info('cmd: $cmd')
-	r := os.exec(cmd) or {
+	r := os.execute(cmd)
+	if r.exit_code < 0 {
 		gen_vc.logger.error('$err_msg_cmd_x: "$cmd" could not start.')
-		gen_vc.logger.error(err.msg)
+		gen_vc.logger.error(r.output)
 		// something went wrong, better start fresh next time
 		gen_vc.purge_repos()
 		gen_vc.gen_error = true

cmd/tools/modules/scripting/scripting.v

@@ -60,19 +60,23 @@ pub fn rmrf(path string) {
 	}
 }
 
+// execute a command, and return a result, or an error, if it failed in any way.
 pub fn exec(cmd string) ?os.Result {
 	verbose_trace(@FN, cmd)
-	x := os.exec(cmd) or {
+	x := os.execute(cmd)
+	if x.exit_code != 0 {
 		verbose_trace(@FN, '## failed.')
-		return err
+		return error(x.output)
 	}
 	verbose_trace_exec_result(x)
 	return x
 }
 
+// run a command, tracing its results, and returning ONLY its output
 pub fn run(cmd string) string {
 	verbose_trace(@FN, cmd)
-	x := os.exec(cmd) or {
+	x := os.execute(cmd)
+	if x.exit_code < 0 {
 		verbose_trace(@FN, '## failed.')
 		return ''
 	}
@@ -85,7 +89,8 @@ pub fn run(cmd string) string {
 
 pub fn exit_0_status(cmd string) bool {
 	verbose_trace(@FN, cmd)
-	x := os.exec(cmd) or {
+	x := os.execute(cmd)
+	if x.exit_code < 0 {
 		verbose_trace(@FN, '## failed.')
 		return false
 	}

cmd/tools/modules/testing/common.v

@@ -287,7 +287,8 @@ fn worker_trunner(mut p pool.PoolProcessor, idx int, thread_id int) voidptr {
 		if testing.show_start {
 			ts.append_message(.info, '                 starting $relative_file ...')
 		}
-		r := os.exec(cmd) or {
+		r := os.execute(cmd)
+		if r.exit_code < 0 {
 			ts.failed = true
 			ts.benchmark.fail()
 			tls_bench.fail()
@@ -387,7 +388,10 @@ pub fn v_build_failing_skipped(zargs string, folder string, oskipped []string) b
 }
 
 pub fn build_v_cmd_failed(cmd string) bool {
-	res := os.exec(cmd) or { return true }
+	res := os.execute(cmd)
+	if res.exit_code < 0 {
+		return true
+	}
 	if res.exit_code != 0 {
 		eprintln('')
 		eprintln(res.output)

cmd/tools/oldv.v

@@ -29,18 +29,18 @@ const (
 
 struct Context {
 mut:
-	vgo           vgit.VGitOptions
-	commit_v      string = 'master'
+	vgo      vgit.VGitOptions
+	commit_v string = 'master'
 	// the commit from which you want to produce a working v compiler (this may be a commit-ish too)
-	commit_vc     string = 'master'
+	commit_vc string = 'master'
 	// this will be derived from commit_v
 	commit_v_hash string // this will be filled from the commit-ish commit_v using rev-list. It IS a commit hash.
 	path_v        string // the full path to the v folder inside workdir.
 	path_vc       string // the full path to the vc folder inside workdir.
 	cmd_to_run    string // the command that you want to run *in* the oldv repo
 	cc            string = 'cc'
 	// the C compiler to use for bootstrapping.
-	cleanup       bool // should the tool run a cleanup first
+	cleanup bool // should the tool run a cleanup first
 }
 
 fn (mut c Context) compile_oldv_if_needed() {
@@ -100,9 +100,7 @@ fn main() {
 	scripting.cprintln('#     v commit hash: $context.commit_v_hash')
 	scripting.cprintln('#   checkout folder: $context.path_v')
 	if context.cmd_to_run.len > 0 {
-		cmdres := os.exec(context.cmd_to_run) or {
-			panic(err)
-		}
+		cmdres := os.execute_or_panic(context.cmd_to_run)
 		scripting.cprintln('#           command: ${context.cmd_to_run:-34s} exit code: ${cmdres.exit_code:-4d}  result:')
 		println(cmdres.output)
 		exit(cmdres.exit_code)

cmd/tools/repeat.v

@@ -42,7 +42,7 @@ mut:
 }
 
 struct Aints {
-	values  []int
+	values []int
 mut:
 	imin    int
 	imax    int
@@ -206,7 +206,10 @@ fn (mut context Context) run() {
 				for i in 1 .. context.warmup + 1 {
 					print('${context.cgoback}warming up run: ${i:4}/${context.warmup:-4} for ${cmd:-50s} took ${duration:6} ms ...')
 					mut sw := time.new_stopwatch({})
-					os.exec(cmd) or { continue }
+					res := os.execute(cmd)
+					if res.exit_code != 0 {
+						continue
+					}
 					duration = int(sw.elapsed().milliseconds())
 				}
 				run_warmups++
@@ -225,8 +228,8 @@ fn (mut context Context) run() {
 					eprintln('${i:10} non 0 exit code for cmd: $cmd')
 					continue
 				}
-				context.results[icmd].outputs <<
-					res.output.trim_right('\r\n').replace('\r\n', '\n').split('\n')
+				context.results[icmd].outputs << res.output.trim_right('\r\n').replace('\r\n',
+					'\n').split('\n')
 				context.results[icmd].timings << duration
 				sum += duration
 				runs++

cmd/tools/test_if_v_test_system_works.v

@@ -55,7 +55,7 @@ fn main() {
 
 fn check_ok(cmd string) string {
 	println('>   check_ok cmd: $cmd')
-	res := os.exec(cmd) or { panic(err) }
+	res := os.execute(cmd)
 	if res.exit_code != 0 {
 		eprintln('>   check_ok failed.\n$res.output')
 		exit(1)
@@ -65,7 +65,7 @@ fn check_ok(cmd string) string {
 
 fn check_fail(cmd string) string {
 	println('> check_fail cmd: $cmd')
-	res := os.exec(cmd) or { panic(err) }
+	res := os.execute(cmd)
 	if res.exit_code == 0 {
 		eprintln('> check_fail succeeded, but it should have failed.\n$res.output')
 		exit(1)