Setup for testing

Author: Le Tien Tai

.gitignore

@@ -2,3 +2,4 @@
 *~
 .DS_Store
 tags
+vader.vim/

test/basic.vader

@@ -0,0 +1,5 @@
+Do (Sample):
+  iHello, world!
+
+Expect(Sample):
+  Hello, world!

test/custom-template.vader

@@ -0,0 +1,5 @@
+Do (Test 2):
+  iThis is the second test file.
+
+Expect (Test 2):
+  This is the second test file.

test/minimal_vimrc

@@ -0,0 +1,11 @@
+" Minimal vimrc to run tests
+" --------------------------
+
+set nocompatible
+set nu
+" Clear all rtp
+set rtp=
+
+" Now add vader.vim to runtime path
+set rtp+=./vader.vim
+filetype plugin indent on

test/nodemon.json

@@ -0,0 +1,13 @@
+{
+  "watch": "../",
+  "ignore": [
+    ".git",
+    "node_modules/**/node_modules",
+    "vader.vim"
+  ],
+  "verbose": true,
+  "ext": "vader vim",
+  "execMap": {
+    "vader": "./run-single-test-file.sh"
+  }
+}

test/readme.md

@@ -0,0 +1,46 @@
+Test cases for vim-pydocstring
+==========================================
+
+Prerequisite
+------------
+
+- [vader.vim](https://github.com/junegunn/vader.vim)
+
+Before running test, clone vader into this directory with:
+
+```
+git clone https://github.com/junegunn/vader.vim
+```
+
+
+Run
+---
+
+```
+./run.sh
+```
+
+Note that the command need to be executed under `test` folder.
+
+Use TDD during development (optional)
+-------------------------------------
+
+You need [nodemon](https://github.com/remy/nodemon) to watch for files
+change and re-run the test cases in given file. Here I already provide
+nodemon configuration (see `nodemon.json`.)
+
+Run (again, this need to be executed under `test` folder)
+
+```
+nodemon <test-file>.vader
+```
+
+Now, if you modify the `vader` or `vim` files in this project, nodemon will
+re-run all the test cases (via `run-single-test-file.sh`).
+
+
+### Know issue
+
+Vim warns `Input is not from a terminal` when we run tests with
+`nodemon`. Neovim doesn't. That why in the scripts, we prefer to use
+`nvim` if it is found on path.

test/run-single-test-file.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+###############################################################################
+#                         Execute a single test file                          #
+###############################################################################
+
+if [ $# -eq 0 ]; then
+  echo "Please supply an input *.vader file"
+  exit
+fi
+
+VIM_EXE="vim"
+
+if  hash nvim 2>/dev/null ; then
+  VIM_EXE="nvim"
+fi
+
+# Open vim with readonly mode just to execute all *.vader tests.
+$VIM_EXE -Nu minimal_vimrc -R "+Vader $1"

test/run.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+###############################################################################
+#                            Execute all test case                            #
+###############################################################################
+
+VIM_EXE="vim"
+
+# If nvim is available in PATH, then we prefer to use nvim
+# since it works better with nodemon
+if  hash nvim 2>/dev/null ; then
+  VIM_EXE="nvim"
+fi
+
+# Open vim with readonly mode just to execute all *.vader tests.
+$VIM_EXE -Nu minimal_vimrc -R '+Vader *.vader'