Merge pull request #17388 from zeertzjq/test-assert

test(old): move some tests from assert_spec.lua to test_assert.vim

src/nvim/testdir/test_assert.vim

@@ -1,5 +1,55 @@
 " Test that the methods used for testing work.
 
+func Test_assert_false()
+  call assert_equal(0, assert_false(0))
+  call assert_equal(0, assert_false(v:false))
+  call assert_equal(0, v:false->assert_false())
+
+  call assert_equal(1, assert_false(123))
+  call assert_match("Expected False but got 123", v:errors[0])
+  call remove(v:errors, 0)
+
+  call assert_equal(1, 123->assert_false())
+  call assert_match("Expected False but got 123", v:errors[0])
+  call remove(v:errors, 0)
+endfunc
+
+func Test_assert_true()
+  call assert_equal(0, assert_true(1))
+  call assert_equal(0, assert_true(123))
+  call assert_equal(0, assert_true(v:true))
+  call assert_equal(0, v:true->assert_true())
+
+  call assert_equal(1, assert_true(0))
+  call assert_match("Expected True but got 0", v:errors[0])
+  call remove(v:errors, 0)
+
+  call assert_equal(1, 0->assert_true())
+  call assert_match("Expected True but got 0", v:errors[0])
+  call remove(v:errors, 0)
+endfunc
+
+func Test_assert_equal()
+  let s = 'foo'
+  call assert_equal(0, assert_equal('foo', s))
+  let n = 4
+  call assert_equal(0, assert_equal(4, n))
+  let l = [1, 2, 3]
+  call assert_equal(0, assert_equal([1, 2, 3], l))
+  call assert_equal(v:_null_list, v:_null_list)
+  call assert_equal(v:_null_list, [])
+  call assert_equal([], v:_null_list)
+
+  let s = 'foo'
+  call assert_equal(1, assert_equal('bar', s))
+  call assert_match("Expected 'bar' but got 'foo'", v:errors[0])
+  call remove(v:errors, 0)
+
+  call assert_equal('XxxxxxxxxxxxxxxxxxxxxxX', 'XyyyyyyyyyyyyyyyyyyyyyyyyyX')
+  call assert_match("Expected 'X\\\\\\[x occurs 21 times]X' but got 'X\\\\\\[y occurs 25 times]X'", v:errors[0])
+  call remove(v:errors, 0)
+endfunc
+
 func Test_assert_equalfile()
   call assert_equal(1, assert_equalfile('abcabc', 'xyzxyz'))
   call assert_match("E485: Can't read file abcabc", v:errors[0])
@@ -46,17 +96,129 @@ func Test_assert_equalfile()
   call delete('Xtwo')
 endfunc
 
+func Test_assert_notequal()
+  let n = 4
+  call assert_equal(0, assert_notequal('foo', n))
+  let s = 'foo'
+  call assert_equal(0, assert_notequal([1, 2, 3], s))
+
+  call assert_equal(1, assert_notequal('foo', s))
+  call assert_match("Expected not equal to 'foo'", v:errors[0])
+  call remove(v:errors, 0)
+endfunc
+
+func Test_assert_report()
+  call assert_equal(1, assert_report('something is wrong'))
+  call assert_match('something is wrong', v:errors[0])
+  call remove(v:errors, 0)
+  call assert_equal(1, 'also wrong'->assert_report())
+  call assert_match('also wrong', v:errors[0])
+  call remove(v:errors, 0)
+endfunc
+
+func Test_assert_exception()
+  try
+    nocommand
+  catch
+    call assert_equal(0, assert_exception('E492:'))
+  endtry
+
+  try
+    nocommand
+  catch
+    try
+      " illegal argument, get NULL for error
+      call assert_equal(1, assert_exception([]))
+    catch
+      call assert_equal(0, assert_exception('E730:'))
+    endtry
+  endtry
+endfunc
+
+func Test_wrong_error_type()
+  let save_verrors = v:errors
+  let v:['errors'] = {'foo': 3}
+  call assert_equal('yes', 'no')
+  let verrors = v:errors
+  let v:errors = save_verrors
+  call assert_equal(type([]), type(verrors))
+endfunc
+
+func Test_match()
+  call assert_equal(0, assert_match('^f.*b.*r$', 'foobar'))
+
+  call assert_equal(1, assert_match('bar.*foo', 'foobar'))
+  call assert_match("Pattern 'bar.*foo' does not match 'foobar'", v:errors[0])
+  call remove(v:errors, 0)
+
+  call assert_equal(1, assert_match('bar.*foo', 'foobar', 'wrong'))
+  call assert_match('wrong', v:errors[0])
+  call remove(v:errors, 0)
+
+  call assert_equal(1, 'foobar'->assert_match('bar.*foo', 'wrong'))
+  call assert_match('wrong', v:errors[0])
+  call remove(v:errors, 0)
+endfunc
+
+func Test_notmatch()
+  call assert_equal(0, assert_notmatch('foo', 'bar'))
+  call assert_equal(0, assert_notmatch('^foobar$', 'foobars'))
+
+  call assert_equal(1, assert_notmatch('foo', 'foobar'))
+  call assert_match("Pattern 'foo' does match 'foobar'", v:errors[0])
+  call remove(v:errors, 0)
+
+  call assert_equal(1, 'foobar'->assert_notmatch('foo'))
+  call assert_match("Pattern 'foo' does match 'foobar'", v:errors[0])
+  call remove(v:errors, 0)
+endfunc
+
+func Test_assert_fail_fails()
+  call assert_equal(1, assert_fails('xxx', 'E12345'))
+  call assert_match("Expected 'E12345' but got 'E492:", v:errors[0])
+  call remove(v:errors, 0)
+
+  call assert_equal(1, assert_fails('xxx', 'E9876', 'stupid'))
+  call assert_match("stupid: Expected 'E9876' but got 'E492:", v:errors[0])
+  call remove(v:errors, 0)
+
+  call assert_equal(1, assert_fails('echo', '', 'echo command'))
+  call assert_match("command did not fail: echo command", v:errors[0])
+  call remove(v:errors, 0)
+
+  call assert_equal(1, 'echo'->assert_fails('', 'echo command'))
+  call assert_match("command did not fail: echo command", v:errors[0])
+  call remove(v:errors, 0)
+endfunc
+
 func Test_assert_fails_in_try_block()
   try
     call assert_equal(0, assert_fails('throw "error"'))
   endtry
 endfunc
 
