local t = require('luatest')
local fio = require('fio')
local it = require('test.interactive_tarantool')

local function unescape(s)
    return s and s:gsub('[\27\155][][()#;?%d]*[A-PRZcf-ntqry=><~]', '') or ''
end

local function trim(s)
    return s and s:gsub('%s+$', '') or ''
end

local DEBUGGER = 'luadebug'
local dbg_prompt = DEBUGGER .. '>'
local dbg_failed_bp = 'command expects argument in format filename:NN or ' ..
                      'filename+NN, where NN should be a positive number.'
local dbg_failed_bpd = 'command expects argument specifying breakpoint or' ..
                       ' * for all breakpoints.'

local function dbg_failed_range(v)
    return ('line number %d is out of allowed range [%d, %d]'):
            format(v, 1, 0x7fffff00)
end

local function debuglog(...)
    print('--', ...)
end

--[[
    Convert passed multi-line literal script
    to the temporary file. Get rid of line annotations,
    leaving code alone.

    Annotated lines are in a form:
        1 | local date = require 'datetime'
        2 | local T = date.new{hour = 3, tzoffset = '+0300'}
]]
local function dbg_script(content)
    assert(content ~= nil)
    local tmpname = os.tmpname()
    local f = assert(io.open(tmpname, "wb"))
    debuglog("Temporary script name:", tmpname)
    -- process multi-line literal
    for line in string.gmatch(content, "[^\n]+") do
        --[[
            Process annotated code line, delimited with '|'.

        +-------- virtual line number (for easier maintaining)
        | +------ delimiter
        | | +---- Lua code to be executed
        V V V
        1 | local date = require 'datetime'

        ]]
        local delim = line:find('|')

        -- if there is no delimiter - write it as-is
        if not delim then
            f:write(line..'\n')
        else
            -- TODO - assert if there is incorrect line numbers
            -- at the moment just ignore annotation entirely.
            f:write(line:sub(delim + 1)..'\n')
        end
    end
    f:close()
    return tmpname
end

local cmd_aliases = {
    ['b'] = 'b|break|breakpoint|add_break|add_breakpoint',
    ['bd'] = 'bd|bdelete|delete_break|delete_breakpoint',
    ['bl'] = 'bl|blist|list_break|list_breakpoints',
    ['c'] = 'c|cont|continue',
    ['d'] = 'd|down',
    ['e'] = 'e|eval',
    ['f'] = 'f|finish|step_out',
    ['h'] = 'h|help|?',
    ['l'] = 'l|locals',
    ['n'] = 'n|next|step_over',
    ['p'] = 'p|print',
    ['q'] = 'q|quit',
    ['s'] = 's|st|step|step_into',
    ['t'] = 't|trace|bt',
    ['u'] = 'u|up',
    ['w'] = 'w|where',
}

local MAX_ALIASES_COUNT = 5

