Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kana/vim-vspec
Vim plugin: Testing framework for Vim script
https://github.com/kana/vim-vspec
testing-framework vim vim-plugins
Last synced: 5 days ago
JSON representation
Vim plugin: Testing framework for Vim script
- Host: GitHub
- URL: https://github.com/kana/vim-vspec
- Owner: kana
- Created: 2010-03-01T13:21:01.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T09:48:52.000Z (3 months ago)
- Last Synced: 2024-08-07T18:48:32.198Z (3 months ago)
- Topics: testing-framework, vim, vim-plugins
- Language: Vim Script
- Homepage: http://www.vim.org/scripts/script.php?script_id=3012
- Size: 423 KB
- Stars: 220
- Watchers: 7
- Forks: 13
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vim-vspec - A testing framework for Vim script
[](https://github.com/kana/vim-vspec/actions/workflows/ci.yml)
vim-vspec is a testing framework for Vim script. It consists of:
* Utilities to run tests in an isolated Vim process,
* A testing framework to write tests in a format which resembles [RSpec](https://rspec.info/), and
* Additional syntax/indent files for Vim script to write tests.
A typical test script written with vim-vspec looks like as follows:
```vim
runtime plugin/MyGitUtilities.vim
describe 'GetGitBranchName()'
before
call delete('tmp/test', 'rf')
call mkdir('tmp/test', 'p')
cd tmp/test
end
after
cd -
end
context 'in a non-Git directory'
it 'returns "-"'
Expect GetGitBranchName('.') ==# '-'
end
end
context 'in a Git repository'
before
!git init && touch foo && git add foo && git commit -m 'Initial commit'
end
it 'returns the current branch'
Expect GetGitBranchName('.') ==# 'master'
end
it 'detects detached HEAD state'
!git checkout master~0
Expect GetGitBranchName('.') ==# 'master~0'
end
end
end
```
Typical ways to run tests are as follows:
```bash
# Run tests in a specific file.
# The current directory is injected into &rutimepath before running tests.
$PATH_TO_VSPEC/bin/prove-vspec -d $PWD t/branch.vim
# Like the above, but run all tests in all files under the `t` directory.
$PATH_TO_VSPEC/bin/prove-vspec -d $PWD t/
# Like the above, but you may omit `t` because it's the default target.
$PATH_TO_VSPEC/bin/prove-vspec -d $PWD
```
Its output looks like as follows:
```
t/branch.vim .. ok
All tests successful.
Files=1, Tests=3, 1 wallclock secs ( 0.02 usr 0.00 sys + 0.07 cusr 0.11 csys = 0.20 CPU)
Result: PASS
```
`prove-vspec` runs a test script in an isolated Vim process, and show
a summary like the above. User-specific configurations, like `~/.vimrc` and
files in `~/.vim`, will never be used to avoid unintentional dependencies.
For proper testing, you have to set up environment to run tests. Suppose that
you want to test a plugin which depends on some other plugins, you have to:
* Install such dependencies to somewhere, and
* Specify where the dependencies are installed to run tests.
These steps are tedious to do by hand. It is recommended to use
[vim-flavor](https://github.com/kana/vim-flavor) to automate such tasks.
See [How to set up GitHub Actios as CI for Vim plugin development](./TUTORIAL-CI.md) for details.
## Further reading
* [A tutorial to use vim-vspec by Vimcasts.org](http://vimcasts.org/episodes/an-introduction-to-vspec/)
* [Introduce unit testing to Vim plugin development with vim-vspec](https://whileimautomaton.net/2013/02/13211500)
* [How to set up GitHub Actios as CI for Vim plugin development](./TUTORIAL-CI.md)