gecko-dev/dom/media/test/gUM_support.js
Bryce Van Dyk 898975f341 Bug 1436523 - Update dom/media/test/ tests to better handle loopback + gUM device config. r=achronop
This changeset adds a gUM_support.js to dom/media/test/. This file provides
functions to setup prefs for loopback or fake device selection before gUM calls
are made. This is useful for configuring tests and providing an explicit point
of reference for settings, rather than the implicit ones provided by the
harness.

Updates tests so that the new helper functions are called before gUM. This
will result in loopback prefs being set if loopback device names are detected,
if not then fake devices will be used. This also removes the use of the fake
constraint in gUM calls.

Update touched tests to use some more modern JS. No behavioural changes were
made (except in minor cases, but functionality should be the same). These
changes are largely as follows:
- var -> let
- async is used in places where I felt it improved readability
- semicolons added to various event handler assignments

MozReview-Commit-ID: 1HuE8thBA6w

--HG--
extra : rebase_source : b866056b2821436cf34ea683421c200b4bb4e55f
2018-02-21 09:11:29 -05:00

88 lines
3.6 KiB
JavaScript

// Support script for test that use getUserMedia. This allows explicit
// configuration of prefs which affect gUM. See also
// `testing/mochitest/runtests.py` for how the harness configures values.
// Setup preconditions for tests using getUserMedia. This functions helps
// manage different prefs that affect gUM calls in tests and makes explicit
// the expected state before test runs.
async function pushGetUserMediaTestPrefs({
fakeAudio = false,
fakeVideo = false,
loopbackAudio = false,
loopbackVideo = false}) {
// Make sure we have sensical arguments
if (!fakeAudio && !loopbackAudio) {
throw new Error("pushGetUserMediaTestPrefs: Should have fake or loopback audio!");
} else if (fakeAudio && loopbackAudio) {
throw new Error("pushGetUserMediaTestPrefs: Should not have both fake and loopback audio!");
}
if (!fakeVideo && !loopbackVideo) {
throw new Error("pushGetUserMediaTestPrefs: Should have fake or loopback video!");
} else if (fakeVideo && loopbackVideo) {
throw new Error("pushGetUserMediaTestPrefs: Should not have both fake and loopback video!");
}
let testPrefs = [];
if (fakeAudio) {
// Unset the loopback device so it doesn't take precedence
testPrefs.push(["media.audio_loopback_dev", ""]);
// Setup fake streams pref
testPrefs.push(["media.navigator.streams.fake", true]);
}
if (loopbackAudio) {
// If audio loopback is requested we expect the test harness to have set
// the loopback device pref, make sure it's set
let audioLoopDev = SpecialPowers.getCharPref("media.audio_loopback_dev", "");
if (!audioLoopDev) {
throw new Error("pushGetUserMediaTestPrefs: Loopback audio requested but " +
"media.audio_loopback_dev does not appear to be set!");
}
}
if (fakeVideo) {
// Unset the loopback device so it doesn't take precedence
testPrefs.push(["media.video_loopback_dev", ""]);
// Setup fake streams pref
testPrefs.push(["media.navigator.streams.fake", true]);
}
if (loopbackVideo) {
// If video loopback is requested we expect the test harness to have set
// the loopback device pref, make sure it's set
let videoLoopDev = SpecialPowers.getCharPref("media.video_loopback_dev", "");
if (!videoLoopDev) {
throw new Error("pushGetUserMediaTestPrefs: Loopback video requested but " +
"media.video_loopback_dev does not appear to be set!");
}
}
if (loopbackAudio || loopbackVideo) {
// Prevent gUM permission prompt. Since loopback devices are considered
// real devices we need to set prefs so the gUM prompt isn't presented.
testPrefs.push(['media.navigator.permission.disabled', true]);
}
return SpecialPowers.pushPrefEnv({set: testPrefs});
}
// Setup preconditions for tests using getUserMedia. This function will
// configure prefs to select loopback device(s) if it can find loopback device
// names already set in the prefs. If no loopback device name can be found then
// prefs are setup such that a fake device is used.
async function setupGetUserMediaTestPrefs() {
prefRequests = {};
let audioLoopDev = SpecialPowers.getCharPref("media.audio_loopback_dev", "");
if (audioLoopDev) {
prefRequests.fakeAudio = false;
prefRequests.loopbackAudio = true;
} else {
prefRequests.fakeAudio = true;
prefRequests.loopbackAudio = false;
}
let videoLoopDev = SpecialPowers.getCharPref("media.video_loopback_dev", "");
if (videoLoopDev) {
prefRequests.fakeVideo = false;
prefRequests.loopbackVideo = true;
} else {
prefRequests.fakeVideo = true;
prefRequests.loopbackVideo = false;
}
return pushGetUserMediaTestPrefs(prefRequests);
}