functests: Add a number of “generic” functional tests

test/functional/shada/compatibility_spec.lua

@@ -9,32 +9,10 @@ local reset, set_additional_cmd, clear, exc_exec, get_shada_rw =
   shada_helpers.reset, shada_helpers.set_additional_cmd,
   shada_helpers.clear, shada_helpers.exc_exec,
   shada_helpers.get_shada_rw
+local read_shada_file = shada_helpers.read_shada_file
 
 local wshada, sdrcmd, shada_fname = get_shada_rw('Xtest-functional-shada-compatibility.shada')
 
-local msgpack = require('MessagePack')
-local mpack_keys = {'type', 'timestamp', 'length', 'value'}
-local read_shada_file = function(fname)
-  local fd = io.open(fname, 'r')
-  local mstring = fd:read('*a')
-  fd:close()
-  local unpacker = msgpack.unpacker(mstring)
-  local ret = {}
-  local cur
-  local i = 0
-  while true do
-    local off, val = unpacker()
-    if not off then break end
-    if i % 4 == 0 then
-      cur = {}
-      ret[#ret + 1] = cur
-    end
-    cur[mpack_keys[(i % 4) + 1]] = val
-    i = i + 1
-  end
-  return ret
-end
-
 describe('ShaDa forward compatibility support code', function()
   before_each(reset)
   after_each(function()

test/functional/shada/errors_spec.lua

@@ -10,20 +10,14 @@ local reset, set_additional_cmd, clear, exc_exec, get_shada_rw =
   shada_helpers.clear, shada_helpers.exc_exec,
   shada_helpers.get_shada_rw
 
-local wshada, sdrcmd, shada_fname = get_shada_rw('Xtest-functional-shada-errors.shada')
+local wshada, sdrcmd, shada_fname, clean =
+  get_shada_rw('Xtest-functional-shada-errors.shada')
 
 describe('ShaDa error handling', function()
   before_each(reset)
   after_each(function()
     clear()
-    os.remove(shada_fname)
-    local i = ('a'):byte()
-    while i < ('z'):byte() do
-      if not os.remove(shada_fname .. ('.tmp.%c'):format(i)) then
-        break
-      end
-      i = i + 1
-    end
+    clean()
   end)
 
   -- Note: most of tests have additional items like sX, mX, rX. These are for 

test/functional/shada/helpers.lua

@@ -4,6 +4,8 @@ local spawn, set_session, nvim, nvim_prog, nvim_command, nvim_eval =
   helpers.command, helpers.eval
 local write_file = helpers.write_file
 
+local msgpack = require('MessagePack')
+
 local tmpname = os.tmpname()
 local additional_cmd = ''
 
@@ -68,7 +70,40 @@ local get_shada_rw = function(fname)
   local sdrcmd = function(bang)
     return 'rshada' .. (bang and '!' or '') .. ' ' .. fname
   end
-  return wshada, sdrcmd, fname
+  local clean = function()
+    os.remove(fname)
+    local i = ('a'):byte()
+    while i <= ('z'):byte() do
+      if not os.remove(fname .. ('.tmp.%c'):format(i)) then
+        break
+      end
+      i = i + 1
+    end
+  end
+  return wshada, sdrcmd, fname, clean
+end
+
+local mpack_keys = {'type', 'timestamp', 'length', 'value'}
+
+local read_shada_file = function(fname)
+  local fd = io.open(fname, 'r')
+  local mstring = fd:read('*a')
+  fd:close()
+  local unpacker = msgpack.unpacker(mstring)
+  local ret = {}
+  local cur
+  local i = 0
+  while true do
+    local off, val = unpacker()
+    if not off then break end
+    if i % 4 == 0 then
+      cur = {}
+      ret[#ret + 1] = cur
+    end
+    cur[mpack_keys[(i % 4) + 1]] = val
+    i = i + 1
+  end
+  return ret
 end
 
 return {
@@ -77,4 +112,5 @@ return {
   clear=clear,
   exc_exec=exc_exec,
   get_shada_rw=get_shada_rw,
+  read_shada_file=read_shada_file,
 }

test/functional/shada/shada_spec.lua

@@ -0,0 +1,130 @@
+-- Other ShaDa tests
+local helpers = require('test.functional.helpers')
+local nvim, nvim_window, nvim_curwin, nvim_command, nvim_feed, nvim_eval, eq =
+  helpers.nvim, helpers.window, helpers.curwin, helpers.command, helpers.feed,
+  helpers.eval, helpers.eq
+local write_file = helpers.write_file
+local lfs = require('lfs')
+
+local msgpack = require('MessagePack')
+
+local shada_helpers = require('test.functional.shada.helpers')
+local reset, set_additional_cmd, clear, exc_exec, get_shada_rw =
+  shada_helpers.reset, shada_helpers.set_additional_cmd,
+  shada_helpers.clear, shada_helpers.exc_exec,
+  shada_helpers.get_shada_rw
+local read_shada_file = shada_helpers.read_shada_file
+
+local wshada, sdrcmd, shada_fname, clean = get_shada_rw('Xtest-functional-shada-shada.shada')
+
+describe('ShaDa support code', function()
+  before_each(reset)
+  after_each(function()
+    clear()
+    clean()
+  end)
+
+  it('preserves `s` item size limit with unknown entries', function()
+    wshada('\100\000\207\000\000\000\000\000\000\004\000\218\003\253' .. ('-'):rep(1024 - 3)
+           .. '\100\000\207\000\000\000\000\000\000\004\001\218\003\254' .. ('-'):rep(1025 - 3))
+    eq(0, exc_exec('wshada ' .. shada_fname))
+    local found = 0
+    for _, v in ipairs(read_shada_file(shada_fname)) do
+      if v.type == 100 then
+        found = found + 1
+      end
+    end
+    eq(2, found)
+    eq(0, exc_exec('set shada-=s10 shada+=s1'))
+    eq(0, exc_exec('wshada ' .. shada_fname))
+    found = 0
+    for _, v in ipairs(read_shada_file(shada_fname)) do
+      if v.type == 100 then
+        found = found + 1
+      end
+    end
+    eq(1, found)
+  end)
+
+  it('preserves `s` item size limit with instance history entries', function()
+    local hist1 = ('-'):rep(1024 - 5)
+    local hist2 = ('-'):rep(1025 - 5)
+    nvim_command('set shada-=s10 shada+=s1')
+    nvim_eval(('histadd(":", "%s")'):format(hist1))
+    nvim_eval(('histadd(":", "%s")'):format(hist2))
+    eq(0, exc_exec('wshada ' .. shada_fname))
+    local found = 0
+    for _, v in ipairs(read_shada_file(shada_fname)) do
+      if v.type == 4 then
+        found = found + 1
+        eq(hist1, v.value[2])
+      end
+    end
+    eq(1, found)
+  end)
+
+  it('leaves .tmp.a in-place when there is error in original ShaDa', function()
+    wshada('Some text file')
+    eq('Vim(wshada):E576: Error while reading ShaDa file: last entry specified that it occupies 109 bytes, but file ended earlier', exc_exec('wshada ' .. shada_fname))
+    eq(1, read_shada_file(shada_fname .. '.tmp.a')[1].type)
+  end)
+
+  it('does not leave .tmp.a in-place when there is error in original ShaDa, but writing with bang', function()
+    wshada('Some text file')
+    eq(0, exc_exec('wshada! ' .. shada_fname))
+    eq(1, read_shada_file(shada_fname)[1].type)
+    eq(nil, lfs.attributes(shada_fname .. '.tmp.a'))
+  end)
+
+  it('leaves .tmp.b in-place when there is error in original ShaDa and it has .tmp.a', function()
+    wshada('Some text file')
+    eq('Vim(wshada):E576: Error while reading ShaDa file: last entry specified that it occupies 109 bytes, but file ended earlier', exc_exec('wshada ' .. shada_fname))
+    eq('Vim(wshada):E576: Error while reading ShaDa file: last entry specified that it occupies 109 bytes, but file ended earlier', exc_exec('wshada ' .. shada_fname))
+    eq(1, read_shada_file(shada_fname .. '.tmp.a')[1].type)
+    eq(1, read_shada_file(shada_fname .. '.tmp.b')[1].type)
+  end)
+
+  it('leaves .tmp.z in-place when there is error in original ShaDa and it has .tmp.a … .tmp.x', function()
+    wshada('Some text file')
+    local i = ('a'):byte()
+    while i < ('z'):byte() do
+      write_file(shada_fname .. ('.tmp.%c'):format(i), 'Some text file', true)
+      i = i + 1
+    end
+    eq('Vim(wshada):E576: Error while reading ShaDa file: last entry specified that it occupies 109 bytes, but file ended earlier', exc_exec('wshada ' .. shada_fname))
+    eq(1, read_shada_file(shada_fname .. '.tmp.z')[1].type)
+  end)
+
+  it('errors out when there are .tmp.a … .tmp.z ShaDa files', function()
+    wshada('')
+    local i = ('a'):byte()
+    while i <= ('z'):byte() do
+      write_file(shada_fname .. ('.tmp.%c'):format(i), '', true)
+      i = i + 1
+    end
+    eq('Vim(wshada):E138: All Xtest-functional-shada-shada.shada.tmp.X files exist, cannot write ShaDa file!', exc_exec('wshada ' .. shada_fname))
+  end)
+
+  it('reads correctly various timestamps', function()
+    local mpack = {
+      '\100',  -- Positive fixnum 100
+      '\204\255',  -- uint 8 255
+      '\205\010\003',  -- uint 16 2563
+      '\206\255\010\030\004',  -- uint 32 4278853124
+      '\207\005\100\060\250\255\010\030\004',  -- uint 64 388502516579048964
+    }
+    local s = '\100'
+    local e = '\001\192'
+    wshada(s .. table.concat(mpack, e .. s) .. e)
+    eq(0, exc_exec('wshada ' .. shada_fname))
+    local found = 0
+    local typ = select(2, msgpack.unpacker(s)())
+    for _, v in ipairs(read_shada_file(shada_fname)) do
+      if v.type == typ then
+        found = found + 1
+        eq(select(2, msgpack.unpacker(mpack[found])()), v.timestamp)
+      end
+    end
+    eq(#mpack, found)
+  end)
+end)