805838 - Allow JavaScript Marionette tests to import a script for common code

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, defect)

Description

[Dave Hunt [:davehunt] [he/him] ⌚BST]

In order to reduce duplication across WebAPI tests, it would be beneficial to allow importing of JavaScript files containing common functions.

Comment 1

[Malini Das [:mdas] - Away, not checking bugmail]

We'll have a way to import scripts as soon as we land the change in this bug.

Comment 2

[Henrik Skupin [:whimboo][⌚️UTC+2]]

I believe it will be good to keep this bug open regarding any dependency we have here to create Marionette tests. Bug 797912 is too general to understand why we depend on it. Usually we add a dependency in such a case.

Comment 3

[Jonathan Griffin (:jgriffin)]

Yes, this won't be helped by bug 797912, because this will need to call back into the client to fetch the script to load.

Comment 4

[Jonathan Griffin (:jgriffin)]

This will require a completely separate implementation from bug 797912, so am removing that as a dependency.

Comment 7

[Szu-Yu Chen [:aknow] (inactive)]

What's the current status of this one? I've raise a duplicate bug 917223 and come here from that bug.

Another duplicate Bug 734189 suggest a node.js-style 'require' statement. For that solution, We might need to handle the scope issue and manipulate the js script.

In bug 917223, my initial idea is to introduce a tag in the test script

  MARIONETTE_JS_HEADER = 'head.js';

We could just simply prepend the head.js and the run the script. It could be implement in marionette client.

Comment 8

[Jonathan Griffin (:jgriffin)]

I like the head.js approach, as it's considerably simpler than a 'require' implementation.

Comment 9

[Szu-Yu Chen [:aknow] (inactive)]

Attachment: Add MARIONETTE_HEAD_JS support

Comment 10

[Szu-Yu Chen [:aknow] (inactive)]

Attachment: Example test with head.js

Example test case that use head.js to do some common setup and teardown works.

Comment 11

[Szu-Yu Chen [:aknow] (inactive)]

(In reply to Szu-Yu Chen [:aknow] from comment #9)
> Created attachment 806416 [details] [diff] [review]
> Add MARIONETTE_HEAD_JS support

Some limitation now.
1. Only allow to prepend 1 head.js.
2. Not allow nested HEAD. We should not put the line of MARIONETTE_HEAD_JS = xxx in some head.js

It's not hard to break the above limitations. However, I would like to keep them as the restrictions and make everything simple.

Comment 12

[Jonathan Griffin (:jgriffin)]

Comment on attachment 806416 [details] [diff] [review]
Add MARIONETTE_HEAD_JS support

Review of attachment 806416 [details] [diff] [review]:
-----------------------------------------------------------------

Looks great, thanks for the patch!

Comment 13

[Szu-Yu Chen [:aknow] (inactive)]

Attachment: [Final] Add MARIONETTE_HEAD_JS support. r=jgriffin

Comment 14

[Szu-Yu Chen [:aknow] (inactive)]

https://tbpl.mozilla.org/?tree=Try&rev=0ee487cbd753

Comment 15

[Szu-Yu Chen [:aknow] (inactive)]

We should also update the mdn for the new test flag (MARIONETTE_HEAD_JS).
https://developer.mozilla.org/en-US/docs/Marionette/Marionette_JavaScript_Tests

Comment 16

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/b2g-inbound/rev/ecae0b6f22e3

Comment 17

[Ed Morley [:emorley]]

https://hg.mozilla.org/mozilla-central/rev/ecae0b6f22e3

Comment 18

[Jonathan Griffin (:jgriffin)]

https://hg.mozilla.org/releases/mozilla-b2g26_v1_2/rev/4fbe1b01ed63