The main goal of this plugin is to give a minimal structure to write vimscript
tests based on the existing assert_* functions that already exist.
- minimal structure: use basic vimscript data structures and functions.
VMTest simple iterate over g:vmtests keys looking for functions to run and
print Success or Failed based on v:errors.
There are a few reserved keys, used internally:
_name- Optional custom name of a scope_before- Call back to run before each test of the scope_after- Call back to run after each test of the scope_tests_counter- Count of tests that failed
On your plugin you create a vmtest folder with a test file like:
- tests
" Setup the vmtest for the given plugin
call vmtest#plugin('vmtest')
" Scope without a custom name
" The scope key will be used as its name
let g:vmtests.vmtest.first_scope = {}
" Similar to the `setup` of some test libraries
function! g:vmtests.vmtest.first_scope._before()
echo "callback to run before each test\n"
let self.context_var = 'foo'
endfunction
" Similar to the `teardown` of some test libraries
function! g:vmtests.vmtest.first_scope._after()
echo "callback to run after each test\n"
endfunction
" A test function on the `first_scope` scope
function! g:vmtests.vmtest.first_scope.test_foo()
call assert_equal(self.context_var, 2)
endfunction
" A test function on the `first_scope` scope
function! g:vmtests.vmtest.first_scope.test_bar()
call assert_notequal(self.context_var, 2)
endfunction
" Scope with a custom name
let g:vmtests.vmtest.second_scope = { '_name': 'My Other Scope' }
" A test function on the `second_scope` scope
function! g:vmtests.vmtest.second_scope.test_bar()
call assert_equal(1, 1)
endfunction- output
=> vmtest
-> first_scope
callback to run before each test
» test_bar: Success
callback to run after each test
callback to run before each test
» test_foo: Failed
! Expected 'foo' but got 2
callback to run after each test
-> second_scope
» test_bar: Success
=> 3 Tests Runned.
=> 2 Tests Succeed, 1 Tests Failed.
Feedback and Pull Requests are welcome.