Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
patch 8.0.1770: assert functions don't return anything 
Problem:    Assert functions don't return anything.
Solution:   Return non-zero when the assertion fails.
  • Loading branch information
@brammool
brammool committed Apr 28, 2018
1 parent 9b25af3 commit 65a5464
Show file tree
Hide file tree
Showing 6 changed files with 149 additions and 105 deletions.
56 changes: 34 additions & 22 deletions runtime/doc/eval.txt
View file
@@ -1,4 +1,4 @@
*eval.txt* For Vim version 8.0. Last change: 2018 Apr 20
*eval.txt* For Vim version 8.0. Last change: 2018 Apr 28


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -1548,10 +1548,12 @@ v:errmsg Last given error message. It's allowed to set this variable.
: ... handle error
< "errmsg" also works, for backwards compatibility.

*v:errors* *errors-variable*
*v:errors* *errors-variable* *assert-return*
v:errors Errors found by assert functions, such as |assert_true()|.
This is a list of strings.
The assert functions append an item when an assert fails.
The return value indicates this: a one is returned if an item
was added to v:errors, otherwise zero is returned.
To remove old results make it empty: >
:let v:errors = []
< If v:errors is set to anything but a list it is made an empty
Expand Down Expand Up @@ -2020,26 +2022,26 @@ argidx() Number current index in the argument list
arglistid([{winnr} [, {tabnr}]]) Number argument list id
argv({nr}) String {nr} entry of the argument list
argv() List the argument list
assert_beeps({cmd}) none assert {cmd} causes a beep
assert_beeps({cmd}) Number assert {cmd} causes a beep
assert_equal({exp}, {act} [, {msg}])
none assert {exp} is equal to {act}
Number assert {exp} is equal to {act}
assert_equalfile({fname-one}, {fname-two})
none assert file contents is equal
Number assert file contents is equal
assert_exception({error} [, {msg}])
none assert {error} is in v:exception
assert_fails({cmd} [, {error}]) none assert {cmd} fails
Number assert {error} is in v:exception
assert_fails({cmd} [, {error}]) Number assert {cmd} fails
assert_false({actual} [, {msg}])
none assert {actual} is false
Number assert {actual} is false
assert_inrange({lower}, {upper}, {actual} [, {msg}])
none assert {actual} is inside the range
Number assert {actual} is inside the range
assert_match({pat}, {text} [, {msg}])
none assert {pat} matches {text}
Number assert {pat} matches {text}
assert_notequal({exp}, {act} [, {msg}])
none assert {exp} is not equal {act}
Number assert {exp} is not equal {act}
assert_notmatch({pat}, {text} [, {msg}])
none assert {pat} not matches {text}
assert_report({msg}) none report a test failure
assert_true({actual} [, {msg}]) none assert {actual} is true
Number assert {pat} not matches {text}
assert_report({msg}) Number report a test failure
assert_true({actual} [, {msg}]) Number assert {actual} is true
asin({expr}) Float arc sine of {expr}
atan({expr}) Float arc tangent of {expr}
atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2}
Expand Down Expand Up @@ -2593,12 +2595,13 @@ argv([{nr}]) The result is the {nr}th file in the argument list of the
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()|.
Also see |assert_fails()| and |assert-return|.

*assert_equal()*
assert_equal({expected}, {actual} [, {msg}])
When {expected} and {actual} are not equal an error message is
added to |v:errors|.
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
Expand All @@ -2614,13 +2617,14 @@ assert_equal({expected}, {actual} [, {msg}])
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.
Mainly useful with |terminal-diff|.

assert_exception({error} [, {msg}]) *assert_exception()*
When v:exception does not contain the string {error} an error
message is added to |v:errors|.
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: >
Expand All @@ -2633,14 +2637,15 @@ assert_exception({error} [, {msg}]) *assert_exception()*
assert_fails({cmd} [, {error}]) *assert_fails()*
Run {cmd} and add an error message to |v:errors| if it does
NOT produce an error.
NOT produce an error. Also see |assert-return|.
When {error} is given it must match in |v:errmsg|.
Note that beeping is not considered an error, and some failing
commands only beep. Use |assert_beeps()| for those.

assert_false({actual} [, {msg}]) *assert_false()*
When {actual} is not false an error message is added to
|v:errors|, like with |assert_equal()|.
|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
Expand All @@ -2649,15 +2654,15 @@ assert_false({actual} [, {msg}]) *assert_false()*
assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()*
This asserts number values. When {actual} is lower than
{lower} or higher than {upper} an error message is added to
|v:errors|.
|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|.
added to |v:errors|. Also see |assert-return|.

{pattern} is used as with |=~|: The matching is always done
like 'magic' was set and 'cpoptions' is empty, no matter what
Expand All @@ -2678,18 +2683,22 @@ assert_match({pattern}, {actual} [, {msg}])
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|.

*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|.

assert_report({msg}) *assert_report()*
Report a test failure directly, using {msg}.
Always returns one.

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. When {actual}
is not a number the assert fails.
When {msg} is omitted an error in the form "Expected True but
Expand Down Expand Up @@ -5392,17 +5401,20 @@ job_getchannel({job}) *job_getchannel()*
<
{only available when compiled with the |+job| feature}

job_info({job}) *job_info()*
job_info([{job}]) *job_info()*
Returns a Dictionary with information about {job}:
"status" what |job_status()| returns
"channel" what |job_getchannel()| returns
"cmd" List of command arguments used to start the job
"process" process ID
"tty_in" terminal input name, empty when none
"tty_out" terminal output name, empty when none
"exitval" only valid when "status" is "dead"
"exit_cb" function to be called on exit
"stoponexit" |job-stoponexit|

