1
0
forked from aniani/vim

patch 8.1.0357: instructions for tests are outdated

Problem:    Instructions for tests are outdated. (Jason Franklin)
Solution:   Update the text.
This commit is contained in:
Bram Moolenaar
2018-09-09 15:56:06 +02:00
parent 99f043a57d
commit 02c972153d
2 changed files with 30 additions and 11 deletions

View File

@@ -15,23 +15,40 @@ TO ADD A NEW STYLE TEST:
1) Create a test_<subject>.vim file.
2) Add test_<subject>.res to NEW_TESTS in Make_all.mak in alphabetical order.
3) Also add an entry in src/Makefile.
3) Also add an entry "test_<subject>" in src/Make_all.mak.
4) Use make test_<subject>.res to run a single test in src/testdir/.
Use make test_<subject> to run a single test in src/.
At 2), instead of running the test separately, it can be included in
"test_alot". Do this for quick tests without side effects. The test runs a
bit faster, because Vim doesn't have to be started, one Vim instance runs many
tests.
What you can use (see test_assert.vim for an example):
- Call assert_equal(), assert_true(), assert_false(), etc.
- Use try/catch to check for exceptions.
- Use alloc_fail() to have memory allocation fail. This makes it possible
to check memory allocation failures are handled gracefully. You need to
change the source code to add an ID to the allocation. Update LAST_ID_USED
above alloc_id() to the highest ID used.
- Use disable_char_avail_for_testing(1) if char_avail() must return FALSE for
a while. E.g. to trigger the CursorMovedI autocommand event.
See test_cursor_func.vim for an example
- Use assert_fails() to check for expected errors.
- Use try/catch to avoid an exception aborts the test.
- Use alloc_fail() to have memory allocation fail. This makes it possible to
check memory allocation failures are handled gracefully. You need to change
- the source code to add an ID to the allocation. Update LAST_ID_USED above
alloc_id() to the highest ID used.
- Use test_override() to make Vim behave differently, e.g. if char_avail()
must return FALSE for a while. E.g. to trigger the CursorMovedI autocommand
event.
- See test_cursor_func.vim for an example.
- If the bug that is being tested isn't fixed yet, you can throw an exception
so that it's clear this still needs work. E.g.:
throw "Skipped: Bug with <c-e> and popupmenu not fixed yet"
with "Skipped" so that it's clear this still needs work. E.g.: throw
"Skipped: Bug with <c-e> and popupmenu not fixed yet"
- See the start of runtest.vim for more help.

View File

@@ -794,6 +794,8 @@ static char *(features[]) =
static int included_patches[] =
{ /* Add new patch number below this line */
/**/
357,
/**/
356,
/**/