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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
/* globals chrome */
const PREF_MAX_READ = "webextensions.native-messaging.max-input-message-bytes";
const PREF_MAX_WRITE =
"webextensions.native-messaging.max-output-message-bytes";
const server = createHttpServer({ hosts: ["example.com"] });
server.registerPathHandler("/dummy", (request, response) => {
response.setStatusLine(request.httpVersion, 200, "OK");
response.setHeader("Content-Type", "text/html", false);
response.write("<!DOCTYPE html><html></html>");
});
const ECHO_BODY = String.raw`
import struct
import sys
stdin = getattr(sys.stdin, 'buffer', sys.stdin)
stdout = getattr(sys.stdout, 'buffer', sys.stdout)
while True:
rawlen = stdin.read(4)
if len(rawlen) == 0:
sys.exit(0)
msglen = struct.unpack('@I', rawlen)[0]
msg = stdin.read(msglen)
stdout.write(struct.pack('@I', msglen))
stdout.write(msg)
`;
const INFO_BODY = String.raw`
import json
import os
import struct
import sys
msg = json.dumps({"args": sys.argv, "cwd": os.getcwd()})
if sys.version_info >= (3,):
sys.stdout.buffer.write(struct.pack('@I', len(msg)))
else:
sys.stdout.write(struct.pack('@I', len(msg)))
sys.stdout.write(msg)
sys.exit(0)
`;
const STDERR_LINES = ["hello stderr", "this should be a separate line"];
let STDERR_MSG = STDERR_LINES.join("\\n");
const STDERR_BODY = String.raw`
import sys
sys.stderr.write("${STDERR_MSG}")
`;
let SCRIPTS = [
{
name: "echo",
description: "a native app that echoes back messages it receives",
script: ECHO_BODY.replace(/^ {2}/gm, ""),
},
{
name: "info",
description: "a native app that gives some info about how it was started",
script: INFO_BODY.replace(/^ {2}/gm, ""),
},
{
name: "stderr",
description: "a native app that writes to stderr and then exits",
script: STDERR_BODY.replace(/^ {2}/gm, ""),
},
];
if (AppConstants.platform == "win") {
SCRIPTS.push({
name: "echocmd",
description: "echo but using a .cmd file",
scriptExtension: "cmd",
script: ECHO_BODY.replace(/^ {2}/gm, ""),
});
}
add_task(async function setup() {
await setupHosts(SCRIPTS);
});
// Test the basic operation of native messaging with a simple
// script that echoes back whatever message is sent to it.
add_task(async function test_happy_path() {
function background() {
let port = browser.runtime.connectNative("echo");
port.onMessage.addListener(msg => {
browser.test.sendMessage("message", msg);
});
browser.test.onMessage.addListener((what, payload) => {
if (what == "send") {
if (payload._json) {
let json = payload._json;
payload.toJSON = () => json;
delete payload._json;
}
port.postMessage(payload);
}
});
browser.test.sendMessage("ready");
}
let extension = ExtensionTestUtils.loadExtension({
background,
manifest: {
applications: { gecko: { id: ID } },
permissions: ["nativeMessaging"],
},
});
await extension.startup();
await extension.awaitMessage("ready");
const tests = [
{
data: "this is a string",
what: "simple string",
},
{
data: "Это юникода",
what: "unicode string",
},
{
data: { test: "hello" },
what: "simple object",
},
{
data: {
what: "An object with a few properties",
number: 123,
bool: true,
nested: { what: "another object" },
},
what: "object with several properties",
},
{
data: {
ignoreme: true,
_json: { data: "i have a tojson method" },
},
expected: { data: "i have a tojson method" },
what: "object with toJSON() method",
},
];
for (let test of tests) {
extension.sendMessage("send", test.data);
let response = await extension.awaitMessage("message");
let expected = test.expected || test.data;
deepEqual(response, expected, `Echoed a message of type ${test.what}`);
}
let procCount = await getSubprocessCount();
equal(procCount, 1, "subprocess is still running");
let exitPromise = waitForSubprocessExit();
await extension.unload();
await exitPromise;
});
// Just test that the given app (which should be the echo script above)
// can be started. Used to test corner cases in how the native application
// is located/launched.
async function simpleTest(app) {
function background(appname) {
let port = browser.runtime.connectNative(appname);
let MSG = "test";
port.onMessage.addListener(msg => {
browser.test.assertEq(MSG, msg, "Got expected message back");
browser.test.sendMessage("done");
});
port.postMessage(MSG);
}
let extension = ExtensionTestUtils.loadExtension({
background: `(${background})(${JSON.stringify(app)});`,
manifest: {
applications: { gecko: { id: ID } },
permissions: ["nativeMessaging"],
},
});
await extension.startup();
await extension.awaitMessage("done");
let procCount = await getSubprocessCount();
equal(procCount, 1, "subprocess is still running");
let exitPromise = waitForSubprocessExit();
await extension.unload();
await exitPromise;
}
if (AppConstants.platform == "win") {
// "relative.echo" has a relative path in the host manifest.
add_task(function test_relative_path() {
return simpleTest("relative.echo");
});
// "echocmd" uses a .cmd file instead of a .bat file
add_task(function test_cmd_file() {
return simpleTest("echocmd");
});
}
// Test sendNativeMessage()
add_task(async function test_sendNativeMessage() {
async function background() {
let MSG = { test: "hello world" };
// Check error handling
await browser.test.assertRejects(
browser.runtime.sendNativeMessage("nonexistent", MSG),
/Attempt to postMessage on disconnected port/,
"sendNativeMessage() to a nonexistent app failed"
);
// Check regular message exchange
let reply = await browser.runtime.sendNativeMessage("echo", MSG);
let expected = JSON.stringify(MSG);
let received = JSON.stringify(reply);
browser.test.assertEq(expected, received, "Received echoed native message");
browser.test.sendMessage("finished");
}
let extension = ExtensionTestUtils.loadExtension({
background,
manifest: {
applications: { gecko: { id: ID } },
permissions: ["nativeMessaging"],
},
});
await extension.startup();
await extension.awaitMessage("finished");
// With sendNativeMessage(), the subprocess should be disconnected
// after exchanging a single message.
await waitForSubprocessExit();
await extension.unload();
});
// Test calling Port.disconnect()
add_task(async function test_disconnect() {
function background() {
let port = browser.runtime.connectNative("echo");
port.onMessage.addListener((msg, msgPort) => {
browser.test.assertEq(
port,
msgPort,
"onMessage handler should receive the port as the second argument"
);
browser.test.sendMessage("message", msg);
});
port.onDisconnect.addListener(msgPort => {
browser.test.fail("onDisconnect should not be called for disconnect()");
});
browser.test.onMessage.addListener((what, payload) => {
if (what == "send") {
if (payload._json) {
let json = payload._json;
payload.toJSON = () => json;
delete payload._json;
}
port.postMessage(payload);
} else if (what == "disconnect") {
try {
port.disconnect();
browser.test.assertThrows(
() => port.postMessage("void"),
"Attempt to postMessage on disconnected port"
);
browser.test.sendMessage("disconnect-result", { success: true });
} catch (err) {
browser.test.sendMessage("disconnect-result", {
success: false,
errmsg: err.message,
});
}
}
});
browser.test.sendMessage("ready");
}
let extension = ExtensionTestUtils.loadExtension({
background,
manifest: {
applications: { gecko: { id: ID } },
permissions: ["nativeMessaging"],
},
});
await extension.startup();
await extension.awaitMessage("ready");
extension.sendMessage("send", "test");
let response = await extension.awaitMessage("message");
equal(response, "test", "Echoed a string");
let procCount = await getSubprocessCount();
equal(procCount, 1, "subprocess is running");
extension.sendMessage("disconnect");
response = await extension.awaitMessage("disconnect-result");
equal(response.success, true, "disconnect succeeded");
info("waiting for subprocess to exit");
await waitForSubprocessExit();
procCount = await getSubprocessCount();
equal(procCount, 0, "subprocess is no longer running");
extension.sendMessage("disconnect");
response = await extension.awaitMessage("disconnect-result");
equal(response.success, true, "second call to disconnect silently ignored");
await extension.unload();
});
// Test the limit on message size for writing
add_task(async function test_write_limit() {
Services.prefs.setIntPref(PREF_MAX_WRITE, 10);
function clearPref() {
Services.prefs.clearUserPref(PREF_MAX_WRITE);
}
registerCleanupFunction(clearPref);
function background() {
const PAYLOAD = "0123456789A";
let port = browser.runtime.connectNative("echo");
try {
port.postMessage(PAYLOAD);
browser.test.sendMessage("result", null);
} catch (ex) {
browser.test.sendMessage("result", ex.message);
}
}
let extension = ExtensionTestUtils.loadExtension({
background,
manifest: {
applications: { gecko: { id: ID } },
permissions: ["nativeMessaging"],
},
});
await extension.startup();
let errmsg = await extension.awaitMessage("result");
notEqual(
errmsg,
null,
"native postMessage() failed for overly large message"
);
await extension.unload();
await waitForSubprocessExit();
clearPref();
});
// Test the limit on message size for reading
add_task(async function test_read_limit() {
Services.prefs.setIntPref(PREF_MAX_READ, 10);
function clearPref() {
Services.prefs.clearUserPref(PREF_MAX_READ);
}
registerCleanupFunction(clearPref);
function background() {
const PAYLOAD = "0123456789A";
let port = browser.runtime.connectNative("echo");
port.onDisconnect.addListener(msgPort => {
browser.test.assertEq(
port,
msgPort,
"onDisconnect handler should receive the port as the first argument"
);
browser.test.assertEq(
"Native application tried to send a message of 13 bytes, which exceeds the limit of 10 bytes.",
port.error && port.error.message
);
browser.test.sendMessage("result", "disconnected");
});
port.onMessage.addListener(msg => {
browser.test.sendMessage("result", "message");
});
port.postMessage(PAYLOAD);
}
let extension = ExtensionTestUtils.loadExtension({
background,
manifest: {
applications: { gecko: { id: ID } },
permissions: ["nativeMessaging"],
},
});
await extension.startup();
let result = await extension.awaitMessage("result");
equal(
result,
"disconnected",
"native port disconnected on receiving large message"
);
await extension.unload();
await waitForSubprocessExit();
clearPref();
});
// Test that an extension without the nativeMessaging permission cannot
// use native messaging.
add_task(async function test_ext_permission() {
function background() {
browser.test.assertEq(
chrome.runtime.connectNative,
undefined,
"chrome.runtime.connectNative does not exist without nativeMessaging permission"
);
browser.test.assertEq(
browser.runtime.connectNative,
undefined,
"browser.runtime.connectNative does not exist without nativeMessaging permission"
);
browser.test.assertEq(
chrome.runtime.sendNativeMessage,
undefined,
"chrome.runtime.sendNativeMessage does not exist without nativeMessaging permission"
);
browser.test.assertEq(
browser.runtime.sendNativeMessage,
undefined,
"browser.runtime.sendNativeMessage does not exist without nativeMessaging permission"
);
browser.test.sendMessage("finished");
}
let extension = ExtensionTestUtils.loadExtension({
background,
manifest: {},
});
await extension.startup();
await extension.awaitMessage("finished");
await extension.unload();
});
// Test that an extension that is not listed in allowed_extensions for
// a native application cannot use that application.
add_task(async function test_app_permission() {
function background() {
let port = browser.runtime.connectNative("echo");
port.onDisconnect.addListener(msgPort => {
browser.test.assertEq(
port,
msgPort,
"onDisconnect handler should receive the port as the first argument"
);
browser.test.assertEq(
"No such native application echo",
port.error && port.error.message
);
browser.test.sendMessage("result", "disconnected");
});
port.onMessage.addListener(msg => {
browser.test.sendMessage("result", "message");
});
port.postMessage({ test: "test" });
}
let extension = ExtensionTestUtils.loadExtension(
{
background,
manifest: {
permissions: ["nativeMessaging"],
},
},
"somethingelse@tests.mozilla.org"
);
await extension.startup();
let result = await extension.awaitMessage("result");
equal(
result,
"disconnected",
"connectNative() failed without native app permission"
);
await extension.unload();
let procCount = await getSubprocessCount();
equal(procCount, 0, "No child process was started");
});
// Test that the command-line arguments and working directory for the
// native application are as expected.
add_task(async function test_child_process() {
function background() {
let port = browser.runtime.connectNative("info");
port.onMessage.addListener(msg => {
browser.test.sendMessage("result", msg);
});
}
let extension = ExtensionTestUtils.loadExtension({
background,
manifest: {
applications: { gecko: { id: ID } },
permissions: ["nativeMessaging"],
},
});
await extension.startup();
let msg = await extension.awaitMessage("result");
equal(msg.args.length, 3, "Received two command line arguments");
equal(
msg.args[1],
getPath("info.json"),
"Command line argument is the path to the native host manifest"
);
equal(
msg.args[2],
ID,
"Second command line argument is the ID of the calling extension"
);
equal(
msg.cwd.replace(/^\/private\//, "/"),
OS.Path.join(tmpDir.path, TYPE_SLUG),
"Working directory is the directory containing the native appliation"
);
let exitPromise = waitForSubprocessExit();
await extension.unload();
await exitPromise;
});
add_task(async function test_stderr() {
function background() {
let port = browser.runtime.connectNative("stderr");
port.onDisconnect.addListener(msgPort => {
browser.test.assertEq(
port,
msgPort,
"onDisconnect handler should receive the port as the first argument"
);
browser.test.assertEq(
null,
port.error,
"Normal application exit is not an error"
);
browser.test.sendMessage("finished");
});
}
let { messages } = await promiseConsoleOutput(async function() {
let extension = ExtensionTestUtils.loadExtension({
background,
manifest: {
applications: { gecko: { id: ID } },
permissions: ["nativeMessaging"],
},
});
await extension.startup();
await extension.awaitMessage("finished");
await extension.unload();
await waitForSubprocessExit();
});
let lines = STDERR_LINES.map(line =>
messages.findIndex(msg => msg.message.includes(line))
);
notEqual(lines[0], -1, "Saw first line of stderr output on the console");
notEqual(lines[1], -1, "Saw second line of stderr output on the console");
notEqual(
lines[0],
lines[1],
"Stderr output lines are separated in the console"
);
});
// Test that calling connectNative() multiple times works
// (see bug 1313980 for a previous regression in this area)
add_task(async function test_multiple_connects() {
async function background() {
function once() {
return new Promise(resolve => {
let MSG = "hello";
let port = browser.runtime.connectNative("echo");
port.onMessage.addListener(msg => {
browser.test.assertEq(MSG, msg, "Got expected message back");
port.disconnect();
resolve();
});
port.postMessage(MSG);
});
}
await once();
await once();
browser.test.notifyPass("multiple-connect");
}
let extension = ExtensionTestUtils.loadExtension({
background,
manifest: {
applications: { gecko: { id: ID } },
permissions: ["nativeMessaging"],
},
});
await extension.startup();
await extension.awaitFinish("multiple-connect");
await extension.unload();
});
// Test that native messaging is always rejected on content scripts
add_task(async function test_connect_native_from_content_script() {
async function testScript() {
let port = browser.runtime.connectNative("echo");
port.onDisconnect.addListener(msgPort => {
browser.test.assertEq(
port,
msgPort,
"onDisconnect handler should receive the port as the first argument"
);
browser.test.assertEq(
"An unexpected error occurred",
port.error && port.error.message
);
browser.test.sendMessage("result", "disconnected");
});
port.onMessage.addListener(msg => {
browser.test.sendMessage("result", "message");
});
port.postMessage({ test: "test" });
}
let extension = ExtensionTestUtils.loadExtension({
manifest: {
content_scripts: [
{
run_at: "document_end",
js: ["test.js"],
matches: ["http://example.com/dummy"],
},
],
applications: { gecko: { id: ID } },
permissions: ["nativeMessaging"],
},
files: {
"test.js": testScript,
},
});
await extension.startup();
const page = await ExtensionTestUtils.loadContentPage(
"http://example.com/dummy"
);
let result = await extension.awaitMessage("result");
equal(result, "disconnected", "connectNative() failed from content script");
await page.close();
await extension.unload();
let procCount = await getSubprocessCount();
equal(procCount, 0, "No child process was started");
});
|