Without any arguments, returns a List with all Job objects.

job_setoptions({job}, {options}) *job_setoptions()*
Change options for {job}. Supported are:
"stoponexit" |job-stoponexit|
Expand Down
46 changes: 34 additions & 12 deletions src/eval.c
View file
Expand Up @@ -8815,7 +8815,7 @@ assert_error(garray_T *gap)
list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
}

void
int
assert_equal_common(typval_T *argvars, assert_type_T atype)
{
garray_T ga;
Expand All @@ -8828,10 +8828,12 @@ assert_equal_common(typval_T *argvars, assert_type_T atype)
atype);
assert_error(&ga);
ga_clear(&ga);
return 1;
}
return 0;
}

void
int
assert_equalfile(typval_T *argvars)
{
char_u buf1[NUMBUFLEN];
Expand All @@ -8843,7 +8845,7 @@ assert_equalfile(typval_T *argvars)
FILE *fd2;

if (fname1 == NULL || fname2 == NULL)
return;
return 0;

IObuff[0] = NUL;
fd1 = mch_fopen((char *)fname1, READBIN);
Expand Down Expand Up @@ -8897,10 +8899,12 @@ assert_equalfile(typval_T *argvars)
ga_concat(&ga, IObuff);
assert_error(&ga);
ga_clear(&ga);
return 1;
}
return 0;
}

void
int
assert_match_common(typval_T *argvars, assert_type_T atype)
{
garray_T ga;
Expand All @@ -8918,10 +8922,12 @@ assert_match_common(typval_T *argvars, assert_type_T atype)
atype);
assert_error(&ga);
ga_clear(&ga);
return 1;
}
return 0;
}

void
int
assert_inrange(typval_T *argvars)
{
garray_T ga;
Expand All @@ -8934,7 +8940,7 @@ assert_inrange(typval_T *argvars)
char_u numbuf[NUMBUFLEN];

if (error)
return;
return 0;
if (actual < lower || actual > upper)
{
prepare_assert_error(&ga);
Expand All @@ -8951,21 +8957,24 @@ assert_inrange(typval_T *argvars)
}
assert_error(&ga);
ga_clear(&ga);
return 1;
}
return 0;
}

/*
* Common for assert_true() and assert_false().
* Return non-zero for failure.
*/
void
int
assert_bool(typval_T *argvars, int isTrue)
{
int error = FALSE;
garray_T ga;

if (argvars[0].v_type == VAR_SPECIAL
&& argvars[0].vval.v_number == (isTrue ? VVAL_TRUE : VVAL_FALSE))
return;
return 0;
if (argvars[0].v_type != VAR_NUMBER
|| (get_tv_number_chk(&argvars[0], &error) == 0) == isTrue
|| error)
Expand All @@ -8976,10 +8985,12 @@ assert_bool(typval_T *argvars, int isTrue)
NULL, &argvars[0], ASSERT_OTHER);
assert_error(&ga);
ga_clear(&ga);
return 1;
}
return 0;
}

void
int
assert_report(typval_T *argvars)
{
garray_T ga;
Expand All @@ -8988,9 +8999,10 @@ assert_report(typval_T *argvars)
ga_concat(&ga, get_tv_string(&argvars[0]));
assert_error(&ga);
ga_clear(&ga);
return 1;
}

void
int
assert_exception(typval_T *argvars)
{
garray_T ga;
Expand All @@ -9002,6 +9014,7 @@ assert_exception(typval_T *argvars)
ga_concat(&ga, (char_u *)"v:exception is not set");
assert_error(&ga);
ga_clear(&ga);
return 1;
}
else if (error != NULL
&& strstr((char *)vimvars[VV_EXCEPTION].vv_str, (char *)error) == NULL)
Expand All @@ -9011,14 +9024,17 @@ assert_exception(typval_T *argvars)
&vimvars[VV_EXCEPTION].vv_tv, ASSERT_OTHER);
assert_error(&ga);
ga_clear(&ga);
return 1;
}
return 0;
}

void
int
assert_beeps(typval_T *argvars)
{
char_u *cmd = get_tv_string_chk(&argvars[0]);
garray_T ga;
int ret = 0;

called_vim_beep = FALSE;
suppress_errthrow = TRUE;
Expand All @@ -9031,17 +9047,20 @@ assert_beeps(typval_T *argvars)
ga_concat(&ga, cmd);
assert_error(&ga);
ga_clear(&ga);
ret = 1;
}

suppress_errthrow = FALSE;
emsg_on_display = FALSE;
return ret;
}

void
int
assert_fails(typval_T *argvars)
{
char_u *cmd = get_tv_string_chk(&argvars[0]);
garray_T ga;
int ret = 0;

called_emsg = FALSE;
suppress_errthrow = TRUE;
Expand All @@ -9054,6 +9073,7 @@ assert_fails(typval_T *argvars)
ga_concat(&ga, cmd);
assert_error(&ga);
ga_clear(&ga);
ret = 1;
}
else if (argvars[1].v_type != VAR_UNKNOWN)
{
Expand All @@ -9068,6 +9088,7 @@ assert_fails(typval_T *argvars)
&vimvars[VV_ERRMSG].vv_tv, ASSERT_OTHER);
assert_error(&ga);
ga_clear(&ga);
ret = 1;
}
}

Expand All @@ -9076,6 +9097,7 @@ assert_fails(typval_T *argvars)
emsg_silent = FALSE;
emsg_on_display = FALSE;
set_vim_var_string(VV_ERRMSG, NULL, 0);
return ret;
}

/*
Expand Down

0 comments on commit 65a5464

Please sign in to comment.