aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/testing.txt
diff options
context:
space:
mode:
authorJosh Rahm <joshuarahm@gmail.com>2023-11-30 20:35:25 +0000
committerJosh Rahm <joshuarahm@gmail.com>2023-11-30 20:35:25 +0000
commit1b7b916b7631ddf73c38e3a0070d64e4636cb2f3 (patch)
treecd08258054db80bb9a11b1061bb091c70b76926a /runtime/doc/testing.txt
parenteaa89c11d0f8aefbb512de769c6c82f61a8baca3 (diff)
parent4a8bf24ac690004aedf5540fa440e788459e5e34 (diff)
downloadrneovim-aucmd_textputpost.tar.gz
rneovim-aucmd_textputpost.tar.bz2
rneovim-aucmd_textputpost.zip
Merge remote-tracking branch 'upstream/master' into aucmd_textputpostaucmd_textputpost
Diffstat (limited to 'runtime/doc/testing.txt')
-rw-r--r--runtime/doc/testing.txt201
1 files changed, 15 insertions, 186 deletions
diff --git a/runtime/doc/testing.txt b/runtime/doc/testing.txt
index ef5e179c86..941c440b6c 100644
--- a/runtime/doc/testing.txt
+++ b/runtime/doc/testing.txt
@@ -31,195 +31,24 @@ Find more information in the file src/testdir/README.txt.
==============================================================================
2. Test functions *test-functions-details*
-test_garbagecollect_now() *test_garbagecollect_now()*
- Like garbagecollect(), but executed right away. This must
- only be called directly to avoid any structure to exist
- internally, and |v:testing| must have been set before calling
- any function.
+See |test_garbagecollect_now()|.
==============================================================================
3. Assert functions *assert-functions-details*
-
-assert_beeps({cmd}) *assert_beeps()*
- Run {cmd} and add an error message to |v:errors| if it does
- NOT produce a beep or visual bell.
- Also see |assert_fails()|, |assert_nobeep()| and
- |assert-return|.
-
- Can also be used as a |method|: >
- GetCmd()->assert_beeps()
-<
- *assert_equal()*
-assert_equal({expected}, {actual} [, {msg}])
- When {expected} and {actual} are not equal an error message is
- added to |v:errors| and 1 is returned. Otherwise zero is
- returned |assert-return|.
- There is no automatic conversion, the String "4" is different
- from the Number 4. And the number 4 is different from the
- Float 4.0. The value of 'ignorecase' is not used here, case
- always matters.
- When {msg} is omitted an error in the form "Expected
- {expected} but got {actual}" is produced.
- Example: >
- assert_equal('foo', 'bar')
-< Will result in a string to be added to |v:errors|:
- test.vim line 12: Expected 'foo' but got 'bar' ~
-
- Can also be used as a |method|: >
- mylist->assert_equal([1, 2, 3])
-
-< *assert_equalfile()*
-assert_equalfile({fname-one}, {fname-two})
- When the files {fname-one} and {fname-two} do not contain
- exactly the same text an error message is added to |v:errors|.
- Also see |assert-return|.
- When {fname-one} or {fname-two} does not exist the error will
- mention that.
-
- Can also be used as a |method|: >
- GetLog()->assert_equalfile('expected.log')
-
-assert_exception({error} [, {msg}]) *assert_exception()*
- When v:exception does not contain the string {error} an error
- message is added to |v:errors|. Also see |assert-return|.
- This can be used to assert that a command throws an exception.
- Using the error number, followed by a colon, avoids problems
- with translations: >
- try
- commandthatfails
- call assert_false(1, 'command should have failed')
- catch
- call assert_exception('E492:')
- endtry
-<
- *assert_fails()*
-assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
- Run {cmd} and add an error message to |v:errors| if it does
- NOT produce an error or when {error} is not found in the
- error message. Also see |assert-return|.
-
- When {error} is a string it must be found literally in the
- first reported error. Most often this will be the error code,
- including the colon, e.g. "E123:". >
- assert_fails('bad cmd', 'E987:')
-<
- When {error} is a |List| with one or two strings, these are
- used as patterns. The first pattern is matched against the
- first reported error: >
- assert_fails('cmd', ['E987:.*expected bool'])
-< The second pattern, if present, is matched against the last
- reported error. To only match the last error use an empty
- string for the first error: >
- assert_fails('cmd', ['', 'E987:'])
-<
- If {msg} is empty then it is not used. Do this to get the
- default message when passing the {lnum} argument.
-
- When {lnum} is present and not negative, and the {error}
- argument is present and matches, then this is compared with
- the line number at which the error was reported. That can be
- the line number in a function or in a script.
-
- When {context} is present it is used as a pattern and matched
- against the context (script name or function name) where
- {lnum} is located in.
-
- Note that beeping is not considered an error, and some failing
- commands only beep. Use |assert_beeps()| for those.
-
- Can also be used as a |method|: >
- GetCmd()->assert_fails('E99:')
-
-assert_false({actual} [, {msg}]) *assert_false()*
- When {actual} is not false an error message is added to
- |v:errors|, like with |assert_equal()|.
- Also see |assert-return|.
- A value is false when it is zero. When {actual} is not a
- number the assert fails.
- When {msg} is omitted an error in the form
- "Expected False but got {actual}" is produced.
-
- Can also be used as a |method|: >
- GetResult()->assert_false()
-
-assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()*
- This asserts number and |Float| values. When {actual} is lower
- than {lower} or higher than {upper} an error message is added
- to |v:errors|. Also see |assert-return|.
- When {msg} is omitted an error in the form
- "Expected range {lower} - {upper}, but got {actual}" is
- produced.
-
- *assert_match()*
-assert_match({pattern}, {actual} [, {msg}])
- When {pattern} does not match {actual} an error message is
- added to |v:errors|. Also see |assert-return|.
-
- {pattern} is used as with |expr-=~|: The matching is always done
- like 'magic' was set and 'cpoptions' is empty, no matter what
- the actual value of 'magic' or 'cpoptions' is.
-
- {actual} is used as a string, automatic conversion applies.
- Use "^" and "$" to match with the start and end of the text.
- Use both to match the whole text.
-
- When {msg} is omitted an error in the form
- "Pattern {pattern} does not match {actual}" is produced.
- Example: >
- assert_match('^f.*o$', 'foobar')
-< Will result in a string to be added to |v:errors|:
- test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~
-
- Can also be used as a |method|: >
- getFile()->assert_match('foo.*')
-<
-assert_nobeep({cmd}) *assert_nobeep()*
- Run {cmd} and add an error message to |v:errors| if it
- produces a beep or visual bell.
- Also see |assert_beeps()|.
-
- Can also be used as a |method|: >
- GetCmd()->assert_nobeep()
-<
- *assert_notequal()*
-assert_notequal({expected}, {actual} [, {msg}])
- The opposite of `assert_equal()`: add an error message to
- |v:errors| when {expected} and {actual} are equal.
- Also see |assert-return|.
-
- Can also be used as a |method|: >
- mylist->assert_notequal([1, 2, 3])
-
-< *assert_notmatch()*
-assert_notmatch({pattern}, {actual} [, {msg}])
- The opposite of `assert_match()`: add an error message to
- |v:errors| when {pattern} matches {actual}.
- Also see |assert-return|.
-
- Can also be used as a |method|: >
- getFile()->assert_notmatch('bar.*')
-
-
-assert_report({msg}) *assert_report()*
- Report a test failure directly, using String {msg}.
- Always returns one.
-
- Can also be used as a |method|: >
- GetMessage()->assert_report()
-
-
-assert_true({actual} [, {msg}]) *assert_true()*
- When {actual} is not true an error message is added to
- |v:errors|, like with |assert_equal()|.
- Also see |assert-return|.
- A value is |TRUE| when it is a non-zero number or |v:true|.
- When {actual} is not a number or |v:true| the assert fails.
- When {msg} is omitted an error in the form "Expected True but
- got {actual}" is produced.
-
- Can also be used as a |method|: >
- GetResult()->assert_true()
-<
+See:
+ - |assert_beeps()|
+ - |assert_equal()|
+ - |assert_equalfile()|
+ - |assert_exception()|
+ - |assert_fails()|
+ - |assert_false()|
+ - |assert_inrange()|
+ - |assert_match()|
+ - |assert_nobeep()|
+ - |assert_notequal()|
+ - |assert_notmatch()|
+ - |assert_report()|
+ - |assert_true()|
vim:tw=78:ts=8:noet:ft=help:norl: