-- Copyright (c) 2026 Huawei Technologies Co., Ltd.
-- openUBMC is licensed under Mulan PSL v2.
-- You can use this software according to the terms and conditions of the Mulan PSL v2.
-- You may obtain a copy of Mulan PSL v2 at:
--          http://license.coscl.org.cn/MulanPSL2
-- THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
-- EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
-- MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
-- See the Mulan PSL v2 for more details.

local lu = require('luaunit')
local skynet = require('skynet')
local json = require('cjson')
local tests = {}

-- 独立于 runtime 的字段映射和生产默认表;对应 root.sr 中两个全量配置对象。
local configured = {
    Cl = 13,
    Coen = 5,
    OenPreCsn = 1,
    Aoe = 3,
    Csrp = 255,
    Acs = 2,
    Cdn = 4,
    Cwen = 6,
    WenPreCsn = 0,
    Awe = 8,
    Cswp = 255,
    Lale = 10,
    Csn = 14,
    Prc = 15,
    Ln = 9,
    LnPreCsn = 1,
    Al = 11,
    LgtaSamp = 12,
    Addr2DataNum = 0,
}

local function read_snapshot(cs)
    local path = assert(skynet.getenv('TEST_DATA_DIR')) .. '/localbus-timing-' .. cs .. '.json'
    -- 等待构造完成标记,而不是等待调用数达到预期(那会漏掉缺省/额外调用)。
    for _ = 1, 300 do
        local file = io.open(path, 'rb')
        if file then
            local content = file:read('*a')
            file:close()
            local snapshot = json.decode(content)
            lu.assertEquals(snapshot.complete, true, path)
            lu.assertEquals(snapshot.contract_errors, {}, 'localbus contract violations, including caught errors')
            lu.assertEquals(snapshot.mmap_contract_errors, {}, 'mmap contract violations, including caught errors')
            lu.assertEquals(snapshot.success, true, snapshot.error)
            lu.assertNotEquals(snapshot.service, skynet.self(), 'must observe the real work service')
            lu.assertEquals(snapshot.properties.class_name, 'LocalBus')
            lu.assertEquals(snapshot.properties.Id, cs)
            lu.assertEquals(snapshot.restored_chip_name, 0, 'work service chip selection leaked')
            lu.assertEquals(snapshot.init_calls, { { cs = cs } }, 'normal driver init(cs)')
            lu.assertEquals(snapshot.mmap_init_calls, { { mode = 0, cs = cs } }, 'mmap init(mode, cs)')
            lu.assertEquals(snapshot.config_calls, {}, 'omitted Width/AddrOffset must not be programmed')
            lu.assertEquals(snapshot.csrp_calls, {}, 'no dedicated CSRP calls during initialization')
            return snapshot
        end
        skynet.sleep(10)
    end
    error('LocalBus work initialization snapshot timed out: ' .. path)
end

local function assert_properties(snapshot, omitted)
    for name, value in pairs(configured) do
        if omitted then
            -- 检查模型确实填入哨兵,而不是 nil 恰好被 runtime 跳过。
            value = (name == 'Csrp' or name == 'Cswp') and 65535 or 255
        elseif name == 'Addr2DataNum' and snapshot.chip_name == 0x1712 then
            value = 1 -- Hi1712 遵循至少 1 周期的下限;Hi1711 保留显式 0 的兼容行为。
        end
        lu.assertEquals(snapshot.properties[name], value, 'forwarded model property: ' .. name)
    end
    lu.assertEquals(snapshot.properties.Width, 255)
    lu.assertEquals(snapshot.properties.AddrOffset, 255)
end