local function get_cmd_alias(cmd, number)
    if not cmd_aliases[cmd] then
        return cmd
    end
    local cmds = {}
    for v, _ in cmd_aliases[cmd]:gmatch('[^|]+') do
        table.insert(cmds, v)
    end
    return cmds[number % #cmds + 1]
end

--[[
    Should handle equally well both:
    'n' and 'p obj'
]]
local function get_key_arg_pair(cmd)
    local gen = cmd:gmatch('[^%s]+')
    return gen(), gen()
end

local g = t.group('debug', {
    {sequence = 'full'},
    {sequence = 'bp_set_ok'},
    {sequence = 'bp_set_fail'},
    {sequence = 'bp_delete_ok'},
    {sequence = 'bp_delete_fail'},
})

local sequences = {

    -- full, complex sequence
    full = {
        dbg_script [[
     1 | local date = require 'datetime'
     2 |
     3 | local T = date.new{hour = 3, tzoffset = '+0300'}
     4 | print(T)
     5 |
     6 | local fmt = '%Y-%m-%dT%H%M%z'
     7 | local S  = T:format(fmt)
     8 | print(S)
     9 | local T1 = date.parse(S, {format = fmt})
    10 | print(T1)
    11 |
    12 | os.exit(0)
]],
        { ['\t'] = '' }, -- \t is a special value for start
        { ['n'] = '' },
        { ['s'] = '' },
        { ['n'] = '' },
        { ['n'] = '' },
        { ['p'] = 'expects argument, but none received' },
        { ['p obj'] = 'obj => {"tzoffset" = "+0300", "hour" = 3}' },
        { ['n'] = '' },
        { ['p ymd'] = 'ymd => false' },
        { ['w 0'] = 'local h, m, s, hms = extract_obj_hms(obj)' },
        { ['bogus;'] = 'is not recognized.' },
        { ['h'] = '' },
        { ['t'] = '=> builtin/datetime.lua' },
        { ['u'] = '{file}:3 in chunk at' },
        -- FIXME (gh-8190) - we should not show calling side at luadebug.lua
        -- { ['u'] = 'Already at the bottom of the stack.' },
        { ['u'] = 'Inspecting frame: builtin/luadebug.lua' },
        { ['d'] = '{file}:3 in chunk at' },
        { ['d'] = 'Inspecting frame: builtin/datetime.lua' },
        { ['l'] = 'obj => {"tzoffset" = "+0300", "hour" = 3}' },
        { ['f'] = '' },
        { ['n'] = '' },
        { ['p T'] = 'T => 1970-01-01T03:00:00+0300' },
        { ['n'] = '' },
        { [''] = '' },
        { [''] = '' },
        { [''] = '' },
        { ['p S'] = 'S => "1970-01-01T0300+0300"' },
        { ['c'] = '<END_OF_EXECUTION>' },
    },

    -- partial sequence with successful breakpoints added
    bp_set_ok = {
        dbg_script [[
     1 | local date = require 'datetime'
     2 |
     3 | local T = date.new{hour = 3, tzoffset = '+0300'}
     4 | print(T)
     5 |
     6 | local fmt = '%Y-%m-%dT%H%M%z'
     7 | local S  = T:format(fmt)
     8 | print(S)
     9 | local T1 = date.parse(S, {format = fmt})
    10 | print(T1)
    11 |
    12 | os.exit(0)
]],
        { ['\t'] = '' }, -- \t is a special value for start
        { ['b +9'] = '' },
        { ['c'] = '{file}:9' },
        { ['n'] = '' },
        { ['p S'] = 'S => "1970-01-01T0300+0300"' },
        { ['p T'] = 'T => 1970-01-01T03:00:00+0300' },
        { ['c'] = '<END_OF_EXECUTION>' },
    },

    -- partial sequence with failed breakpoint addsitions
    bp_set_fail = {
        dbg_script [[
    1 | local date = require 'datetime'
    2 | local T = date.new{hour = 3, tzoffset = '+0300'}
    3 | print(T)
    4 | os.exit(0)
]],
        { ['\t'] = '' }, -- \t is a special value for start
        { ['b'] = 'expects argument, but none received' },
        { ['b 11'] = dbg_failed_bp },
        { ['b {file}'] = dbg_failed_bp },
        { ['b {file}:'] = dbg_failed_bp },
        { ['b {file}:-10'] = dbg_failed_bp },
        { ['b {file}+0'] = dbg_failed_range(0) },
        { ['b +0'] = dbg_failed_range(0) },
        { ['b {file}+2147483632'] = dbg_failed_range(2147483632) },
        { ['b +21474836480'] = dbg_failed_range(21474836480) },
    },

    -- partial sequence with breakpoints additions and removals
    bp_delete_ok = {
        dbg_script [[
     1 | local date = require 'datetime'
     2 |
     3 | local T = date.new{hour = 3, tzoffset = '+0300'}
     4 | print(T)
     5 |
     6 | local fmt = '%Y-%m-%dT%H%M%z'
     7 | local S  = T:format(fmt)
     8 | print(S)
     9 | local T1 = date.parse(S, {format = fmt})
    10 | print(T1)
    11 |
    12 | os.exit(0)
]],
        { ['\t'] = '' }, -- \t is a special value for start
        { ['b +7'] = '{file}:7' },
        { ['bl'] = '{file}:7' },
        { ['b :5'] = '{file}:5' },
        { ['bl'] = '{file}:5' },
        { ['bd :5'] = '{file}:5' },
        { ['bl'] = '{file}:7' },
        { ['bd +7'] = '{file}:7' },
        { ['b :6'] = '{file}:6' },
        { ['bl'] = '{file}:6' },
        { ['bd *'] = 'Removed all breakpoints' },
        { ['bl'] = 'No active breakpoints defined' },
    },
    -- partial sequence with failed breakpoints removals
    bp_delete_fail = {
        dbg_script [[
    1 | local date = require 'datetime'
    2 | local T = date.new{hour = 3, tzoffset = '+0300'}
    3 | print(T)
    4 | os.exit(0)
]],
        { ['\t'] = '' }, -- \t is a special value for start
        { ['bd'] = 'expects argument, but none received' },
        { ['bd 11'] = dbg_failed_bpd },
        { ['bd {file}'] = dbg_failed_bpd },
        { ['bd {file}:'] = dbg_failed_bpd },
        { ['bd {file}:-10'] = dbg_failed_bpd },
    },
}

local function run_debug_session(sequence, tmpfile, flags)
    local short_src = fio.basename(tmpfile)
    --[[
        repeat multiple times to check all command aliases
    ]]
    for i = 1, MAX_ALIASES_COUNT do
        local args
        if flags then
            args = {flags, tmpfile}
        else
            args = {tmpfile}
        end
        local expect_header = type(flags) == 'string' and flags:find("-d")
        local child = it.new_debugger({args = args,
                                       expect_header = expect_header})

        debuglog(child:read_until_prompt(dbg_prompt))
        for _, row in pairs(sequence) do
            local cmd, expected = next(row)
            -- interpret template strings {file}
            expected = expected:gsub('{file}', short_src)
            if cmd ~= '\t' then
                if cmd ~= '' then
                    local key, arg = get_key_arg_pair(cmd)
                    arg = arg and (' ' .. arg) or ''
                    cmd = get_cmd_alias(key, i) .. arg
                end
                debuglog('Execute command: "' .. trim(cmd) .. '"')
                child:execute_command(cmd)
            end

            if expected == '<END_OF_EXECUTION>' then
                t.assert_error_msg_contains('Unexpected EOF',
                    child.read_until_prompt, child)
            else
                local res = trim(unescape(child:read_until_prompt(dbg_prompt)))
                debuglog(res)
                t.assert_str_contains(res, expected)
            end
        end
        child:close()
    end
    debuglog('Delete temporary file ', tmpfile)
    os.remove(tmpfile)
end

-- `tarantool -d debug-target.lua`
g.test_debugger = function(cg)
    local scenario_name = cg.params.sequence
    t.assert(scenario_name)
    local sequence = sequences[scenario_name]
    t.assert(sequence)
    local tmpfile = table.remove(sequence, 1)
    t.assert(type(tmpfile) == 'string')

    run_debug_session(sequences[scenario_name], tmpfile, '-d')
end

local g_self = t.group('self-debug')

local shorter_sequence = {
        dbg_script [[
    1 | local dbg = require 'luadebug'
    2 | dbg()
    3 | local date = require 'datetime'
    4 |
    5 | local T = date.new{hour = 3, tzoffset = '+0300'}
    6 | print(T)
    7 |
    8 | os.exit(0)
]],
    { ['\t'] = '' }, -- \t is a special value for start
    { ['n'] = '' },
    { ['s'] = '' },
    { ['n'] = '' },
    { ['n'] = '' },
    { ['p'] = 'expects argument, but none received' },
    { ['p obj'] = 'obj => {"tzoffset" = "+0300", "hour" = 3}' },
    { ['u'] = '{file}:5 in chunk at' },
    { ['u'] = 'Already at the bottom of the stack.' },
    { ['d'] = 'Inspecting frame: builtin/datetime.lua' },
    { ['l'] = 'obj => {"tzoffset" = "+0300", "hour" = 3}' },
    { ['f'] = '{file}:6 in chunk at' },
    { ['c'] = '<END_OF_EXECUTION>' },
}

-- `tarantool debug-self-target.lua`, where
-- initiate debugging session via `require 'luadebug'()`
g_self.test_debug_self_invoke = function()
    local tmpfile = table.remove(shorter_sequence, 1)
    t.assert(type(tmpfile) == 'string')

    run_debug_session(shorter_sequence, tmpfile)
end
