forked from SeleniumHQ/selenium
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[grid] detect a client timeout while session creation SeleniumHQ#14743
- Loading branch information
Showing
4 changed files
with
220 additions
and
26 deletions.
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
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
199 changes: 199 additions & 0 deletions
199
java/test/org/openqa/selenium/grid/router/DistributedTest.java
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 |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| // Licensed to the Software Freedom Conservancy (SFC) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The SFC licenses this file | ||
| // to you 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 org.openqa.selenium.grid.router; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| import java.io.StringReader; | ||
| import java.time.Duration; | ||
| import java.util.LinkedList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.openqa.selenium.SessionNotCreatedException; | ||
| import org.openqa.selenium.WebDriver; | ||
| import org.openqa.selenium.grid.config.MapConfig; | ||
| import org.openqa.selenium.grid.config.MemoizedConfig; | ||
| import org.openqa.selenium.grid.config.TomlConfig; | ||
| import org.openqa.selenium.grid.router.DeploymentTypes.Deployment; | ||
| import org.openqa.selenium.grid.server.BaseServerOptions; | ||
| import org.openqa.selenium.grid.server.Server; | ||
| import org.openqa.selenium.json.Json; | ||
| import org.openqa.selenium.json.JsonInput; | ||
| import org.openqa.selenium.netty.server.NettyServer; | ||
| import org.openqa.selenium.remote.RemoteWebDriver; | ||
| import org.openqa.selenium.remote.http.ClientConfig; | ||
| import org.openqa.selenium.remote.http.Contents; | ||
| import org.openqa.selenium.remote.http.HttpClient; | ||
| import org.openqa.selenium.remote.http.HttpMethod; | ||
| import org.openqa.selenium.remote.http.HttpRequest; | ||
| import org.openqa.selenium.remote.http.HttpResponse; | ||
| import org.openqa.selenium.testing.Safely; | ||
| import org.openqa.selenium.testing.TearDownFixture; | ||
| import org.openqa.selenium.testing.drivers.Browser; | ||
|
|
||
| class DistributedTest { | ||
|
|
||
| private final List<TearDownFixture> tearDowns = new LinkedList<>(); | ||
| private Server<?> server; | ||
| private Browser browser; | ||
| private Server<?> appServer; | ||
|
|
||
| @BeforeEach | ||
| public void setupServers() { | ||
| browser = Objects.requireNonNull(Browser.detect()); | ||
|
|
||
| Deployment deployment = | ||
| DeploymentTypes.DISTRIBUTED.start( | ||
| browser.getCapabilities(), | ||
| new TomlConfig( | ||
| new StringReader( | ||
| "[node]\n" | ||
| + "driver-implementation = " | ||
| + String.format("\"%s\"", browser.displayName()) | ||
| + "\n" | ||
| + "session-timeout = 240" | ||
| + "\n" | ||
| + "override-max-sessions = true" | ||
| + "\n" | ||
| + "max-sessions = 2"))); | ||
| tearDowns.add(deployment); | ||
|
|
||
| server = deployment.getServer(); | ||
|
|
||
| appServer = | ||
| new NettyServer( | ||
| new BaseServerOptions(new MemoizedConfig(new MapConfig(Map.of()))), | ||
| req -> { | ||
| try { | ||
| Thread.sleep(2000); | ||
| } catch (InterruptedException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| return new HttpResponse().setContent(Contents.string("<h1>Cheese</h1>", UTF_8)); | ||
| }); | ||
|
|
||
| tearDowns.add(() -> appServer.stop()); | ||
| appServer.start(); | ||
| } | ||
|
|
||
| @AfterEach | ||
| public void tearDown() { | ||
| tearDowns.parallelStream().forEach(Safely::safelyCall); | ||
| } | ||
|
|
||
| @Test | ||
| void clientTimeoutDoesNotLeakARunningBrowser() throws Exception { | ||
| assertThat(server.isStarted()).isTrue(); | ||
|
|
||
| // using nanoTime is intentionally, the clock in WSL2 is jumping | ||
| var start = System.nanoTime(); | ||
|
|
||
| // one healthy to ensure the distributed grid is working as expected | ||
| WebDriver healthy = | ||
| RemoteWebDriver.builder() | ||
| .oneOf(browser.getCapabilities()) | ||
| .config( | ||
| ClientConfig.defaultConfig() | ||
| .baseUrl(server.getUrl()) | ||
| // ensures the time taken * 2 is smaller than session-timeout | ||
| .readTimeout(Duration.ofSeconds(90))) | ||
| .build(); | ||
|
|
||
| var end = System.nanoTime(); | ||
|
|
||
| try { | ||
| // provoke the client to run into a http timeout | ||
| SessionNotCreatedException nce = | ||
| Assertions.assertThrows( | ||
| SessionNotCreatedException.class, | ||
| () -> | ||
| RemoteWebDriver.builder() | ||
| .oneOf(browser.getCapabilities()) | ||
| .config( | ||
| ClientConfig.defaultConfig() | ||
| .baseUrl(server.getUrl()) | ||
| .readTimeout(Duration.ofMillis(600))) | ||
| .build()); | ||
|
|
||
| assertThat(nce.getMessage()).contains("TimeoutException"); | ||
|
|
||
| Thread.sleep( | ||
| // ensure the grid has some time to start the browser | ||
| Duration.ofNanos((end - start) * 2) | ||
| // and shutdown the browser | ||
| .plusSeconds(20) | ||
| .toMillis()); | ||
|
|
||
| HttpClient client = HttpClient.Factory.createDefault().createClient(server.getUrl()); | ||
| try { | ||
| HttpRequest request = new HttpRequest(HttpMethod.POST, "/graphql"); | ||
| request.setContent(Contents.utf8String("{\"query\": \"{grid { sessionCount }}\"}")); | ||
| HttpResponse response = client.execute(request); | ||
|
|
||
| JsonInput input = new Json().newInput(Contents.reader(response)); | ||
| int sessionCount = -1; | ||
|
|
||
| input.beginObject(); | ||
| while (input.hasNext()) { | ||
| switch (input.nextName()) { | ||
| case "data": | ||
| input.beginObject(); | ||
| while (input.hasNext()) { | ||
| switch (input.nextName()) { | ||
| case "grid": | ||
| input.beginObject(); | ||
| while (input.hasNext()) { | ||
| switch (input.nextName()) { | ||
| case "sessionCount": | ||
| sessionCount = input.read(Integer.class); | ||
| break; | ||
| default: | ||
| input.skipValue(); | ||
| break; | ||
| } | ||
| } | ||
| input.endObject(); | ||
| break; | ||
| default: | ||
| input.skipValue(); | ||
| break; | ||
| } | ||
| } | ||
| input.endObject(); | ||
| break; | ||
| default: | ||
| input.skipValue(); | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| Assertions.assertEquals(1, sessionCount); | ||
| } finally { | ||
| Safely.safelyCall(client::close); | ||
| } | ||
| } finally { | ||
| Safely.safelyCall(healthy::close); | ||
| } | ||
| } | ||
| } |