Skip to content

Commit a890964

Browse files
titusfortnertitusfortner
committed
update example code for remote webdriver
1 parent 32d4a10 commit a890964

File tree

27 files changed

+653
-40
lines changed

27 files changed

+653
-40
lines changed

‎.github/workflows/dotnet-examples.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ jobs:
4747
uses: actions/setup-dotnet@v3
4848
with:
4949
dotnet-version: 6.0.x
50+
- name: Set up Java
51+
uses: actions/setup-java@v3
52+
with:
53+
distribution: 'temurin'
54+
java-version: 11
5055
- name: Run tests
5156
uses: nick-invision/[email protected]
5257
with:

‎.github/workflows/python-examples.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ jobs:
5252
run: |
5353
python -m pip install --upgrade pip
5454
pip install -r requirements.txt
55+
- name: Set up Java
56+
uses: actions/setup-java@v3
57+
with:
58+
distribution: 'temurin'
59+
java-version: 11
5560
- name: Run tests
5661
uses: nick-invision/[email protected]
5762
with:

‎.github/workflows/ruby-examples.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ jobs:
5151
- name: Install Gems
5252
working-directory: ./examples/ruby
5353
run: bundle install
54+
- name: Set up Java
55+
uses: actions/setup-java@v3
56+
with:
57+
distribution: 'temurin'
58+
java-version: 11
5459
- name: Run tests
5560
uses: nick-invision/[email protected]
5661
with:

‎examples/dotnet/SeleniumDocs/BaseTest.cs‎

Lines changed: 95 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
using System;
2+
using System.Diagnostics;
3+
using System.IO;
4+
using System.Net;
5+
using System.Net.Http;
6+
using System.Net.Sockets;
7+
using System.Runtime.InteropServices;
8+
using System.Threading.Tasks;
19
using Microsoft.VisualStudio.TestTools.UnitTesting;
210
using OpenQA.Selenium;
311
using OpenQA.Selenium.Chrome;
@@ -7,25 +15,105 @@ namespace SeleniumDocs
715
public class BaseTest
816
{
917
protected IWebDriver driver;
18+
protected Uri GridUrl;
19+
private Process _webserverProcess;
20+
private const string ServerJarName = "selenium-server-4.15.0.jar";
21+
private static readonly string BaseDirectory = AppContext.BaseDirectory;
22+
private const string RelativePathToGrid = "../../../../../";
23+
private readonly string _examplesDirectory = Path.GetFullPath(Path.Combine(BaseDirectory, RelativePathToGrid));
1024

11-
public void StartDriver()
25+
[TestCleanup]
26+
public void Cleanup()
27+
{
28+
driver?.Quit();
29+
30+
if (_webserverProcess != null)
31+
{
32+
StopServer();
33+
}
34+
}
35+
36+
protected void StartDriver()
1237
{
1338
driver = new ChromeDriver();
1439
}
15-
16-
public void StartDriver(string browserVersion)
40+
41+
protected void StartDriver(string browserVersion)
1742
{
1843
ChromeOptions options = new ChromeOptions
1944
{
2045
BrowserVersion = browserVersion
2146
};
2247
driver = new ChromeDriver(options);
2348
}
24-
25-
[TestCleanup]
26-
public void QuitDriver()
49+
50+
protected async Task StartServer()
51+
{
52+
if (_webserverProcess == null || _webserverProcess.HasExited)
53+
{
54+
_webserverProcess = new Process();
55+
_webserverProcess.StartInfo.FileName =
56+
RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "java.exe" : "java";
57+
string port = GetFreeTcpPort().ToString();
58+
GridUrl = new Uri("http://localhost:" + port + "/wd/hub");
59+
_webserverProcess.StartInfo.Arguments = " -jar " + ServerJarName +
60+
" standalone --port " + port +
61+
" --selenium-manager true --enable-managed-downloads true";
62+
_webserverProcess.StartInfo.WorkingDirectory = _examplesDirectory;
63+
_webserverProcess.Start();
64+
await EnsureGridIsRunningAsync();
65+
}
66+
}
67+
68+
private void StopServer()
69+
{
70+
if (_webserverProcess != null && !_webserverProcess.HasExited)
71+
{
72+
_webserverProcess.Kill();
73+
_webserverProcess.Dispose();
74+
_webserverProcess = null;
75+
}
76+
}
77+
78+
private static int GetFreeTcpPort()
79+
{
80+
TcpListener l = new TcpListener(IPAddress.Loopback, 0);
81+
l.Start();
82+
int port = ((IPEndPoint)l.LocalEndpoint).Port;
83+
l.Stop();
84+
return port;
85+
}
86+
87+
private async Task EnsureGridIsRunningAsync()
2788
{
28-
driver.Quit();
89+
DateTime timeout = DateTime.Now.Add(TimeSpan.FromSeconds(30));
90+
bool isRunning = false;
91+
HttpClient client = new HttpClient();
92+
93+
while (!isRunning && DateTime.Now < timeout)
94+
{
95+
try
96+
{
97+
HttpResponseMessage response = await client.GetAsync(GridUrl + "/status");
98+
if (response.IsSuccessStatusCode)
99+
{
100+
isRunning = true;
101+
}
102+
else
103+
{
104+
await Task.Delay(500);
105+
}
106+
}
107+
catch (HttpRequestException)
108+
{
109+
await Task.Delay(500);
110+
}
111+
}
112+
113+
if (!isRunning)
114+
{
115+
throw new TimeoutException("Could not confirm the remote selenium server is running within 30 seconds");
116+
}
29117
}
30118
}
31119
}

