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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
|
// SPDX-License-Identifier: MIT OR LGPL-2.0-or-later
// SPDX-FileCopyrightText: 2016 Endless Mobile, Inc.
#include <config.h>
#include <stdint.h>
#include <string.h> // for strlen, strstr
#include <glib.h>
#include <js/CallArgs.h>
#include <js/CompilationAndEvaluation.h>
#include <js/CompileOptions.h>
#include <js/PropertyAndElement.h>
#include <js/PropertySpec.h>
#include <js/RootingAPI.h>
#include <js/SourceText.h>
#include <js/String.h>
#include <js/TypeDecls.h>
#include <js/Utility.h> // for UniqueChars
#include "gjs/jsapi-util-args.h"
#include "gjs/jsapi-util.h"
#include "test/gjs-test-common.h"
#include "test/gjs-test-utils.h"
namespace mozilla {
union Utf8Unit;
}
// COMPAT: https://gitlab.gnome.org/GNOME/glib/-/merge_requests/1553
#ifdef __clang_analyzer__
void g_assertion_message(const char*, const char*, int, const char*,
const char*) __attribute__((analyzer_noreturn));
#endif
#define assert_match(str, pattern) \
G_STMT_START { \
const char *__s1 = (str), *__s2 = (pattern); \
if (!g_pattern_match_simple(__s2, __s1)) { \
g_assertion_message_cmpstr( \
G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
"assertion failed (\"" #str "\" matches \"" #pattern "\")", \
__s1, "~=", __s2); \
} \
} \
G_STMT_END
typedef enum _test_enum {
ZERO,
ONE,
TWO,
THREE
} test_enum_t;
typedef enum _test_signed_enum {
MINUS_THREE = -3,
MINUS_TWO,
MINUS_ONE
} test_signed_enum_t;
#define JSNATIVE_TEST_FUNC_BEGIN(name) \
static bool \
name(JSContext *cx, \
unsigned argc, \
JS::Value *vp) \
{ \
JS::CallArgs args = JS::CallArgsFromVp(argc, vp); \
bool retval;
#define JSNATIVE_TEST_FUNC_END \
if (retval) \
args.rval().setUndefined(); \
return retval; \
}
JSNATIVE_TEST_FUNC_BEGIN(no_args)
retval = gjs_parse_call_args(cx, "noArgs", args, "");
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(no_args_ignore_trailing)
retval = gjs_parse_call_args(cx, "noArgsIgnoreTrailing", args, "!");
JSNATIVE_TEST_FUNC_END
#define JSNATIVE_NO_ASSERT_TYPE_TEST_FUNC(type, fmt) \
JSNATIVE_TEST_FUNC_BEGIN(type##_arg_no_assert) \
type val; \
retval = gjs_parse_call_args(cx, #type "ArgNoAssert", args, fmt, \
"val", &val); \
JSNATIVE_TEST_FUNC_END
JSNATIVE_NO_ASSERT_TYPE_TEST_FUNC(bool, "b");
JSNATIVE_NO_ASSERT_TYPE_TEST_FUNC(int, "i");
#undef JSNATIVE_NO_ASSERT_TYPE_TEST_FUNC
JSNATIVE_TEST_FUNC_BEGIN(object_arg_no_assert)
JS::RootedObject val(cx);
retval = gjs_parse_call_args(cx, "objectArgNoAssert", args, "o",
"val", &val);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(optional_int_args_no_assert)
int val1, val2;
retval = gjs_parse_call_args(cx, "optionalIntArgsNoAssert", args, "i|i",
"val1", &val1,
"val2", &val2);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(args_ignore_trailing)
int val;
retval = gjs_parse_call_args(cx, "argsIgnoreTrailing", args, "!i",
"val", &val);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(one_of_each_type)
bool boolval;
JS::UniqueChars strval;
GjsAutoChar fileval;
JS::RootedString jsstrval(cx);
int intval;
unsigned uintval;
int64_t int64val;
double dblval;
JS::RootedObject objval(cx);
retval = gjs_parse_call_args(
cx, "oneOfEachType", args, "bsFSiutfo", "bool", &boolval, "str",
&strval, "file", &fileval, "jsstr", &jsstrval, "int", &intval, "uint",
&uintval, "int64", &int64val, "dbl", &dblval, "obj", &objval);
g_assert_cmpint(boolval, ==, true);
g_assert_cmpstr(strval.get(), ==, "foo");
g_assert_cmpstr(fileval, ==, "foo");
bool match;
bool ok = JS_StringEqualsLiteral(cx, jsstrval, "foo", &match);
g_assert_true(ok);
g_assert_true(match);
g_assert_cmpint(intval, ==, 1);
g_assert_cmpint(uintval, ==, 1);
g_assert_cmpint(int64val, ==, 1);
g_assert_cmpfloat(dblval, ==, 1.0);
g_assert_true(objval);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(optional_args_all)
bool val1, val2, val3;
retval = gjs_parse_call_args(cx, "optionalArgsAll", args, "b|bb",
"val1", &val1,
"val2", &val2,
"val3", &val3);
g_assert_cmpint(val1, ==, true);
g_assert_cmpint(val2, ==, true);
g_assert_cmpint(val3, ==, true);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(optional_args_only_required)
bool val1 = false, val2 = false, val3 = false;
retval = gjs_parse_call_args(cx, "optionalArgsOnlyRequired", args, "b|bb",
"val1", &val1,
"val2", &val2,
"val3", &val3);
g_assert_cmpint(val1, ==, true);
g_assert_cmpint(val2, ==, false);
g_assert_cmpint(val3, ==, false);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(only_optional_args)
int val1, val2;
retval = gjs_parse_call_args(cx, "onlyOptionalArgs", args, "|ii",
"val1", &val1,
"val2", &val2);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(unsigned_enum_arg)
test_enum_t val;
retval = gjs_parse_call_args(cx, "unsignedEnumArg", args, "i",
"enum_param", &val);
g_assert_cmpint(val, ==, ONE);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(signed_enum_arg)
test_signed_enum_t val;
retval = gjs_parse_call_args(cx, "signedEnumArg", args, "i",
"enum_param", &val);
g_assert_cmpint(val, ==, MINUS_ONE);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(one_of_each_nullable_type)
JS::UniqueChars strval;
GjsAutoChar fileval;
JS::RootedString jsstrval(cx);
JS::RootedObject objval(cx);
retval = gjs_parse_call_args(cx, "oneOfEachNullableType", args, "?s?F?S?o",
"strval", &strval, "fileval", &fileval,
"jsstrval", &jsstrval, "objval", &objval);
g_assert_null(strval);
g_assert_null(fileval);
g_assert_false(jsstrval);
g_assert_false(objval);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(unwind_free_test)
int intval;
unsigned uval;
JS::RootedString jsstrval(cx);
JS::RootedObject objval(cx);
retval = gjs_parse_call_args(cx, "unwindFreeTest", args, "oSiu", "objval",
&objval, "jsstrval", &jsstrval, "intval",
&intval, "error", &uval);
g_assert_false(objval);
g_assert_false(jsstrval);
JSNATIVE_TEST_FUNC_END
#define JSNATIVE_BAD_NULLABLE_TEST_FUNC(type, fmt) \
JSNATIVE_TEST_FUNC_BEGIN(type##_invalid_nullable) \
type val; \
retval = gjs_parse_call_args(cx, #type "InvalidNullable", \
args, "?" fmt, \
"val", &val); \
JSNATIVE_TEST_FUNC_END
JSNATIVE_BAD_NULLABLE_TEST_FUNC(bool, "b");
JSNATIVE_BAD_NULLABLE_TEST_FUNC(int, "i");
JSNATIVE_BAD_NULLABLE_TEST_FUNC(unsigned, "u");
JSNATIVE_BAD_NULLABLE_TEST_FUNC(int64_t, "t");
JSNATIVE_BAD_NULLABLE_TEST_FUNC(double, "f");
#undef JSNATIVE_BAD_NULLABLE_TEST_FUNC
#define JSNATIVE_BAD_TYPE_TEST_FUNC(type, ch) \
JSNATIVE_TEST_FUNC_BEGIN(type##_invalid_type) \
type val; \
retval = gjs_parse_call_args(cx, #type "InvalidType", args, ch, \
"val", &val); \
JSNATIVE_TEST_FUNC_END
JSNATIVE_BAD_TYPE_TEST_FUNC(bool, "i");
JSNATIVE_BAD_TYPE_TEST_FUNC(int, "u");
JSNATIVE_BAD_TYPE_TEST_FUNC(unsigned, "t");
JSNATIVE_BAD_TYPE_TEST_FUNC(int64_t, "f");
JSNATIVE_BAD_TYPE_TEST_FUNC(double, "b");
JSNATIVE_BAD_TYPE_TEST_FUNC(GjsAutoChar, "i");
#undef JSNATIVE_BAD_TYPE_TEST_FUNC
JSNATIVE_TEST_FUNC_BEGIN(UniqueChars_invalid_type)
JS::UniqueChars value;
retval = gjs_parse_call_args(cx, "UniqueCharsInvalidType", args, "i",
"value", &value);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(JSString_invalid_type)
JS::RootedString val(cx);
retval =
gjs_parse_call_args(cx, "JSStringInvalidType", args, "i", "val", &val);
JSNATIVE_TEST_FUNC_END
JSNATIVE_TEST_FUNC_BEGIN(object_invalid_type)
JS::RootedObject val(cx);
retval = gjs_parse_call_args(cx, "objectInvalidType", args, "i",
"val", &val);
JSNATIVE_TEST_FUNC_END
static JSFunctionSpec native_test_funcs[] = {
JS_FN("noArgs", no_args, 0, 0),
JS_FN("noArgsIgnoreTrailing", no_args_ignore_trailing, 0, 0),
JS_FN("boolArgNoAssert", bool_arg_no_assert, 0, 0),
JS_FN("intArgNoAssert", int_arg_no_assert, 0, 0),
JS_FN("objectArgNoAssert", object_arg_no_assert, 0, 0),
JS_FN("optionalIntArgsNoAssert", optional_int_args_no_assert, 0, 0),
JS_FN("argsIgnoreTrailing", args_ignore_trailing, 0, 0),
JS_FN("oneOfEachType", one_of_each_type, 0, 0),
JS_FN("optionalArgsAll", optional_args_all, 0, 0),
JS_FN("optionalArgsOnlyRequired", optional_args_only_required, 0, 0),
JS_FN("onlyOptionalArgs", only_optional_args, 0, 0),
JS_FN("unsignedEnumArg", unsigned_enum_arg, 0, 0),
JS_FN("signedEnumArg", signed_enum_arg, 0, 0),
JS_FN("oneOfEachNullableType", one_of_each_nullable_type, 0, 0),
JS_FN("unwindFreeTest", unwind_free_test, 0, 0),
JS_FN("boolInvalidNullable", bool_invalid_nullable, 0, 0),
JS_FN("intInvalidNullable", int_invalid_nullable, 0, 0),
JS_FN("unsignedInvalidNullable", unsigned_invalid_nullable, 0, 0),
JS_FN("int64_tInvalidNullable", int64_t_invalid_nullable, 0, 0),
JS_FN("doubleInvalidNullable", double_invalid_nullable, 0, 0),
JS_FN("boolInvalidType", bool_invalid_type, 0, 0),
JS_FN("intInvalidType", int_invalid_type, 0, 0),
JS_FN("unsignedInvalidType", unsigned_invalid_type, 0, 0),
JS_FN("int64_tInvalidType", int64_t_invalid_type, 0, 0),
JS_FN("doubleInvalidType", double_invalid_type, 0, 0),
JS_FN("GjsAutoCharInvalidType", GjsAutoChar_invalid_type, 0, 0),
JS_FN("UniqueCharsInvalidType", UniqueChars_invalid_type, 0, 0),
JS_FN("JSStringInvalidType", JSString_invalid_type, 0, 0),
JS_FN("objectInvalidType", object_invalid_type, 0, 0),
JS_FS_END};
static void
setup(GjsUnitTestFixture *fx,
gconstpointer unused)
{
gjs_unit_test_fixture_setup(fx, unused);
JS::RootedObject global(fx->cx, gjs_get_import_global(fx->cx));
bool success = JS_DefineFunctions(fx->cx, global, native_test_funcs);
g_assert_true(success);
}
static void
run_code(GjsUnitTestFixture *fx,
gconstpointer code)
{
const char *script = (const char *) code;
JS::SourceText<mozilla::Utf8Unit> source;
bool ok = source.init(fx->cx, script, strlen(script),
JS::SourceOwnership::Borrowed);
g_assert_true(ok);
JS::CompileOptions options(fx->cx);
options.setFileAndLine("unit test", 1);
JS::RootedValue ignored(fx->cx);
ok = JS::Evaluate(fx->cx, options, source, &ignored);
g_assert_null(gjs_test_get_exception_message(fx->cx));
g_assert_true(ok);
}
static void
run_code_expect_exception(GjsUnitTestFixture *fx,
gconstpointer code)
{
const char *script = (const char *) code;
JS::SourceText<mozilla::Utf8Unit> source;
bool ok = source.init(fx->cx, script, strlen(script),
JS::SourceOwnership::Borrowed);
g_assert_true(ok);
JS::CompileOptions options(fx->cx);
options.setFileAndLine("unit test", 1);
JS::RootedValue ignored(fx->cx);
ok = JS::Evaluate(fx->cx, options, source, &ignored);
g_assert_false(ok);
GjsAutoChar message = gjs_test_get_exception_message(fx->cx);
g_assert_nonnull(message);
/* Cheap way to shove an expected exception message into the data argument */
const char *expected_msg = strstr((const char *) code, "//");
if (expected_msg != NULL) {
expected_msg += 2;
assert_match(message, expected_msg);
}
}
void
gjs_test_add_tests_for_parse_call_args(void)
{
#define ADD_CALL_ARGS_TEST_BASE(path, code, f) \
g_test_add("/callargs/" path, GjsUnitTestFixture, code, setup, f, \
gjs_unit_test_fixture_teardown)
#define ADD_CALL_ARGS_TEST(path, code) \
ADD_CALL_ARGS_TEST_BASE(path, code, run_code)
#define ADD_CALL_ARGS_TEST_XFAIL(path, code) \
ADD_CALL_ARGS_TEST_BASE(path, code, run_code_expect_exception)
ADD_CALL_ARGS_TEST("no-args-works", "noArgs()");
ADD_CALL_ARGS_TEST_XFAIL("no-args-fails-on-extra-args",
"noArgs(1, 2, 3)//*Expected 0 arguments, got 3");
ADD_CALL_ARGS_TEST("no-args-ignores-trailing",
"noArgsIgnoreTrailing(1, 2, 3)");
ADD_CALL_ARGS_TEST_XFAIL("too-many-args-fails",
"intArgNoAssert(1, 2)"
"//*Expected 1 arguments, got 2");
ADD_CALL_ARGS_TEST_XFAIL("too-many-args-fails-when-more-than-optional",
"optionalIntArgsNoAssert(1, 2, 3)"
"//*Expected minimum 1 arguments (and 1 optional), got 3");
ADD_CALL_ARGS_TEST_XFAIL("too-few-args-fails",
"intArgNoAssert()//*At least 1 argument required, "
"but only 0 passed");
ADD_CALL_ARGS_TEST_XFAIL("too-few-args-fails-with-optional",
"optionalIntArgsNoAssert()//*At least 1 argument "
"required, but only 0 passed");
ADD_CALL_ARGS_TEST("args-ignores-trailing", "argsIgnoreTrailing(1, 2, 3)");
ADD_CALL_ARGS_TEST(
"one-of-each-type-works",
"oneOfEachType(true, 'foo', 'foo', 'foo', 1, 1, 1, 1, {})");
ADD_CALL_ARGS_TEST("optional-args-work-when-passing-all-args",
"optionalArgsAll(true, true, true)");
ADD_CALL_ARGS_TEST("optional-args-work-when-passing-only-required-args",
"optionalArgsOnlyRequired(true)");
ADD_CALL_ARGS_TEST("enum-types-work", "unsignedEnumArg(1)");
ADD_CALL_ARGS_TEST("signed-enum-types-work", "signedEnumArg(-1)");
ADD_CALL_ARGS_TEST("one-of-each-nullable-type-works",
"oneOfEachNullableType(null, null, null, null)");
ADD_CALL_ARGS_TEST("passing-no-arguments-when-all-optional",
"onlyOptionalArgs()");
ADD_CALL_ARGS_TEST("passing-some-arguments-when-all-optional",
"onlyOptionalArgs(1)");
ADD_CALL_ARGS_TEST("passing-all-arguments-when-all-optional",
"onlyOptionalArgs(1, 1)");
ADD_CALL_ARGS_TEST_XFAIL("allocated-args-are-freed-on-error",
"unwindFreeTest({}, 'foo', 1, -1)"
"//*Value * is out of range");
ADD_CALL_ARGS_TEST_XFAIL("nullable-bool-is-invalid",
"boolInvalidNullable(true)"
"//*Invalid format string combination ?b");
ADD_CALL_ARGS_TEST_XFAIL("nullable-int-is-invalid",
"intInvalidNullable(1)"
"//*Invalid format string combination ?i");
ADD_CALL_ARGS_TEST_XFAIL("nullable-unsigned-is-invalid",
"unsignedInvalidNullable(1)"
"//*Invalid format string combination ?u");
ADD_CALL_ARGS_TEST_XFAIL("nullable-int64-is-invalid",
"int64_tInvalidNullable(1)"
"//*Invalid format string combination ?t");
ADD_CALL_ARGS_TEST_XFAIL("nullable-double-is-invalid",
"doubleInvalidNullable(1)"
"//*Invalid format string combination ?f");
ADD_CALL_ARGS_TEST_XFAIL("invalid-bool-type",
"boolInvalidType(1)"
"//*Wrong type for i, got bool?");
ADD_CALL_ARGS_TEST_XFAIL("invalid-int-type",
"intInvalidType(1)"
"//*Wrong type for u, got int32_t?");
ADD_CALL_ARGS_TEST_XFAIL("invalid-unsigned-type",
"unsignedInvalidType(1)"
"//*Wrong type for t, got uint32_t?");
ADD_CALL_ARGS_TEST_XFAIL("invalid-int64-type",
"int64_tInvalidType(1)"
"//*Wrong type for f, got int64_t?");
ADD_CALL_ARGS_TEST_XFAIL("invalid-double-type",
"doubleInvalidType(false)"
"//*Wrong type for b, got double?");
ADD_CALL_ARGS_TEST_XFAIL("invalid-autochar-type",
"GjsAutoCharInvalidType(1)"
"//*Wrong type for i, got GjsAutoChar?");
ADD_CALL_ARGS_TEST_XFAIL("invalid-autojschar-type",
"UniqueCharsInvalidType(1)"
"//*Wrong type for i, got JS::UniqueChars?");
ADD_CALL_ARGS_TEST_XFAIL(
"invalid-jsstring-type",
"JSStringInvalidType(1)"
"//*Wrong type for i, got JS::MutableHandleString");
ADD_CALL_ARGS_TEST_XFAIL("invalid-object-type",
"objectInvalidType(1)"
"//*Wrong type for i, got JS::MutableHandleObject");
ADD_CALL_ARGS_TEST_XFAIL("invalid-boolean",
"boolArgNoAssert({})//*Not a boolean");
ADD_CALL_ARGS_TEST_XFAIL("invalid-object",
"objectArgNoAssert(3)//*Not an object");
#undef ADD_CALL_ARGS_TEST_XFAIL
#undef ADD_CALL_ARGS_TEST
#undef ADD_CALL_ARGS_TEST_BASE
}
|
