summaryrefslogtreecommitdiff
path: root/tests/linescanner.lua
blob: 8aa1923db6f2ae06c49b1b91cfd83505871c3509 (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
245
246
247
248
-- Allow testing without installing,
package.path = "src/?.lua;"..package.path

local LineScanner = require("luacov.reporter").LineScanner

local ntests = 0

-- source must contain "+", "?" or "-" at the end of each line,
-- marking expected output: "+" for always included lines, "?" for lines
-- included when hit, "-" for excluded lines.
local function test(source)
   ntests = ntests + 1

   local lines = {}
   local failed = false
   local scanner = LineScanner:new()

   for line in source:gmatch("[^\n]+") do
      local expected_symbol = line:sub(-1)
      line = line:sub(1, -2)

      local always_excluded, excluded_when_not_hit = scanner:consume(line)
      local actual_symbol = always_excluded and "-" or (excluded_when_not_hit and "?" or "+")

      if actual_symbol ~= expected_symbol then
         failed = true
      end

      table.insert(lines, line..expected_symbol.." "..actual_symbol)
   end

   if failed then
      error(("LineScanner test #%d failed!\nLine/expected/actual:\n\n%s"):format(
         ntests, table.concat(lines, "\n")
      ), 0)
   end
end

-- Tests from tests/issue_1.lua:

-- First line used to be annotated as excluded, but was not actually excluded.
test [[
   local thing = nil +
   print("test1")    +
]]

test [[
   local stuff = function (x) return x end +
   local thing = stuff({                   +
      b = { name = 'bob',                  ?
      },                                   +
      -- comment                           -
   })                                      ?
   print("test2")                          +
]]

test [[
   local stuff = function (x) return x end +
   local thing = stuff({                   +
      b = { name = 'bob',                  ?
      },                                   +
      -- comment                           -
   }                                       ?
   )                                       ?
   print("test2")                          +
]]

test [[
   if true then      -
      print("test3") +
   end               -
]]

test [[
   if true then      -
   end               -
   print("test3")    +
]]


test [[
   while true do     -
      print("test4") +
      break          ?
   end               -
]]

test [[
   local a, b = 1,2 +
   if               -
      a < b         +
   then             -
      a = b         +
   end              -
   print("test7")   +
]]

test [[
   local a,b = 1,2               +
   if a < b then                 +
      a = b                      +
   end;                          -
                                 -
   local function foo(f) f() end +
   foo(function()                +
      a = b                      +
   end)                          -
                                 -
   print("test8")                +
]]

test [[
   local function foo(f) -
      return function()  ?
         a = a           +
      end                -
   end                   -
   foo()()               +
                         -
   print("test9")        +
]]

-- Line 'c = 3' used to be annotated as excluded, but was not actually excluded.
test [[
   local s = {     +
      a = 1;       ?
      b = 2,       ?
      c = 3        +
   }               ?
                   -
   print("test10") +
]]

-- Line 'return 1, 2, function()' is supposed to be excluded,
-- but corresponding exclusion rule is bugged, see #27.
test [[
   local function foo(f)      -
      return 1, 2, function() +
         a = a                +
      end                     -
   end                        -
   local a,b,c = foo()        +
   c()                        +
                              -
   print("test11")            +
]]

-- Lines inside long strings.
test [=[
print([[         +
some long string -
]==]             -
still going      -
end]])           +
]=]

-- Assignments of long strings.
test [=[
local s = [[ ?
abc          -
]]           +
]=]

test [=[
s = [[ ?
abc    -
]]     +
]=]

test [=[
t.k = [[ ?
abc      -
]]       +
]=]

test [=[
t.k1.k2 = [[ +
abc          -
]]           +
]=]

test [=[
t["k"] = [[ ?
abc         -
]]          +
]=]

-- Inline long comments.
test [=[
local function foo(--[[unused]] x) -
   return x                        +
end                                -
]=]

-- Chaotic whitespace.
test [=[
  while     true     do -
      end               -
]=]

-- Strange strings.
test [=[
local a = "[[\ ?
]]\            -
print(b)"      +
print(a)       +
]=]

test [=[
local a = ("\     +
local function(") +
]=]

-- Incomplete function declarations.
test [[
local function fff(a, -
   b,                 -
   c)                 -
   return a + b + c   +
end                   -
]]

test [[
local function fff( -
      a, b, c)      -
   return a + b + c +
end                 -
]]

test [[
local function fff  -
      (a, b, c)     -
   return a + b + c +
end                 -
]]

-- Local declarations
test [[
local function f() end +
local x                -
local x, y             -
local x =              -
1                      +
local x, y =           -
2, 3                   +
]]

print(("%d LineScanner tests passed."):format(ntests))