summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/Scribunto/tests/phpunit/engines/LuaCommon/LibraryUtilTests.lua
blob: 8855742c4502e2e009ba21cf8bf7d3be448212cd (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
--[[
	Tests for the libraryUtil module

	@license GNU GPL v2+
	@author Mr. Stradivarius < misterstrad@gmail.com >
]]

local testframework = require 'Module:TestFramework'

local util = require( 'libraryUtil' )
local checkType = util.checkType
local checkTypeMulti = util.checkTypeMulti
local checkTypeForIndex = util.checkTypeForIndex
local checkTypeForNamedArg = util.checkTypeForNamedArg
local makeCheckSelfFunction = util.makeCheckSelfFunction

local function testExpectTypes( arg, expectTypes )
	pcall( checkTypeMulti, 'myFunc', 1, arg, expectTypes )
	return unpack( expectTypes )
end

local function testCheckSelf( self, method, ... )
	local checkSelf = makeCheckSelfFunction( ... )
	return checkSelf( self, method )
end

local testObject = {}

-- Tests
local tests = {
	-- checkType
	{ name = 'checkType, valid', func = checkType, type='ToString',
	  args = { 'myFunc', 1, 'foo', 'string' },
	  expect = { nil }
	},
	{ name = 'checkType, invalid', func = checkType, type='ToString',
	  args = { 'myFunc', 1, 9, 'string' },
	  expect = "bad argument #1 to 'myFunc' (string expected, got number)"
	},
	{ name = 'checkType, nil valid', func = checkType, type='ToString',
	  args = { 'myFunc', 1, nil, 'string', true },
	  expect = { nil }
	},
	{ name = 'checkType, nil invalid', func = checkType, type='ToString',
	  args = { 'myFunc', 1, nil, 'string', false },
	  expect = "bad argument #1 to 'myFunc' (string expected, got nil)"
	},
	{ name = 'checkType, boolean', func = checkType, type='ToString',
	  args = { 'myFunc', 1, true, 'boolean' },
	  expect = { nil }
	},
	{ name = 'checkType, table', func = checkType, type='ToString',
	  args = { 'myFunc', 1, {}, 'table' },
	  expect = { nil }
	},
	{ name = 'checkType, function', func = checkType, type='ToString',
	  args = { 'myFunc', 1, function () return end, 'function' },
	  expect = { nil }
	},
	{ name = 'checkType, argument #2', func = checkType, type='ToString',
	  args = { 'myFunc', 2, 9, 'string' },
	  expect = "bad argument #2 to 'myFunc' (string expected, got number)"
	},
	{ name = 'checkType, name', func = checkType, type='ToString',
	  args = { 'otherFunc', 1, 9, 'string' },
	  expect = "bad argument #1 to 'otherFunc' (string expected, got number)"
	},

	-- checkTypeMulti
	{ name = 'checkTypeMulti, single valid', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, 'foo', { 'string' } },
	  expect = { nil }
	},
	{ name = 'checkTypeMulti, single type invalid (1)', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, 9, { 'string' } },
	  expect = "bad argument #1 to 'myFunc' (string expected, got number)"
	},
	{ name = 'checkTypeMulti, single type invalid (2)', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, nil, { 'string' } },
	  expect = "bad argument #1 to 'myFunc' (string expected, got nil)"
	},
	{ name = 'checkTypeMulti, multiple types valid (1)', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, 'foo', { 'string', 'number', 'table' } },
	  expect = { nil }
	},
	{ name = 'checkTypeMulti, multiple types valid (2)', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, 9, { 'string', 'number', 'table' } },
	  expect = { nil }
	},
	{ name = 'checkTypeMulti, multiple types valid (3)', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, {}, { 'string', 'number', 'table' } },
	  expect = { nil }
	},
	{ name = 'checkTypeMulti, multiple types invalid (1)', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, true, { 'string', 'number', 'table' } },
	  expect = "bad argument #1 to 'myFunc' (string, number or table expected, got boolean)"
	},
	{ name = 'checkTypeMulti, multiple types invalid (2)', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, nil, { 'string', 'number', 'table' } },
	  expect = "bad argument #1 to 'myFunc' (string, number or table expected, got nil)"
	},
	{ name = 'checkTypeMulti, multiple types invalid (3)', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, function () return end, { 'string', 'number', 'table' } },
	  expect = "bad argument #1 to 'myFunc' (string, number or table expected, got function)"
	},
	{ name = 'checkTypeMulti, two types invalid', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, {}, { 'string', 'number' } },
	  expect = "bad argument #1 to 'myFunc' (string or number expected, got table)"
	},
	{ name = 'checkTypeMulti, type order', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 1, true, { 'table', 'number', 'string' } },
	  expect = "bad argument #1 to 'myFunc' (table, number or string expected, got boolean)"
	},
	{ name = 'checkTypeMulti, argument #2', func = checkTypeMulti, type='ToString',
	  args = { 'myFunc', 2, 9, { 'string' } },
	  expect = "bad argument #2 to 'myFunc' (string expected, got number)"
	},
	{ name = 'checkTypeMulti, other name', func = checkTypeMulti, type='ToString',
	  args = { 'otherFunc', 1, 9, { 'string' } },
	  expect = "bad argument #1 to 'otherFunc' (string expected, got number)"
	},
	{ name = 'checkTypeMulti, expectTypes not altered (1)', func = testExpectTypes, type='ToString',
	  args = { 'foo', { 'string', 'number', 'table' } },
	  expect = { 'string', 'number', 'table' }
	},
	{ name = 'checkTypeMulti, expectTypes not altered (2)', func = testExpectTypes, type='ToString',
	  args = { true, { 'string', 'number', 'table' } },
	  expect = { 'string', 'number', 'table' }
	},
	{ name = 'checkTypeMulti, expectTypes not altered (3)', func = testExpectTypes, type='ToString',
	  args = { 'foo', { 'string' } },
	  expect = { 'string' }
	},
	{ name = 'checkTypeMulti, expectTypes not altered (4)', func = testExpectTypes, type='ToString',
	  args = { true, { 'string' } },
	  expect = { 'string' }
	},

	-- checkTypeForIndex
	{ name = 'checkTypeForIndex, valid', func = checkTypeForIndex, type='ToString',
	  args = { 'foo', 'bar', 'string' },
	  expect = { nil }
	},
	{ name = 'checkTypeForIndex, invalid (1)', func = checkTypeForIndex, type='ToString',
	  args = { 'foo', 9, 'string' },
	  expect = "value for index 'foo' must be string, number given"
	},
	{ name = 'checkTypeForIndex, invalid (2)', func = checkTypeForIndex, type='ToString',
	  args = { 'foo', 9, 'string' },
	  expect = "value for index 'foo' must be string, number given"
	},
	{ name = 'checkTypeForIndex, other index', func = checkTypeForIndex, type='ToString',
	  args = { 'bar', 9, 'string' },
	  expect = "value for index 'bar' must be string, number given"
	},

	-- checkTypeForNamedArg
	{ name = 'checkTypeForNamedArg, valid', func = checkTypeForNamedArg, type='ToString',
	  args = { 'myFunc', 'myArg', 'foo', 'string' },
	  expect = { nil }
	},
	{ name = 'checkTypeForNamedArg, invalid', func = checkTypeForNamedArg, type='ToString',
	  args = { 'myFunc', 'myArg', 9, 'string' },
	  expect = "bad named argument myArg to 'myFunc' (string expected, got number)"
	},
	{ name = 'checkTypeForNamedArg, nil valid', func = checkTypeForNamedArg, type='ToString',
	  args = { 'myFunc', 'myArg', nil, 'string', true },
	  expect = { nil }
	},
	{ name = 'checkTypeForNamedArg, nil invalid', func = checkTypeForNamedArg, type='ToString',
	  args = { 'myFunc', 'myArg', nil, 'string', false },
	  expect = "bad named argument myArg to 'myFunc' (string expected, got nil)"
	},
	{ name = 'checkTypeForNamedArg, other function', func = checkTypeForNamedArg, type='ToString',
	  args = { 'otherFunc', 'myArg', 9, 'string' },
	  expect = "bad named argument myArg to 'otherFunc' (string expected, got number)"
	},
	{ name = 'checkTypeForNamedArg, other argument', func = checkTypeForNamedArg, type='ToString',
	  args = { 'myFunc', 'otherArg', 9, 'string' },
	  expect = "bad named argument otherArg to 'myFunc' (string expected, got number)"
	},

	-- makeCheckSelfFunction
	{ name = 'makeCheckSelfFunction, valid', func = testCheckSelf, type='ToString',
	  args = { testObject, 'myMethod', 'myLibrary', 'myObject', testObject, 'test object' },
	  expect = { nil }
	},
	{ name = 'makeCheckSelfFunction, invalid (1)', func = testCheckSelf, type='ToString',
	  args = { {}, 'myMethod', 'myLibrary', 'myObject', testObject, 'test object' },
	  expect = 'myLibrary: invalid test object. Did you call myMethod with a dot instead ' ..
		'of a colon, i.e. myObject.myMethod() instead of myObject:myMethod()?'
	},
	{ name = 'makeCheckSelfFunction, invalid (2)', func = testCheckSelf, type='ToString',
	  args = { 'foo', 'myMethod', 'myLibrary', 'myObject', testObject, 'test object' },
	  expect = 'myLibrary: invalid test object. Did you call myMethod with a dot instead ' ..
		'of a colon, i.e. myObject.myMethod() instead of myObject:myMethod()?'
	},
	{ name = 'makeCheckSelfFunction, other method', func = testCheckSelf, type='ToString',
	  args = { {}, 'otherMethod', 'myLibrary', 'myObject', testObject, 'test object' },
	  expect = 'myLibrary: invalid test object. Did you call otherMethod with a dot instead ' ..
		'of a colon, i.e. myObject.otherMethod() instead of myObject:otherMethod()?'
	},
	{ name = 'makeCheckSelfFunction, other library', func = testCheckSelf, type='ToString',
	  args = { {}, 'myMethod', 'otherLibrary', 'myObject', testObject, 'test object' },
	  expect = 'otherLibrary: invalid test object. Did you call myMethod with a dot instead ' ..
		'of a colon, i.e. myObject.myMethod() instead of myObject:myMethod()?'
	},
	{ name = 'makeCheckSelfFunction, other object', func = testCheckSelf, type='ToString',
	  args = { {}, 'myMethod', 'otherLibrary', 'otherObject', testObject, 'test object' },
	  expect = 'otherLibrary: invalid test object. Did you call myMethod with a dot instead ' ..
		'of a colon, i.e. otherObject.myMethod() instead of otherObject:myMethod()?'
	},
	{ name = 'makeCheckSelfFunction, other description', func = testCheckSelf, type='ToString',
	  args = { {}, 'myMethod', 'myLibrary', 'myObject', testObject, 'test object' },
	  expect = 'myLibrary: invalid test object. Did you call myMethod with a dot instead ' ..
		'of a colon, i.e. myObject.myMethod() instead of myObject:myMethod()?'
	},
}

return testframework.getTestProvider( tests )