summaryrefslogtreecommitdiff
path: root/lua/telescope/pickers/_test.lua
blob: 2124635d54f8f3c4e6968afe7861fb047f72013c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
local assert = require "luassert"
local builtin = require "telescope.builtin"
local log = require "telescope.log"

local Job = require "plenary.job"
local Path = require "plenary.path"

local tester = {}

tester.debug = false

local replace_terms = function(input)
  return vim.api.nvim_replace_termcodes(input, true, false, true)
end

local nvim_feed = function(text, feed_opts)
  feed_opts = feed_opts or "m"

  vim.api.nvim_feedkeys(text, feed_opts, true)
end

local writer = function(val)
  if type(val) == "table" then
    val = vim.fn.json_encode(val) .. "\n"
  end

  if tester.debug then
    print(val)
  else
    io.stderr:write(val)
  end
end

local execute_test_case = function(location, key, spec)
  local ok, actual = pcall(spec[2])

  if not ok then
    writer {
      location = "Error: " .. location,
      case = key,
      expected = "To succeed and return: " .. tostring(spec[1]),
      actual = actual,

      _type = spec._type,
    }
  else
    writer {
      location = location,
      case = key,
      expected = spec[1],
      actual = actual,

      _type = spec._type,
    }
  end
end

local end_test_cases = function()
  vim.cmd [[qa!]]
end

local invalid_test_case = function(k)
  writer { case = k, expected = "<a valid key>", actual = k }

  end_test_cases()
end

tester.picker_feed = function(input, test_cases)
  input = replace_terms(input)

  return coroutine.wrap(function()
    for i = 1, #input do
      local char = input:sub(i, i)
      nvim_feed(char, "")

      -- TODO: I'm not 100% sure this is a hack or not...
      -- it's possible these characters  could still have an on_complete... but i'm not sure.
      if string.match(char, "%g") then
        coroutine.yield()
      end

      if tester.debug then
        vim.wait(200)
      end
    end

    vim.wait(10)

    if tester.debug then
      coroutine.yield()
    end

    vim.defer_fn(function()
      if test_cases.post_typed then
        for k, v in ipairs(test_cases.post_typed) do
          execute_test_case("post_typed", k, v)
        end
      end

      nvim_feed(replace_terms "<CR>", "")
    end, 20)

    vim.defer_fn(function()
      if test_cases.post_close then
        for k, v in ipairs(test_cases.post_close) do
          execute_test_case("post_close", k, v)
        end
      end

      if tester.debug then
        return
      end

      vim.defer_fn(end_test_cases, 20)
    end, 40)

    coroutine.yield()
  end)
end

local _VALID_KEYS = {
  post_typed = true,
  post_close = true,
}

tester.builtin_picker = function(builtin_key, input, test_cases, opts)
  opts = opts or {}
  tester.debug = opts.debug or false

  for k, _ in pairs(test_cases) do
    if not _VALID_KEYS[k] then
      return invalid_test_case(k)
    end
  end

  opts.on_complete = {
    tester.picker_feed(input, test_cases),
  }

  builtin[builtin_key](opts)
end

local get_results_from_file = function(file)
  local j = Job:new {
    command = "nvim",
    args = {
      "--noplugin",
      "-u",
      "scripts/minimal_init.vim",
      "-c",
      string.format([[lua require("telescope.pickers._test")._execute("%s")]], file),
    },
  }

  j:sync(10000)

  local results = j:stderr_result()
  local result_table = {}
  for _, v in ipairs(results) do
    table.insert(result_table, vim.fn.json_decode(v))
  end

  return result_table
end

local asserters = {
  _default = assert.are.same,

  are = assert.are.same,
  are_not = assert.are_not.same,
}

local check_results = function(results)
  -- TODO: We should get all the test cases here that fail, not just the first one.
  for _, v in ipairs(results) do
    local assertion = asserters[v._type or "default"]

    assertion(v.expected, v.actual, string.format("Test Case: %s // %s", v.location, v.case))
  end
end

tester.run_string = function(contents)
  local tempname = vim.fn.tempname()

  contents = [[
  local tester = require('telescope.pickers._test')
  local helper = require('telescope.pickers._test_helpers')

  helper.make_globals()
  ]] .. contents

  vim.fn.writefile(vim.split(contents, "\n"), tempname)
  local result_table = get_results_from_file(tempname)
  vim.fn.delete(tempname)

  check_results(result_table)
end

tester.run_file = function(filename)
  local file = "./lua/tests/pickers/" .. filename .. ".lua"

  if not Path:new(file):exists() then
    assert.are.same("<An existing file>", file)
  end

  local result_table = get_results_from_file(file)

  check_results(result_table)
end

tester.not_ = function(val)
  val._type = "are_not"
  return val
end

tester._execute = function(filename)
  -- Important so that the outputs don't get mixed
  log.use_console = false

  vim.cmd(string.format("luafile %s", filename))

  local f = loadfile(filename)
  if not f then
    writer {
      location = "Error: " .. filename,
      case = filename,
      expected = "To succeed",
      actual = nil,
    }
  end

  local ok, msg = pcall(f)
  if not ok then
    writer {
      location = "Error: " .. msg,
      case = msg,
      expected = msg,
    }
  end

  end_test_cases()
end

return tester