blob: 07beb64e64edd070a288da12d2e369f907882fde [file] [log] [blame]
" Tests for the writefile() function and some :write commands.
source check.vim
source term_util.vim
func Test_writefile()
let f = tempname()
call writefile(["over","written"], f, "b")
call writefile(["hello","world"], f, "b")
call writefile(["!", "good"], f, "a")
call writefile(["morning"], f, "ab")
call writefile(["", "vimmers"], f, "ab")
let l = readfile(f)
call assert_equal("hello", l[0])
call assert_equal("world!", l[1])
call assert_equal("good", l[2])
call assert_equal("morning", l[3])
call assert_equal("vimmers", l[4])
call delete(f)
call assert_fails('call writefile("text", "Xfile")', 'E475: Invalid argument: writefile() first argument must be a List or a Blob')
endfunc
func Test_writefile_ignore_regexp_error()
write Xt[z-a]est.txt
call delete('Xt[z-a]est.txt')
endfunc
func Test_writefile_fails_gently()
call assert_fails('call writefile(["test"], "Xfile", [])', 'E730:')
call assert_false(filereadable("Xfile"))
call delete("Xfile")
call assert_fails('call writefile(["test", [], [], [], "tset"], "Xfile")', 'E730:')
call assert_false(filereadable("Xfile"))
call delete("Xfile")
call assert_fails('call writefile([], "Xfile", [])', 'E730:')
call assert_false(filereadable("Xfile"))
call delete("Xfile")
call assert_fails('call writefile([], [])', 'E730:')
endfunc
func Test_writefile_fails_conversion()
CheckFeature iconv
if has('sun')
throw 'Skipped: does not work on SunOS'
endif
" Without a backup file the write won't happen if there is a conversion
" error.
set nobackup nowritebackup backupdir=. backupskip=
new
let contents = ["line one", "line two"]
call writefile(contents, 'Xfile')
edit Xfile
call setline(1, ["first line", "cannot convert \u010b", "third line"])
call assert_fails('write ++enc=cp932', 'E513:')
call assert_equal(contents, readfile('Xfile'))
call delete('Xfile')
bwipe!
set backup& writebackup& backupdir&vim backupskip&vim
endfunc
func Test_writefile_fails_conversion2()
CheckFeature iconv
if has('sun')
throw 'Skipped: does not work on SunOS'
endif
" With a backup file the write happens even if there is a conversion error,
" but then the backup file must remain
set nobackup writebackup backupdir=. backupskip=
let contents = ["line one", "line two"]
call writefile(contents, 'Xfile_conversion_err')
edit Xfile_conversion_err
call setline(1, ["first line", "cannot convert \u010b", "third line"])
set fileencoding=latin1
let output = execute('write')
call assert_match('CONVERSION ERROR', output)
call assert_equal(contents, readfile('Xfile_conversion_err~'))
call delete('Xfile_conversion_err')
call delete('Xfile_conversion_err~')
bwipe!
set backup& writebackup& backupdir&vim backupskip&vim
endfunc
func SetFlag(timer)
let g:flag = 1
endfunc
func Test_write_quit_split()
" Prevent exiting by splitting window on file write.
augroup testgroup
autocmd BufWritePre * split
augroup END
e! Xfile
call setline(1, 'nothing')
wq
if has('timers')
" timer will not run if "exiting" is still set
let g:flag = 0
call timer_start(1, 'SetFlag')
sleep 50m
call assert_equal(1, g:flag)
unlet g:flag
endif
au! testgroup
bwipe Xfile
call delete('Xfile')
endfunc
func Test_nowrite_quit_split()
" Prevent exiting by opening a help window.
e! Xfile
help
wincmd w
exe winnr() . 'q'
if has('timers')
" timer will not run if "exiting" is still set
let g:flag = 0
call timer_start(1, 'SetFlag')
sleep 50m
call assert_equal(1, g:flag)
unlet g:flag
endif
bwipe Xfile
endfunc
func Test_writefile_sync_arg()
" This doesn't check if fsync() works, only that the argument is accepted.
call writefile(['one'], 'Xtest', 's')
call writefile(['two'], 'Xtest', 'S')
call delete('Xtest')
endfunc
func Test_writefile_sync_dev_stdout()
CheckUnix
if filewritable('/dev/stdout')
" Just check that this doesn't cause an error.
call writefile(['one'], '/dev/stdout')
else
throw 'Skipped: /dev/stdout is not writable'
endif
endfunc
func Test_writefile_autowrite()
set autowrite
new
next Xa Xb Xc
call setline(1, 'aaa')
next
call assert_equal(['aaa'], readfile('Xa'))
call setline(1, 'bbb')
call assert_fails('edit XX')
call assert_false(filereadable('Xb'))
set autowriteall
edit XX
call assert_equal(['bbb'], readfile('Xb'))
bwipe!
call delete('Xa')
call delete('Xb')
set noautowrite
endfunc
func Test_writefile_autowrite_nowrite()
set autowrite
new
next Xa Xb Xc
set buftype=nowrite
call setline(1, 'aaa')
let buf = bufnr('%')
" buffer contents silently lost
edit XX
call assert_false(filereadable('Xa'))
rewind
call assert_equal('', getline(1))
bwipe!
set noautowrite
endfunc
" Test for ':w !<cmd>' to pipe lines from the current buffer to an external
" command.
func Test_write_pipe_to_cmd()
CheckUnix
new
call setline(1, ['L1', 'L2', 'L3', 'L4'])
2,3w !cat > Xfile
call assert_equal(['L2', 'L3'], readfile('Xfile'))
close!
call delete('Xfile')
endfunc
" Test for :saveas
func Test_saveas()
call assert_fails('saveas', 'E471:')
call writefile(['L1'], 'Xfile')
new Xfile
new
call setline(1, ['L1'])
call assert_fails('saveas Xfile', 'E139:')
close!
enew | only
call delete('Xfile')
endfunc
func Test_write_errors()
" Test for writing partial buffer
call writefile(['L1', 'L2', 'L3'], 'Xfile')
new Xfile
call assert_fails('1,2write', 'E140:')
close!
call assert_fails('w > Xtest', 'E494:')
" Try to overwrite a directory
if has('unix')
call mkdir('Xdir1')
call assert_fails('write Xdir1', 'E17:')
call delete('Xdir1', 'd')
endif
" Test for :wall for a buffer with no name
enew | only
call setline(1, ['L1'])
call assert_fails('wall', 'E141:')
enew!
" Test for writing a 'readonly' file
new Xfile
set readonly
call assert_fails('write', 'E45:')
close
" Test for writing to a read-only file
new Xfile
call setfperm('Xfile', 'r--r--r--')
call assert_fails('write', 'E505:')
call setfperm('Xfile', 'rw-rw-rw-')
close
call delete('Xfile')
call writefile(test_null_list(), 'Xfile')
call assert_false(filereadable('Xfile'))
call writefile(test_null_blob(), 'Xfile')
call assert_false(filereadable('Xfile'))
call assert_fails('call writefile([], "")', 'E482:')
" very long file name
let long_fname = repeat('n', 5000)
call assert_fails('exe "w " .. long_fname', 'E75:')
call assert_fails('call writefile([], long_fname)', 'E482:')
endfunc
" Test for writing to a file which is modified after Vim read it
func Test_write_file_mtime()
CheckEnglish
CheckRunVimInTerminal
" First read the file into a buffer
call writefile(["Line1", "Line2"], 'Xfile')
let old_ftime = getftime('Xfile')
let buf = RunVimInTerminal('Xfile', #{rows : 10})
call TermWait(buf)
call term_sendkeys(buf, ":set noswapfile\<CR>")
call TermWait(buf)
" Modify the file directly. Make sure the file modification time is
" different. Note that on Linux/Unix, the file is considered modified
" outside, only if the difference is 2 seconds or more
sleep 1
call writefile(["Line3", "Line4"], 'Xfile')
let new_ftime = getftime('Xfile')
while new_ftime - old_ftime < 2
sleep 100m
call writefile(["Line3", "Line4"], 'Xfile')
let new_ftime = getftime('Xfile')
endwhile
" Try to overwrite the file and check for the prompt
call term_sendkeys(buf, ":w\<CR>")
call TermWait(buf)
call WaitForAssert({-> assert_equal("WARNING: The file has been changed since reading it!!!", term_getline(buf, 9))})
call assert_equal("Do you really want to write to it (y/n)?",
\ term_getline(buf, 10))
call term_sendkeys(buf, "n\<CR>")
call TermWait(buf)
call assert_equal(new_ftime, getftime('Xfile'))
call term_sendkeys(buf, ":w\<CR>")
call TermWait(buf)
call term_sendkeys(buf, "y\<CR>")
call TermWait(buf)
call WaitForAssert({-> assert_equal('Line2', readfile('Xfile')[1])})
" clean up
call StopVimInTerminal(buf)
call delete('Xfile')
endfunc
" Test for an autocmd unloading a buffer during a write command
func Test_write_autocmd_unloadbuf_lockmark()
augroup WriteTest
autocmd BufWritePre Xfile enew | write
augroup END
e Xfile
call assert_fails('lockmarks write', ['E32:', 'E203:'])
augroup WriteTest
au!
augroup END
augroup! WriteTest
endfunc
" Test for writing a buffer with 'acwrite' but without autocmds
func Test_write_acwrite_error()
new Xfile
call setline(1, ['line1', 'line2', 'line3'])
set buftype=acwrite
call assert_fails('write', 'E676:')
call assert_fails('1,2write!', 'E676:')
call assert_fails('w >>', 'E676:')
close!
endfunc
" Test for adding and removing lines from an autocmd when writing a buffer
func Test_write_autocmd_add_remove_lines()
new Xfile
call setline(1, ['aaa', 'bbb', 'ccc', 'ddd'])
" Autocmd deleting lines from the file when writing a partial file
augroup WriteTest2
au!
autocmd FileWritePre Xfile 1,2d
augroup END
call assert_fails('2,3w!', 'E204:')
" Autocmd adding lines to a file when writing a partial file
augroup WriteTest2
au!
autocmd FileWritePre Xfile call append(0, ['xxx', 'yyy'])
augroup END
%d
call setline(1, ['aaa', 'bbb', 'ccc', 'ddd'])
1,2w!
call assert_equal(['xxx', 'yyy', 'aaa', 'bbb'], readfile('Xfile'))
" Autocmd deleting lines from the file when writing the whole file
augroup WriteTest2
au!
autocmd BufWritePre Xfile 1,2d
augroup END
%d
call setline(1, ['aaa', 'bbb', 'ccc', 'ddd'])
w
call assert_equal(['ccc', 'ddd'], readfile('Xfile'))
augroup WriteTest2
au!
augroup END
augroup! WriteTest2
close!
call delete('Xfile')
endfunc
" Test for writing to a readonly file
func Test_write_readonly()
call writefile([], 'Xfile')
call setfperm('Xfile', "r--------")
edit Xfile
set noreadonly backupskip=
call assert_fails('write', 'E505:')
let save_cpo = &cpo
set cpo+=W
call assert_fails('write!', 'E504:')
let &cpo = save_cpo
call setline(1, ['line1'])
write!
call assert_equal(['line1'], readfile('Xfile'))
set backupskip&
call delete('Xfile')
endfunc
" Test for 'patchmode'
func Test_patchmode()
call writefile(['one'], 'Xfile')
set patchmode=.orig nobackup backupskip= writebackup
new Xfile
call setline(1, 'two')
" first write should create the .orig file
write
call assert_equal(['one'], readfile('Xfile.orig'))
call setline(1, 'three')
" subsequent writes should not create/modify the .orig file
write
call assert_equal(['one'], readfile('Xfile.orig'))
set patchmode& backup& backupskip& writebackup&
call delete('Xfile')
call delete('Xfile.orig')
endfunc
" Test for writing to a file in a readonly directory
func Test_write_readonly_dir()
" On MS-Windows, modifying files in a read-only directory is allowed.
CheckUnix
call mkdir('Xdir')
call writefile(['one'], 'Xdir/Xfile1')
call setfperm('Xdir', 'r-xr--r--')
" try to create a new file in the directory
new Xdir/Xfile2
call setline(1, 'two')
call assert_fails('write', 'E212:')
" try to create a backup file in the directory
edit! Xdir/Xfile1
set backupdir=./Xdir backupskip=
set patchmode=.orig
call assert_fails('write', 'E509:')
call setfperm('Xdir', 'rwxr--r--')
call delete('Xdir', 'rf')
set backupdir& backupskip& patchmode&
endfunc
" Test for writing a file using invalid file encoding
func Test_write_invalid_encoding()
new
call setline(1, 'abc')
call assert_fails('write ++enc=axbyc Xfile', 'E213:')
close!
endfunc
" Tests for reading and writing files with conversion for Win32.
func Test_write_file_encoding()
CheckMSWindows
let save_encoding = &encoding
let save_fileencodings = &fileencodings
set encoding& fileencodings&
let text =<< trim END
1 utf-8 text: Для Vim version 6.2. Последнее изменение: 1970 Jan 01
2 cp1251 text: Äëÿ Vim version 6.2. Ïîñëåäíåå èçìåíåíèå: 1970 Jan 01
3 cp866 text: „«ï Vim version 6.2. ®á«¥¤­¥¥ ¨§¬¥­¥­¨¥: 1970 Jan 01
END
call writefile(text, 'Xfile')
edit Xfile
" write tests:
" combine three values for 'encoding' with three values for 'fileencoding'
" also write files for read tests
call cursor(1, 1)
set encoding=utf-8
.w! ++enc=utf-8 Xtest
.w ++enc=cp1251 >> Xtest
.w ++enc=cp866 >> Xtest
.w! ++enc=utf-8 Xutf8
let expected =<< trim END
1 utf-8 text: Для Vim version 6.2. Последнее изменение: 1970 Jan 01
1 utf-8 text: Äëÿ Vim version 6.2. Ïîñëåäíåå èçìåíåíèå: 1970 Jan 01
1 utf-8 text: „«ï Vim version 6.2. ®á«¥¤­¥¥ ¨§¬¥­¥­¨¥: 1970 Jan 01
END
call assert_equal(expected, readfile('Xtest'))
call cursor(2, 1)
set encoding=cp1251
.w! ++enc=utf-8 Xtest
.w ++enc=cp1251 >> Xtest
.w ++enc=cp866 >> Xtest
.w! ++enc=cp1251 Xcp1251
let expected =<< trim END
2 cp1251 text: Для Vim version 6.2. Последнее изменение: 1970 Jan 01
2 cp1251 text: Äëÿ Vim version 6.2. Ïîñëåäíåå èçìåíåíèå: 1970 Jan 01
2 cp1251 text: „«ï Vim version 6.2. ®á«¥¤­¥¥ ¨§¬¥­¥­¨¥: 1970 Jan 01
END
call assert_equal(expected, readfile('Xtest'))
call cursor(3, 1)
set encoding=cp866
.w! ++enc=utf-8 Xtest
.w ++enc=cp1251 >> Xtest
.w ++enc=cp866 >> Xtest
.w! ++enc=cp866 Xcp866
let expected =<< trim END
3 cp866 text: Для Vim version 6.2. Последнее изменение: 1970 Jan 01
3 cp866 text: Äëÿ Vim version 6.2. Ïîñëåäíåå èçìåíåíèå: 1970 Jan 01
3 cp866 text: „«ï Vim version 6.2. ®á«¥¤­¥¥ ¨§¬¥­¥­¨¥: 1970 Jan 01
END
call assert_equal(expected, readfile('Xtest'))
" read three 'fileencoding's with utf-8 'encoding'
set encoding=utf-8 fencs=utf-8,cp1251
e Xutf8
.w! ++enc=utf-8 Xtest
e Xcp1251
.w ++enc=utf-8 >> Xtest
set fencs=utf-8,cp866
e Xcp866
.w ++enc=utf-8 >> Xtest
let expected =<< trim END
1 utf-8 text: Для Vim version 6.2. Последнее изменение: 1970 Jan 01
2 cp1251 text: Для Vim version 6.2. Последнее изменение: 1970 Jan 01
3 cp866 text: Для Vim version 6.2. Последнее изменение: 1970 Jan 01
END
call assert_equal(expected, readfile('Xtest'))
" read three 'fileencoding's with cp1251 'encoding'
set encoding=utf-8 fencs=utf-8,cp1251
e Xutf8
.w! ++enc=cp1251 Xtest
e Xcp1251
.w ++enc=cp1251 >> Xtest
set fencs=utf-8,cp866
e Xcp866
.w ++enc=cp1251 >> Xtest
let expected =<< trim END
1 utf-8 text: Äëÿ Vim version 6.2. Ïîñëåäíåå èçìåíåíèå: 1970 Jan 01
2 cp1251 text: Äëÿ Vim version 6.2. Ïîñëåäíåå èçìåíåíèå: 1970 Jan 01
3 cp866 text: Äëÿ Vim version 6.2. Ïîñëåäíåå èçìåíåíèå: 1970 Jan 01
END
call assert_equal(expected, readfile('Xtest'))
" read three 'fileencoding's with cp866 'encoding'
set encoding=cp866 fencs=utf-8,cp1251
e Xutf8
.w! ++enc=cp866 Xtest
e Xcp1251
.w ++enc=cp866 >> Xtest
set fencs=utf-8,cp866
e Xcp866
.w ++enc=cp866 >> Xtest
let expected =<< trim END
1 utf-8 text: „«ï Vim version 6.2. ®á«¥¤­¥¥ ¨§¬¥­¥­¨¥: 1970 Jan 01
2 cp1251 text: „«ï Vim version 6.2. ®á«¥¤­¥¥ ¨§¬¥­¥­¨¥: 1970 Jan 01
3 cp866 text: „«ï Vim version 6.2. ®á«¥¤­¥¥ ¨§¬¥­¥­¨¥: 1970 Jan 01
END
call assert_equal(expected, readfile('Xtest'))
call delete('Xfile')
call delete('Xtest')
call delete('Xutf8')
call delete('Xcp1251')
call delete('Xcp866')
let &encoding = save_encoding
let &fileencodings = save_fileencodings
%bw!
endfunc
" Test for writing and reading a file starting with a BOM.
" Byte Order Mark (BOM) character for various encodings is below:
" UTF-8 : EF BB BF
" UTF-16 (BE): FE FF
" UTF-16 (LE): FF FE
" UTF-32 (BE): 00 00 FE FF
" UTF-32 (LE): FF FE 00 00
func Test_readwrite_file_with_bom()
let utf8_bom = "\xEF\xBB\xBF"
let utf16be_bom = "\xFE\xFF"
let utf16le_bom = "\xFF\xFE"
let utf32be_bom = "\n\n\xFE\xFF"
let utf32le_bom = "\xFF\xFE\n\n"
let save_fileencoding = &fileencoding
set cpoptions+=S
" Check that editing a latin1 file doesn't see a BOM
call writefile(["\xFE\xFElatin-1"], 'Xtest1')
edit Xtest1
call assert_equal('latin1', &fileencoding)
call assert_equal(0, &bomb)
set fenc=latin1
write Xfile2
call assert_equal(["\xFE\xFElatin-1", ''], readfile('Xfile2', 'b'))
set bomb fenc=latin1
write Xtest3
call assert_equal(["\xFE\xFElatin-1", ''], readfile('Xtest3', 'b'))
set bomb&
" Check utf-8 BOM
%bw!
call writefile([utf8_bom .. "utf-8"], 'Xtest1')
edit! Xtest1
call assert_equal('utf-8', &fileencoding)
call assert_equal(1, &bomb)
call assert_equal('utf-8', getline(1))
set fenc=latin1
write! Xfile2
call assert_equal(['utf-8', ''], readfile('Xfile2', 'b'))
set fenc=utf-8
w! Xtest3
call assert_equal([utf8_bom .. "utf-8", ''], readfile('Xtest3', 'b'))
" Check utf-8 with an error (will fall back to latin-1)
%bw!
call writefile([utf8_bom .. "utf-8\x80err"], 'Xtest1')
edit! Xtest1
call assert_equal('latin1', &fileencoding)
call assert_equal(0, &bomb)
call assert_equal("\xC3\xAF\xC2\xBB\xC2\xBFutf-8\xC2\x80err", getline(1))
set fenc=latin1
write! Xfile2
call assert_equal([utf8_bom .. "utf-8\x80err", ''], readfile('Xfile2', 'b'))
set fenc=utf-8
w! Xtest3
call assert_equal(["\xC3\xAF\xC2\xBB\xC2\xBFutf-8\xC2\x80err", ''],
\ readfile('Xtest3', 'b'))
" Check ucs-2 BOM
%bw!
call writefile([utf16be_bom .. "\nu\nc\ns\n-\n2\n"], 'Xtest1')
edit! Xtest1
call assert_equal('utf-16', &fileencoding)
call assert_equal(1, &bomb)
call assert_equal('ucs-2', getline(1))
set fenc=latin1
write! Xfile2
call assert_equal(["ucs-2", ''], readfile('Xfile2', 'b'))
set fenc=ucs-2
w! Xtest3
call assert_equal([utf16be_bom .. "\nu\nc\ns\n-\n2\n", ''],
\ readfile('Xtest3', 'b'))
" Check ucs-2le BOM
%bw!
call writefile([utf16le_bom .. "u\nc\ns\n-\n2\nl\ne\n"], 'Xtest1')
" Need to add a NUL byte after the NL byte
call writefile(0z00, 'Xtest1', 'a')
edit! Xtest1
call assert_equal('utf-16le', &fileencoding)
call assert_equal(1, &bomb)
call assert_equal('ucs-2le', getline(1))
set fenc=latin1
write! Xfile2
call assert_equal(["ucs-2le", ''], readfile('Xfile2', 'b'))
set fenc=ucs-2le
w! Xtest3
call assert_equal([utf16le_bom .. "u\nc\ns\n-\n2\nl\ne\n", "\n"],
\ readfile('Xtest3', 'b'))
" Check ucs-4 BOM
%bw!
call writefile([utf32be_bom .. "\n\n\nu\n\n\nc\n\n\ns\n\n\n-\n\n\n4\n\n\n"], 'Xtest1')
edit! Xtest1
call assert_equal('ucs-4', &fileencoding)
call assert_equal(1, &bomb)
call assert_equal('ucs-4', getline(1))
set fenc=latin1
write! Xfile2
call assert_equal(["ucs-4", ''], readfile('Xfile2', 'b'))
set fenc=ucs-4
w! Xtest3
call assert_equal([utf32be_bom .. "\n\n\nu\n\n\nc\n\n\ns\n\n\n-\n\n\n4\n\n\n", ''], readfile('Xtest3', 'b'))
" Check ucs-4le BOM
%bw!
call writefile([utf32le_bom .. "u\n\n\nc\n\n\ns\n\n\n-\n\n\n4\n\n\nl\n\n\ne\n\n\n"], 'Xtest1')
" Need to add three NUL bytes after the NL byte
call writefile(0z000000, 'Xtest1', 'a')
edit! Xtest1
call assert_equal('ucs-4le', &fileencoding)
call assert_equal(1, &bomb)
call assert_equal('ucs-4le', getline(1))
set fenc=latin1
write! Xfile2
call assert_equal(["ucs-4le", ''], readfile('Xfile2', 'b'))
set fenc=ucs-4le
w! Xtest3
call assert_equal([utf32le_bom .. "u\n\n\nc\n\n\ns\n\n\n-\n\n\n4\n\n\nl\n\n\ne\n\n\n", "\n\n\n"], readfile('Xtest3', 'b'))
set cpoptions-=S
let &fileencoding = save_fileencoding
call delete('Xtest1')
call delete('Xfile2')
call delete('Xtest3')
%bw!
endfunc
func Test_read_write_bin()
" write file missing EOL
call writefile(['noeol'], "XNoEolSetEol", 'bS')
call assert_equal(0z6E6F656F6C, readfile('XNoEolSetEol', 'B'))
" when file is read 'eol' is off
set nofixeol
e! ++ff=unix XNoEolSetEol
call assert_equal(0, &eol)
" writing with 'eol' set adds the newline
setlocal eol
w
call assert_equal(0z6E6F656F6C0A, readfile('XNoEolSetEol', 'B'))
call delete('XNoEolSetEol')
set ff&
bwipe! XNoEolSetEol
endfunc
" vim: shiftwidth=2 sts=2 expandtab