+func Test_assert_beeps()
+  new
+  call assert_equal(0, assert_beeps('normal h'))
+
+  call assert_equal(1, assert_beeps('normal 0'))
+  call assert_match("command did not beep: normal 0", v:errors[0])
+  call remove(v:errors, 0)
+
+  call assert_equal(0, 'normal h'->assert_beeps())
+  call assert_equal(1, 'normal 0'->assert_beeps())
+  call assert_match("command did not beep: normal 0", v:errors[0])
+  call remove(v:errors, 0)
+
+  bwipe
+endfunc
+
 func Test_assert_inrange()
   call assert_equal(0, assert_inrange(7, 7, 7))
   call assert_equal(0, assert_inrange(5, 7, 5))
   call assert_equal(0, assert_inrange(5, 7, 6))
   call assert_equal(0, assert_inrange(5, 7, 7))
+
   call assert_equal(1, assert_inrange(5, 7, 4))
   call assert_match("Expected range 5 - 7, but got 4", v:errors[0])
   call remove(v:errors, 0)
@@ -64,6 +226,12 @@ func Test_assert_inrange()
   call assert_match("Expected range 5 - 7, but got 8", v:errors[0])
   call remove(v:errors, 0)
 
+  call assert_equal(0, 5->assert_inrange(5, 7))
+  call assert_equal(0, 7->assert_inrange(5, 7))
+  call assert_equal(1, 8->assert_inrange(5, 7))
+  call assert_match("Expected range 5 - 7, but got 8", v:errors[0])
+  call remove(v:errors, 0)
+
   call assert_fails('call assert_inrange(1, 1)', 'E119:')
 
   if has('float')
@@ -83,6 +251,12 @@ func Test_assert_inrange()
   endif
 endfunc
 
+func Test_assert_with_msg()
+  call assert_equal('foo', 'bar', 'testing')
+  call assert_match("testing: Expected 'foo' but got 'bar'", v:errors[0])
+  call remove(v:errors, 0)
+endfunc
+
 " Must be last.
 func Test_zz_quit_detected()
   " Verify that if a test function ends Vim the test script detects this.

test/functional/legacy/assert_spec.lua

@@ -19,36 +19,10 @@ describe('assert function:', function()
     clear()
   end)
 
