-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Expand documentation on fresh browser per test #1671
Open
jflorez
wants to merge
7
commits into
SeleniumHQ:trunk
Choose a base branch
from
jflorez:patch-1
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
203bd69
Update fresh_browser_per_test.en.md
jflorez 7bc6b21
extend explanation of browser per test with additional code examples
jflorez d95089b
Merge branch 'SeleniumHQ:trunk' into patch-1
jflorez 70ce085
extend explanation of browser per test with additional code examples
jflorez bbee03e
extend explanation of browser per test with additional code examples
jflorez 7f2aa0a
Merge branch 'patch-1' of github.com:jflorez/seleniumhq.github.io int…
jflorez 8d72b74
Merge branch 'trunk' into patch-1
jflorez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,6 +14,59 @@ If spinning up a new virtual machine is not practical, | |
at least start a new WebDriver for each test. | ||
Most browser drivers like GeckoDriver and ChromeDriver will start with a clean | ||
known state with a new user profile, by default. | ||
|
||
A new browser per test can be achieved by using a test framework's "before each test" hook or fixture. This also implies using the "after each test" hook to close the browser. | ||
|
||
```java | ||
// Using a class variable | ||
public abstract class BaseTest { | ||
protected WebDriver driver; | ||
... | ||
|
||
// Before each test hook | ||
public void setupTest() { | ||
driver = new FirefoxDriver(); | ||
... | ||
} | ||
|
||
// After each test hook | ||
public void teardownTest() { | ||
... | ||
driver.quit(); | ||
} | ||
} | ||
``` | ||
|
||
```python | ||
# Using python fixtures | ||
@pytest.fixture(autouse=True, scope='function') | ||
def driver(self, request, page: Page): | ||
# Create the driver | ||
driver = webdriver.Firefox() | ||
|
||
# Return control to the test | ||
yield self.driver | ||
|
||
# Test ends driver quits | ||
driver.quit() | ||
``` | ||
|
||
A static WebDriver will cause multiple issues both with parallel test execution but also with keeping alignment with this approach of one browser per test. Aditionally this forces the code to deal with ThreadLocal type techniques that unneccesarily complicate the code. | ||
|
||
```java | ||
WebDriver driver = new FirefoxDriver(); | ||
# Using a static variable | ||
|
||
# This forces the ThreadLocal<WebDriver> variable to call driver.get() every time the driver wants to be used. | ||
|
||
# In general static variables in non-thread safe code can have unintended consequences and increase the maintanance effort in the code base. | ||
|
||
public abstract class BaseTest { | ||
protected ThreadLocal<WebDriver> driver; | ||
... | ||
// Before each test hook | ||
public void setupTest() { | ||
BaseTest.driver = ThreadLocal.withInitial(()->new FirefoxDriver()); | ||
... | ||
} | ||
} | ||
Comment on lines
+59
to
+71
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We prefer to avoid mentioning Perhaps show here the code examples we have already: |
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is already a code sample for this: https://github.com/SeleniumHQ/seleniumhq.github.io/blob/trunk/examples/python/tests/conftest.py#L15-L21