Initial project import

tools/v/vlib/io/util/util.v

@@ -0,0 +1,85 @@
+module util
+
+import os
+import rand
+
+const retries = 10000
+
+@[params]
+pub struct TempFileOptions {
+pub:
+	path    string = os.temp_dir()
+	pattern string
+}
+
+// temp_file returns a uniquely named, open, writable, `os.File` and it's path.
+pub fn temp_file(tfo TempFileOptions) !(os.File, string) {
+	mut d := tfo.path
+	if d == '' {
+		d = os.temp_dir()
+	}
+	os.ensure_folder_is_writable(d) or {
+		return error(@FN +
+			' could not create temporary file in "${d}". Please ensure write permissions.')
+	}
+	d = d.trim_right(os.path_separator)
+	prefix, suffix := prefix_and_suffix(tfo.pattern) or { return error(@FN + ' ${err.msg()}') }
+	for retry := 0; retry < retries; retry++ {
+		path := os.join_path(d, prefix + random_number() + suffix)
+		mut mode := 'rw+'
+		$if windows {
+			mode = 'w+'
+		}
+		mut file := os.open_file(path, mode, 0o600) or { continue }
+		if os.exists(path) && os.is_file(path) {
+			return file, path
+		}
+	}
+	return error(@FN +
+		' could not create temporary file in "${d}". Retry limit (${retries}) exhausted. Please ensure write permissions.')
+}
+
+@[params]
+pub struct TempDirOptions {
+pub:
+	path    string = os.temp_dir()
+	pattern string
+}
+
+fn error_for_temporary_folder(fn_name string, d string) !string {
+	return error('${fn_name} could not create temporary directory "${d}". Please ensure you have write permissions for it.')
+}
+
+// temp_dir returns a uniquely named, writable, directory path.
+pub fn temp_dir(tdo TempDirOptions) !string {
+	mut d := tdo.path
+	if d == '' {
+		d = os.temp_dir()
+	}
+	os.ensure_folder_is_writable(d) or { return error_for_temporary_folder(@FN, d) }
+	d = d.trim_right(os.path_separator)
+	prefix, suffix := prefix_and_suffix(tdo.pattern) or { return error(@FN + ' ${err.msg()}') }
+	for retry := 0; retry < retries; retry++ {
+		path := os.join_path(d, prefix + random_number() + suffix)
+		os.mkdir_all(path) or { continue }
+		if os.is_dir(path) && os.exists(path) {
+			os.ensure_folder_is_writable(path) or { return error_for_temporary_folder(@FN, d) }
+			return path
+		}
+	}
+	return error('${@FN} could not create temporary directory "${d}". Retry limit (${retries}) exhausted.')
+}
+
+// * Utility functions
+fn random_number() string {
+	s := (1_000_000_000 + (u32(os.getpid()) + rand.u32n(1_000_000_000) or { 0 })).str()
+	return s.substr(1, s.len)
+}
+
+fn prefix_and_suffix(pattern string) !(string, string) {
+	if pattern.contains(os.path_separator) {
+		return error('pattern cannot contain path separators (${os.path_separator}).')
+	}
+	prefix, suffix := pattern.rsplit_once('*') or { pattern, '' }
+	return prefix, suffix
+}

tools/v/vlib/io/util/util_test.v

@@ -0,0 +1,123 @@
+import os
+import io.util
+
+// tfolder will contain all the temporary files/subfolders made by
+// the different tests. It would be removed in testsuite_end(), so
+// individual os tests do not need to clean up after themselves.
+const tfolder = os.join_path(os.vtmp_dir(), 'io_util_tests')
+
+fn testsuite_begin() {
+	eprintln('testsuite_begin, tfolder = ${tfolder}')
+	os.rmdir_all(tfolder) or {}
+	assert !os.is_dir(tfolder)
+	os.mkdir_all(tfolder) or { panic(err) }
+	os.chdir(tfolder) or {}
+	assert os.is_dir(tfolder)
+}
+
+fn testsuite_end() {
+	os.chdir(os.wd_at_startup) or {}
+	os.rmdir_all(tfolder) or {}
+	assert !os.is_dir(tfolder)
+	// eprintln('testsuite_end  , tfolder = ${tfolder} removed.')
+}
+
+fn test_temp_file() {
+	// Test defaults
+	mut f, mut path := util.temp_file() or {
+		assert false
+		return
+	}
+	mut prev_path := path
+	defer {
+		f.close()
+	}
+	assert os.is_file(path)
+	assert f.is_opened
+	// Test pattern
+	f.close()
+	f, path = util.temp_file(
+		pattern: 'some_*_test.file'
+	) or {
+		assert false
+		return
+	}
+	assert path != prev_path
+	assert os.is_file(path)
+	assert f.is_opened
+	mut filename := os.file_name(path)
+	assert filename.contains('_test.file')
+	// Check for 9 digits where the wildcard is placed in the pattern
+	for i, c in filename {
+		if i > 4 && i <= 4 + 9 {
+			assert c.is_digit()
+		}
+	}
+	// Test custom path
+	prev_path = path
+	f.close()
+	f, path = util.temp_file(
+		path: tfolder
+	) or {
+		assert false
+		return
+	}
+	assert path != prev_path
+	assert os.is_file(path)
+	assert path.contains(tfolder)
+	assert f.is_opened
+	filename = os.file_name(path)
+	for c in filename {
+		assert c.is_digit()
+	}
+}
+
+fn test_temp_dir() {
+	// Test defaults
+	mut path := util.temp_dir() or {
+		assert false
+		return
+	}
+	assert os.is_dir(path)
+	os.ensure_folder_is_writable(path) or {
+		assert false
+		return
+	}
+	mut prev_path := path
+	// Test pattern
+	path = util.temp_dir(
+		pattern: 'some_*_test_dir'
+	) or {
+		assert false
+		return
+	}
+	assert path != prev_path
+	assert os.is_dir(path)
+	mut filename := os.file_name(path)
+	assert filename.contains('_test_dir')
+	// Check for 9 digits where the wildcard is placed in the pattern
+	for i, c in filename {
+		if i > 4 && i <= 4 + 9 {
+			assert c.is_digit()
+		}
+	}
+	// Test custom path
+	prev_path = path
+	path = util.temp_dir(
+		path: tfolder
+	) or {
+		assert false
+		return
+	}
+	assert path != prev_path
+	assert os.is_dir(path)
+	os.ensure_folder_is_writable(path) or {
+		assert false
+		return
+	}
+	assert path.contains(tfolder)
+	filename = os.file_name(path)
+	for c in filename {
+		assert c.is_digit()
+	}
+}