name: 'screendump'
-description: "Upload failed syntax tests"
+description: "Upload failed screendump tests"
runs:
using: "composite"
steps:
- - name: Upload failed syntax tests
+ - name: Upload failed tests
uses: actions/upload-artifact@v4
with:
# Name of the artifact to upload.
- name: ${{ github.workflow }}-${{ github.job }}-${{ join(matrix.*, '-') }}-failed-syntax-tests
+ name: ${{ github.workflow }}-${{ github.job }}-${{ join(matrix.*, '-') }}-failed-tests
# A file, directory or wildcard pattern that describes what
# to upload.
runtime/syntax/Makefile \
runtime/syntax/testdir/README.txt \
runtime/syntax/testdir/runtest.vim \
+ runtime/syntax/testdir/viewdumps.vim \
runtime/syntax/testdir/ftplugin/*.* \
runtime/syntax/testdir/input/*.* \
runtime/syntax/testdir/input/selftestdir/* \
test.
+Viewing generated screendumps
+-----------------------------
+
+You may also wish to look at the whole batch of failed screendumps after
+running "make test". Source the "viewdumps.vim" script for this task:
+
+ [VIMRUNTIME=../..] \
+ ../../src/vim --clean -S testdir/viewdumps.vim \
+ [testdir/dumps/java_*.dump ...]
+
+By default, all screendumps found in the "failed" directory will be added to
+the argument list and then the first one will be loaded. Loaded screendumps
+that bear filenames of screendumps found in the "dumps" directory will be
+rendering the contents of any such pair of files and the difference between
+them (:help term_dumpdiff()); otherwise, they will be rendering own contents
+(:help term_dumpload()). Remember to execute :edit when occasionally you see
+raw file contents instead of rendered.
+
+At any time, you can add, list, and abandon other screendumps:
+
+ :$argedit testdir/dumps/java_*.dump
+ :args
+ :qall
+
+The listing of argument commands can be found under :help buffer-list.
TODO: run test for one specific filetype
if exists("$VIM_SYNTAX_SELF_TESTING")
let dirpath = 'input/selftestdir/'
- let fnames = readdir(dirpath, {fname -> fname !~ '^README.txt$'})
+ let fnames = readdir(dirpath, {fname -> fname !~ '^README\.txt$'})
else
let dirpath = 'input/'
let fnames = readdir(dirpath, {fname -> fname !~ '\~$' && fname =~ '^.\+\..\+$'})
call Message('OK: ' .. ok_count)
call Message('FAILED: ' .. len(failed_tests) .. ': ' .. string(failed_tests))
call Message('skipped: ' .. skipped_count)
+
+ if !empty(failed_tests)
+ call Message('')
+ call Message('View generated screendumps with "../../src/vim --clean -S testdir/viewdumps.vim"')
+ endif
+
call AppendMessages('== SUMMARY ==')
if len(failed_tests) > 0
--- /dev/null
+vim9script
+
+# Support sourcing this script from this directory or any other directory in
+# the direct path that leads to the project's root directory.
+const failed_path: string = finddir('failed', getcwd() .. '/**', -1)
+ ->filter(((cwdpath: string) => (_: number, dirpath: string) =>
+ cwdpath =~ '\<syntax\>' || dirpath =~ '\<syntax\>')(getcwd()))
+ ->get(-1, '') .. '/'
+var error: string = null_string
+
+if failed_path == '/'
+ error = 'No such directory: "failed"'
+else
+ const failed_fnames: string = failed_path .. readdir(failed_path,
+ (fname: string) => fname =~ '^.\+\.dump$')
+ ->join(' ' .. failed_path)
+
+ if failed_fnames =~ 'failed/$'
+ error = 'No such file: "*.dump"'
+ else
+ exec ':0argedit ' .. failed_fnames
+ buffers
+ endif
+endif
+
+def Render()
+ const failed_fname: string = bufname()
+ try
+ setlocal suffixesadd=.dump
+ const dumps_fname: string = findfile(
+ fnamemodify(failed_fname, ':p:t'),
+ fnamemodify(failed_fname, ':p:h:h') .. '/dumps')
+ if filereadable(dumps_fname)
+ term_dumpdiff(failed_fname, dumps_fname)
+ else
+ term_dumpload(failed_fname)
+ endif
+ finally
+ exec 'bwipeout ' .. failed_fname
+ endtry
+enddef
+
+# THE FOLLOWING SETTINGS PERTAIN TO "input/" FILES THAT ARE LIKELY TO BE
+# LOADED SIDE BY SIDE WHENEVER BATCHES OF NEW SCREENDUMPS ARE GENERATED.
+
+# Match "LC_ALL=C" of Makefile.
+language C
+
+# Match the settings from term_util.vim#RunVimInTerminal().
+set t_Co=256 background=light
+hi Normal ctermfg=NONE ctermbg=NONE
+
+# Match the settings from runtest.vim#Xtestscript#SetUpVim().
+set display=lastline ruler scrolloff=5 t_ZH= t_ZR=
+
+# Anticipate non-Latin-1 characters in "input/" files.
+set encoding=utf-8 termencoding=utf-8
+
+autocmd_add([{
+ replace: true,
+ group: 'viewdumps',
+ event: 'BufRead',
+ pattern: '*.dump',
+ cmd: 'Render()',
+}])
+
+# Unconditionally help, in case a list of filenames is passed to the command,
+# the first terminal window with its BufRead event.
+silent doautocmd viewdumps BufRead
+
+if error != null_string
+ # Instead of sleeping, fill half a window with blanks and prompt hit-enter.
+ echom error .. repeat("\x20", (winwidth(0) * (winheight(0) / 2) - strlen(error)))
+ error = null_string
+endif
+
+# vim:fdm=syntax:sw=2:ts=8:noet:nolist:nosta:
- To cleanup the temporary files after running the tests:
$ make clean
+
+# ANALYZE FAILED SCREENDUMPS FROM CI:
+
+See the file ../../runtime/syntax/testdir/README.txt section
+"Viewing generated screendumps" on how to analyze failed screen dumps
+(from CI or locally) using the provided Vim script
+../../runtime/syntax/testdir/viewdumps.vim in a more automatic way.
projects / thirdparty / vim.git / commitdiff