-  describe('assert_beeps', function()
-    it('works', function()
-      call('assert_beeps', 'normal h')
-      expected_empty()
-      call('assert_beeps', 'normal 0')
-      expected_errors({'command did not beep: normal 0'})
-    end)
-
-    it('can be used as a method', function()
-      local tmpname = source [[
-        call assert_equal(0, 'normal h'->assert_beeps())
-        call assert_equal(1, 'normal 0'->assert_beeps())
-      ]]
-      expected_errors({tmpname .. ' line 2: command did not beep: normal 0'})
-    end)
-  end)
-
   -- assert_equal({expected}, {actual}, [, {msg}])
   describe('assert_equal', function()
     it('should not change v:errors when expected is equal to actual', function()
       source([[
-        let s = 'foo'
-        call assert_equal('foo', s)
-        let n = 4
-        call assert_equal(4, n)
-        let l = [1, 2, 3]
-        call assert_equal([1, 2, 3], l)
-        call assert_equal(v:_null_list, v:_null_list)
-        call assert_equal(v:_null_list, [])
-        call assert_equal([], v:_null_list)
         fu Func()
         endfu
         let F1 = function('Func')
@@ -98,30 +72,6 @@ describe('assert function:', function()
       eq('Vim(call):E724: unable to correctly dump variable with self-referencing container',
          exc_exec('call CheckAssert()'))
     end)
-
-    it('can specify a message and get a message about what failed', function()
-      call('assert_equal', 'foo', 'bar', 'testing')
-      expected_errors({"testing: Expected 'foo' but got 'bar'"})
-    end)
-
-    it('should shorten a long message', function()
-      call ('assert_equal', 'XxxxxxxxxxxxxxxxxxxxxxX', 'XyyyyyyyyyyyyyyyyyyyyyyyyyX')
-      expected_errors({"Expected 'X\\[x occurs 21 times]X' but got 'X\\[y occurs 25 times]X'"})
-    end)
-  end)
-
-  -- assert_notequal({expected}, {actual}[, {msg}])
-  describe('assert_notequal', function()
-    it('should not change v:errors when expected differs from actual', function()
-      eq(0, call('assert_notequal', 'foo', 4))
-      eq(0, call('assert_notequal', {1, 2, 3}, 'foo'))
-      expected_empty()
-    end)
-
-    it('should change v:errors when expected is equal to actual', function()
-      eq(1, call('assert_notequal', 'foo', 'foo'))
-      expected_errors({"Expected not equal to 'foo'"})
-    end)
   end)
 
   -- assert_false({actual}, [, {msg}])
@@ -141,14 +91,6 @@ describe('assert function:', function()
       call('assert_false', {})
       expected_errors({'Expected False but got []'})
     end)
-
-    it('can be used as a method', function()
-      local tmpname = source [[
-        call assert_equal(0, v:false->assert_false())
-        call assert_equal(1, 123->assert_false())
-      ]]
-      expected_errors({tmpname .. ' line 2: Expected False but got 123'})
-    end)
   end)
 
   -- assert_true({actual}, [, {msg}])
@@ -164,14 +106,6 @@ describe('assert function:', function()
       eq(1, call('assert_true', 1.5))
       expected_errors({'Expected True but got 1.5'})
     end)
-
-    it('can be used as a method', function()
-      local tmpname = source [[
-        call assert_equal(0, v:true->assert_true())
-        call assert_equal(1, 0->assert_true())
-      ]]
-      expected_errors({tmpname .. ' line 2: Expected True but got 0'})
-    end)
   end)
 
   describe('v:errors', function()
@@ -217,76 +151,10 @@ describe('assert function:', function()
         tmpname_two .. " line 1: file two: Expected True but got ''",
       })
     end)
-
-    it('is reset to a list by assert functions', function()
-      source([[
-        let save_verrors = v:errors
-        let v:['errors'] = {'foo': 3}
-        call assert_equal('yes', 'no')
-        let verrors = v:errors
-        let v:errors = save_verrors
-        call assert_equal(type([]), type(verrors))
-      ]])
-      expected_empty()
-    end)
-  end)
-
-  -- assert_match({pat}, {text}[, {msg}])
-  describe('assert_match', function()
-    it('should not change v:errors when pat matches text', function()
-      call('assert_match', '^f.*b.*r$', 'foobar')
-      expected_empty()
-    end)
-
-    it('should change v:errors when pat does not match text', function()
-      call('assert_match', 'bar.*foo', 'foobar')
-      expected_errors({"Pattern 'bar.*foo' does not match 'foobar'"})
-    end)
-
-    it('should set v:errors to msg when given and match fails', function()
-      call('assert_match', 'bar.*foo', 'foobar', 'wrong')
-      expected_errors({"wrong: Pattern 'bar.*foo' does not match 'foobar'"})
-    end)
-
-    it('can be used as a method', function()
-      local tmpname = source [[
-        call assert_equal(1, 'foobar'->assert_match('bar.*foo', 'wrong'))
-      ]]
-      expected_errors({
-        tmpname .. " line 1: wrong: Pattern 'bar.*foo' does not match 'foobar'"
-      })
-    end)
-  end)
-
-  -- assert_notmatch({pat}, {text}[, {msg}])
-  describe('assert_notmatch', function()
-    it('should not change v:errors when pat does not match text', function()
-      call('assert_notmatch', 'foo', 'bar')
-      call('assert_notmatch', '^foobar$', 'foobars')
-      expected_empty()
-    end)
-
-    it('should change v:errors when pat matches text', function()
-      call('assert_notmatch', 'foo', 'foobar')
-      expected_errors({"Pattern 'foo' does match 'foobar'"})
-    end)
-
-    it('can be used as a method', function()
-      local tmpname = source [[
-        call assert_equal(1, 'foobar'->assert_notmatch('foo'))
-      ]]
-      expected_errors({tmpname .. " line 1: Pattern 'foo' does match 'foobar'"})
-    end)
   end)
 
   -- assert_fails({cmd}, [, {error}])
   describe('assert_fails', function()
-    it('should change v:errors when error does not match v:errmsg', function()
-      eq(1, eval([[assert_fails('xxx', 'E12345')]]))
-      command([[call assert_match("Expected 'E12345' but got 'E492:", v:errors[0])]])
-      expected_errors({"Expected 'E12345' but got 'E492: Not an editor command: xxx': xxx"})
-    end)
-
     it('should not change v:errors when cmd errors', function()
       eq(0, eval([[assert_fails('NonexistentCmd')]]))
       expected_empty()
@@ -296,106 +164,5 @@ describe('assert function:', function()
       eq(1, eval([[assert_fails('call empty("")', '')]]))
       expected_errors({'command did not fail: call empty("")'})
     end)
-
-    it('can specify and get a message about what failed', function()
-      eq(1, eval([[assert_fails('xxx', 'E9876', 'stupid')]]))
-      command([[call assert_match("stupid: Expected 'E9876' but got 'E492:", v:errors[0])]])
-      expected_errors({"stupid: Expected 'E9876' but got 'E492: Not an editor command: xxx': stupid"})
-    end)
-
-    it('can specify and get a message even when cmd succeeds', function()
-      eq(1, eval([[assert_fails('echo', '', 'echo command')]]))
-      expected_errors({'command did not fail: echo command'})
-    end)
-
-    it('can be used as a method', function()
-      local tmpname = source [[
-        call assert_equal(1, 'echo'->assert_fails('', 'echo command'))
-      ]]
-      expected_errors({
-        tmpname .. ' line 1: command did not fail: echo command'
-      })
-    end)
-  end)
-
-  -- assert_inrange({lower}, {upper}, {actual}[, {msg}])
-  describe('assert_inrange()', function()
-    it('should not change v:errors when actual is in range', function()
-      call('assert_inrange', 7, 7, 7)
-      call('assert_inrange', 5, 7, 5)
-      call('assert_inrange', 5, 7, 6)
-      call('assert_inrange', 5, 7, 7)
-      expected_empty()
-    end)
-
-    it('should change v:errors when actual is not in range', function()
-      call('assert_inrange', 5, 7, 4)
-      call('assert_inrange', 5, 7, 8)
-      expected_errors({
-        "Expected range 5 - 7, but got 4",
-        "Expected range 5 - 7, but got 8",
-      })
-    end)
-
-    it('assert_inrange(1, 1) returns E119', function()
-      eq('Vim(call):E119: Not enough arguments for function: assert_inrange',
-         exc_exec("call assert_inrange(1, 1)"))
-    end)
-
-    it('can be used as a method', function()
-      local tmpname = source [[
-        call assert_equal(0, 5->assert_inrange(5, 7))
-        call assert_equal(0, 7->assert_inrange(5, 7))
-        call assert_equal(1, 8->assert_inrange(5, 7))
-      ]]
-      expected_errors({tmpname .. ' line 3: Expected range 5 - 7, but got 8'})
-    end)
-  end)
-
-  -- assert_report({msg})
-  describe('assert_report()', function()
-    it('should add a message to v:errors', function()
-      eq(1, call('assert_report', 'something is wrong'))
-      command("call assert_match('something is wrong', v:errors[0])")
-      command('call remove(v:errors, 0)')
-      expected_empty()
-    end)
-
-    it('can be used as a method', function()
-      local tmpname = source [[
-        call assert_equal(1, 'also wrong'->assert_report())
-      ]]
-      expected_errors({tmpname .. ' line 1: also wrong'})
-    end)
-  end)
-
-  -- assert_exception({cmd}, [, {error}])
-  describe('assert_exception()', function()
-    it('should assert thrown exceptions properly', function()
-      source([[
-        try
-          nocommand
-        catch
-          call assert_equal(0, assert_exception('E492'))
-        endtry
-      ]])
-      expected_empty()
-    end)
-
-    it('should work properly when nested', function()
-      source([[
-        try
-          nocommand
-        catch
-          try
-            " illegal argument, get NULL for error
-            call assert_equal(1, assert_exception([]))
-          catch
-            call assert_equal(0, assert_exception('E730'))
-          endtry
-        endtry
-      ]])
-      expected_empty()
-    end)
   end)
 end)