Merge #7082 'api: nvim_get_hl_by_name/by_id'

test/functional/api/highlight_spec.lua

@@ -0,0 +1,56 @@
+local helpers = require('test.functional.helpers')(after_each)
+local clear, nvim = helpers.clear, helpers.nvim
+local Screen = require('test.functional.ui.screen')
+local eq, eval = helpers.eq, helpers.eval
+local command = helpers.command
+local meths = helpers.meths
+
+describe('highlight api',function()
+  local expected_rgb = { background = Screen.colors.Yellow,
+                         foreground = Screen.colors.Red,
+                         special = Screen.colors.Blue,
+                         bold = true,
+                       }
+
+  local expected_cterm = { background = 10,
+                           underline = true,
+                         }
+
+  before_each(function()
+    clear()
+    command("hi NewHighlight cterm=underline ctermbg=green guifg=red guibg=yellow guisp=blue gui=bold")
+  end)
+
+  it("nvim_get_hl_by_id", function()
+    local hl_id = eval("hlID('NewHighlight')")
+    eq(expected_cterm, nvim("get_hl_by_id", hl_id, false))
+
+    hl_id = eval("hlID('NewHighlight')")
+    eq(expected_rgb, nvim("get_hl_by_id", hl_id, true))
+
+    local expected_error = 'Invalid highlight id'
+    -- Assume there is no hl id 30000.
+    local err, emsg = pcall(meths.get_hl_by_id, 30000, false)
+    eq(false, err)
+    eq(expected_error, string.match(emsg, expected_error))
+  end)
+
+  it("nvim_get_hl_by_name", function()
+    local expected_normal = { background = Screen.colors.Yellow,
+                              foreground = Screen.colors.Red }
+
+    -- Test "Normal" hl defaults.
+    eq({}, nvim("get_hl_by_name", 'Normal', true))
+
+    eq(expected_cterm, nvim("get_hl_by_name", 'NewHighlight', false))
+    eq(expected_rgb, nvim("get_hl_by_name", 'NewHighlight', true))
+
+    command('hi Normal guifg=red guibg=yellow')
+    eq(expected_normal, nvim("get_hl_by_name", 'Normal', true))
+
+    local expected_error = 'Invalid highlight name'
+    local err, emsg = pcall(meths.get_hl_by_name , 'unknown_highlight', false)
+    eq(false, err)
+    eq(expected_error, string.match(emsg, expected_error))
+  end)
+end)