[🐛 Bug]: Outdated documentation: "Fresh browser per test"

[palbr]

What happened?

The documentation at https://www.selenium.dev/documentation/test_practices/encouraged/fresh_browser_per_test/ is recommending to start a new FirefoxDriver with a certain FirefoxProfile.

If I understand the API correct, Selenium 4.1.1 does not support creating a new FirefoxDriver with a FirefoxProfile as parameter.
See Selenium Java API for FirefoxDriver.

How can we reproduce the issue?

Visit https://www.selenium.dev/documentation/test_practices/encouraged/fresh_browser_per_test/ and compare to https://www.selenium.dev/selenium/docs/api/java/org/openqa/selenium/firefox/FirefoxDriver.html

Or copy this code snipped in your IDE:

FirefoxProfile profile = new FirefoxProfile(new File("pathToFirefoxProfile"));
WebDriver driver = new FirefoxDriver(profile);

Relevant log output

IDE is telling:
"Cannot resolve constructor 'FirefoxDriver(org.openqa.selenium.firefox.FirefoxProfile)'"

Operating System

Windows 10

Selenium version

Java 4.1.1

What are the browser(s) and version(s) where you see this issue?

does not matter

What are the browser driver(s) and version(s) where you see this issue?

does not matter

Are you using Selenium Grid?

No

[github-actions]

@palbr, thank you for creating this issue. We will troubleshoot it as soon as we can.

---

Info for maintainers

Triage this issue by using labels.

If information is missing, add a helpful comment and then I-issue-template label.

If the issue is a question, add the I-question label.

If the issue is valid but there is no time to troubleshoot it, consider adding the help wanted label.

If the issue requires changes or fixes from an external project (e.g., ChromeDriver, GeckoDriver, W3C), add the applicable G-* label, and it will provide the correct link and auto-close the issue.

After troubleshooting the issue, please add the R-awaiting answer label.

Thank you!

[palbr]

A new version of this code sample could be:

FirefoxProfile profile = new FirefoxProfile(new File("pathToFirefoxProfile"));
WebDriver driver = new FirefoxDriver(new FirefoxOptions().setProfile(profile));

Inserted new FirefoxOptions().setProfile(. And a closing parenthesis.

[titusfortner]

Thanks for raising the issue, would you like to make a pull request with your solution?
Contributions guide is here — https://www.selenium.dev/documentation/about/contributing/

[palbr]

I think, setting up a development environment for Selenium (git clone, git fork, installing hugo, ...) and reading hugo manuals will take more time than I can afford at the moment. And comparing this time consumption against the "real work" of changing two line in the documentation seems to me like a very bad ratio.

[diemol]

Strange. Given that you have already contributed in the past, we thought it'd be a nice way to keep giving back to this project.

But ok, we will find a way to make contributions more simple then. Thank you for the feedback.

[titusfortner]

Installing Hugo and previewing changes isn't strictly required, though we would appreciate any code updates being made in all 4 of the language files.

And, yes, our hope is that you would continue to help us make the documentation better, which would make the forking/cloning more worth your time. But thank you for raising this issue, either way.

[jags14385]

@diemol Can I pick this issue ?

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.