aboutsummaryrefslogtreecommitdiff
path: root/vim/bundle/vim-gitgutter/test/README.markdown
blob: 2be0c37aea888a01f6d8ad60dd2db8d740a11126 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
## Testing vim-gitgutter

### Run the tests

```sh
$ cd test
$ ./test
```

### Add a new test

- Add a test file named like `testFoo.vim`.  It should have this structure:

```viml
source helper.vim
call Setup()

" test code here
```

- Run the tests.
- Inspect output (in `foo.actual`) from the new test.  If good, copy it to `foo.expected`.
- Run the tests to ensure new test's output is verified.
- Commit changes.

### Limitations

- Currently tests are done by writing out a file and comparing it to a known good one.
- There's no support for assertions within the testcase code.