‎examples/dotnet/SeleniumDocs/Drivers/RemoteWebDriverTest.cs‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,117 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.IO;
4+
using System.Threading.Tasks;
5+
using Microsoft.IdentityModel.Tokens;
16
using Microsoft.VisualStudio.TestTools.UnitTesting;
7+
using OpenQA.Selenium;
8+
using OpenQA.Selenium.Chrome;
9+
using OpenQA.Selenium.Firefox;
10+
using OpenQA.Selenium.Remote;
11+
using OpenQA.Selenium.Support.UI;
212

313
namespace SeleniumDocs.Drivers
414
{
515
[TestClass]
616
public class RemoteWebDriverTest : BaseTest
717
{
18+
[TestInitialize]
19+
public async Task Setup()
20+
{
21+
await StartServer();
22+
}
23+
24+
[TestMethod]
25+
public void RunRemote()
26+
{
27+
var options = new ChromeOptions();
28+
driver = new RemoteWebDriver(GridUrl, options);
29+
30+
Assert.IsInstanceOfType(driver, typeof(IHasDownloads));
31+
}
32+
33+
[TestMethod]
34+
public void Uploads()
35+
{
36+
var options = new ChromeOptions();
37+
driver = new RemoteWebDriver(GridUrl, options);
38+
39+
driver.Url = "https://the-internet.herokuapp.com/upload";
40+
41+
string baseDirectory = AppContext.BaseDirectory;
42+
string relativePath = "../../../TestSupport/selenium-snapshot.png";
43+
44+
string uploadFile = Path.GetFullPath(Path.Combine(baseDirectory, relativePath));
45+
46+
((RemoteWebDriver)driver).FileDetector = new LocalFileDetector();
47+
IWebElement fileInput = driver.FindElement(By.CssSelector("input[type=file]"));
48+
fileInput.SendKeys(uploadFile);
49+
driver.FindElement(By.Id("file-submit")).Click();
50+
51+
IWebElement fileName = driver.FindElement(By.Id("uploaded-files"));
52+
Assert.AreEqual("selenium-snapshot.png", fileName.Text);
53+
}
54+
55+
[TestMethod]
56+
public void Downloads()
57+
{
58+
ChromeOptions options = new ChromeOptions
59+
{
60+
EnableDownloads = true
61+
};
62+
driver = new RemoteWebDriver(GridUrl, options);
63+
64+
driver.Url = "https://selenium.dev/selenium/web/downloads/download.html";
65+
driver.FindElement(By.Id("file-1")).Click();
66+
driver.FindElement(By.Id("file-2")).Click();
67+
WebDriverWait wait = new WebDriverWait(driver, TimeSpan.FromSeconds(3));
68+
wait.Until(d => ((RemoteWebDriver)d).GetDownloadableFiles().Contains("file_2.jpg"));
69+
70+
List<string> names = ((RemoteWebDriver)driver).GetDownloadableFiles();
71+
72+
Assert.IsTrue(names.Contains("file_1.txt"));
73+
Assert.IsTrue(names.Contains("file_2.jpg"));
74+
string downloadableFile = names[0];
75+
string targetDirectory = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString());
76+
77+
((RemoteWebDriver)driver).DownloadFile(downloadableFile, targetDirectory);
78+
79+
string fileContent = File.ReadAllText(Path.Combine(targetDirectory, downloadableFile));
80+
Assert.AreEqual("Hello, World!", fileContent.Trim());
81+
82+
((RemoteWebDriver)driver).DeleteDownloadableFiles();
83+
84+
Assert.IsTrue(((RemoteWebDriver)driver).GetDownloadableFiles().IsNullOrEmpty());
85+
Directory.Delete(targetDirectory, recursive: true);
86+
}
87+
88+
[TestMethod]
89+
public void CustomExecutor()
90+
{
91+
driver = new RemoteWebDriver(GridUrl, new FirefoxOptions());
92+
driver.Navigate().GoToUrl("https://www.selenium.dev/");
93+
94+
var customCommandDriver = driver as ICustomDriverCommandExecutor;
95+
customCommandDriver.RegisterCustomDriverCommands(FirefoxDriver.CustomCommandDefinitions);
96+
97+
var screenshotResponse = customCommandDriver
98+
.ExecuteCustomDriverCommand(FirefoxDriver.GetFullPageScreenshotCommand, null);
99+
100+
Screenshot image = new Screenshot((string)screenshotResponse);
101+
102+
string targetDirectory = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString());
103+
Directory.CreateDirectory(targetDirectory);
104+
string targetFile = Path.GetFullPath(Path.Combine(targetDirectory, "fullPage.png"));
105+
106+
using (var memoryStream = new MemoryStream(image.AsByteArray))
107+
using (var fileStream = new FileStream(targetFile, FileMode.Create))
108+
{
109+
memoryStream.WriteTo(fileStream);
110+
}
111+
112+
Assert.IsTrue(File.Exists(targetFile));
113+
114+
Directory.Delete(targetDirectory, true);
115+
}
8116
}
9117
}

