summaryrefslogtreecommitdiff
path: root/test/test-lace.compiler.lua
blob: 89fde98961a6cea722ef8f281bcf0a3884cb3ead (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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
-- test/test-compiler.lua
--
-- Lua Access Control Engine -- Tests for the compiler
--
-- Copyright 2012 Daniel Silverstone <dsilvers@digital-scurf.org>
--
-- For Licence terms, see COPYING
--

-- Step one, start coverage

pcall(require, 'luacov')

local compiler = require 'lace.compiler'
local err = require 'lace.error'

local testnames = {}

local real_assert = assert
local total_asserts = 0
local function assert(...)
   real_assert(...)
   total_asserts = total_asserts + 1
end

local function add_test(suite, name, value)
   rawset(suite, name, value)
   testnames[#testnames+1] = name
end

local suite = setmetatable({}, {__newindex = add_test})

function suite.context_missing()
   local result, msg = compiler.compile(nil, "")
   assert(result == nil, "Lua errors should return nil")
   assert(msg:match("context must be a table"), "Supposed to whinge about context not being a table")
end

function suite.context_missing_dot_lace()
   local result, msg = compiler.compile({}, "")
   assert(result == nil, "Lua errors should return nil")
   assert(msg:match("context must contain"), "Supposed to whinge about context missing _lace")
end

function suite.context_dot_lace_not_table()
   local result, msg = compiler.compile({_lace = true}, "")
   assert(result == nil, "Lua errors should return nil")
   assert(msg:match("context must contain"), "Supposed to whinge about context missing _lace")
end

function suite.source_not_string()
   local result, msg = compiler.compile({_lace = {}}, false)
   assert(result == nil, "Lua errors should return nil")
   assert(msg:match("name must be a string"), "Supposed to whinge about name not being a string")
end

function suite.content_not_string()
   local result, msg = compiler.compile({_lace = {}}, "", false)
   assert(result == nil, "Lua errors should return nil")
   assert(msg:match("must be nil or a string"), "Supposed to whinge about content not being a string but being non-nil")
end

function suite.empty_content_no_loader()
   local result, msg = compiler.compile({_lace = {}}, "", "")
   assert(result == false, "Internal errors should return false")
   assert(msg:match("whatsoever"), "Supposed to whinge about no allow/deny at all")
end

function suite.no_content_no_loader()
   local result, msg = compiler.compile({_lace = {}}, "")
   assert(result == false, "Internal errors should return false")
   assert(msg:match("Ruleset not found:"), "Supposed to whinge about ruleset not being found")
end

function suite.no_unconditional_action()
   local result, msg = compiler.compile({_lace = {}}, "", "deny stuff cond")
   assert(type(result) == "table", "Loading a ruleset should result in a table")
   assert(#result.rules == 2, "There should be two rules present")
   local rule = result.rules[1]
   assert(type(rule) == "table", "Rules should be tables")
   assert(type(rule.fn) == "function", "Rules should have functions")
   assert(type(rule.args) == "table", "Rules should have arguments")
   -- rule 2 should be an unconditional allow with 'Default behaviour' as the reason,
   -- let's check
   local r2a = result.rules[2].args
   assert(r2a[1] == "allow", "Rule 2 should be an allow")
   assert(r2a[2] == "Default behaviour", "Rule 2's reason should be 'Default behaviour'")
   assert(#r2a[3] == 0, "Rule 2 should have no conditions")
end

function suite.no_unconditional_action_default_deny()
   local result, msg = compiler.compile({_lace = {}}, "", "default deny\ndeny stuff cond")
   assert(type(result) == "table", "Loading a ruleset should result in a table")
   assert(#result.rules == 3, "There should be three rules present")
   local rule = result.rules[1]
   assert(type(rule) == "table", "Rules should be tables")
   assert(type(rule.fn) == "function", "Rules should have functions")
   assert(type(rule.args) == "table", "Rules should have arguments")
   -- rule 3 should be an unconditional deny with 'Default behaviour' as the reason,
   -- let's check
   local r3a = result.rules[3].args
   assert(r3a[1] == "deny", "Rule 3 should be a deny, despite last rule behind a deny")
   assert(r3a[2] == "Default behaviour", "Rule 3's reason should be 'Default behaviour'")
   assert(#r3a[3] == 0, "Rule 2 should have no conditions")
end

function suite.is_unconditional_action_default_deny()
   local result, msg = compiler.compile({_lace = {}}, "", "default deny\nallow stuff")
   assert(type(result) == "table", "Loading a ruleset should result in a table")
   assert(#result.rules == 2, "There should be two rules present")
   local rule = result.rules[1]
   assert(type(rule) == "table", "Rules should be tables")
   assert(type(rule.fn) == "function", "Rules should have functions")
   assert(type(rule.args) == "table", "Rules should have arguments")
   -- rule 2 should be an unconditional allow with 'stuff' as the reason
   -- let's check
   local r2a = result.rules[2].args
   assert(r2a[1] == "allow", "Rule 2 should be an allow, despite default being deny")
   assert(r2a[2] == "stuff", "Rule 2's reason should be 'stuff'")
   assert(#r2a[3] == 0, "Rule 2 should have no conditions")
end

-- Now we set up a more useful context and use that going forward:

local comp_context = {
   _lace = {
      loader = function(ctx, name)
		  if name == "THROW_ERROR" then
		     error("THROWN")
		  end
		  local fh = io.open("test/test-lace.compile-" .. name .. ".rules", "r")
		  if not fh then
		     return err.error("LOADER: Unknown: " .. name, {1})
		  end
		  local content = fh:read("*a")
		  fh:close()
		  return "real-" .. name, content
	       end,
      commands = {
	 DISABLEDCOMMAND = false,
      },
      controltype = {
	 nocompile = function()
			return err.error("NOCOMPILE", {2})
		     end,
      },
   },
}

function suite.loader_errors()
   local result, msg = compiler.compile(comp_context, "THROW_ERROR")
   assert(result == nil, "Lua errors should return nil")
   assert(msg:match("THROWN"), "Error returned didn't match what we threw")
end

function suite.load_no_file()
   local result, msg = compiler.compile(comp_context, "NOT_FOUND")
   assert(result == false, "Internal errors should return false")
   assert(msg:match("LOADER: Unknown: NOT_FOUND"), "Error returned didn't match what we returned from loader")
end

function suite.load_file_with_no_rules()
   local result, msg = compiler.compile(comp_context, "nothing")
   assert(result == false, "Internal errors should return false")
   assert(msg:match("whatsoever"), "Error returned didn't match expected whinge about no allow/deny")
end

function suite.load_file_with_bad_command()
   local result, msg = compiler.compile(comp_context, "badcommand")
   assert(result == false, "Internal errors should return false")
   assert(msg:match("BADCOMMAND"), "Error returned did not match the bad command")
end

function suite.load_file_with_disabled_command()
   local result, msg = compiler.compile(comp_context, "disabledcommand")
   assert(result == false, "Internal errors should return false")
   assert(msg:match("is disabled by"), "Error returned did not match the bad command")
end

function suite.load_file_with_bad_deny_command()
   local result, msg = compiler.compile(comp_context, "denynoreason")
   assert(result == false, "Internal errors should return false")
   assert(msg:match("got nothing"), "Error returned did not match expected behaviour from deny")
end

function suite.load_file_with_one_command()
   local result, msg = compiler.compile(comp_context, "denyall")
   assert(type(result) == "table", "Loading a ruleset should result in a table")
   assert(#result.rules == 1, "There should be one rule present")
   local rule = result.rules[1]
   assert(type(rule) == "table", "Rules should be tables")
   assert(type(rule.fn) == "function", "Rules should have functions")
   assert(type(rule.args) == "table", "Rules should have arguments")
end

-- The various error paths must now be tested for location veracity

function suite.error_does_not_exist()
   local result, msg = compiler.compile(comp_context, "does-not-exist")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("does%-not%-exist"), "The first line must mention the error")
   assert(line2 == "Implicit inclusion of does-not-exist :: 1", "The second line is where the error happened")
   assert(line3 == "include does-not-exist", "The third line is the original line")
   assert(line4 == "        ^^^^^^^^^^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_define_anyof1()
   local result, msg = compiler.compile(comp_context, "errorindefineanyof1")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("at least"), "The first line must mention the error")
   assert(line2 == "real-errorindefineanyof1 :: 3", "The second line is where the error happened")
   assert(line3 == "define fish anyof", "The third line is the original line")
   assert(line4 == "            ^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_define_anyof2()
   local result, msg = compiler.compile(comp_context, "errorindefineanyof2")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("at least"), "The first line must mention the error")
   assert(line2 == "real-errorindefineanyof2 :: 3", "The second line is where the error happened")
   assert(line3 == "define fish anyof something", "The third line is the original line")
   assert(line4 == "            ^^^^^ ^^^^^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_allow_or_deny()
   local result, msg = compiler.compile(comp_context, "errorinallow")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("Expected reason"), "The first line must mention the error")
   assert(line2 == "real-errorinallow :: 3", "The second line is where the error happened")
   assert(line3 == "allow", "The third line is the original line")
   assert(line4 == "^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_default1()
   local result, msg = compiler.compile(comp_context, "errorindefault1")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("Expected result"), "The first line must mention the error")
   assert(line2 == "real-errorindefault1 :: 3", "The second line is where the error happened")
   assert(line3 == "default", "The third line is the original line")
   assert(line4 == "^^^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_default2()
   local result, msg = compiler.compile(comp_context, "errorindefault2")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("allow or deny"), "The first line must mention the error")
   assert(line2 == "real-errorindefault2 :: 3", "The second line is where the error happened")
   assert(line3 == "default fish", "The third line is the original line")
   assert(line4 == "        ^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_default3()
   local result, msg = compiler.compile(comp_context, "errorindefault3")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("additional"), "The first line must mention the error")
   assert(line2 == "real-errorindefault3 :: 3", "The second line is where the error happened")
   assert(line3 == 'default allow "" extrashite', "The third line is the original line")
   assert(line4 == "                 ^^^^^^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_default4()
   local result, msg = compiler.compile(comp_context, "errorindefault4")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("Cannot change"), "The first line must mention the error")
   assert(line2 == "real-errorindefault4 :: 5", "The second line is where the error happened")
   assert(line3 == 'default allow', "The third line is the original line")
   assert(line4 == "^^^^^^^ ^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_define1()
   local result, msg = compiler.compile(comp_context, "errorindefine1")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("Expected name"), "The first line must mention the error")
   assert(line2 == "real-errorindefine1 :: 3", "The second line is where the error happened")
   assert(line3 == 'define', "The third line is the original line")
   assert(line4 == "^^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_define2()
   local result, msg = compiler.compile(comp_context, "errorindefine2")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("Bad name"), "The first line must mention the error")
   assert(line2 == "real-errorindefine2 :: 3", "The second line is where the error happened")
   assert(line3 == 'define !fish', "The third line is the original line")
   assert(line4 == "       ^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_define3()
   local result, msg = compiler.compile(comp_context, "errorindefine3")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("Expected control"), "The first line must mention the error")
   assert(line2 == "real-errorindefine3 :: 3", "The second line is where the error happened")
   assert(line3 == 'define fish', "The third line is the original line")
   assert(line4 == "^^^^^^ ^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_define4()
   local result, msg = compiler.compile(comp_context, "errorindefine4")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("Unknown control"), "The first line must mention the error")
   assert(line2 == "real-errorindefine4 :: 3", "The second line is where the error happened")
   assert(line3 == "define fish does_not_exist", "The third line is the original line")
   assert(line4 == "            ^^^^^^^^^^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_define5()
   local result, msg = compiler.compile(comp_context, "errorindefine5")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("NOCOMPILE"), "The first line must mention the error")
   assert(line2 == "real-errorindefine5 :: 3", "The second line is where the error happened")
   assert(line3 == "define fish NOCOMPILE", "The third line is the original line")
   assert(line4 == "            ^^^^^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_include1()
   local result, msg = compiler.compile(comp_context, "errorininclude1")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("No ruleset named"), "The first line must mention the error")
   assert(line2 == "real-errorininclude1 :: 3", "The second line is where the error happened")
   assert(line3 == "include", "The third line is the original line")
   assert(line4 == "^^^^^^^", "The fourth line highlights relevant words")
end

function suite.error_in_include2()
   local result, msg = compiler.compile(comp_context, "errorininclude2")
   assert(result == false, "Errors compiling should return false")
   assert(type(msg) == "string", "Compilation errors should be strings")
   assert(msg:find("\n"), "Compilation errors are multiline")
   local line1, line2, line3, line4 = msg:match("^([^\n]*)\n([^\n]*)\n([^\n]*)\n([^\n]*)$")
   assert(line1:find("NOTFOUND"), "The first line must mention the error")
   assert(line2 == "real-errorininclude2 :: 3", "The second line is where the error happened")
   assert(line3 == "include errorininclude2-NOTFOUND", "The third line is the original line")
   assert(line4 == "        ^^^^^^^^^^^^^^^^^^^^^^^^", "The fourth line highlights relevant words")
end

local count_ok = 0
for _, testname in ipairs(testnames) do
--   print("Run: " .. testname)
   local ok, err = xpcall(suite[testname], debug.traceback)
   if not ok then
      print(err)
      print()
   else
      count_ok = count_ok + 1
   end
end

print(tostring(count_ok) .. "/" .. tostring(#testnames) .. " [" .. tostring(total_asserts) .. "] OK")

os.exit(count_ok == #testnames and 0 or 1)