Testing Vim and Vim script

runtime/doc/testing.txt

6805213568d1c1aca17d4b8f8d623a812533b86b07b16def0000000300000646

*testing.txt*	Nvim


		  VIM REFERENCE MANUAL	  by Bram Moolenaar


Testing Vim and Vim script			*testing-support*

Expression evaluation is explained in |eval.txt|.  This file goes into details
about writing tests in Vim script.  This can be used for testing Vim itself
and for testing plugins.

1. Testing Vim				|testing|
2. Test functions			|test-functions-details|
3. Assert functions			|assert-functions-details|

==============================================================================
1. Testing Vim						*testing*

Vim can be tested after building it, usually with "make test".
The tests are located in the directory "src/testdir".

						*new-style-testing*
New tests should be added as new style tests.  The test scripts are named
test_<feature>.vim (replace <feature> with the feature under test). These use
functions such as |assert_equal()| to keep the test commands and the expected
result in one place.

Find more information in the file src/testdir/README.txt.

==============================================================================
2. Test functions				*test-functions-details*

See |test_garbagecollect_now()|.

==============================================================================
3. Assert functions				*assert-functions-details*

See:
  - |assert_beeps()|
  - |assert_equal()|
  - |assert_equalfile()|
  - |assert_exception()|
  - |assert_fails()|
  - |assert_false()|
  - |assert_inrange()|
  - |assert_match()|
  - |assert_nobeep()|
  - |assert_notequal()|
  - |assert_notmatch()|
  - |assert_report()|
  - |assert_true()|

 vim:tw=78:ts=8:noet:ft=help:norl:

Chunks

51d12550 (1st chunk of `runtime/doc/testing.txt`)

Title: Testing Vim and Vim script

Summary

This section of the Vim documentation explains how to write tests in Vim script for both Vim itself and for plugins. It covers the location of test files, the recommended "new-style-testing" approach using functions like assert_equal(), and provides links to more details on specific test and assert functions.