blob: 734039aca1eae68aa9c71238ed94aaba3dd9b1fc [file] [log] [blame]
Bram Moolenaar43345542015-11-29 17:35:35 +01001" This script is sourced while editing the .vim file with the tests.
2" When the script is successful the .res file will be created.
3" Errors are appended to the test.log file.
4"
5" The test script may contain anything, only functions that start with
6" "Test_" are special. These will be invoked and should contain assert
7" functions. See test_assert.vim for an example.
8"
9" It is possible to source other files that contain "Test_" functions. This
10" can speed up testing, since Vim does not need to restart. But be careful
11" that the tests do not interfere with each other.
12"
13" If an error cannot be detected properly with an assert function add the
14" error to the v:errors list:
15" call add(v:errors, 'test foo failed: Cannot find xyz')
16"
17" If preparation for each Test_ function is needed, define a SetUp function.
18" It will be called before each Test_ function.
19"
20" If cleanup after each Test_ function is needed, define a TearDown function.
21" It will be called after each Test_ function.
22
23" Without the +eval feature we can't run these tests, bail out.
Bram Moolenaar4686b322015-12-28 14:44:10 +010024so small.vim
Bram Moolenaar43345542015-11-29 17:35:35 +010025
26" Check that the screen size is at least 24 x 80 characters.
27if &lines < 24 || &columns < 80
28 let error = 'Screen size too small! Tests require at least 24 lines with 80 characters'
29 echoerr error
30 split test.log
31 $put =error
32 w
33 cquit
34endif
35
Bram Moolenaarc0662462015-12-30 15:49:05 +010036" For consistency run all tests with 'nocompatible' set.
37" This also enables use of line continuation.
38set nocp viminfo+=nviminfo
39
40" Avoid stopping at the "hit enter" prompt
41set nomore
42
43" Output all messages in English.
44lang mess C
45
Bram Moolenaar43345542015-11-29 17:35:35 +010046" Source the test script. First grab the file name, in case the script
47" navigates away.
48let testname = expand('%')
Bram Moolenaar4686b322015-12-28 14:44:10 +010049let done = 0
50let fail = 0
51let errors = []
Bram Moolenaar096c8bb2015-12-29 14:26:57 +010052let messages = []
Bram Moolenaara2cce862016-01-02 19:50:04 +010053if expand('%') =~ 'test_viml.vim'
54 " this test has intentional errors, don't use try/catch.
Bram Moolenaar4686b322015-12-28 14:44:10 +010055 source %
Bram Moolenaara2cce862016-01-02 19:50:04 +010056else
57 try
58 source %
59 catch
60 let fail += 1
61 call add(errors, 'Caught exception: ' . v:exception . ' @ ' . v:throwpoint)
62 endtry
63endif
Bram Moolenaar43345542015-11-29 17:35:35 +010064
65" Locate Test_ functions and execute them.
66redir @q
67function /^Test_
68redir END
69let tests = split(substitute(@q, 'function \(\k*()\)', '\1', 'g'))
70
Bram Moolenaarcfc0a352016-01-09 20:23:00 +010071" Execute the tests in alphabetical order.
72 for test in sort(tests)
Bram Moolenaar43345542015-11-29 17:35:35 +010073 if exists("*SetUp")
74 call SetUp()
75 endif
76
Bram Moolenaar096c8bb2015-12-29 14:26:57 +010077 call add(messages, 'Executing ' . test)
Bram Moolenaar43345542015-11-29 17:35:35 +010078 let done += 1
79 try
80 exe 'call ' . test
81 catch
82 let fail += 1
83 call add(v:errors, 'Caught exception in ' . test . ': ' . v:exception . ' @ ' . v:throwpoint)
84 endtry
85
86 if len(v:errors) > 0
87 let fail += 1
88 call add(errors, 'Found errors in ' . test . ':')
89 call extend(errors, v:errors)
90 let v:errors = []
91 endif
92
93 if exists("*TearDown")
94 call TearDown()
95 endif
96endfor
97
98if fail == 0
99 " Success, create the .res file so that make knows it's done.
Bram Moolenaarde0ad402015-12-03 17:21:28 +0100100 exe 'split ' . fnamemodify(testname, ':r') . '.res'
Bram Moolenaar43345542015-11-29 17:35:35 +0100101 write
102endif
103
104if len(errors) > 0
105 " Append errors to test.log
106 split test.log
107 call append(line('$'), '')
108 call append(line('$'), 'From ' . testname . ':')
109 call append(line('$'), errors)
110 write
111endif
112
Bram Moolenaar096c8bb2015-12-29 14:26:57 +0100113let message = 'Executed ' . done . (done > 1 ? ' tests': ' test')
114echo message
115call add(messages, message)
Bram Moolenaar43345542015-11-29 17:35:35 +0100116if fail > 0
Bram Moolenaar096c8bb2015-12-29 14:26:57 +0100117 let message = fail . ' FAILED'
118 echo message
119 call add(messages, message)
Bram Moolenaar43345542015-11-29 17:35:35 +0100120endif
121
Bram Moolenaar096c8bb2015-12-29 14:26:57 +0100122" Append messages to "messages"
123split messages
124call append(line('$'), '')
125call append(line('$'), 'From ' . testname . ':')
126call append(line('$'), messages)
127write
128
Bram Moolenaar43345542015-11-29 17:35:35 +0100129qall!