function tests.legacy()
    local snapshot = read_snapshot(1)
    lu.assertEquals(snapshot.chip_name, 0)
    assert_properties(snapshot, false)
    lu.assertEquals(snapshot.timing_calls, {
        { cs = 2, type = 0, value = 10 }, -- 只有 Lale 映射 CS: 1 -> 2
        { cs = 1, type = 1, value = 0 },
    })
    lu.assertEquals(snapshot.timing_field_calls, {})

    local omitted = read_snapshot(0)
    lu.assertEquals(omitted.chip_name, 0)
    assert_properties(omitted, true)
    lu.assertEquals(omitted.timing_calls, {})
    lu.assertEquals(omitted.timing_field_calls, {})
end

function tests.chipv2()
    local snapshot = read_snapshot(2)
    lu.assertEquals(snapshot.chip_name, 0x1712)
    assert_properties(snapshot, false)
    lu.assertEquals(snapshot.timing_calls, {})
    -- 完整独立预期,不能由 runtime 参数表或收到的调用生成;同时拒绝重复、缺失、额外调用。
    lu.assertEquals(snapshot.timing_field_calls, {
        { cs = 2, field = 0, value = 13 },
        { cs = 2, field = 1, value = 5 },
        { cs = 2, field = 2, value = 1 },
        { cs = 2, field = 3, value = 3 },
        { cs = 2, field = 4, value = 255 },
        { cs = 2, field = 5, value = 2 },
        { cs = 2, field = 6, value = 4 },
        { cs = 2, field = 7, value = 6 },
        { cs = 2, field = 8, value = 0 },
        { cs = 2, field = 9, value = 8 },
        { cs = 2, field = 10, value = 255 },
        { cs = 2, field = 11, value = 10 },
        { cs = 2, field = 12, value = 14 },
        { cs = 2, field = 13, value = 15 },
        { cs = 2, field = 14, value = 9 },
        { cs = 2, field = 15, value = 1 },
        { cs = 2, field = 16, value = 11 },
        { cs = 2, field = 17, value = 12 },
        { cs = 2, field = 18, value = 1 },
    })

    local omitted = read_snapshot(3)
    lu.assertEquals(omitted.chip_name, 0x1712)
    assert_properties(omitted, true)
    lu.assertEquals(omitted.timing_calls, {})
    lu.assertEquals(omitted.timing_field_calls, {})
end

