1442243 - Add multi-session support for GeckoSessionTestRule

Status: RESOLVED FIXED

(GeckoView :: General, enhancement)

Description

[(inactive) Jim Chen [:jchen] [:darchons]]

Add support for using multiple sessions within a test.

Comment 1

[(inactive) Jim Chen [:jchen] [:darchons]]

Attachment: Bug 1442243 - 1. Add GeckoSessionTestRule.env;

Add an env object to GeckoSessionTestRule to easily check if we're in
automation, in e10s mode, etc.

Review commit: https://reviewboard.mozilla.org/r/224314/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/224314/

Comment 2

[(inactive) Jim Chen [:jchen] [:darchons]]

Attachment: Bug 1442243 - 2. Allow Callbacks interfaces for waitUntilCalled(Class<?>);

Allow calls like `waitUntilCalled(Callbacks.NavigationListener::class)`
in addition to `waitUntilCalled(GeckoSession.NavigationListener::class)`.

Review commit: https://reviewboard.mozilla.org/r/224316/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/224316/

Comment 3

[(inactive) Jim Chen [:jchen] [:darchons]]

Attachment: Bug 1442243 - 3. Add ClosedSessionAtStart test annotation;

Add an annotation for having a closed session at the start of a test.

Review commit: https://reviewboard.mozilla.org/r/224318/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/224318/

Comment 4

[(inactive) Jim Chen [:jchen] [:darchons]]

Attachment: Bug 1442243 - 4. Add calls for creating sessions;

Add createOpenSession and createClosedSession to create new sessions
from the test rule. The names are chosen to be explicit about the state
of the newly created session.

Review commit: https://reviewboard.mozilla.org/r/224320/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/224320/

Comment 5

[(inactive) Jim Chen [:jchen] [:darchons]]

Attachment: Bug 1442243 - 5. Add session-specific versions of test rule calls;

Keep track of the session of recorded calls, and add session-specific
overrides of the wait*, for*, and delegate* calls that allow operations
on a particular session. The session-less call will operate on all
sessions.

Review commit: https://reviewboard.mozilla.org/r/224322/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/224322/

Comment 6

[(inactive) Jim Chen [:jchen] [:darchons]]

Attachment: Bug 1442243 - 6. Add BaseSessionTest;

Add BaseSessionTest to provide some common boilerplate code, as well as
Kotlin extension functions for operating on a GeckoSession.

Review commit: https://reviewboard.mozilla.org/r/224324/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/224324/

Comment 7

[(inactive) Jim Chen [:jchen] [:darchons]]

Attachment: Bug 1442243 - 7. Add tests for new session-specific calls/extensions;

Add some tests to GeckoSessionTestRuleTest for the session-specific
calls in the test rule, using the new Kotlin extension functions
provided by BaseSessionTest.

Review commit: https://reviewboard.mozilla.org/r/224326/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/224326/

Comment 8

[James Willcox (:snorp) ([e-mail]) (he/him)]

Comment on attachment 8955151 [details]
Bug 1442243 - 1. Add GeckoSessionTestRule.env;

https://reviewboard.mozilla.org/r/224314/#review231680

