Skip to content

Commit 1f9e14e

Browse files
bonigarciatitusfortner
bonigarcia
and
titusfortner
authored
[rust] Include support for browser path in Selenium Manager (#11351) (#11496)
* [rust] Include support for browser path in Selenium Manager (#11351) * fix bad merge Co-authored-by: Titus Fortner <[email protected]> Co-authored-by: titusfortner <[email protected]>
1 parent aba0d5c commit 1f9e14e

8 files changed

Lines changed: 135 additions & 68 deletions

File tree

‎rust/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Options:
2929
Driver version (e.g., 106.0.5249.61, 0.31.0, etc.)
3030
-B, --browser-version <BROWSER_VERSION>
3131
Major browser version (e.g., 105, 106, etc. Also: beta, dev, canary -or nightly- is accepted)
32+
-P, --browser-path <BROWSER_PATH>
33+
Browser path (absolute) for browser version detection (e.g., /usr/bin/google-chrome, "/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome", "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe")
3234
-D, --debug
3335
Display DEBUG messages
3436
-T, --trace

‎rust/src/chrome.rs‎

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ use crate::metadata::{
2929
};
3030
use crate::{
3131
SeleniumManager, BETA, DASH_DASH_VERSION, DEV, ENV_LOCALAPPDATA, ENV_PROGRAM_FILES,
32-
ENV_PROGRAM_FILES_X86, FALLBACK_RETRIES, NIGHTLY, REG_QUERY, STABLE, WMIC_COMMAND,
32+
ENV_PROGRAM_FILES_X86, FALLBACK_RETRIES, NIGHTLY, REG_QUERY, STABLE, WMIC_COMMAND, WMIC_COMMAND_ENV,
3333
};
3434

3535
const BROWSER_NAME: &str = "chrome";
@@ -99,33 +99,41 @@ impl SeleniumManager for ChromeManager {
9999
}
100100

101101
fn discover_browser_version(&self) -> Option<String> {
102-
match self.get_browser_path() {
103-
Some(browser_path) => {
104-
let (shell, flag, args) =
105-
if WINDOWS.is(self.get_os()) {
106-
let mut commands = vec![
107-
self.format_two_args(WMIC_COMMAND, ENV_PROGRAM_FILES, browser_path),
108-
self.format_two_args(WMIC_COMMAND, ENV_PROGRAM_FILES_X86, browser_path),
109-
self.format_two_args(WMIC_COMMAND, ENV_LOCALAPPDATA, browser_path),
110-
];
111-
if !self.is_browser_version_unstable() {
112-
commands.push(self.format_one_arg(
102+
let mut commands;
103+
let mut browser_path = self.get_browser_path();
104+
if browser_path.is_empty() {
105+
match self.detect_browser_path() {
106+
Some(path) => {
107+
browser_path = path;
108+
commands = vec![
109+
self.format_two_args(WMIC_COMMAND_ENV, ENV_PROGRAM_FILES, browser_path),
110+
self.format_two_args(WMIC_COMMAND_ENV, ENV_PROGRAM_FILES_X86, browser_path),
111+
self.format_two_args(WMIC_COMMAND_ENV, ENV_LOCALAPPDATA, browser_path),
112+
];
113+
if !self.is_browser_version_unstable() {
114+
commands.push(
115+
self.format_one_arg(
113116
REG_QUERY,
114117
r#"HKCU\Software\Google\Chrome\BLBeacon"#,
115-
));
116-
}
117-
("cmd", "/C", commands)
118-
} else {
119-
(
120-
"sh",
121-
"-c",
122-
vec![self.format_one_arg(DASH_DASH_VERSION, browser_path)],
123-
)
124-
};
125-
self.detect_browser_version(shell, flag, args)
118+
),
119+
);
120+
}
121+
}
122+
_ => return None,
126123
}
127-
_ => None,
124+
} else {
125+
commands = vec![self.format_one_arg(WMIC_COMMAND, browser_path)];
128126
}
127+
let (shell, flag, args) = if WINDOWS.is(self.get_os()) {
128+
("cmd", "/C", commands)
129+
} else {
130+
(
131+
"sh",
132+
"-c",
133+
vec![self.format_one_arg(DASH_DASH_VERSION, browser_path)],
134+
)
135+
};
136+
self.detect_browser_version(shell, flag, args)
129137
}
130138

131139
fn get_driver_name(&self) -> &str {

‎rust/src/config.rs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ pub struct ManagerConfig {
2323
pub driver_version: String,
2424
pub os: String,
2525
pub arch: String,
26+
pub browser_path: String,
2627
}
2728

2829
impl ManagerConfig {
@@ -32,6 +33,7 @@ impl ManagerConfig {
3233
driver_version: "".to_string(),
3334
os: OS.to_string(),
3435
arch: ARCH.to_string(),
36+
browser_path: "".to_string(),
3537
}
3638
}
3739

@@ -42,6 +44,7 @@ impl ManagerConfig {
4244
driver_version: config.driver_version.as_str().to_string(),
4345
os: config.os.as_str().to_string(),
4446
arch: config.arch.as_str().to_string(),
47+
browser_path: config.browser_path.as_str().to_string(),
4548
}
4649
}
4750
}

‎rust/src/edge.rs‎

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ use crate::metadata::{
2929
};
3030
use crate::{
3131
SeleniumManager, BETA, DASH_DASH_VERSION, DEV, ENV_PROGRAM_FILES, ENV_PROGRAM_FILES_X86,
32-
NIGHTLY, REG_QUERY, STABLE, WMIC_COMMAND,
32+
NIGHTLY, REG_QUERY, STABLE, WMIC_COMMAND, WMIC_COMMAND_ENV,
3333
};
3434

3535
const BROWSER_NAME: &str = "edge";
@@ -100,31 +100,40 @@ impl SeleniumManager for EdgeManager {
100100
}
101101

102102
fn discover_browser_version(&self) -> Option<String> {
103-
match self.get_browser_path() {
104-
Some(browser_path) => {
105-
let (shell, flag, args) = if WINDOWS.is(self.get_os()) {
106-
let mut commands = vec![
107-
self.format_two_args(WMIC_COMMAND, ENV_PROGRAM_FILES_X86, browser_path),
108-
self.format_two_args(WMIC_COMMAND, ENV_PROGRAM_FILES, browser_path),
103+
let mut commands;
104+
let mut browser_path = self.get_browser_path();
105+
if browser_path.is_empty() {
106+
match self.detect_browser_path() {
107+
Some(path) => {
108+
browser_path = path;
109+
commands = vec![
110+
self.format_two_args(WMIC_COMMAND_ENV, ENV_PROGRAM_FILES_X86, browser_path),
111+
self.format_two_args(WMIC_COMMAND_ENV, ENV_PROGRAM_FILES, browser_path),
109112
];
110113
if !self.is_browser_version_unstable() {
111-
commands.push(self.format_one_arg(
112-
REG_QUERY,
113-
r#"REG QUERY HKCU\Software\Microsoft\Edge\BLBeacon"#,
114-
));
114+
commands.push(
115+
self.format_one_arg(
116+
REG_QUERY,
117+
r#"HKCU\Software\Microsoft\Edge\BLBeacon"#,
118+
),
119+
);
115120
}
116-
("cmd", "/C", commands)
117-
} else {
118-
(
119-
"sh",
120-
"-c",
121-
vec![self.format_one_arg(DASH_DASH_VERSION, browser_path)],
122-
)
123-
};
124-
self.detect_browser_version(shell, flag, args)
121+
}
122+
_ => return None,
125123
}
126-
_ => None,
124+
} else {
125+
commands = vec![self.format_one_arg(WMIC_COMMAND, browser_path)];
127126
}
127+
let (shell, flag, args) = if WINDOWS.is(self.get_os()) {
128+
("cmd", "/C", commands)
129+
} else {
130+
(
131+
"sh",
132+
"-c",
133+
vec![self.format_one_arg(DASH_DASH_VERSION, browser_path)],
134+
)
135+
};
136+
self.detect_browser_version(shell, flag, args)
128137
}
129138

130139
fn get_driver_name(&self) -> &str {

‎rust/src/firefox.rs‎

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ use crate::metadata::{
2929
};
3030
use crate::{
3131
SeleniumManager, BETA, DASH_VERSION, DEV, ENV_PROGRAM_FILES, ENV_PROGRAM_FILES_X86, NIGHTLY,
32-
STABLE, WMIC_COMMAND,
32+
STABLE, WMIC_COMMAND, WMIC_COMMAND_ENV,
3333
};
3434

3535
const BROWSER_NAME: &str = "firefox";
@@ -100,28 +100,32 @@ impl SeleniumManager for FirefoxManager {
100100
}
101101

102102
fn discover_browser_version(&self) -> Option<String> {
103-
match self.get_browser_path() {
104-
Some(browser_path) => {
105-
let (shell, flag, args) = if WINDOWS.is(self.get_os()) {
106-
(
107-
"cmd",
108-
"/C",
109-
vec![
110-
self.format_two_args(WMIC_COMMAND, ENV_PROGRAM_FILES, browser_path),
111-
self.format_two_args(WMIC_COMMAND, ENV_PROGRAM_FILES_X86, browser_path),
112-
],
113-
)
114-
} else {
115-
(
116-
"sh",
117-
"-c",
118-
vec![self.format_one_arg(DASH_VERSION, browser_path)],
119-
)
120-
};
121-
self.detect_browser_version(shell, flag, args)
103+
let commands;
104+
let mut browser_path = self.get_browser_path();
105+
if browser_path.is_empty() {
106+
match self.detect_browser_path() {
107+
Some(path) => {
108+
browser_path = path;
109+
commands = vec![
110+
self.format_two_args(WMIC_COMMAND_ENV, ENV_PROGRAM_FILES, browser_path),
111+
self.format_two_args(WMIC_COMMAND_ENV, ENV_PROGRAM_FILES_X86, browser_path),
112+
];
113+
}
114+
_ => return None,
122115
}
123-
_ => None,
116+
} else {
117+
commands = vec![self.format_one_arg(WMIC_COMMAND, browser_path)];
124118
}
119+
let (shell, flag, args) = if WINDOWS.is(self.get_os()) {
120+
("cmd", "/C", commands)
121+
} else {
122+
(
123+
"sh",
124+
"-c",
125+
vec![self.format_one_arg(DASH_VERSION, browser_path)],
126+
)
127+
};
128+
self.detect_browser_version(shell, flag, args)
125129
}
126130

127131
fn get_driver_name(&self) -> &str {

‎rust/src/lib.rs‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ pub const BETA: &str = "beta";
4848
pub const DEV: &str = "dev";
4949
pub const CANARY: &str = "canary";
5050
pub const NIGHTLY: &str = "nightly";
51-
pub const WMIC_COMMAND: &str = r#"wmic datafile where name='%{}:\=\\%{}' get Version /value"#;
51+
pub const WMIC_COMMAND: &str = r#"wmic datafile where name='{}' get Version /value"#;
52+
pub const WMIC_COMMAND_ENV: &str = r#"wmic datafile where name='%{}:\=\\%{}' get Version /value"#;
5253
pub const REG_QUERY: &str = r#"REG QUERY {} /v version"#;
5354
pub const DASH_VERSION: &str = "{} -v";
5455
pub const DASH_DASH_VERSION: &str = "{} --version";
@@ -91,7 +92,7 @@ pub trait SeleniumManager {
9192
uncompress(&driver_zip_file, driver_path_in_cache)
9293
}
9394

94-
fn get_browser_path(&self) -> Option<&str> {
95+
fn detect_browser_path(&self) -> Option<&str> {
9596
let mut browser_version = self.get_browser_version();
9697
if browser_version.eq_ignore_ascii_case(CANARY) {
9798
browser_version = NIGHTLY;
@@ -282,6 +283,16 @@ pub trait SeleniumManager {
282283
config.driver_version = driver_version;
283284
self.set_config(config);
284285
}
286+
287+
fn get_browser_path(&self) -> &str {
288+
self.get_config().browser_path.as_str()
289+
}
290+
291+
fn set_browser_path(&mut self, browser_path: String) {
292+
let mut config = ManagerConfig::clone(self.get_config());
293+
config.browser_path = browser_path;
294+
self.set_config(config);
295+
}
285296
}
286297

287298
// ----------------------------------------------------------

‎rust/src/main.rs‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@ struct Cli {
5656
#[clap(short = 'B', long, value_parser)]
5757
browser_version: Option<String>,
5858

59+
/// Browser path (absolute) for browser version detection (e.g., /usr/bin/google-chrome,
60+
/// "/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome",
61+
/// "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe")
62+
#[clap(short = 'P', long, value_parser)]
63+
browser_path: Option<String>,
64+
5965
/// Display DEBUG messages
6066
#[clap(short = 'D', long)]
6167
debug: bool,
@@ -97,6 +103,7 @@ fn main() -> Result<(), Box<dyn Error>> {
97103

98104
selenium_manager.set_browser_version(cli.browser_version.unwrap_or_default());
99105
selenium_manager.set_driver_version(cli.driver_version.unwrap_or_default());
106+
selenium_manager.set_browser_path(cli.browser_path.unwrap_or_default());
100107

101108
match selenium_manager.resolve_driver() {
102109
Ok(driver_path) => log::info!("{}", driver_path.display()),

‎rust/tests/cli_tests.rs‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,26 @@ fn error_test(
9595
.failure()
9696
.code(error_code);
9797
}
98+
99+
#[rstest]
100+
#[case(
101+
"chrome",
102+
r#"C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe"#
103+
)]
104+
#[case("chrome", "/usr/bin/google-chrome")]
105+
#[case(
106+
"chrome",
107+
r#"/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome"#
108+
)]
109+
fn path_test(#[case] browser: String, #[case] browser_path: String) {
110+
println!(
111+
"Path test browser={} -- browser_path={}",
112+
browser, browser_path
113+
);
114+
115+
let mut cmd = Command::cargo_bin(env!("CARGO_PKG_NAME")).unwrap();
116+
cmd.args(["--browser", &browser, "--browser-path", &browser_path])
117+
.assert()
118+
.success()
119+
.code(0);
120+
}

0 commit comments

Comments
 (0)