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
|
/* -*- Mode: Java; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: nil; -*-
* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
package org.mozilla.geckoview.test
import android.content.pm.ActivityInfo
import android.content.res.Configuration
import androidx.test.ext.junit.rules.ActivityScenarioRule
import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.filters.MediumTest
import org.hamcrest.Matchers.* // ktlint-disable no-wildcard-imports
import org.junit.Before
import org.junit.Rule
import org.junit.Test
import org.junit.rules.RuleChain
import org.junit.runner.RunWith
import org.mozilla.geckoview.* // ktlint-disable no-wildcard-imports
import org.mozilla.geckoview.GeckoSession.ContentDelegate
import org.mozilla.geckoview.OrientationController
import org.mozilla.geckoview.test.rule.GeckoSessionTestRule
import org.mozilla.geckoview.test.rule.GeckoSessionTestRule.AssertCalled
import org.mozilla.geckoview.test.rule.GeckoSessionTestRule.WithDisplay
@RunWith(AndroidJUnit4::class)
@MediumTest
class OrientationDelegateTest : BaseSessionTest() {
val activityRule = ActivityScenarioRule(GeckoViewTestActivity::class.java)
@get:Rule
override val rules: RuleChain = RuleChain.outerRule(activityRule).around(sessionRule)
@Before
fun setup() {
sessionRule.setPrefsUntilTestEnd(mapOf("dom.screenorientation.allow-lock" to true))
}
private fun goFullscreen() {
sessionRule.setPrefsUntilTestEnd(mapOf("full-screen-api.allow-trusted-requests-only" to false))
mainSession.loadTestPath(FULLSCREEN_PATH)
mainSession.waitForPageStop()
val promise = mainSession.evaluatePromiseJS("document.querySelector('#fullscreen').requestFullscreen()")
sessionRule.waitUntilCalled(object : ContentDelegate {
@AssertCalled(count = 1)
override fun onFullScreen(session: GeckoSession, fullScreen: Boolean) {
assertThat("Div went fullscreen", fullScreen, equalTo(true))
}
})
promise.value
}
private fun lockPortrait() {
val promise = mainSession.evaluatePromiseJS("screen.orientation.lock('portrait-primary')")
sessionRule.delegateDuringNextWait(object : OrientationController.OrientationDelegate {
@AssertCalled(count = 1)
override fun onOrientationLock(aOrientation: Int): GeckoResult<AllowOrDeny> {
assertThat(
"The orientation should be portrait",
aOrientation,
equalTo(ActivityInfo.SCREEN_ORIENTATION_PORTRAIT),
)
activityRule.scenario.onActivity { activity ->
activity.requestedOrientation = aOrientation
}
return GeckoResult.allow()
}
})
sessionRule.runtime.orientationChanged(Configuration.ORIENTATION_PORTRAIT)
promise.value
// Remove previous delegate
mainSession.waitForRoundTrip()
}
private fun lockLandscape() {
val promise = mainSession.evaluatePromiseJS("screen.orientation.lock('landscape-primary')")
sessionRule.delegateDuringNextWait(object : OrientationController.OrientationDelegate {
@AssertCalled(count = 1)
override fun onOrientationLock(aOrientation: Int): GeckoResult<AllowOrDeny> {
assertThat(
"The orientation should be landscape",
aOrientation,
equalTo(ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE),
)
activityRule.scenario.onActivity { activity ->
activity.requestedOrientation = aOrientation
}
return GeckoResult.allow()
}
})
sessionRule.runtime.orientationChanged(Configuration.ORIENTATION_LANDSCAPE)
promise.value
// Remove previous delegate
mainSession.waitForRoundTrip()
}
@Test fun orientationLock() {
goFullscreen()
activityRule.scenario.onActivity { activity ->
// If the orientation is landscape, lock to portrait and wait for delegate. If portrait, lock to landscape instead.
if (activity.resources.configuration.orientation == ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE) {
lockPortrait()
} else if (activity.resources.configuration.orientation == ActivityInfo.SCREEN_ORIENTATION_PORTRAIT) {
lockLandscape()
}
}
}
@Test fun orientationUnlock() {
goFullscreen()
mainSession.evaluateJS("screen.orientation.unlock()")
sessionRule.waitUntilCalled(object : OrientationController.OrientationDelegate {
@AssertCalled(count = 1)
override fun onOrientationUnlock() {
activityRule.scenario.onActivity { activity ->
activity.requestedOrientation = ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED
}
}
})
}
@Test fun orientationLockedAlready() {
goFullscreen()
// Lock to landscape twice to verify successful locking with existing lock
lockLandscape()
lockLandscape()
}
@Test fun orientationLockedExistingOrientation() {
goFullscreen()
val promise = mainSession.evaluatePromiseJS(
"""
new Promise(resolve => {
if (screen.orientation.type == "landscape-primary") {
resolve();
}
screen.orientation.addEventListener("change", e => {
if (screen.orientation.type == "landscape-primary") {
resolve();
}
}, { once: true });
})
""".trimIndent(),
)
// Lock to landscape twice to verify successful locking to existing orientation
activityRule.scenario.onActivity { activity ->
activity.requestedOrientation = ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE
}
// Wait for orientation change by activity.requestedOrientation.
promise.value
lockLandscape()
}
@Test(expected = GeckoSessionTestRule.RejectedPromiseException::class)
fun orientationLockNoFullscreen() {
// Verify if fullscreen pre-lock conditions are not met, a rejected promise is returned.
mainSession.loadTestPath(FULLSCREEN_PATH)
mainSession.waitForPageStop()
mainSession.evaluateJS("screen.orientation.lock('landscape-primary')")
}
@Test fun orientationLockUnlock() {
goFullscreen()
val promise = mainSession.evaluatePromiseJS("screen.orientation.lock('landscape-primary')")
sessionRule.delegateDuringNextWait(object : OrientationController.OrientationDelegate {
@AssertCalled(count = 1)
override fun onOrientationLock(aOrientation: Int): GeckoResult<AllowOrDeny> {
assertThat(
"The orientation value is as expected",
aOrientation,
equalTo(ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE),
)
activityRule.scenario.onActivity { activity ->
activity.requestedOrientation = aOrientation
}
return GeckoResult.allow()
}
})
sessionRule.runtime.orientationChanged(Configuration.ORIENTATION_LANDSCAPE)
promise.value
// Remove previous delegate
mainSession.waitForRoundTrip()
// after locking to orientation landscape, unlock to default
mainSession.evaluateJS("screen.orientation.unlock()")
sessionRule.waitUntilCalled(object : OrientationController.OrientationDelegate {
@AssertCalled(count = 1)
override fun onOrientationUnlock() {
activityRule.scenario.onActivity { activity ->
activity.requestedOrientation = ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED
}
}
})
}
@Test fun orientationLockUnsupported() {
// If no delegate, orientation.lock must throws NotSupportedError
goFullscreen()
val promise = mainSession.evaluatePromiseJS(
"""
new Promise(r => {
screen.orientation.lock('landscape-primary')
.then(() => r("successful"))
.catch(e => r(e.name))
})
""".trimIndent(),
)
assertThat(
"The operation must throw NotSupportedError",
promise.value,
equalTo("NotSupportedError"),
)
val promise2 = mainSession.evaluatePromiseJS(
"""
new Promise(r => {
screen.orientation.lock(screen.orientation.type)
.then(() => r("successful"))
.catch(e => r(e.name))
})
""".trimIndent(),
)
assertThat(
"The operation must throw NotSupportedError even if same orientation",
promise2.value,
equalTo("NotSupportedError"),
)
}
@WithDisplay(width = 300, height = 200)
@Test
fun orientationUnlockByExitFullscreen() {
goFullscreen()
activityRule.scenario.onActivity { activity ->
// If the orientation is landscape, lock to portrait and wait for delegate. If portrait, lock to landscape instead.
if (activity.resources.configuration.orientation == ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE) {
lockPortrait()
} else if (activity.resources.configuration.orientation == ActivityInfo.SCREEN_ORIENTATION_PORTRAIT) {
lockLandscape()
}
}
val promise = mainSession.evaluatePromiseJS("document.exitFullscreen()")
sessionRule.waitUntilCalled(object : ContentDelegate, OrientationController.OrientationDelegate {
@AssertCalled(count = 1)
override fun onFullScreen(session: GeckoSession, fullScreen: Boolean) {
assertThat("Exited fullscreen", fullScreen, equalTo(false))
}
@AssertCalled(count = 1)
override fun onOrientationUnlock() {
activityRule.scenario.onActivity { activity ->
activity.requestedOrientation = ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED
}
}
})
promise.value
}
@WithDisplay(width = 200, height = 300)
@Test
fun orientationNatural() {
goFullscreen()
// Set orientation to landscape since natural is portrait.
var promise = mainSession.evaluatePromiseJS(
"""
new Promise(resolve => {
if (screen.orientation.type == "landscape-primary") {
resolve();
}
screen.orientation.addEventListener("change", e => {
if (screen.orientation.type == "landscape-primary") {
resolve();
}
}, { once: true });
})
""".trimIndent(),
)
activityRule.scenario.onActivity { activity ->
activity.requestedOrientation = ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE
}
// Wait for orientation change by activity.requestedOrientation.
promise.value
sessionRule.delegateDuringNextWait(object : OrientationController.OrientationDelegate {
@AssertCalled(count = 1)
override fun onOrientationLock(aOrientation: Int): GeckoResult<AllowOrDeny> {
assertThat(
"The orientation should be portrait",
aOrientation,
equalTo(ActivityInfo.SCREEN_ORIENTATION_PORTRAIT),
)
activityRule.scenario.onActivity { activity ->
activity.requestedOrientation = aOrientation
}
return GeckoResult.allow()
}
})
promise = mainSession.evaluatePromiseJS("screen.orientation.lock('natural')")
promise.value
// Remove previous delegate
mainSession.waitForRoundTrip()
}
}
|
