Skip to content

Commit 5c73ef9

Browse files
committed
working on the text
1 parent 9b2f87c commit 5c73ef9

File tree

1 file changed

+41
-31
lines changed

1 file changed

+41
-31
lines changed

src/site/xdoc/development.xml

Lines changed: 41 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -94,16 +94,17 @@ mvn test ... -Dhtmlunit.test.port=10101
9494
</subsection>
9595

9696
<subsection name="Running Test with real browsers">
97-
<p>The aim of the development of HtmlUnit is to provide as accurate a simulation of the various browsers as possible.
98-
As browsers are constantly evolving, we have to adapt our test assumptions with every update. Therefore (almost)
97+
<p>The primary goal of HtmlUnit development is to provide the most accurate simulation possible
98+
of supported browsers. Since browsers are constantly evolving, we have to adapt our
99+
test assumptions with every browser version update. Therefore almost
99100
all tests are implemented in such a way that they can be executed with HtmlUnit as well
100101
as (with the help of Selenium WebDriver) with the supported real browsers.</p>
101102

102-
<p>This behavior is provided by the superclass org.htmlunit.WebDriverTestCase. The test execution can be
103-
switched accordingly with the help of a configuration file.</p>
103+
<p>This functionality is provided by the superclass org.htmlunit.WebDriverTestCase.
104+
Test execution can be switched accordingly with the help of a configuration file.</p>
104105

105-
<p>By default, all tests runing with HtmlUnit, but this behavior can be changed by having a property file named
106-
"{@code test.properties}" in the HtmlUnit root directory.</p>
106+
<p>By default, all tests runking with HtmlUnit, but this behavior can be changed
107+
by having a property file named "{@code test.properties}" in the HtmlUnit root directory.</p>
107108

108109
<p>Sample (remove the part not matching your os)</p>
109110
<source>
@@ -112,36 +113,41 @@ browsers=hu
112113
#browsers=hu-ff, hu-chrome
113114
#browsers=ff, chrome, edge
114115

115-
ff.bin=/usr/bin/firefox [Unix]
116-
ff-esr.bin=/usr/bin/firefox-esr [Unix]
117-
geckodriver.bin=/usr/bin/driver/geckodriver [Unix]
118-
chrome.bin=/path/to/chromedriver [Unix]
119-
edge.bin=/path/to/chromedriver [Unix]
120-
121-
geckodriver.bin=C:\\path\\to\\geckodriver.exe [Windows]
122-
ff.bin=C:\\path\\to\\Mozilla Firefox\\firefox.exe [Windows]
123-
ff-esr.bin=C:\\path\\to\\Mozilla Firefox ESR\\firefox.exe [Windows]
124-
chrome.bin=C:\\path\\to\\chromedriver.exe [Windows]
125-
edge.bin=C:\\path\\to\\msedgedriver.exe [Windows]
126-
116+
# Unix/Linux paths
117+
ff.bin=/usr/bin/firefox
118+
ff-esr.bin=/usr/bin/firefox-esr
119+
geckodriver.bin=/usr/bin/driver/geckodriver
120+
chrome.bin=/path/to/chromedriver
121+
edge.bin=/path/to/chromedriver
122+
123+
# Windows paths
124+
geckodriver.bin=C:\\path\\to\\geckodriver.exe
125+
ff.bin=C:\\path\\to\\Mozilla Firefox\\firefox.exe
126+
ff-esr.bin=C:\\path\\to\\Mozilla Firefox ESR\\firefox.exe
127+
chrome.bin=C:\\path\\to\\chromedriver.exe
128+
edge.bin=C:\\path\\to\\msedgedriver.exe
129+
130+
# optional
127131
autofix=false
128132
</source>
129133
<p>The file could contain some properties</p>
134+
<h4>Configuration Properties</h4>
135+
<h5>browsers</h5>
136+
<p>a comma separated list contains any combination of:</p>
130137
<ul>
131-
<li>browsers: is a comma separated list contains any combination of
132-
<ul>
133-
<li>hu (for HtmlUnit with all browser versions),</li>
134-
<li>hu-ff,</li>
135-
<li>hu-ff-esr,</li>
136-
<li>hu-chrome,</li>
137-
<li>hu-edge,</li>
138-
<li>ff, (running test using real Firefox),</li>
139-
<li>ff-esr, (running test using real Firefox ESR),</li>
140-
<li>chrome (running test using real Chrome),</li>
141-
<li>edge (running test using real Edge),</li>
142-
</ul>
143-
</li>
138+
<li>hu (for HtmlUnit with all browser versions),</li>
139+
<li>hu-ff,</li>
140+
<li>hu-ff-esr,</li>
141+
<li>hu-chrome,</li>
142+
<li>hu-edge,</li>
143+
<li>ff, (running tests using real Firefox),</li>
144+
<li>ff-esr, (running tests using real Firefox ESR),</li>
145+
<li>chrome (running tests using real Chrome),</li>
146+
<li>edge (running tests using real Edge),</li>
147+
</ul>
144148

149+
<h5>Browser Binary Paths</h5>
150+
<ul>
145151
<li>chrome.bin (mandatory if it does not exist in the <i>path</i>): is the location of the ChromeDriver binary (see
146152
<a href="https://googlechromelabs.github.io/chrome-for-testing/last-known-good-versions-with-downloads.json">Chrome Driver downloads</a>)</li>
147153
<li>geckodriver.bin (mandatory if it does not exist in the <i>path</i>): is the location of the GeckoDriver binary
@@ -150,6 +156,10 @@ autofix=false
150156
<li>ff-esr.bin (optional): is the location of the FF binary, in Windows use double back-slashes</li>
151157
<li>edge.bin (mandatory if it does not exist in the <i>path</i>): is the location of the MicrosoftWebDriver binary
152158
(see <a href="https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/">Microsoft Edge WebDriver downloads</a>)</li>
159+
</ul>
160+
161+
<h5>Additional Options</h5>
162+
<ul>
153163
<li>autofix (optional): if {@code true}, try to automatically fix the real browser expectations,
154164
or add/remove {@code @NotYetImplemented} annotations, use with caution!</li>
155165
</ul>

0 commit comments

Comments
 (0)