Skip to content
This repository was archived by the owner on Apr 28, 2025. It is now read-only.

Commit 941b178

Browse files
committed
Updating the README to have first time run instructions
1 parent 7903bc2 commit 941b178

File tree

1 file changed

+51
-11
lines changed

1 file changed

+51
-11
lines changed

README.md

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,71 @@
11
Selenium-Grid-Extras
22
====================
33

4-
This project is designed to help you manage your Selenium Grid installation by giving you control over the Grid Hub machine and Grid Node machine. This is very useful in cases when Internet Explorer Driver crashes, and you need to kill the iedriver.exe so that next test can start and not fail.
4+
Selenium Grid Extras is a project that helps you set up and manage your local Selenium Grid. Typical instances of the Grid consists of the HUB and Nodes. The HUB is responsible for managing test sessions and assigning new session idle nodes.
5+
6+
Setup of Grid Extras is made to be simple, just run the packaged JAR file and point the node at the HUB location, Grid Extras will take care of the rest for you.
7+
Here are the features you get by using Selenium Grid Extras vs Selenium Grid alone:
8+
* Ability to control individual grid nodes, following is an incomplete list of OS level tasks:
9+
** Killing any browser instance by name
10+
** Stopping any Process by PID
11+
** Moving mouse to specific location
12+
** Get Memory usage and disk statistics
13+
* Automatically upgrade WebDriver binaries
14+
* Restart node after a set number of test executions
15+
* Central storage of configurations for all nodes on the HUB server
16+
* Screenshots at the OS level
17+
* And much more.
18+
519

620

721
Setup Instructions
822
------------------
923

10-
Obtain the latest version of Grid Extras Jars, by either downloading pre-compiled binaries or compiling from source
24+
Setup is simple, just download the Grid Extras Jar to get started from here: [Download Latest](https://github.com/groupon/Selenium-Grid-Extras/releases)
25+
26+
27+
### Setting up Grid Hub ###
28+
29+
1. In the terminal run following command:
30+
```bash
31+
java -jar Selenium-Grid-Extras-Jar.jar
32+
```
33+
34+
2. You will be prompted with several questions, first one will ask you if you want to set this computer as a HUB, Node, or both. Answer 2 for HUB
1135

36+
3. Leave the Host name for Grid Hub as default 127.0.0.1
1237

13-
### [Compiled Jars](https://github.com/groupon/Selenium-Grid-Extras/releases) ###
38+
4. Set port to be used by Selenium Grid Hub, default is 4444
1439

40+
5. You will be asked if you wish to auto update Selenium. If you answer yes, then every time Selenium Grid Extras is started it will check fo the latest version of Selenium Stand Alone Server, IEDriver, and ChromeDriver. If you choose to not auto update, you will be asked what versions of each driver to lock into.
1541

16-
### Compile from source: ###
1742

43+
### Setting up Grid Node ###
44+
45+
1. In the terminal run following command:
1846
```bash
19-
git clone https://github.com/groupon/Selenium-Grid-Extras.git
20-
cd Selenium-Grid-Extras
21-
mvn package
47+
java -jar Selenium-Grid-Extras-Jar.jar
2248
```
23-
After all the tests are finished running and all dependencies are downloaded, you will find 2 JAR files in SeleniumGridExtras/target/
24-
* SeleniumGridExtras-X.X.X-SNAPSHOT-jar-with-dependencies.jar
25-
* SeleniumGridExtras-X.X.X-SNAPSHOT.jar
49+
50+
2. You will be asked if you wish to use this computer as HUB or Node, select 1 for Node
51+
52+
3. You will be asked for the host name of the HUB computer, type in the IP or hostname of the HUB computer
53+
54+
4. When prompted for the port used by the HUB, enter that value
55+
56+
5. Selenium Grid Extras will attempt to guess the Operating System of the current computer, if it's wrong please enter the correct value
57+
58+
6. You will be asked what Browsers this Node will host, choose the ones that apply
59+
60+
7. You will be asked how often to restart your whole computer. By default after 10 tests Selenium Grid Extras will attempt to restart the Node, provided the node is idle. Choose 0 if you do not wish to have the computer automatically restart.
61+
62+
8. You will be asked if Selenium Grid Extras should automatically check for updates of IEDriver, ChromeDriver and Selenium Stand Alone Server. If you answer no, you will be asked what version to lock into.
63+
64+
9. Finally, you will be asked if you wish to store all of the Node configs on the HUB. If you answer yes, Selenium Grid Extras will attempt to push Node's configs to the HUB. If it is successful, Selenium Grid Extras will attempt to download all of the configs from the HUB before it starts. This way all of the Node configs can be controlled directly from the HUB.
65+
66+
2667

2768

28-
### [Change log](https://github.com/groupon/Selenium-Grid-Extras/blob/master/CHANGELOG.txt) ###
2969

3070
Auto Restarting Nodes
3171
-------------------

0 commit comments

Comments
 (0)