koreader/spec/unit/persist_spec.lua

describe("Persist module", function()
    local Persist
    local sample
    local bitserInstance, luajitInstance, zstdInstance, dumpInstance, serpentInstance
    local fail = { a = function() end, }

    local function arrayOf(n)
        assert(type(n) == "number", "wrong type (expected number)")
        local t = {}
        for i = 1, n do
            table.insert(t, i, {
                a = "sample " .. tostring(i),
                b = true,
                c = nil,
                d = i,
                e = {
                    f = {
                        g = nil,
                        h = false,
                    },
                },
            })
        end
        return t
    end

    setup(function()
        require("commonrequire")
        Persist = require("persist")
        bitserInstance = Persist:new{ path = "test.dat", codec = "bitser" }
        luajitInstance = Persist:new{ path = "testj.dat", codec = "luajit" }
        zstdInstance = Persist:new{ path = "test.zst", codec = "zstd" }
        dumpInstance = Persist:new{ path = "test.lua", codec = "dump" }
        serpentInstance = Persist:new{ path = "tests.lua", codec = "serpent" }
        sample = arrayOf(1000)
    end)

    it("should save a table to file", function()
        assert.is_true(bitserInstance:save(sample))
        assert.is_true(luajitInstance:save(sample))
        assert.is_true(zstdInstance:save(sample))
        assert.is_true(dumpInstance:save(sample))
        assert.is_true(serpentInstance:save(sample))
    end)

    it("should generate a valid file", function()
        assert.is_true(bitserInstance:exists())
        assert.is_true(bitserInstance:size() > 0)
        assert.is_true(type(bitserInstance:timestamp()) == "number")

        assert.is_true(luajitInstance:exists())
        assert.is_true(luajitInstance:size() > 0)
        assert.is_true(type(luajitInstance:timestamp()) == "number")

        assert.is_true(zstdInstance:exists())
        assert.is_true(zstdInstance:size() > 0)
        assert.is_true(type(zstdInstance:timestamp()) == "number")
    end)

    it("should load a table from file", function()
        assert.are.same(sample, bitserInstance:load())
        assert.are.same(sample, luajitInstance:load())
        assert.are.same(sample, zstdInstance:load())
        assert.are.same(sample, dumpInstance:load())
        assert.are.same(sample, serpentInstance:load())
    end)

    it("should delete the file", function()
        bitserInstance:delete()
        luajitInstance:delete()
        zstdInstance:delete()
        dumpInstance:delete()
        serpentInstance:delete()
        assert.is_nil(bitserInstance:exists())
        assert.is_nil(luajitInstance:exists())
        assert.is_nil(zstdInstance:exists())
        assert.is_nil(dumpInstance:exists())
        assert.is_nil(serpentInstance:exists())
    end)

    it("should return standalone serializers/deserializers", function()
        local tab = sample
        -- NOTE: zstd only deser from a *file*, not a string.
        for _, codec in ipairs({"dump", "serpent", "bitser", "luajit"}) do
            assert.is_true(Persist.getCodec(codec).id == codec)
            local ser = Persist.getCodec(codec).serialize
            local deser = Persist.getCodec(codec).deserialize
            local str = ser(tab)
            local t, err = deser(str)
            if not t then
                print(codec, "deser failed:", err)
            end
            assert.are.same(t, tab)
        end
    end)

    it("should work with huge tables", function()
        local tab = arrayOf(100000)
        for _, codec in ipairs({"bitser", "luajit"}) do
            local ser = Persist.getCodec(codec).serialize
            local deser = Persist.getCodec(codec).deserialize
            local str = ser(tab)
            assert.are.same(deser(str), tab)
        end
    end)

    it("should fail to serialize functions", function()
        for _, codec in ipairs({"dump", "bitser", "luajit", "zstd"}) do
            assert.is_true(Persist.getCodec(codec).id == codec)
            local ser = Persist.getCodec(codec).serialize
            local deser = Persist.getCodec(codec).deserialize
            local str = ser(fail)
            assert.are_not.same(deser(str), fail)
        end
    end)

    it("should successfully serialize functions", function()
        for _, codec in ipairs({"serpent"}) do
            assert.is_true(Persist.getCodec(codec).id == codec)
            local ser = Persist.getCodec(codec).serialize
            local deser = Persist.getCodec(codec).deserialize
            local str = ser(fail)
            assert.are_not.same(deser(str), fail)
        end
    end)

end)