‎examples/dotnet/SeleniumDocs/Elements/FileUploadTest.cs‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,29 @@
1+
using System;
2+
using System.IO;
13
using Microsoft.VisualStudio.TestTools.UnitTesting;
4+
using OpenQA.Selenium;
25

36
namespace SeleniumDocs.Elements
47
{
58
[TestClass]
6-
public class FileUploadTest : BaseTest
9+
public class FileUploadTest : BaseChromeTest
710
{
11+
[TestMethod]
12+
public void Uploads()
13+
{
14+
driver.Url = "https://the-internet.herokuapp.com/upload";
15+
16+
string baseDirectory = AppContext.BaseDirectory;
17+
string relativePath = "../../../TestSupport/selenium-snapshot.png";
18+
19+
string uploadFile = Path.GetFullPath(Path.Combine(baseDirectory, relativePath));
20+
21+
IWebElement fileInput = driver.FindElement(By.CssSelector("input[type=file]"));
22+
fileInput.SendKeys(uploadFile);
23+
driver.FindElement(By.Id("file-submit")).Click();
24+
25+
IWebElement fileName = driver.FindElement(By.Id("uploaded-files"));
26+
Assert.AreEqual("selenium-snapshot.png", fileName.Text);
27+
}
828
}
929
}

‎examples/dotnet/SeleniumDocs/TestSupport/selenium-snapshot.png‎

15.9 KB
Loading

‎examples/java/pom.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@
3131
<artifactId>selenium-java</artifactId>
3232
<version>4.15.0</version>
3333
</dependency>
34+
<dependency>
35+
<groupId>org.seleniumhq.selenium</groupId>
36+
<artifactId>selenium-grid</artifactId>
37+
<version>4.15.0</version>
38+
</dependency>
3439
<dependency>
3540
<groupId>org.junit.jupiter</groupId>
3641
<artifactId>junit-jupiter-engine</artifactId>

‎examples/java/src/test/java/dev/selenium/BaseTest.java‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import java.io.File;
44
import java.io.IOException;
5+
import java.net.URL;
56
import java.nio.file.Files;
67
import java.time.Duration;
78
import org.junit.jupiter.api.AfterEach;
@@ -12,6 +13,8 @@
1213
import org.openqa.selenium.chrome.ChromeOptions;
1314
import org.openqa.selenium.firefox.FirefoxDriver;
1415
import org.openqa.selenium.firefox.FirefoxOptions;
16+
import org.openqa.selenium.grid.Main;
17+
import org.openqa.selenium.net.PortProber;
1518
import org.openqa.selenium.support.ui.WebDriverWait;
1619

1720
public class BaseTest {
@@ -46,7 +49,7 @@ protected ChromeDriver startChromeDriver(ChromeOptions options) {
4649
return (ChromeDriver) driver;
4750
}
4851

49-
protected File getTempDirectory(String prefix) {
52+
protected File getTempDirectory(String prefix) {
5053
File tempDirectory = null;
5154
try {
5255
tempDirectory = Files.createTempDirectory(prefix).toFile();
@@ -70,6 +73,27 @@ protected File getTempFile(String prefix, String suffix) {
7073
return logLocation;
7174
}
7275

76+
protected URL startStandaloneGrid() {
77+
int port = PortProber.findFreePort();
78+
try {
79+
Main.main(
80+
new String[] {
81+
"standalone",
82+
"--port",
83+
String.valueOf(port),
84+
"--selenium-manager",
85+
"true",
86+
"--enable-managed-downloads",
87+
"true",
88+
"--log-level",
89+
"WARNING"
90+
});
91+
return new URL("http://localhost:" + port);
92+
} catch (Exception e) {
93+
throw new RuntimeException(e);
94+
}
95+
}
96+
7397
@AfterEach
7498
public void quit() {
7599
if (driver != null) {

0 commit comments

Comments
 (0)