::: mobile/android/geckoview/src/androidTest/java/org/mozilla/geckoview/test/rule/GeckoSessionTestRule.java:334
(Diff revision 1)
> +
> +    public class Environment {
> +        /* package */ Environment() {
> +        }
> +
> +        private String getEnvVar(final String name) {

Might be worth caching the key/value pairs in a Bundle for faster lookup later.

::: mobile/android/geckoview/src/androidTest/java/org/mozilla/geckoview/test/rule/GeckoSessionTestRule.java:359
(Diff revision 1)
> +            return mSession.getSettings().getBoolean(
> +                    GeckoSessionSettings.USE_MULTIPROCESS);
> +        }
> +
> +        public boolean isDebugging() {
> +            return Debug.isDebuggerConnected();

Wow, this is really helpful!

Comment 9

[James Willcox (:snorp) ([e-mail]) (he/him)]

Comment on attachment 8955153 [details]
Bug 1442243 - 3. Add ClosedSessionAtStart test annotation;

https://reviewboard.mozilla.org/r/224318/#review231682

Comment 10

[James Willcox (:snorp) ([e-mail]) (he/him)]

Comment on attachment 8955154 [details]
Bug 1442243 - 4. Add calls for creating sessions;

https://reviewboard.mozilla.org/r/224320/#review231684

::: mobile/android/geckoview/src/androidTest/java/org/mozilla/geckoview/test/rule/GeckoSessionTestRule.java:698
(Diff revision 1)
> +        if (!e10s) {
> +            return;
> +        }
>  
> -        if (settings.getBoolean(GeckoSessionSettings.USE_MULTIPROCESS)) {
> -            // Under e10s, we receive an initial about:blank load; don't expose that to the test.
> +        // Under e10s, we receive an initial about:blank load; don't expose that to the test.

This is a giant PITA. We really need to solve the root problem rather than work around it everywhere, but that can happen later.

Comment 11

[James Willcox (:snorp) ([e-mail]) (he/him)]

Comment on attachment 8955155 [details]
Bug 1442243 - 5. Add session-specific versions of test rule calls;

https://reviewboard.mozilla.org/r/224322/#review231686

::: mobile/android/geckoview/src/androidTest/java/org/mozilla/geckoview/test/rule/GeckoSessionTestRule.java:868
(Diff revision 1)
>              }
>          }
>      }
>  
>      /**
>       * Wait until a page load has finished. The session must have started a page load since

Update docs here to indicat that it will wait on all sessions

::: mobile/android/geckoview/src/androidTest/java/org/mozilla/geckoview/test/rule/GeckoSessionTestRule.java:886
(Diff revision 1)
> +    public void waitForPageStop(final GeckoSession session) {
> +        waitForPageStops(session, /* count */ 1);
>      }
>  
>      /**
>       * Wait until a page load has finished. The session must have started a page load since

Same here

Comment 12

[James Willcox (:snorp) ([e-mail]) (he/him)]

Comment on attachment 8955156 [details]
Bug 1442243 - 6. Add BaseSessionTest;

https://reviewboard.mozilla.org/r/224324/#review231688

Comment 13

[James Willcox (:snorp) ([e-mail]) (he/him)]

Comment on attachment 8955157 [details]
Bug 1442243 - 7. Add tests for new session-specific calls/extensions;

https://reviewboard.mozilla.org/r/224326/#review231690

Comment 14

[(inactive) Jim Chen [:jchen] [:darchons]]

Comment on attachment 8955151 [details]
Bug 1442243 - 1. Add GeckoSessionTestRule.env;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/224314/diff/1-2/

Comment 15

[(inactive) Jim Chen [:jchen] [:darchons]]

Comment on attachment 8955152 [details]
Bug 1442243 - 2. Allow Callbacks interfaces for waitUntilCalled(Class<?>);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/224316/diff/1-2/

Comment 16

[(inactive) Jim Chen [:jchen] [:darchons]]

Comment on attachment 8955153 [details]
Bug 1442243 - 3. Add ClosedSessionAtStart test annotation;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/224318/diff/1-2/

Comment 17

[(inactive) Jim Chen [:jchen] [:darchons]]

Comment on attachment 8955154 [details]
Bug 1442243 - 4. Add calls for creating sessions;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/224320/diff/1-2/

Comment 18

[(inactive) Jim Chen [:jchen] [:darchons]]

Comment on attachment 8955155 [details]
Bug 1442243 - 5. Add session-specific versions of test rule calls;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/224322/diff/1-2/

Comment 19

[(inactive) Jim Chen [:jchen] [:darchons]]

Comment on attachment 8955156 [details]
Bug 1442243 - 6. Add BaseSessionTest;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/224324/diff/1-2/

Comment 20

[(inactive) Jim Chen [:jchen] [:darchons]]

Comment on attachment 8955157 [details]
Bug 1442243 - 7. Add tests for new session-specific calls/extensions;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/224326/diff/1-2/

Comment 21

[(inactive) Jim Chen [:jchen] [:darchons]]

Comment on attachment 8955152 [details]
Bug 1442243 - 2. Allow Callbacks interfaces for waitUntilCalled(Class<?>);

https://reviewboard.mozilla.org/r/224316/#review231802

Comment 22

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/72cd096b3ced
1. Add GeckoSessionTestRule.env; r=snorp
https://hg.mozilla.org/integration/autoland/rev/c271ebbb2461
2. Allow Callbacks interfaces for waitUntilCalled(Class<?>); r=jchen
https://hg.mozilla.org/integration/autoland/rev/c7d9be0e00a6
3. Add ClosedSessionAtStart test annotation; r=snorp
https://hg.mozilla.org/integration/autoland/rev/2205567d8b91
4. Add calls for creating sessions; r=snorp
https://hg.mozilla.org/integration/autoland/rev/396f4ce2ae48
5. Add session-specific versions of test rule calls; r=snorp
https://hg.mozilla.org/integration/autoland/rev/775219a5e8ca
6. Add BaseSessionTest; r=snorp
https://hg.mozilla.org/integration/autoland/rev/9703d2406c22
7. Add tests for new session-specific calls/extensions; r=snorp

Comment 23

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/72cd096b3ced
https://hg.mozilla.org/mozilla-central/rev/c271ebbb2461
https://hg.mozilla.org/mozilla-central/rev/c7d9be0e00a6
https://hg.mozilla.org/mozilla-central/rev/2205567d8b91
https://hg.mozilla.org/mozilla-central/rev/396f4ce2ae48
https://hg.mozilla.org/mozilla-central/rev/775219a5e8ca
https://hg.mozilla.org/mozilla-central/rev/9703d2406c22