import os import time const ( // 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. tfolder = os.join_path(os.temp_dir(), 'v', 'tests', 'os_test') ) // os.args has to be *already initialized* with the program's argc/argv at this point // thus it can be used for other consts too: const args_at_start = os.args.clone() 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) // println('args_at_start: $args_at_start') assert args_at_start.len > 0 assert args_at_start == os.args } 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_open_file() { filename := './test1.txt' hello := 'hello world!' os.open_file(filename, 'r+', 0o666) or { assert err.msg == 'No such file or directory' os.File{} } mut file := os.open_file(filename, 'w+', 0o666) or { panic(err) } file.write_string(hello) or { panic(err) } file.close() assert hello.len == os.file_size(filename) read_hello := os.read_file(filename) or { panic('error reading file $filename') } assert hello == read_hello os.rm(filename) or { panic(err) } } fn test_open_file_binary() { filename := './test1.dat' hello := 'hello \n world!' os.open_file(filename, 'r+', 0o666) or { assert err.msg == 'No such file or directory' os.File{} } mut file := os.open_file(filename, 'wb+', 0o666) or { panic(err) } bytes := hello.bytes() unsafe { file.write_ptr(bytes.data, bytes.len) } file.close() assert hello.len == os.file_size(filename) read_hello := os.read_bytes(filename) or { panic('error reading file $filename') } assert bytes == read_hello os.rm(filename) or { panic(err) } } // fn test_file_get_line() { // filename := './fgetline.txt' // os.write_file(filename, 'line 1\nline 2') // mut f := os.open_file(filename, 'r', 0) or { // assert false // return // } // line1 := f.get_line() or { // '' // } // line2 := f.get_line() or { // '' // } // f.close() // // // eprintln('line1: $line1 $line1.bytes()') // eprintln('line2: $line2 $line2.bytes()') // assert line1 == 'line 1\n' // assert line2 == 'line 2' // } fn create_file(fpath string) ? { mut f := os.create(fpath) ? f.close() } fn create_and_write_to_file(fpath string, content string) ? { mut f := os.create(fpath) ? f.write_string(content) ? f.close() } fn test_create_file() ? { filename := './test1.txt' hello := 'hello world!' create_and_write_to_file(filename, hello) ? assert hello.len == os.file_size(filename) os.rm(filename) or { panic(err) } } fn test_is_file() { // Setup work_dir := os.join_path(os.getwd(), 'is_file_test') os.mkdir_all(work_dir) or { panic(err) } tfile := os.join_path(work_dir, 'tmp_file') // Test things that shouldn't be a file assert os.is_file(work_dir) == false assert os.is_file('non-existent_file.tmp') == false // Test file tfile_content := 'temporary file' os.write_file(tfile, tfile_content) or { panic(err) } assert os.is_file(tfile) // Test dir symlinks $if windows { assert true } $else { dsymlink := os.join_path(work_dir, 'dir_symlink') os.symlink(work_dir, dsymlink) or { panic(err) } assert os.is_file(dsymlink) == false } // Test file symlinks $if windows { assert true } $else { fsymlink := os.join_path(work_dir, 'file_symlink') os.symlink(tfile, fsymlink) or { panic(err) } assert os.is_file(fsymlink) } } fn test_write_and_read_string_to_file() { filename := './test1.txt' hello := 'hello world!' os.write_file(filename, hello) or { panic(err) } assert hello.len == os.file_size(filename) read_hello := os.read_file(filename) or { panic('error reading file $filename') } assert hello == read_hello os.rm(filename) or { panic(err) } } // test_write_and_read_bytes checks for regressions made in the functions // read_bytes, read_bytes_at and write_bytes. fn test_write_and_read_bytes() { file_name := './byte_reader_writer.tst' payload := [byte(`I`), `D`, `D`, `Q`, `D`] mut file_write := os.create(os.real_path(file_name)) or { eprintln('failed to create file $file_name') return } // We use the standard write_bytes function to write the payload and // compare the length of the array with the file size (have to match). unsafe { file_write.write_ptr(payload.data, 5) } file_write.close() assert payload.len == os.file_size(file_name) mut file_read := os.open(os.real_path(file_name)) or { eprintln('failed to open file $file_name') return } // We only need to test read_bytes because this function calls // read_bytes_at with second parameter zeroed (size, 0). rbytes := file_read.read_bytes(5) // eprintln('rbytes: $rbytes') // eprintln('payload: $payload') assert rbytes == payload // check that trying to read data from EOF doesn't error and returns 0 mut a := []byte{len: 5} nread := file_read.read_bytes_into(5, mut a) or { n := if err is none { int(0) } else { eprintln(err) int(-1) } n } assert nread == 0 file_read.close() // We finally delete the test file. os.rm(file_name) or { panic(err) } } fn test_ls() { if x := os.ls('') { assert false } else { assert true } if x := os.ls('.') { assert x.len > 0 } else { assert false } } fn create_tree() ? { os.mkdir_all('myfolder/f1/f2/f3') ? os.mkdir_all('myfolder/a1/a2/a3') ? f3 := os.real_path('myfolder/f1/f2/f3') assert os.is_dir(f3) create_file('myfolder/f1/f2/f3/a.txt') ? create_file('myfolder/f1/f2/f3/b.txt') ? create_file('myfolder/f1/f2/f3/c.txt') ? create_file('myfolder/f1/f2/f3/d.md') ? create_file('myfolder/f1/0.txt') ? create_file('myfolder/another.md') ? create_file('myfolder/a1/a2/a3/x.txt') ? create_file('myfolder/a1/a2/a3/y.txt') ? create_file('myfolder/a1/a2/a3/z.txt') ? create_file('myfolder/a1/1.txt') ? create_file('myfolder/xyz.ini') ? } fn remove_tree() { os.rmdir_all('myfolder') or {} } fn test_walk_ext() ? { create_tree() ? defer { remove_tree() } all := os.walk_ext('.', '') assert all.len > 10 mut top := os.walk_ext('myfolder', '.txt') top.sort() assert top == [ 'myfolder/a1/1.txt', 'myfolder/a1/a2/a3/x.txt', 'myfolder/a1/a2/a3/y.txt', 'myfolder/a1/a2/a3/z.txt', 'myfolder/f1/0.txt', 'myfolder/f1/f2/f3/a.txt', 'myfolder/f1/f2/f3/b.txt', 'myfolder/f1/f2/f3/c.txt', ] mut subfolder_txts := os.walk_ext('myfolder/a1/a2', '.txt') subfolder_txts.sort() assert subfolder_txts == [ 'myfolder/a1/a2/a3/x.txt', 'myfolder/a1/a2/a3/y.txt', 'myfolder/a1/a2/a3/z.txt', ] mut mds := os.walk_ext('myfolder', '.md') mds.sort() assert mds == ['myfolder/another.md', 'myfolder/f1/f2/f3/d.md'] } fn test_walk_with_context() ? { create_tree() ? defer { remove_tree() } mut res := []string{} os.walk_with_context('myfolder', &res, fn (mut res []string, fpath string) { res << fpath }) assert 'myfolder/f1/f2/f3/b.txt' in res assert 'myfolder/another.md' in res } fn test_create_and_delete_folder() { folder := './test1' os.mkdir(folder) or { panic(err) } assert os.is_dir(folder) folder_contents := os.ls(folder) or { panic(err) } assert folder_contents.len == 0 os.rmdir(folder) or { panic(err) } folder_exists := os.is_dir(folder) assert folder_exists == false } fn walk_callback(file string) { if file == '.' || file == '..' { return } assert file == 'test_walk' + os.path_separator + 'test1' } fn test_walk() { folder := 'test_walk' os.mkdir(folder) or { panic(err) } file1 := folder + os.path_separator + 'test1' os.write_file(file1, 'test-1') or { panic(err) } os.walk(folder, walk_callback) os.rm(file1) or { panic(err) } os.rmdir(folder) or { panic(err) } } fn test_cp() { old_file_name := 'cp_example.txt' new_file_name := 'cp_new_example.txt' os.write_file(old_file_name, 'Test data 1 2 3, V is awesome #$%^[]!~⭐') or { panic(err) } os.cp(old_file_name, new_file_name) or { panic('$err') } old_file := os.read_file(old_file_name) or { panic(err) } new_file := os.read_file(new_file_name) or { panic(err) } assert old_file == new_file os.rm(old_file_name) or { panic(err) } os.rm(new_file_name) or { panic(err) } } fn test_mv() { work_dir := os.join_path(os.getwd(), 'mv_test') os.mkdir_all(work_dir) or { panic(err) } // Setup test files tfile1 := os.join_path(work_dir, 'file') tfile2 := os.join_path(work_dir, 'file.test') tfile3 := os.join_path(work_dir, 'file.3') tfile_content := 'temporary file' os.write_file(tfile1, tfile_content) or { panic(err) } os.write_file(tfile2, tfile_content) or { panic(err) } // Setup test dirs tdir1 := os.join_path(work_dir, 'dir') tdir2 := os.join_path(work_dir, 'dir2') tdir3 := os.join_path(work_dir, 'dir3') os.mkdir(tdir1) or { panic(err) } os.mkdir(tdir2) or { panic(err) } // Move file with no extension to dir os.mv(tfile1, tdir1) or { panic(err) } mut expected := os.join_path(tdir1, 'file') assert os.exists(expected) assert !os.is_dir(expected) // Move dir with contents to other dir os.mv(tdir1, tdir2) or { panic(err) } expected = os.join_path(tdir2, 'dir') assert os.exists(expected) assert os.is_dir(expected) expected = os.join_path(tdir2, 'dir', 'file') assert os.exists(expected) assert !os.is_dir(expected) // Move dir with contents to other dir (by renaming) os.mv(os.join_path(tdir2, 'dir'), tdir3) or { panic(err) } expected = tdir3 assert os.exists(expected) assert os.is_dir(expected) assert os.is_dir_empty(tdir2) // Move file with extension to dir os.mv(tfile2, tdir2) or { panic(err) } expected = os.join_path(tdir2, 'file.test') assert os.exists(expected) assert !os.is_dir(expected) // Move file to dir (by renaming) os.mv(os.join_path(tdir2, 'file.test'), tfile3) or { panic(err) } expected = tfile3 assert os.exists(expected) assert !os.is_dir(expected) } fn test_cp_all() { // fileX -> dir/fileX // NB: clean up of the files happens inside the cleanup_leftovers function os.write_file('ex1.txt', 'wow!') or { panic(err) } os.mkdir('ex') or { panic(err) } os.cp_all('ex1.txt', 'ex', false) or { panic(err) } old := os.read_file('ex1.txt') or { panic(err) } new := os.read_file('ex/ex1.txt') or { panic(err) } assert old == new os.mkdir('ex/ex2') or { panic(err) } os.write_file('ex2.txt', 'great!') or { panic(err) } os.cp_all('ex2.txt', 'ex/ex2', false) or { panic(err) } old2 := os.read_file('ex2.txt') or { panic(err) } new2 := os.read_file('ex/ex2/ex2.txt') or { panic(err) } assert old2 == new2 // recurring on dir -> local dir os.cp_all('ex', './', true) or { panic(err) } // regression test for executive runs with overwrite := true os.cp_all('ex', './', true) or { panic(err) } os.cp_all('ex', 'nonexisting', true) or { panic(err) } assert os.exists(os.join_path('nonexisting', 'ex1.txt')) } fn test_realpath_of_empty_string_works() { assert os.real_path('') == '' } fn test_realpath_non_existing() { non_existing_path := 'sdyfuisd_non_existing_file' rpath := os.real_path(non_existing_path) $if windows { // on windows, the workdir is prepended, so the result is absolute: assert rpath.len > non_existing_path.len } $if !windows { // on unix, the workdir is NOT prepended for now, so the result remains the same. // TODO: the windows behaviour seems saner, think about normalising the unix case to do the same. assert os.real_path(non_existing_path) == non_existing_path } } fn test_realpath_existing() { existing_file_name := 'existing_file.txt' existing_file := os.join_path(os.temp_dir(), existing_file_name) os.rm(existing_file) or {} os.write_file(existing_file, 'abc') or {} assert os.exists(existing_file) rpath := os.real_path(existing_file) assert os.is_abs_path(rpath) assert rpath.ends_with(existing_file_name) os.rm(existing_file) or {} } fn test_realpath_removes_dots() { examples_folder := os.join_path(@VEXEROOT, 'vlib', 'v', '..', '..', 'cmd', '.', '..', 'examples') real_path_of_examples_folder := os.real_path(examples_folder) assert real_path_of_examples_folder.len < examples_folder.len assert !real_path_of_examples_folder.contains('..') } fn test_realpath_absolutizes_existing_relative_paths() { old_wd := os.getwd() defer { os.chdir(old_wd) or { panic(err) } } os.chdir(@VEXEROOT) or { panic(err) } examples_folder := os.join_path('vlib', 'v', '..', '..', 'cmd', '.', '..', 'examples') real_path_of_examples_folder := os.real_path(examples_folder) assert os.is_abs_path(real_path_of_examples_folder) } // TODO: think much more about whether this is desirable: fn test_realpath_does_not_absolutize_non_existing_relative_paths() { relative_path := os.join_path('one', 'nonexisting_folder', '..', 'something') $if !windows { assert os.real_path(relative_path).contains('..') assert os.real_path(relative_path) == relative_path } } fn test_realpath_absolutepath_symlink() ? { file_name := 'tolink_file.txt' symlink_name := 'symlink.txt' create_file(file_name) ? assert os.symlink(file_name, symlink_name) ? rpath := os.real_path(symlink_name) println(rpath) assert os.is_abs_path(rpath) assert rpath.ends_with(file_name) os.rm(symlink_name) or {} os.rm(file_name) or {} } fn test_tmpdir() { t := os.temp_dir() assert t.len > 0 assert os.is_dir(t) tfile := t + os.path_separator + 'tmpfile.txt' os.rm(tfile) or {} // just in case tfile_content := 'this is a temporary file' os.write_file(tfile, tfile_content) or { panic(err) } tfile_content_read := os.read_file(tfile) or { panic(err) } assert tfile_content_read == tfile_content os.rm(tfile) or { panic(err) } } fn test_is_writable_folder() { tmp := os.temp_dir() f := os.is_writable_folder(tmp) or { eprintln('err: $err') false } assert f } fn test_make_symlink_check_is_link_and_remove_symlink() { folder := 'tfolder' symlink := 'tsymlink' // windows creates a directory symlink, so delete it with rmdir() $if windows { os.rmdir(symlink) or {} } $else { os.rm(symlink) or {} } os.rmdir(folder) or {} os.mkdir(folder) or { panic(err) } folder_contents := os.ls(folder) or { panic(err) } assert folder_contents.len == 0 os.symlink(folder, symlink) or { panic(err) } assert os.is_link(symlink) $if windows { os.rmdir(symlink) or { panic(err) } } $else { os.rm(symlink) or { panic(err) } } os.rmdir(folder) or { panic(err) } folder_exists := os.is_dir(folder) assert folder_exists == false symlink_exists := os.is_link(symlink) assert symlink_exists == false } fn test_make_symlink_check_is_link_and_remove_symlink_with_file() ? { file := 'tfile' symlink := 'tsymlink' os.rm(symlink) or {} os.rm(file) or {} create_file(file) ? os.symlink(file, symlink) or { panic(err) } assert os.is_link(symlink) os.rm(symlink) or { panic(err) } os.rm(file) or { panic(err) } symlink_exists := os.is_link(symlink) assert symlink_exists == false } fn test_make_hardlink_check_is_link_and_remove_hardlink_with_file() ? { file := 'tfile' symlink := 'tsymlink' os.rm(symlink) or {} os.rm(file) or {} create_file(file) ? os.link(file, symlink) or { panic(err) } assert os.exists(symlink) os.rm(symlink) or { panic(err) } os.rm(file) or { panic(err) } symlink_exists := os.is_link(symlink) assert symlink_exists == false } // fn test_fork() { // pid := os.fork() // if pid == 0 { // println('Child') // } // else { // println('Parent') // } // } // fn test_wait() { // pid := os.fork() // if pid == 0 { // println('Child') // exit(0) // } // else { // cpid := os.wait() // println('Parent') // println(cpid) // } // } fn test_symlink() { os.mkdir('symlink') or { panic(err) } os.symlink('symlink', 'symlink2') or { panic(err) } assert os.exists('symlink2') // cleanup os.rmdir('symlink') or { panic(err) } $if windows { os.rmdir('symlink2') or { panic(err) } } $else { os.rm('symlink2') or { panic(err) } } } fn test_is_executable_writable_readable() ? { file_name := 'rwxfile.exe' create_file(file_name) ? $if !windows { os.chmod(file_name, 0o600) or {} // mark as readable && writable, but NOT executable assert os.is_writable(file_name) assert os.is_readable(file_name) assert !os.is_executable(file_name) os.chmod(file_name, 0o700) or {} // mark as executable too assert os.is_executable(file_name) } $else { assert os.is_writable(file_name) assert os.is_readable(file_name) assert os.is_executable(file_name) } // We finally delete the test file. os.rm(file_name) or { panic(err) } } fn test_ext() { assert os.file_ext('file.v') == '.v' assert os.file_ext('file') == '' } fn test_is_abs() { assert os.is_abs_path('/home/user') assert os.is_abs_path('v/vlib') == false $if windows { assert os.is_abs_path('C:\\Windows\\') } } fn test_join() { $if windows { assert os.join_path('v', 'vlib', 'os') == 'v\\vlib\\os' } $else { assert os.join_path('v', 'vlib', 'os') == 'v/vlib/os' } } fn test_rmdir_all() { mut dirs := ['some/dir', 'some/.hidden/directory'] $if windows { for mut d in dirs { d = d.replace('/', '\\') } } for d in dirs { os.mkdir_all(d) or { panic(err) } assert os.is_dir(d) } os.rmdir_all('some') or { assert false } assert !os.exists('some') } fn test_dir() { $if windows { assert os.dir('C:\\a\\b\\c') == 'C:\\a\\b' assert os.dir('C:\\a\\b\\') == 'C:\\a\\b' assert os.dir('C:/a/b/c') == 'C:\\a\\b' assert os.dir('C:/a/b/') == 'C:\\a\\b' } $else { assert os.dir('/') == '/' assert os.dir('/abc') == '/' assert os.dir('/var/tmp/foo') == '/var/tmp' assert os.dir('/var/tmp/') == '/var/tmp' assert os.dir('C:\\a\\b\\c') == 'C:/a/b' assert os.dir('C:\\a\\b\\') == 'C:/a/b' } assert os.dir('os') == '.' } fn test_base() { $if windows { assert os.base('v\\vlib\\os') == 'os' assert os.base('v\\vlib\\os\\') == 'os' assert os.base('v/vlib/os') == 'os' assert os.base('v/vlib/os/') == 'os' } $else { assert os.base('v/vlib/os') == 'os' assert os.base('v/vlib/os/') == 'os' assert os.base('v\\vlib\\os') == 'os' assert os.base('v\\vlib\\os\\') == 'os' } assert os.base('filename') == 'filename' } fn test_file_name() { $if windows { assert os.file_name('v\\vlib\\os\\os.v') == 'os.v' assert os.file_name('v\\vlib\\os\\') == '' assert os.file_name('v\\vlib\\os') == 'os' } $else { assert os.file_name('v/vlib/os/os.v') == 'os.v' assert os.file_name('v/vlib/os/') == '' assert os.file_name('v/vlib/os') == 'os' } assert os.file_name('filename') == 'filename' } fn test_uname() { u := os.uname() assert u.sysname.len > 0 assert u.nodename.len > 0 assert u.release.len > 0 assert u.version.len > 0 assert u.machine.len > 0 } // tests for write_file_array and read_file_array: const ( maxn = 3 ) struct IntPoint { x int y int } fn test_write_file_array_bytes() { fpath := './abytes.bin' mut arr := []byte{len: maxn} for i in 0 .. maxn { arr[i] = 65 + byte(i) } os.write_file_array(fpath, arr) or { panic(err) } rarr := os.read_bytes(fpath) or { panic(err) } assert arr == rarr // eprintln(arr.str()) // eprintln(rarr.str()) } fn test_write_file_array_structs() { fpath := './astructs.bin' mut arr := []IntPoint{len: maxn} for i in 0 .. maxn { arr[i] = IntPoint{65 + i, 65 + i + 10} } os.write_file_array(fpath, arr) or { panic(err) } rarr := os.read_file_array(fpath) assert rarr == arr assert rarr.len == maxn // eprintln( rarr.str().replace('\n', ' ').replace('},', '},\n')) } fn test_stdout_capture() { /* mut cmd := os.Command{ path:'cat' redirect_stdout: true } cmd.start() for !cmd.eof { line := cmd.read_line() println('line="$line"') } cmd.close() */ } fn test_posix_set_bit() ? { $if windows { assert true } $else { fpath := 'permtest' create_file(fpath) ? os.chmod(fpath, 0o0777) or { panic(err) } c_fpath := &char(fpath.str) mut s := C.stat{} unsafe { C.stat(c_fpath, &s) } // Take the permissions part of the mode mut mode := u32(s.st_mode) & 0o0777 assert mode == 0o0777 // `chmod u-r` os.posix_set_permission_bit(fpath, os.s_irusr, false) unsafe { C.stat(c_fpath, &s) } mode = u32(s.st_mode) & 0o0777 assert mode == 0o0377 // `chmod u+r` os.posix_set_permission_bit(fpath, os.s_irusr, true) unsafe { C.stat(c_fpath, &s) } mode = u32(s.st_mode) & 0o0777 assert mode == 0o0777 // NB: setting the sticky bit is platform dependend // `chmod -s -g -t` os.posix_set_permission_bit(fpath, os.s_isuid, false) os.posix_set_permission_bit(fpath, os.s_isgid, false) os.posix_set_permission_bit(fpath, os.s_isvtx, false) unsafe { C.stat(c_fpath, &s) } mode = u32(s.st_mode) & 0o0777 assert mode == 0o0777 // `chmod g-w o-w` os.posix_set_permission_bit(fpath, os.s_iwgrp, false) os.posix_set_permission_bit(fpath, os.s_iwoth, false) unsafe { C.stat(c_fpath, &s) } mode = u32(s.st_mode) & 0o7777 assert mode == 0o0755 os.rm(fpath) or {} } } fn test_exists_in_system_path() { assert os.exists_in_system_path('') == false $if windows { assert os.exists_in_system_path('cmd.exe') return } assert os.exists_in_system_path('ls') } fn test_truncate() ? { filename := './test_trunc.txt' hello := 'hello world!' mut f := os.create(filename) ? f.write_string(hello) ? f.close() assert hello.len == os.file_size(filename) newlen := u64(40000) os.truncate(filename, newlen) or { panic(err) } assert newlen == os.file_size(filename) os.rm(filename) or { panic(err) } } fn test_hostname() { assert os.hostname().len > 2 } fn test_glob() ? { os.mkdir('test_dir') or { panic(err) } for i in 0 .. 4 { if i == 3 { create_file('test_dir/test0_another') ? create_file('test_dir/test') ? } else { create_file('test_dir/test' + i.str()) ? } } files := os.glob('test_dir/t*') or { panic(err) } assert files.len == 5 assert os.base(files[0]) == 'test' for i in 0 .. 3 { os.rm('test_dir/test' + i.str()) or { panic(err) } } os.rm('test_dir/test0_another') or { panic(err) } os.rm('test_dir/test') or { panic(err) } os.rmdir_all('test_dir') or { panic(err) } } fn test_utime() { filename := './test_utime.txt' hello := 'hello world!' mut f := os.create(filename) or { panic(err) } defer { f.close() os.rm(filename) or { panic(err) } } f.write_string(hello) or { panic(err) } atime := time.now().add_days(2).unix_time() mtime := time.now().add_days(4).unix_time() os.utime(filename, int(atime), int(mtime)) or { panic(err) } assert os.file_last_mod_unix(filename) == mtime } fn test_expand_tilde_to_home() { home_test := os.join_path(os.home_dir(), 'test', 'tilde', 'expansion') home_expansion_test := os.expand_tilde_to_home(os.join_path('~', 'test', 'tilde', 'expansion')) assert home_test == home_expansion_test assert os.expand_tilde_to_home('~') == os.home_dir() }