function tests.mock_contract()
    local mock = require('libsoc_adapter.localbus')
    local mmap = require('libsoc_adapter.localbus_mmap')
    local sys_info = require('libsoc_adapter.sys_info')
    local previous_chip = sys_info.chip_name
    local previous_mmap_calls = mmap.init_calls
    local previous_mmap_errors = mmap.contract_errors
    mock.clear()
    mmap.clear()
    local expected_errors = { [mock] = {}, [mmap] = {} }
    local function expect_error(driver, message, callback, ...)
        lu.assertError(callback, driver, ...)
        local expected = expected_errors[driver]
        expected[#expected + 1] = message
        lu.assertEquals(driver.contract_errors, expected, 'every rejected call must leave exactly one error')
    end
    local ok, err = xpcall(function()
        mock:set_csrp(0, 123)
        lu.assertEquals(mock:get_timing_field(0, 4), 123)
        mock:set_timing_field(0, 4, 255)
        lu.assertEquals(mock:get_csrp(0), 255)
        mock:set_csrp(0, 511)
        lu.assertEquals(mock:get_timing_field(0, 4), 511)
        lu.assertEquals(mock:get_csrp(1), 0, 'CS state must be isolated')
        mock:clear()
        lu.assertEquals(mock:get_csrp(0), 0, 'clear must reset shared state')
        lu.assertEquals(mock:get_timing_field(0, 4), 0)

        for _, cs in ipairs({ -1, 4, 0.5, '1', false, math.huge }) do
            expect_error(mock, 'invalid localbus cs', mock.init, cs)
            expect_error(mock, 'invalid localbus cs', mock.set_timing, { cs = cs, type = 0, value = 1 })
            expect_error(mock, 'invalid localbus cs', mock.set_csrp, cs, 1)
            expect_error(mock, 'invalid localbus cs', mock.get_csrp, cs)
            expect_error(mock, 'invalid localbus cs', mock.set_timing_field, cs, 4, 1)
            expect_error(mock, 'invalid localbus cs', mock.get_timing_field, cs, 4)
            expect_error(mock, 'invalid localbus cs', mock.set_bitwide_and_offset, cs, 0, 1)
            expect_error(mmap, 'invalid mmap cs', mmap.init, 0, cs)
        end
        for _, field in ipairs({ -1, 19, 0.5, '4', false, math.huge }) do
            expect_error(mock, 'invalid localbus field', mock.set_timing_field, 0, field, 1)
            expect_error(mock, 'invalid localbus field', mock.get_timing_field, 0, field)
        end
        expect_error(mock, 'invalid localbus csrp', mock.set_csrp, 0, 512)
        expect_error(mock, 'invalid localbus value', mock.set_timing_field, 0, 4, 0.5)
        expect_error(mock, 'invalid localbus value', mock.set_timing_field, 0, 18, 8)
        expect_error(mock, 'invalid localbus timing config', mock.set_timing, nil)
        expect_error(mock, 'invalid localbus type', mock.set_timing, { cs = 0, type = 2, value = 1 })
        expect_error(mock, 'invalid localbus value', mock.set_timing, { cs = 0, type = 0, value = 32 })
        expect_error(mock, 'invalid localbus offset', mock.set_bitwide_and_offset, 0, 2, 1)
        expect_error(mock, 'invalid localbus width', mock.set_bitwide_and_offset, 0, 0, 2)
        expect_error(mock, 'invalid localbus cs', mock.init)
        expect_error(mock, 'localbus.init expects only cs, not mmap mode', mock.init, 0, 2)
        expect_error(mmap, 'invalid mmap mode', mmap.init, 2)
        expect_error(mmap, 'invalid mmap cs', mmap.init, 0)
        expect_error(mmap, 'localbus_mmap.init expects mode, cs', mmap.init, 0, 3, 1)
        lu.assertEquals(mock.init_calls, {})
        lu.assertEquals(mock.timing_calls, {})
        lu.assertEquals(mock.timing_field_calls, {})
        lu.assertEquals(mock.csrp_calls, {})
        lu.assertEquals(mock.config_calls, {})
        lu.assertEquals(mmap.init_calls, {})
        lu.assertEquals(mock.contract_errors, expected_errors[mock])
        lu.assertEquals(mmap.contract_errors, expected_errors[mmap])
        mock.clear()
        mmap.clear()
        lu.assertEquals(mock.contract_errors, {})
        lu.assertEquals(mmap.contract_errors, {})
        mock:init(3)
        mmap:init(0, 3)
        lu.assertEquals(mock.init_calls, { { cs = 3 } })
        lu.assertEquals(mmap.init_calls, { { mode = 0, cs = 3 } })
        lu.assertEquals(mock.contract_errors, {})
        lu.assertEquals(mmap.contract_errors, {})

        local success, failure = pcall(function()
            sys_info.with_chip(0x1712, function()
                lu.assertEquals(sys_info.new():get_chip_name(), 0x1712)
                error('intentional constructor failure')
            end)
        end)
        lu.assertEquals(success, false)
        lu.assertNotIsNil(tostring(failure):find('intentional constructor failure', 1, true))
        lu.assertEquals(sys_info.chip_name, previous_chip)
        lu.assertEquals(
            sys_info.with_chip(0x1712, function()
                return sys_info.new():get_chip_name()
            end),
            0x1712
        )
        lu.assertEquals(sys_info.chip_name, previous_chip)
    end, debug.traceback)
    mock.clear()
    mmap.clear()
    mmap.init_calls = previous_mmap_calls
    mmap.contract_errors = previous_mmap_errors
    sys_info.chip_name = previous_chip
    if not ok then
        error(err, 0)
    end
end

return tests