| 0.31.0
| ≥ 3.11 (3.14 Python)
diff --git a/marionette/Cargo.toml b/marionette/Cargo.toml
index 034560c..98a1cc9 100644
--- a/marionette/Cargo.toml
+++ b/marionette/Cargo.toml
@@ -1,6 +1,10 @@
[package]
name = "marionette"
version = "0.2.0"
+description = "Library implementing the client side of Gecko's Marionette remote automation protocol."
+keywords = ["mozilla", "firefox", "marionette", "webdriver"]
+repository = "https://hg.mozilla.org/mozilla-central/file/tip/testing/geckodriver/marionette"
+license = "MPL-2.0"
authors = ["Mozilla"]
edition = "2018"
diff --git a/src/browser.rs b/src/browser.rs
index 306bfe1..902f7f7 100644
--- a/src/browser.rs
+++ b/src/browser.rs
@@ -71,6 +71,7 @@ impl LocalBrowser {
options: FirefoxOptions,
marionette_port: u16,
jsdebugger: bool,
+ profile_root: Option<&Path>,
) -> WebDriverResult {
let binary = options.binary.ok_or_else(|| {
WebDriverError::new(
@@ -87,7 +88,7 @@ impl LocalBrowser {
let mut profile = match options.profile {
ProfileType::Named => None,
ProfileType::Path(x) => Some(x),
- ProfileType::Temporary => Some(Profile::new()?),
+ ProfileType::Temporary => Some(Profile::new(profile_root)?),
};
let (profile_path, prefs_backup) = if let Some(ref mut profile) = profile {
@@ -159,10 +160,12 @@ impl LocalBrowser {
}
}
self.process.kill()?;
+
// Restoring the prefs if the browser fails to stop perhaps doesn't work anyway
if let Some(prefs_backup) = self.prefs_backup {
prefs_backup.restore();
};
+
Ok(())
}
@@ -227,6 +230,7 @@ fn read_marionette_port(profile_path: &Path) -> Option {
pub(crate) struct RemoteBrowser {
handler: AndroidHandler,
marionette_port: u16,
+ prefs_backup: Option,
}
impl RemoteBrowser {
@@ -234,6 +238,7 @@ impl RemoteBrowser {
options: FirefoxOptions,
marionette_port: u16,
websocket_port: Option,
+ profile_root: Option<&Path>,
) -> WebDriverResult {
let android_options = options.android.unwrap();
@@ -248,10 +253,10 @@ impl RemoteBrowser {
));
}
ProfileType::Path(x) => (x, true),
- ProfileType::Temporary => (Profile::new()?, false),
+ ProfileType::Temporary => (Profile::new(profile_root)?, false),
};
- set_prefs(
+ let prefs_backup = set_prefs(
handler.marionette_target_port,
&mut profile,
is_custom_profile,
@@ -272,11 +277,18 @@ impl RemoteBrowser {
Ok(RemoteBrowser {
handler,
marionette_port,
+ prefs_backup,
})
}
fn close(self) -> WebDriverResult<()> {
self.handler.force_stop()?;
+
+ // Restoring the prefs if the browser fails to stop perhaps doesn't work anyway
+ if let Some(prefs_backup) = self.prefs_backup {
+ prefs_backup.restore();
+ };
+
Ok(())
}
@@ -398,7 +410,7 @@ mod tests {
// several regressions related to remote.log.level.
#[test]
fn test_remote_log_level() {
- let mut profile = Profile::new().unwrap();
+ let mut profile = Profile::new(None).unwrap();
set_prefs(2828, &mut profile, false, vec![], false).ok();
let user_prefs = profile.user_prefs().unwrap();
@@ -460,7 +472,7 @@ mod tests {
#[test]
fn test_pref_backup() {
- let mut profile = Profile::new().unwrap();
+ let mut profile = Profile::new(None).unwrap();
// Create some prefs in the profile
let initial_prefs = profile.user_prefs().unwrap();
diff --git a/src/capabilities.rs b/src/capabilities.rs
index 97e1e28..3654cc5 100644
--- a/src/capabilities.rs
+++ b/src/capabilities.rs
@@ -432,7 +432,10 @@ impl FirefoxOptions {
rv.env = FirefoxOptions::load_env(options)?;
rv.log = FirefoxOptions::load_log(options)?;
rv.prefs = FirefoxOptions::load_prefs(options)?;
- if let Some(profile) = FirefoxOptions::load_profile(options)? {
+ if let Some(profile) = FirefoxOptions::load_profile(
+ settings.profile_root.as_ref().map(|x| x.as_path()),
+ options,
+ )? {
rv.profile = ProfileType::Path(profile);
}
}
@@ -554,7 +557,10 @@ impl FirefoxOptions {
Ok(rv)
}
- fn load_profile(options: &Capabilities) -> WebDriverResult> {
+ fn load_profile(
+ profile_root: Option<&Path>,
+ options: &Capabilities,
+ ) -> WebDriverResult> {
if let Some(profile_json) = options.get("profile") {
let profile_base64 = profile_json.as_str().ok_or_else(|| {
WebDriverError::new(ErrorStatus::InvalidArgument, "Profile is not a string")
@@ -562,7 +568,7 @@ impl FirefoxOptions {
let profile_zip = &*base64::decode(profile_base64)?;
// Create an emtpy profile directory
- let profile = Profile::new()?;
+ let profile = Profile::new(profile_root)?;
unzip_buffer(
profile_zip,
profile
diff --git a/src/command.rs b/src/command.rs
index abd65f1..c011238 100644
--- a/src/command.rs
+++ b/src/command.rs
@@ -15,8 +15,6 @@ use webdriver::error::WebDriverResult;
use webdriver::httpapi::WebDriverExtensionRoute;
use webdriver::Parameters;
-pub const CHROME_ELEMENT_KEY: &str = "chromeelement-9fc5-4b51-a3c8-01716eedeb04";
-
pub fn extension_routes() -> Vec<(Method, &'static str, GeckoExtensionRoute)> {
return vec![
(
diff --git a/src/main.rs b/src/main.rs
index 115d650..7742b36 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -17,6 +17,7 @@ extern crate serde;
extern crate serde_derive;
extern crate serde_json;
extern crate serde_yaml;
+extern crate tempfile;
extern crate url;
extern crate uuid;
extern crate webdriver;
@@ -33,7 +34,7 @@ use std::path::PathBuf;
use std::result;
use std::str::FromStr;
-use clap::{App, AppSettings, Arg};
+use clap::{AppSettings, Arg, Command};
macro_rules! try_opt {
($expr:expr, $err_type:expr, $err_msg:expr) => {{
@@ -233,8 +234,8 @@ fn get_allowed_origins(allow_origins: Option) -> Result,
.unwrap_or_else(|| Ok(vec![]))
}
-fn parse_args(app: &mut App) -> ProgramResult {
- let args = app.try_get_matches_from_mut(env::args())?;
+fn parse_args(cmd: &mut Command) -> ProgramResult {
+ let args = cmd.try_get_matches_from_mut(env::args())?;
if args.is_present("help") {
return Ok(Operation::Help);
@@ -267,6 +268,20 @@ fn parse_args(app: &mut App) -> ProgramResult {
let binary = args.value_of("binary").map(PathBuf::from);
+ let profile_root = args.value_of("profile_root").map(PathBuf::from);
+
+ // Try to create a temporary directory on startup to check that the directory exists and is writable
+ {
+ let tmp_dir = if let Some(ref tmp_root) = profile_root {
+ tempfile::tempdir_in(tmp_root)
+ } else {
+ tempfile::tempdir()
+ };
+ if tmp_dir.is_err() {
+ usage!("Unable to write to temporary directory; consider --profile-root with a writeable directory")
+ }
+ }
+
let marionette_host = args.value_of("marionette_host").unwrap();
let marionette_port = match args.value_of("marionette_port") {
Some(s) => match u16::from_str(s) {
@@ -305,6 +320,7 @@ fn parse_args(app: &mut App) -> ProgramResult {
let settings = MarionetteSettings {
binary,
+ profile_root,
connect_existing: args.is_present("connect_existing"),
host: marionette_host.into(),
port: marionette_port,
@@ -324,9 +340,9 @@ fn parse_args(app: &mut App) -> ProgramResult {
})
}
-fn inner_main(app: &mut App) -> ProgramResult<()> {
- match parse_args(app)? {
- Operation::Help => print_help(app),
+fn inner_main(cmd: &mut Command) -> ProgramResult<()> {
+ match parse_args(cmd)? {
+ Operation::Help => print_help(cmd),
Operation::Version => print_version(),
Operation::Server {
@@ -365,16 +381,16 @@ fn inner_main(app: &mut App) -> ProgramResult<()> {
fn main() {
use std::process::exit;
- let mut app = make_app();
+ let mut cmd = make_command();
// use std::process:Termination when it graduates
- exit(match inner_main(&mut app) {
+ exit(match inner_main(&mut cmd) {
Ok(_) => EXIT_SUCCESS,
Err(e) => {
eprintln!("{}: {}", get_program_name(), e);
if !e.help_included() {
- print_help(&mut app);
+ print_help(&mut cmd);
}
e.exit_code()
@@ -382,8 +398,8 @@ fn main() {
});
}
-fn make_app<'a>() -> App<'a> {
- App::new(format!("geckodriver {}", build::build_info()))
+fn make_command<'a>() -> Command<'a> {
+ Command::new(format!("geckodriver {}", build::build_info()))
.setting(AppSettings::NoAutoHelp)
.setting(AppSettings::NoAutoVersion)
.about("WebDriver implementation for Firefox")
@@ -473,6 +489,13 @@ fn make_app<'a>() -> App<'a> {
.long("version")
.help("Prints version and copying information"),
)
+ .arg(
+ Arg::new("profile_root")
+ .long("profile-root")
+ .takes_value(true)
+ .value_name("PROFILE_ROOT")
+ .help("Directory in which to create profiles. Defaults to the system temporary directory."),
+ )
.arg(
Arg::new("android_storage")
.long("android-storage")
@@ -502,8 +525,8 @@ fn get_program_name() -> String {
env::args().next().unwrap()
}
-fn print_help(app: &mut App) {
- app.print_help().ok();
+fn print_help(cmd: &mut Command) {
+ cmd.print_help().ok();
println!();
}
diff --git a/src/marionette.rs b/src/marionette.rs
index 325cc9a..0de05f8 100644
--- a/src/marionette.rs
+++ b/src/marionette.rs
@@ -7,7 +7,7 @@ use crate::build;
use crate::capabilities::{FirefoxCapabilities, FirefoxOptions, ProfileType};
use crate::command::{
AddonInstallParameters, AddonUninstallParameters, GeckoContextParameters,
- GeckoExtensionCommand, GeckoExtensionRoute, CHROME_ELEMENT_KEY,
+ GeckoExtensionCommand, GeckoExtensionRoute,
};
use crate::logging;
use marionette_rs::common::{
@@ -81,6 +81,7 @@ struct MarionetteHandshake {
#[derive(Default)]
pub(crate) struct MarionetteSettings {
pub(crate) binary: Option,
+ pub(crate) profile_root: Option,
pub(crate) connect_existing: bool,
pub(crate) host: String,
pub(crate) port: Option,
@@ -188,12 +189,14 @@ impl MarionetteHandler {
options,
marionette_port,
websocket_port,
+ self.settings.profile_root.as_ref().map(|x| x.as_path()),
)?)
} else if !self.settings.connect_existing {
Browser::Local(LocalBrowser::new(
options,
marionette_port,
self.settings.jsdebugger,
+ self.settings.profile_root.as_ref().map(|x| x.as_path()),
)?)
} else {
Browser::Existing(marionette_port)
@@ -333,13 +336,12 @@ impl MarionetteSession {
"Failed to convert data to an object"
);
- let chrome_element = data.get(CHROME_ELEMENT_KEY);
let element = data.get(ELEMENT_KEY);
let frame = data.get(FRAME_KEY);
let window = data.get(WINDOW_KEY);
let value = try_opt!(
- element.or(chrome_element).or(frame).or(window),
+ element.or(frame).or(window),
ErrorStatus::UnknownError,
"Failed to extract web element from Marionette response"
);
|