-
Notifications
You must be signed in to change notification settings - Fork 298
fix(junit): create a new Playwright when the previous launcher run closed it #1988
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -55,6 +55,9 @@ Playwright createPlaywright(Playwright.CreateOptions options) { | |
| return playwright; | ||
| } | ||
|
|
||
| boolean owns(Playwright playwright) { | ||
| return playwrightList.contains(playwright); | ||
| } | ||
|
|
||
| // This is a workaround for JUnit's lack of an "AfterTestRun" hook | ||
| // This will be called once after all tests have completed. | ||
|
|
@@ -85,13 +88,14 @@ public Object resolveParameter(ParameterContext parameterContext, ExtensionConte | |
| * @return The Playwright that belongs to the current test. | ||
| */ | ||
| public static Playwright getOrCreatePlaywright(ExtensionContext extensionContext) { | ||
| PlaywrightRegistry registry = PlaywrightRegistry.getOrCreateFor(extensionContext); | ||
| Playwright playwright = threadLocalPlaywright.get(); | ||
| if (playwright != null) { | ||
| // A previous launcher run on this thread (e.g. a surefire rerun) has already closed its Playwright. | ||
| if (playwright != null && registry.owns(playwright)) { | ||
|
Member
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.
Combined with this new Suggest having |
||
| return playwright; | ||
| } | ||
|
|
||
| Options options = OptionsExtension.getOptions(extensionContext); | ||
| PlaywrightRegistry registry = PlaywrightRegistry.getOrCreateFor(extensionContext); | ||
| playwright = registry.createPlaywright(options.playwrightCreateOptions); | ||
| threadLocalPlaywright.set(playwright); | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| /* | ||
| * Copyright (c) Microsoft Corporation. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
|
|
||
| package com.microsoft.playwright.junit; | ||
|
|
||
| import com.microsoft.playwright.Page; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
|
|
||
| // Not picked up by surefire; TestFixturesRerun runs it through the launcher. | ||
| @UsePlaywright | ||
| public class RerunFixture { | ||
| @Test | ||
| void usesPage(Page page) { | ||
|
Member
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. This launches two real browsers serially (once per launcher run) while blocking a JUnit ForkJoinPool worker on The regression being guarded ( |
||
| page.setContent("<title>rerun</title>"); | ||
| assertEquals("rerun", page.title()); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /* | ||
| * Copyright (c) Microsoft Corporation. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
|
|
||
| package com.microsoft.playwright.junit; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.platform.launcher.LauncherDiscoveryRequest; | ||
| import org.junit.platform.launcher.core.LauncherFactory; | ||
| import org.junit.platform.launcher.listeners.SummaryGeneratingListener; | ||
| import org.junit.platform.launcher.listeners.TestExecutionSummary; | ||
|
|
||
| import java.io.PrintWriter; | ||
| import java.io.StringWriter; | ||
| import java.util.concurrent.ExecutorService; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.Future; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.platform.engine.discovery.DiscoverySelectors.selectClass; | ||
| import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.request; | ||
|
|
||
| public class TestFixturesRerun { | ||
| // Surefire's rerunFailingTestsCount runs the launcher again on the same thread after | ||
| // the first run has already closed every Playwright it created. | ||
| @Test | ||
| void shouldCreateNewPlaywrightForEachLauncherRun() throws Exception { | ||
| ExecutorService thread = Executors.newSingleThreadExecutor(); | ||
| try { | ||
| for (int run = 1; run <= 2; run++) { | ||
| Future<TestExecutionSummary> summary = thread.submit(() -> runOnLauncher(RerunFixture.class)); | ||
| assertEquals(1, summary.get().getTestsSucceededCount(), "run " + run + ": " + describeFailures(summary.get())); | ||
| } | ||
| } finally { | ||
| thread.shutdownNow(); | ||
| } | ||
| } | ||
|
|
||
| private static String describeFailures(TestExecutionSummary summary) { | ||
| StringWriter out = new StringWriter(); | ||
| summary.printFailuresTo(new PrintWriter(out)); | ||
| return out.toString(); | ||
| } | ||
|
|
||
| private static TestExecutionSummary runOnLauncher(Class<?> testClass) { | ||
| LauncherDiscoveryRequest request = request().selectors(selectClass(testClass)).build(); | ||
| SummaryGeneratingListener listener = new SummaryGeneratingListener(); | ||
| LauncherFactory.create().execute(request, listener); | ||
| return listener.getSummary(); | ||
| } | ||
| } |
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.
nit: this comment describes the fall-through case but sits directly above the reuse branch, so it reads as if it justifies the
ifbody — easy for a later reader to "fix" by inverting the condition. Moving it below theifblock, or rewording to something like "reuse only while the current run's registry still owns it", would avoid that.