gitsigns.nvim/test/gitsigns_spec.lua

-- vim: foldnestmax=5:

local Screen = require('test.functional.ui.screen')
local helpers = require('test.gs_helpers')

local clear         = helpers.clear
local command       = helpers.command
local exec_capture  = helpers.exec_capture
local feed          = helpers.feed
local exec_lua      = helpers.exec_lua
local split         = helpers.split
local get_buf_var   = helpers.curbufmeths.get_var
local fn            = helpers.funcs
local system        = fn.system
local init          = helpers.init
local wait          = helpers.wait
local write_to_file = helpers.write_to_file
local edit          = helpers.edit
local cleanup       = helpers.cleanup
local test_file     = helpers.test_file
local git           = helpers.git
local scratch       = helpers.scratch
local newfile       = helpers.newfile
local debug_messages = helpers.debug_messages
local match_dag     = helpers.match_dag
local match_debug_messages = helpers.match_debug_messages
local match_lines   = helpers.match_lines
local p             = helpers.p
local setup         = helpers.setup
local test_config   = helpers.test_config
local check         = helpers.check
local eq            = helpers.eq

local it = helpers.it(it)

describe('gitsigns', function()
  local screen
  local config

  before_each(function()
    clear()
    screen = Screen.new(20, 17)
    screen:attach({ext_messages=true})

    screen:set_default_attr_ids({
      [1] = {foreground = Screen.colors.DarkBlue, background = Screen.colors.WebGray};
      [2] = {background = Screen.colors.LightMagenta};
      [3] = {background = Screen.colors.LightBlue};
      [4] = {background = Screen.colors.LightCyan1, bold = true, foreground = Screen.colors.Blue1};
      [5] = {foreground = Screen.colors.Brown};
      [6] = {foreground = Screen.colors.Blue1, bold = true};
      [7] = {bold = true},
      [8] = {foreground = Screen.colors.White, background = Screen.colors.Red};
      [9] = {foreground = Screen.colors.SeaGreen, bold = true};
    })

    -- Make gitisigns available
    exec_lua('package.path = ...', package.path)
    config = helpers.deepcopy(test_config)
  end)

  after_each(function()
    cleanup()
    screen:detach()
  end)

  it('can run basic setup', function()
    screen:try_resize(60,6)
    setup()
    check { status = {}, signs = {} }
  end)

  it('index watcher works on a fresh repo', function()
    screen:try_resize(20,6)
    init(true)
    config.watch_index = {interval = 5}
    setup(config)
    edit(test_file)

    wait(function()
      match_dag(debug_messages(), {
        "run_job: git --no-pager --version",
        'attach(1): Attaching (trigger=BufRead)',
        p'run_job: git .* config user.name',
        'run_job: git --no-pager rev-parse --show-toplevel --absolute-git-dir --abbrev-ref HEAD',
        p('run_job: git .* ls%-files %-%-stage %-%-others %-%-exclude%-standard '..test_file),
        'watch_index(1): Watching index',
        'watcher_cb(1): Index update error: ENOENT',
        p'run_job: git .* show :0:dummy.txt',
        'update(1): updates: 1, jobs: 5'
      })
    end)

    check {
      status = {head='HEAD', added=18, changed=0, removed=0},
      signs = {added=8}
    }

    git{"add", test_file}

    check {
      status = {head='HEAD', added=0, changed=0, removed=0},
      signs = {}
    }
  end)

  it('can open files not in a git repo', function()
    screen:try_resize(60,6)
    setup(config)
    local tmpfile = os.tmpname()
    edit(tmpfile)

    feed('iline<esc>')
    helpers.sleep(10)
    command("write")

    match_debug_messages {
      "run_job: git --no-pager --version",
      'attach(1): Attaching (trigger=BufRead)',
      p"run_job: git .* config user.name",
      "run_job: git --no-pager rev-parse --show-toplevel --absolute-git-dir --abbrev-ref HEAD",
      'attach(1): Not in git repo',
      'attach(1): Attaching (trigger=BufWritePost)',
      'run_job: git --no-pager config user.name',
      'run_job: git --no-pager rev-parse --show-toplevel --absolute-git-dir --abbrev-ref HEAD',
      'attach(1): Not in git repo'
    }
  end)

  describe('when attaching', function()
    before_each(function()
      init()
      setup(config)
    end)

    it('can setup mappings', function()
      edit(test_file)
      wait(function()
        local res = split(exec_capture('nmap <buffer>'), '\n')
        table.sort(res)

        -- Check all keymaps get set
        match_lines(res, {
          'n  mhS         *@<Cmd>lua require"gitsigns".stage_buffer()<CR>',
          'n  mhU         *@<Cmd>lua require"gitsigns".reset_buffer_index()<CR>',
          'n  mhp         *@<Cmd>lua require"gitsigns".preview_hunk()<CR>',
          'n  mhr         *@<Cmd>lua require"gitsigns".reset_hunk()<CR>',
          'n  mhs         *@<Cmd>lua require"gitsigns".stage_hunk()<CR>',
          'n  mhu         *@<Cmd>lua require"gitsigns".undo_stage_hunk()<CR>',
        })
      end)
    end)

    it('does not attach inside .git', function()
      edit(scratch..'/.git/index')

      match_debug_messages {
        "run_job: git --no-pager --version",
        'attach(1): Attaching (trigger=BufRead)',
        'attach(1): In git dir'
      }
    end)

    it('doesn\'t attach to ignored files', function()
      write_to_file(scratch..'/.gitignore', {'dummy_ignored.txt'})

      local ignored_file = scratch.."/dummy_ignored.txt"

      system{"touch", ignored_file}
      edit(ignored_file)

      match_debug_messages {
        "run_job: git --no-pager --version",
        'attach(1): Attaching (trigger=BufRead)',
        p"run_job: git .* config user.name",
        "run_job: git --no-pager rev-parse --show-toplevel --absolute-git-dir --abbrev-ref HEAD",
        p"run_job: git .* ls%-files .*/dummy_ignored.txt",
        "attach(1): Cannot resolve file in repo",
      }

      check {status = {head='master'}}
    end)

    it('doesn\'t attach to non-existent files', function()
      edit(newfile)

      match_debug_messages {
        "run_job: git --no-pager --version",
        'attach(1): Attaching (trigger=BufNewFile)',
        p"run_job: git .* config user.name",
        "run_job: git --no-pager rev-parse --show-toplevel --absolute-git-dir --abbrev-ref HEAD",
        p("run_job: git .* ls%-files %-%-stage %-%-others %-%-exclude%-standard "..newfile),
        "attach(1): Not a file",
      }

      check {status = {head='master'}}

    end)

    it('doesn\'t attach to non-existent files with non-existent sub-dirs', function()
      edit(scratch..'/does/not/exist')

      match_debug_messages {
        "run_job: git --no-pager --version",
        'attach(1): Attaching (trigger=BufNewFile)',
        "attach(1): Not a path",
      }

      helpers.pcall_err(get_buf_var, 'gitsigns_head')
      helpers.pcall_err(get_buf_var, 'gitsigns_status_dict')

    end)

    it('can run copen', function()
      command("copen")
      match_debug_messages {
        "run_job: git --no-pager --version",
        'attach(2): Attaching (trigger=BufRead)',
        "attach(2): Non-normal buffer",
      }
    end)

    it('can run get_hunks()', function()
      edit(test_file)
      feed("iline1<esc>")
      feed("oline2<esc>")

      wait(function()
        eq({{
            head = '@@ -1,1 +1,2 @@',
            type = 'change',
            lines = { '-This', '+line1This', '+line2' },
            added   = { count = 2, start = 1 },
            removed = { count = 1, start = 1 },
          }},
          exec_lua[[return require'gitsigns'.get_hunks()]]
        )
      end)
    end)
  end)

  describe('current line blame', function()
    it('doesn\'t error on untracked files', function()
      command("set updatetime=1")
      init(true)
      config.current_line_blame = true
      setup(config)
      edit(newfile)
      feed("iline<esc>")
      command("write")
      screen:expect{messages = { { content = { { "<" } }, kind = "" } } }
    end)
  end)

  describe('on_attach()', function()
    it('can prevent attaching to a buffer', function()
      init(true)

      -- Functions can't be serialized over rpc so need to setup config
      -- remotely
      exec_lua('config = ...', config)
      exec_lua[[config.on_attach = function()
        return false
      end]]
      exec_lua('require("gitsigns").setup(config)')
      wait(function()
        exec_capture('au gitsigns')
      end)
      edit(test_file)
      match_debug_messages {
        "run_job: git --no-pager --version",
        'attach(1): Attaching (trigger=BufRead)',
        p"run_job: git .* config user.name",
        "run_job: git --no-pager rev-parse --show-toplevel --absolute-git-dir --abbrev-ref HEAD",
        p'run_job: git %-%-no%-pager %-%-git%-dir=.* %-%-stage %-%-others %-%-exclude%-standard .*',
        "attach(1): User on_attach() returned false",
      }
    end)
  end)

  describe('change_base()', function()
    it('works', function()
      screen:try_resize(20, 4)

      init()
      edit(test_file)

      feed('oEDIT<esc>')
      command('write')

      git{'add', test_file}
      git{"commit", "-m", "commit on main"}

      -- Don't setup gitsigns until the repo has two commits
      setup(config)

      check {
        status = {head='master', added=0, changed=0, removed=0},
        signs  = {}
      }

      command('Gitsigns change_base ~')

      check {
        status = {head='master', added=1, changed=0, removed=0},
        signs  = {added=1}
      }
    end)
  end)

  local function testsuite(advanced_features)
    return function()
      before_each(function()
        config.use_decoration_api = advanced_features
        config.use_internal_diff = advanced_features
        init()
      end)

      it('apply basic signs', function()
        setup(config)
        edit(test_file)
        command("set signcolumn=yes")

        feed("dd") -- Top delete
        feed("j")
        feed("o<esc>") -- Add
        feed("2j")
        feed("x") -- Change
        feed("3j")
        feed("dd") -- Delete
        feed("j")
        feed("ddx") -- Change delete

        check {
          status = {head='master', added=1, changed=2, removed=3},
          signs  = {topdelete=1, changedelete=1, added=1, delete=1, changed=1}
        }

      end)

      it('perform actions', function()
        screen:try_resize(20,6)
        setup(config)
        edit(test_file)
        command("set signcolumn=yes")

        feed("jjj")
        feed("cc")
        feed("EDIT<esc>")

        check {
          status = {head='master', added=0, changed=1, removed=0},
          signs  = {changed=1}
        }

        -- Stage
        feed("mhs")

        check {
          status = {head='master', added=0, changed=0, removed=0},
          signs  = {}
        }

        -- Undo stage
        feed("mhu")

        check {
          status = {head='master', added=0, changed=1, removed=0},
          signs  = {changed=1}
        }

        -- Add multiple edits
        feed('gg')
        feed('cc')
        feed('That<esc>')

        check {
          status = {head='master', added=0, changed=2, removed=0},
          signs  = {changed=2}
        }

        -- Stage buffer
        feed("mhS")

        check {
          status = {head='master', added=0, changed=0, removed=0},
          signs  = {}
        }

        -- Unstage buffer
        feed("mhU")

        check {
          status = {head='master', added=0, changed=2, removed=0},
          signs  = {changed=2}
        }

        -- Reset
        feed("mhr")

        check {
          status = {head='master', added=0, changed=1, removed=0},
          signs  = {changed=1}
        }
      end)

      it('can enable numhl', function()
        config.numhl = true
        setup(config)
        edit(test_file)
        command("set signcolumn=no")
        command("set number")

        feed("dd") -- Top delete
        feed("j")
        feed("o<esc>") -- Add
        feed("2j")
        feed("x") -- Change
        feed("3j")
        feed("dd") -- Delete
        feed("j")
        feed("ddx") -- Change delete

        -- screen:snapshot_util()
        screen:expect{grid=[[
          {4:  1 }is              |
          {5:  2 }a               |
          {3:  3 }                |
          {5:  4 }file            |
          {2:  5 }sed             |
          {5:  6 }for             |
          {4:  7 }testing         |
          {5:  8 }The             |
          {2:  9 }^oesn't          |
          {5: 10 }matter,         |
          {5: 11 }it              |
          {5: 12 }just            |
          {5: 13 }needs           |
          {5: 14 }to              |
          {5: 15 }be              |
          {5: 16 }static.         |
          {6:~                   }|
        ]]}
      end)

      it('attaches to newly created files', function()
        screen:try_resize(4, 4)
        setup(config)
        edit(newfile)
        match_debug_messages{
          'run_job: git --no-pager --version',
          'attach(1): Attaching (trigger=BufNewFile)',
          'run_job: git --no-pager config user.name',
          'run_job: git --no-pager rev-parse --show-toplevel --absolute-git-dir --abbrev-ref HEAD',
          p'run_job: git .* ls%-files .*',
          'attach(1): Not a file',
        }
        command('Gitsigns clear_debug')
        command("write")

        local messages = {
          'attach(1): Attaching (trigger=BufWritePost)',
          p"run_job: git .* config user.name",
          "run_job: git --no-pager rev-parse --show-toplevel --absolute-git-dir --abbrev-ref HEAD",
          p"run_job: git .* ls%-files .*",
          "watch_index(1): Watching index",
          p"run_job: git .* show :0:newfile.txt"
        }

        if not advanced_features then
          table.insert(messages, p'run_job: git .* diff .* /tmp/lua_.* /tmp/lua_.*')
        end

        local jobs = advanced_features and 8 or 9
        table.insert(messages, "update(1): updates: 1, jobs: "..jobs)

        match_debug_messages(messages)

        check {
          status = {head='master', added=1, changed=0, removed=0},
          signs  = {added=1}
        }

      end)

      it('can add untracked files to the index', function()
        screen:try_resize(10, 4)
        setup(config)

        edit(newfile)
        feed("iline<esc>")
        check{ status = {head='master'}}

        command("write")

        check {
          status = {head='master', added=1, changed=0, removed=0},
          signs  = {added=1}
        }

        feed('mhs') -- Stage the file (add file to index)

        check {
          status = {head='master', added=0, changed=0, removed=0},
          signs  = {}
        }

      end)

      it('tracks files in new repos', function()
        screen:try_resize(10, 4)
        setup(config)
        system{"touch", newfile}
        edit(newfile)

        feed("iEDIT<esc>")
        command("write")

        check {
          status = {head='master', added=1, changed=0, removed=0},
          signs  = {added=1}
        }

        git{"add", newfile}

        check {
          status = {head='master', added=0, changed=0, removed=0},
          signs  = {}
        }

        git{"reset"}

        check {
          status = {head='master', added=1, changed=0, removed=0},
          signs  = {added=1}
        }

      end)

      it('can detach from buffers', function()
        setup(config)
        edit(test_file)
        command("set signcolumn=yes")

        feed("dd") -- Top delete
        feed("j")
        feed("o<esc>") -- Add
        feed("2j")
        feed("x") -- Change
        feed("3j")
        feed("dd") -- Delete
        feed("j")
        feed("ddx") -- Change delete

        check {
          status = {head='master', added=1, changed=2, removed=3},
          signs  = {topdelete=1, added=1, changed=1, delete=1, changedelete=1}
        }

        command('Gitsigns detach')

        check { status = {}, signs = {} }
      end)

      it('can stages file with merge conflicts', function()
        screen:try_resize(40, 8)
        setup(config)
        command("set signcolumn=yes")

        -- Edit a file and commit it on main branch
        edit(test_file)
        check{ status = {head='master', added=0, changed=0, removed=0} }
        feed('iedit')
        check{ status = {head='master', added=0, changed=1, removed=0} }
        command("write")
        command("bdelete")
        git{'add', test_file}
        git{"commit", "-m", "commit on main"}

        -- Create a branch, remove last commit, edit file again
        git{'checkout', '-B', 'abranch'}
        git{'reset', '--hard', 'HEAD~1'}
        edit(test_file)
        check{ status = {head='abranch', added=0, changed=0, removed=0} }
        feed('idiff')
        check{ status = {head='abranch', added=0, changed=1, removed=0} }
        command("write")
        command("bdelete")
        git{'add', test_file}
        git{"commit", "-m", "commit on branch"}
        git{"rebase", "master"}

        -- test_file should have a conflict
        edit(test_file)
        check {
          status = {head='(rebasing)', added=4, changed=1, removed=0},
          signs = {changed=1, added=4}
        }

        exec_lua('require("gitsigns.actions").stage_hunk()')

        check {
          status = {head='(rebasing)', added=0, changed=0, removed=0},
          signs = {}
        }

      end)

      it('handle files with spaces', function()
        screen:try_resize(20,6)
        setup(config)
        command("set signcolumn=yes")

        local spacefile = scratch..'/a b c d'

        write_to_file(spacefile, {'spaces', 'in', 'file'})

        edit(spacefile)

        check {
          status = {head='master', added=3, removed=0, changed=0},
          signs = {added=3}
        }

        git{'add', spacefile}
        edit(spacefile)

        check {
          status = {head='master', added=0, removed=0, changed=0},
          signs = {}
        }

      end)
    end
  end

  -- Run regular config
  describe('diff-ext', testsuite(false))

  -- Run with:
  --   - internal diff (ffi)
  --   - decoration provider
  describe('diff-int', testsuite(true))

  it('can handle vimgrep', function()
    init()

    write_to_file(scratch..'/t1.txt', {'hello ben'})
    write_to_file(scratch..'/t2.txt', {'hello ben'})
    write_to_file(scratch..'/t3.txt', {'hello lewis'})

    setup(config)

    helpers.exc_exec("vimgrep ben "..scratch..'/*')

    screen:expect{messages = {{
      kind = "quickfix", content = { { "(1 of 2): hello ben" } },
    }}}

    eq({
      'run_job: git --no-pager --version',
      'attach(2): attaching is disabled',
      'attach(3): attaching is disabled',
      'attach(4): attaching is disabled',
      'attach(5): attaching is disabled',
    }, exec_lua[[return require'gitsigns'.debug_messages(true)]])

  end)

  -- TODO Add test for current_line_blame
  -- TODO Add test for toggle_current_line_blame

  -- TODO Add test for #163: signcolumn=number with signs disabled shouldn't
  -- overwrite number column

  -- TODO Test config.attach_to_untracked
  -- TODO Add test for #194: Should not attach if file is in a custom git dir

  -- TODO Add test diffthis

end)

-- vim: foldminlines=1