refactor(api): VALIDATE macros #22256

- VALIDATE() takes a format string
- deduplicate check_string_array
- VALIDATE_RANGE
- validate UI args

1 files changed, 69 insertions, 35 deletions

diff --git a/test/functional/api/autocmd_spec.lua b/test/functional/api/autocmd_spec.lua
index 56b0a4d9b2..f10f18174e 100644
--- a/test/functional/api/autocmd_spec.lua
+++ b/test/functional/api/autocmd_spec.lua
@@ -14,14 +14,31 @@ before_each(clear)
 
 describe('autocmd api', function()
   describe('nvim_create_autocmd', function()
-    it('"command" and "callback" are mutually exclusive', function()
-      local rv = pcall_err(meths.create_autocmd, "BufReadPost", {
-        pattern = "*.py,*.pyi",
+    it('validation', function()
+      eq("Cannot use both 'callback' and 'command'", pcall_err(meths.create_autocmd, 'BufReadPost', {
+        pattern = '*.py,*.pyi',
         command = "echo 'Should Have Errored",
-        callback = "NotAllowed",
-      })
-
-      eq("Cannot use both 'callback' and 'command'", rv)
+        callback = 'NotAllowed',
+      }))
+      eq("Cannot use both 'pattern' and 'buffer' for the same autocmd", pcall_err(meths.create_autocmd, 'FileType', {
+        command = 'let g:called = g:called + 1',
+        buffer = 0,
+        pattern = '*.py',
+      }))
+      eq("Required: 'event'", pcall_err(meths.create_autocmd, {}, {
+        command = 'ls',
+      }))
+      eq("Required: 'command' or 'callback'", pcall_err(meths.create_autocmd, 'FileType', {
+      }))
+      eq('Invalid desc: expected String, got Integer', pcall_err(meths.create_autocmd, 'FileType', {
+        command = 'ls',
+        desc = 42,
+      }))
+      eq('Invalid callback: expected Lua function or Vim function name, got Integer', pcall_err(meths.create_autocmd, 'FileType', {
+        callback = 0,
+      }))
+      eq("Invalid 'event' item: expected String, got Array", pcall_err(meths.create_autocmd,
+        {'FileType', {}}, {}))
     end)
 
     it('doesnt leak when you use ++once', function()
@@ -59,18 +76,8 @@ describe('autocmd api', function()
       eq(1, meths.get_var('called'))
     end)
 
-    it('does not allow passing buffer and patterns', function()
-      local rv = pcall_err(meths.create_autocmd, "Filetype", {
-        command = "let g:called = g:called + 1",
-        buffer = 0,
-        pattern = "*.py",
-      })
-
-      eq("Cannot use both 'pattern' and 'buffer' for the same autocmd", rv)
-    end)
-
     it('does not allow passing invalid buffers', function()
-      local ok, msg = pcall(meths.create_autocmd, "Filetype", {
+      local ok, msg = pcall(meths.create_autocmd, 'FileType', {
         command = "let g:called = g:called + 1",
         buffer = -1,
       })
@@ -295,7 +302,7 @@ describe('autocmd api', function()
 
   describe('nvim_get_autocmds', function()
     describe('events', function()
-      it('should return one autocmd when there is only one for an event', function()
+      it('returns one autocmd when there is only one for an event', function()
         command [[au! InsertEnter]]
         command [[au InsertEnter * :echo "1"]]
 
@@ -303,7 +310,7 @@ describe('autocmd api', function()
         eq(1, #aus)
       end)
 
-      it('should return two autocmds when there are two for an event', function()
+      it('returns two autocmds when there are two for an event', function()
         command [[au! InsertEnter]]
         command [[au InsertEnter * :echo "1"]]
         command [[au InsertEnter * :echo "2"]]
@@ -312,7 +319,7 @@ describe('autocmd api', function()
         eq(2, #aus)
       end)
 
-      it('should return the same thing if you use string or list', function()
+      it('returns the same thing if you use string or list', function()
         command [[au! InsertEnter]]
         command [[au InsertEnter * :echo "1"]]
         command [[au InsertEnter * :echo "2"]]
@@ -322,7 +329,7 @@ describe('autocmd api', function()
         eq(string_aus, array_aus)
       end)
 
-      it('should return two autocmds when there are two for an event', function()
+      it('returns two autocmds when there are two for an event', function()
         command [[au! InsertEnter]]
         command [[au! InsertLeave]]
         command [[au InsertEnter * :echo "1"]]
@@ -332,7 +339,7 @@ describe('autocmd api', function()
         eq(2, #aus)
       end)
 
-      it('should return different IDs for different autocmds', function()
+      it('returns different IDs for different autocmds', function()
         command [[au! InsertEnter]]
         command [[au! InsertLeave]]
         command [[au InsertEnter * :echo "1"]]
@@ -356,7 +363,7 @@ describe('autocmd api', function()
         eq(first, new_aus[1])
       end)
 
-      it('should return event name', function()
+      it('returns event name', function()
         command [[au! InsertEnter]]
         command [[au InsertEnter * :echo "1"]]
 
@@ -364,7 +371,7 @@ describe('autocmd api', function()
         eq({ { buflocal = false, command = ':echo "1"', event = "InsertEnter", once = false, pattern = "*" } }, aus)
       end)
 
-      it('should work with buffer numbers', function()
+      it('works with buffer numbers', function()
         command [[new]]
         command [[au! InsertEnter]]
         command [[au InsertEnter <buffer=1> :echo "1"]]
@@ -419,7 +426,7 @@ describe('autocmd api', function()
         eq("Too many buffers (maximum of 256)", pcall_err(meths.get_autocmds, { event = "InsertEnter", buffer = bufs }))
       end)
 
-      it('should return autocmds when group is specified by id', function()
+      it('returns autocmds when group is specified by id', function()
         local auid = meths.create_augroup("nvim_test_augroup", { clear = true })
         meths.create_autocmd("FileType", { group = auid, command = 'echo "1"' })
         meths.create_autocmd("FileType", { group = auid, command = 'echo "2"' })
@@ -431,7 +438,7 @@ describe('autocmd api', function()
         eq(0, #aus2)
       end)
 
-      it('should return autocmds when group is specified by name', function()
+      it('returns autocmds when group is specified by name', function()
         local auname = "nvim_test_augroup"
         meths.create_augroup(auname, { clear = true })
         meths.create_autocmd("FileType", { group = auname, command = 'echo "1"' })
@@ -531,7 +538,7 @@ describe('autocmd api', function()
         command [[augroup END]]
       end)
 
-      it('should return all groups if no group is specified', function()
+      it('returns all groups if no group is specified', function()
         local aus = meths.get_autocmds { event = "InsertEnter" }
         if #aus ~= 4 then
           eq({}, aus)
@@ -540,7 +547,7 @@ describe('autocmd api', function()
         eq(4, #aus)
       end)
 
-      it('should return only the group specified', function()
+      it('returns only the group specified', function()
         local aus = meths.get_autocmds {
           event = "InsertEnter",
           group = "GroupOne",
@@ -551,7 +558,7 @@ describe('autocmd api', function()
         eq("GroupOne", aus[1].group_name)
       end)
 
-      it('should return only the group specified, multiple values', function()
+      it('returns only the group specified, multiple values', function()
         local aus = meths.get_autocmds {
           event = "InsertEnter",
           group = "GroupTwo",
@@ -625,7 +632,7 @@ describe('autocmd api', function()
         ]], {}))
 
         eq(false, success)
-        matches("Invalid 'pattern' item type: expected String, got Array", code)
+        matches("Invalid 'pattern' item: expected String, got Array", code)
       end)
     end)
 
@@ -640,7 +647,7 @@ describe('autocmd api', function()
         command [[au InsertEnter <buffer> :echo "Buffer"]]
       end)
 
-      it('should should return for literal match', function()
+      it('returns for literal match', function()
         local aus = meths.get_autocmds {
           event = "InsertEnter",
           pattern = "*"
@@ -650,7 +657,7 @@ describe('autocmd api', function()
         eq([[:echo "No Group"]], aus[1].command)
       end)
 
-      it('should return for multiple matches', function()
+      it('returns for multiple matches', function()
         -- vim.api.nvim_get_autocmds
         local aus = meths.get_autocmds {
           event = "InsertEnter",
@@ -687,6 +694,23 @@ describe('autocmd api', function()
   end)
 
   describe('nvim_exec_autocmds', function()
+    it('validation', function()
+      eq('Invalid group: 9997999', pcall_err(meths.exec_autocmds, 'FileType', {
+        group = 9997999,
+      }))
+      eq("Invalid group: 'bogus'", pcall_err(meths.exec_autocmds, 'FileType', {
+        group = 'bogus',
+      }))
+      eq('Invalid group: expected String or Integer, got Array', pcall_err(meths.exec_autocmds, 'FileType', {
+        group = {},
+      }))
+      eq('Invalid buffer: expected Integer, got Array', pcall_err(meths.exec_autocmds, 'FileType', {
+        buffer = {},
+      }))
+      eq("Invalid 'event' item: expected String, got Array", pcall_err(meths.exec_autocmds,
+        {'FileType', {}}, {}))
+    end)
+
     it("can trigger builtin autocmds", function()
       meths.set_var("autocmd_executed", false)
 
@@ -1036,7 +1060,7 @@ describe('autocmd api', function()
       local augroup = "WillBeDeleted"
 
       meths.create_augroup(augroup, { clear = true })
-      meths.create_autocmd({"Filetype"}, {
+      meths.create_autocmd({"FileType"}, {
         pattern = "*",
         command = "echo 'does not matter'",
       })
@@ -1055,7 +1079,7 @@ describe('autocmd api', function()
       meths.set_var("value_set", false)
 
       meths.create_augroup(augroup, { clear = true })
-      meths.create_autocmd("Filetype", {
+      meths.create_autocmd("FileType", {
         pattern = "<buffer>",
         command = "let g:value_set = v:true",
       })
@@ -1171,6 +1195,16 @@ describe('autocmd api', function()
   end)
 
   describe('nvim_clear_autocmds', function()
+    it('validation', function()
+      eq("Cannot use both 'pattern' and 'buffer'", pcall_err(meths.clear_autocmds, {
+        pattern = '*',
+        buffer = 42,
+      }))
+      eq("Invalid 'event' item: expected String, got Array", pcall_err(meths.clear_autocmds, {
+        event = {'FileType', {}}
+      }))
+    end)
+
     it('should clear based on event + pattern', function()
       command('autocmd InsertEnter *.py  :echo "Python can be cool sometimes"')
       command('autocmd InsertEnter *.txt :echo "Text Files Are Cool"')