tools: support vreduce timeout, vreduce custom run command (#24359)

Author: Eliyaan

cmd/tools/vreduce.v

@@ -1,5 +1,7 @@
 import os
+import v.vmod
 import flag
+import time
 import math
 import log
 
@@ -8,8 +10,6 @@ const default_command = '${os.quoted_path(@VEXE)} -no-skip-unused' // Command us
 const default_error_msg = 'C compilation error' // the pattern to reproduce
 // Temporary files
 const tmp_folder = os.join_path(os.vtmp_dir(), 'vreduce')
-const tmp_reduced_code_file_name = '__v_reduced_code.v'
-const path = '${tmp_folder}/${tmp_reduced_code_file_name}'
 
 fn main() {
 	log.use_stdout()
@@ -20,8 +20,10 @@ fn main() {
 	fp.version(version)
 
 	error_msg := fp.string('error_msg', `e`, default_error_msg, 'the error message you want to reproduce, default: \'${default_error_msg}\'')
-	command := fp.string('command', `c`, default_command, 'the command used to try to reproduce the error, default: \'${default_command}\'')
-	do_fmt := fp.bool('fmt', `w`, false, 'enable v fmt for the output (rpdc.v)')
+	mut command := fp.string('command', `c`, default_command, 'the command used to try to reproduce the error, default: \'${default_command}\', will replace PATH with the path of the folder where it is run')
+	copy_project := fp.bool('cp', `p`, false, 'if used v reduce will copy the whole folder of the project')
+	timeout := fp.int('to', `t`, 0, 'sets a timeout for the command, default=0 : no timeout')
+	do_fmt := fp.bool('fmt', `w`, false, 'enable v fmt for the output (rpdc_file_name.v)')
 	file_paths := fp.finalize() or {
 		eprintln(err)
 		println(fp.usage())
@@ -33,7 +35,7 @@ fn main() {
 		exit(0)
 	}
 
-	file_path := file_paths[1]
+	mut file_path := file_paths[1]
 	if file_path == '' || !os.exists(file_path) {
 		log.error('You need to specify a valid file to reduce.')
 		if file_path != '' {
@@ -46,39 +48,107 @@ fn main() {
 	log.info("Starting to reduce the file: '${file_path}'\n    with command: `${command}`,\n    trying to reproduce: `${error_msg}`")
 
 	if do_fmt {
-		log.info('Will do `v fmt -w rpdc.v` after the reduction.')
+		log.info('Will do `v fmt -w rpdc_file_name.v` after the reduction.')
 	} else {
-		log.info('Will NOT do `v fmt -w rpdc.v` (use the `--fmt` or `-w` flag to enable it)')
+		log.info('Will NOT do `v fmt -w rpdc_file_name.v` (use the `--fmt` or `-w` flag to enable it)')
 	}
 
 	content := os.read_file(file_path)!
-	warn_on_false(string_reproduces(content, error_msg, command), 'string_reproduces',
-		@LOCATION)
 	show_code_stats(content, label: 'Original code size')
 
+	// copy project	
+	if os.exists(tmp_folder) {
+		os.rmdir_all(tmp_folder)!
+	}
+	os.mkdir(tmp_folder)!
+	if copy_project {
+		mut vmod_cacher := vmod.new_mod_file_cacher()
+		project_folder := vmod_cacher.get_by_file(file_path).vmod_folder
+		os.cp_all('${project_folder}/.', tmp_folder + '/', true)!
+		// the path of the target file from the project folder
+		file_path = os.walk_ext(project_folder, os.file_name(file_path))[0] or {
+			panic('File not found in the project folder')
+		}
+		file_path = file_path[project_folder.len + 1..] // will remove the / too
+	}
+	path := '${tmp_folder}/${file_path}'
+	if command == default_command {
+		command = '${default_command} ${path}'
+	} else {
+		command = command.replace('PATH', '${tmp_folder}/')
+	}
+
 	// start tests
 	tmp_code := create_code(parse(content))
-	warn_on_false(string_reproduces(tmp_code, error_msg, command), 'string_reproduces',
-		@LOCATION)
+	warn_on_false(string_reproduces(tmp_code, error_msg, command, path, true, timeout),
+		'string_reproduces', @LOCATION)
 	show_code_stats(tmp_code, label: 'Code size without comments')
 
 	// reduce the code
-	reduce_scope(content, error_msg, command, do_fmt)
+	reduce_scope(content, error_msg, command, do_fmt, path, timeout)
+
+	// cleanse
+	if os.exists(tmp_folder) {
+		os.rmdir_all(tmp_folder)!
+	}
 }
 
 // Return true if the command ran on the file produces the pattern
-fn string_reproduces(file string, pattern string, command string) bool {
+fn string_reproduces(file string, pattern string, command string, path string, debug bool, timeout int) bool {
 	if !os.exists(tmp_folder) {
 		os.mkdir(tmp_folder) or { panic(err) }
 	}
 	os.write_file(path, file) or { panic(err) }
-	res := os.execute(command + ' ' + path)
-	if res.output.contains(pattern) {
+	mut output := ''
+	if timeout == 0 {
+		res := os.execute(command)
+		output = res.output
+	} else {
+		split := command.split(' ')
+		mut prog := os.new_process(split[0])
+		prog.set_args(split[1..])
+		prog.set_redirect_stdio()
+		prog.run()
+		mut sw := time.new_stopwatch()
+		sw.start()
+		for prog.is_alive() {
+			// check if there is any input from the user (it does not block, if there is not):
+			time.sleep(1 * time.millisecond)
+			mut b := true
+			for b {
+				b = false
+				if oline := prog.pipe_read(.stdout) {
+					if oline != '' {
+						output += oline
+						b = true
+					}
+				}
+				if eline := prog.pipe_read(.stderr) {
+					if eline != '' {
+						output += eline
+						b = true
+					}
+				}
+			}
+			if sw.elapsed().seconds() > f32(timeout) {
+				if debug {
+					println('Timeout')
+				}
+				return false
+			}
+		}
+		prog.close()
+		prog.wait()
+	}
+	if output.contains(pattern) {
 		// println('reproduces')
 		return true
 	} else {
 		// println('does not reproduce')
-		// println(res.output)
+		if debug {
+			println(output)
+			println('executed command: ${command}')
+		}
 		return false
 	}
 }
@@ -225,8 +295,8 @@ fn create_code(sc Scope) string {
 	return output_code
 }
 
-// Reduces the code contained in the scope tree and writes the reduced code to `rpdc.v`
-fn reduce_scope(content string, error_msg string, command string, do_fmt bool) {
+// Reduces the code contained in the scope tree and writes the reduced code to `rpdc_file_name.v`
+fn reduce_scope(content string, error_msg string, command string, do_fmt bool, path string, timeout int) {
 	mut sc := parse('') // will get filled in the start of the loop
 	log.info('Cleaning the scopes')
 	mut text_code := content
@@ -242,17 +312,21 @@ fn reduce_scope(content string, error_msg string, command string, do_fmt bool) {
 			for i in 0 .. sc.children.len {
 				stack << &sc.children[i]
 			}
+			mut item_nb := 0
 			for stack.len > 0 { // traverse the tree and disable (ignore) scopes that are not needed for reproduction
 				mut item := stack.pop()
+				item_nb += 1
+				eprint('\ritem n: ${item_nb}')
 				if mut item is Scope {
 					if !item.ignored {
 						item.tmp_ignored = true // try to ignore it
 						code := create_code(sc)
 						item.tmp_ignored = false // dont need it anymore
-						if string_reproduces(code, error_msg, command) {
+						if string_reproduces(code, error_msg, command, path, false, timeout) {
 							item.ignored = true
 							modified_smth = true
 							outer_modified_smth = true
+							println('')
 							show_code_stats(code)
 						} else { // if can remove it, no need to go though it's children
 							for i in 0 .. item.children.len {
@@ -263,6 +337,7 @@ fn reduce_scope(content string, error_msg string, command string, do_fmt bool) {
 				}
 			}
 		}
+		println('')
 
 		text_code = create_code(sc)
 
@@ -296,8 +371,8 @@ fn reduce_scope(content string, error_msg string, command string, do_fmt bool) {
 
 		// Traverse the tree and prune the useless lines / line groups for the reproduction
 		mut line_tree := *line_stack[0]
-		warn_on_false(string_reproduces(create_code(line_tree), error_msg, command), 'string_reproduces',
-			@LOCATION) // should be the same
+		warn_on_false(string_reproduces(create_code(line_tree), error_msg, command, path,
+			true, timeout), 'string_reproduces', @LOCATION) // should be the same
 		log.info('Pruning the lines/line groups')
 		modified_smth = true
 		for modified_smth {
@@ -307,17 +382,21 @@ fn reduce_scope(content string, error_msg string, command string, do_fmt bool) {
 			for i in 0 .. line_tree.children.len {
 				stack << &line_tree.children[i]
 			}
+			mut item_nb := 0
 			for stack.len > 0 { // traverse the binary tree (of the lines)
 				mut item := stack.pop()
+				item_nb += 1
+				eprint('\ritem n: ${item_nb}')
 				if mut item is Scope {
 					if !item.ignored {
 						item.tmp_ignored = true
 						code := create_code(line_tree)
 						item.tmp_ignored = false // dont need it anymore
-						if string_reproduces(code, error_msg, command) {
+						if string_reproduces(code, error_msg, command, path, false, timeout) {
 							item.ignored = true
 							modified_smth = true
 							outer_modified_smth = true
+							println('')
 							show_code_stats(code)
 						} else { // if can remove it, can remove it's children
 							for i in 0 .. item.children.len {
@@ -328,18 +407,20 @@ fn reduce_scope(content string, error_msg string, command string, do_fmt bool) {
 				}
 			}
 		}
+		println('')
 		text_code = create_code(line_tree)
 	}
 
-	warn_on_false(string_reproduces(text_code, error_msg, command), 'string_reproduces',
-		@LOCATION)
-	os.write_file('rpdc.v', text_code) or { panic(err) }
+	warn_on_false(string_reproduces(text_code, error_msg, command, path, true, timeout),
+		'string_reproduces', @LOCATION)
+	rpdc_file_path := 'rpdc_${os.file_name(path)#[..-2]}.v'
+	os.write_file(rpdc_file_path, text_code) or { panic(err) }
 	if do_fmt {
-		os.execute('v fmt -w rpdc.v')
-		final_content := os.read_file('rpdc.v') or { panic(err) }
+		os.execute('v fmt -w ${rpdc_file_path}')
+		final_content := os.read_file(rpdc_file_path) or { panic(err) }
 		show_code_stats(final_content, label: 'Code size after formatting')
 	}
-	println('The reduced code is now in rpdc.v')
+	println('The reduced code is now in ${rpdc_file_path}')
 }
 
 @[params]
@@ -354,6 +435,6 @@ fn show_code_stats(code string, params ShowParams) {
 
 fn warn_on_false(res bool, what string, loc string) {
 	if !res {
-		log.warn('${what} is false, at ${loc}')
+		log.warn('${what} is false, at ${loc}; see output above')
 	}
 }