summaryrefslogtreecommitdiffstats
path: root/tools/NUnit/doc/optionsDialog.html
blob: b642e5a47f9e101bae91297b00b4fa75ed844cb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<!-- Standard Head Part -->
<head>
<title>NUnit - OptionsDialog</title>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<meta http-equiv="Content-Language" content="en-US">
<link rel="stylesheet" type="text/css" href="nunit.css">
<link rel="shortcut icon" href="favicon.ico">
</head>
<!-- End Standard Head Part -->

<body>

<!-- Standard Header for NUnit.org -->
<div id="header">
  <a id="logo" href="http://www.nunit.org"><img src="img/logo.gif" alt="NUnit.org" title="NUnit.org"></a>
  <div id="nav">
    <a href="http://www.nunit.org">NUnit</a>
    <a class="active" href="index.html">Documentation</a>
  </div>
</div>
<!-- End of Header -->

<div id="content">

<h2>Options Dialog</h2>

<p>The Options Dialog is displayed using the Tools | Options menu item and allows the user to
control some aspects of NUnit’s operation. With NUnit 2.4.4, a tree-based dialog
replaced the older tabbed format.</p>

<hr><h3>Gui Options - General</h3><hr>

<div class="screenshot-right">
   <img src="img/generalOptions.jpg"></div>

<h3>Gui Display</h3>

<h4>Full Gui</h4>
<p>Displays the complete gui - as in prior versions of NUnit. This includes the
   errors and failures and other tabs and the progress bar.</p>
   
<h4>Mini Gui</h4>
<p>Switches the display to the mini-gui, which consists of the tree display 
   only.</p>
<h3>Recent Files</h3>

<p>The text box allows the user to choose the number of entries to display in the recent files list.
If <b>Load most recent project at startup</b> is checked, the GUI will load the last file opened unless it
is run with a specific filename or with the <code>/noload</code> parameter.</p>

<hr style="clear: both"><h3>Gui Options - Tree Display</h3><hr>

<div class="screenshot-right">
   <img src="img/treeDisplayOptions.jpg"></div>

<h3>Tree View</h3>

<p>The list box allows selecting the degree of expansion of the tree when tests are loaded:</p>
<blockquote>
<p><b>Expand</b> – expands all tests</p>
<p><b>Collapse</b> – collapses all tests</p>
<p><b>Hide Tests</b> – expands all suites except for the fixtures themselves.</p>
<p><b>Auto</b> – selects one of the above based on the space available for the tree display.</p>
</blockquote>

<p>If <b>Clear results when reloading</b> is checked, an automatic or manual reload will reinitialize all
test nodes in the tree (grey display) – if it is not checked, result information for tests that do
not seem to have changed will be retained.</p>

<p>If <b>Save visual state of each project</b> is checked, NUnit saves the state of the tree
and restores it when the project is next opened. The information saved includes which
branches of the tree are expanded, the selected node, any checked nodes and any
category selection.

<p>If <b>Show Checkboxes</b> is checked, the tree includes checkboxes, which may
   be used to select multiple tests for running.</p>

<hr style="clear: both"><h3>Gui Options - Test Results</h3><hr>

<div class="screenshot-right">
   <img src="img/testResultOptions.jpg"></div>

<h3>Errors Tab</h3>

<p>Check <b>Display Errors and Failures Tab</b> to display the 
<b>Errors and Failures</b> tab, which shows information about failing tests.

<p>Check <b>Enable Failure ToolTips</b> to display the tip window over the
Errors and Failures display and the stack trace. Clear it if you prefer not
to see the tip window.</p>

<p>Check <b>Enable Word Wrap</b> to turn on word wrapping
in the Errors and Failures display. While you can select this item and the
preceding one at the same time, they do not interact well, so you will 
normally choose one or the other.</p>

<h3>Not Run Tab</h3>

<p>Check <b>Display Tests Not Run Tab</b> to display the 
<b>Tests Not Run</b> tab, which shows information about tests that were
skipped or ignored.

<hr style="clear: both"><h3>Gui Options - Text Output</h3><hr>

<div class="screenshot-right">
   <img src="img/textOutputOptions.jpg"></div>

<h3>Select Tab</h3>

<p>The <b>Select Tab</b> dropdown list is used to select one of the output tabs, for which
settings are to be viewed or changed. It also contains entries that allow
you to add a new tab or edit the list of tabs.

<p>The <b>Restore Defaults</b> button is used to restore the default
set of four tabs, in case you have modified the list of tabs.

<p>The <b>Title</b> text box is used to modify the title displayed
for the selected output tab.

<p><b>Enabled</b> is checked by default. If you uncheck it,
the selected tab will be removed from the tab control. This allows you to temporarily
suppress output to a tab without actually removing its definition.

<h3>Content</h3>

<p>The four check boxes enable or disable a particular type of output
on the selected output window. For each type, the display captures
output produced while your test is running - either by the test
itself or by the program you are testing.

<h4>Standard Output</h4>
<p>Captures all output written to Console.Error.

<h4>Error Output</h4>
<p>Captures all output written to Console.Error.

<h4>Trace Output</h4>
<p>Captures all output written to Trace or Debug.

<h4>Log Output</h4>
<p>Captures output written to a log4net log. NUnit captures
all output at the Error level or above unless another level
is specified for the DefaultLogThreshold setting in the  
configuration file for the test assembly or project.

<h3>Test Labels</h3>

<p>Check <b>Display TestCase Labels</b> to precede text in the output window
with the name of the test that produced it.</p>

<p>Check <b>Suppress label if no output is displayed</b> to eliminate display
of labels for tests that produce no output in the window.


<hr style="clear: both"><h3>Test Loader Options - General</h3><hr>

<div class="screenshot-right">
   <img src="img/testLoadOptions.jpg"></div>

<h3>Test Structure</h3>

<p>If <b>Automatic Namespace suites</b> is selected, tests will be
   shown in a hierarchical listing based on namespaces. This is the
   standard display as used in versions prior to NUnit 2.4.

<p>If <b>Flat list of TestFixtures</b> is selected, tests will be
   shown as a sequential list of fixtures.

<h3>Multiple Assemblies</h3>

<p>If <b>Load in separate AppDomains</b> is selected, each assembly
   in a multiple-assembly test run will be loaded in a separate AppDomain.

<p>If <b>Load in a single AppDomain</b> is selected, all assemblies in
   a multiple-assembly test run will use the same AppDomain. This is
   the standard behavior of NUnit prior to version 2.4.

<p>If <b>Merge tests across assemblies</b> is checked, the display of tests
   will not be divided across assemblies. If automatic namespace suites are
   used, they will be merged across all assemblies. This option is only
   available when tests are run in the same appdomain.

<h3>Shadow Copy</h3>

<p>NUnit normally uses .Net shadow-copying in order to allow you to edit
and recompile assemblies while it is running. Uncheck this box to disable
shadow-copy only if you have a particular problem that requires it.</p>

<p><b>Note:</b> If you are tempted to disable shadow copy in order to access
files in the same directory as your assembly, you should be aware that there
are alternatives. Consider using the Assembly.Codebase property rather than
Assembly.Location.

<hr style="clear: both"><h3>Test Loader Options - Assembly Reload</h3><hr>

<div class="screenshot-right">
   <img src="img/assemblyReloadOptions.jpg"></div>

<h3>Assembly Reload</h3>

<p>If <b>Reload before each test run</b> is checked, a reload will occur whenever the run button is
pressed whether the assemblies appear to have changed or not.</p>

<p>If <b>Reload when test assembly changes</b> is checked, assemblies are watched for any change and
an automatic reload is initiated. This item is disabled on Windows 98 or ME.</p>

<p>If <b>Re-run last tests run</b> is checked, tests are re-run whenever a Reload
   takes place.</p>
   
<hr style="clear: both"><h3>IDE Support Options - Visual Studio</h3><hr>

<div class="screenshot-right">
   <img src="img/visualStudioOptions.jpg"></div>

<h3>Visual Studio</h3>

<p>If <b>Enable Visual Studio Support</b> is checked, the user will be able to open Visual Studio projects
and solutions and add Visual Studio projects to existing test projects.</p>


</div>

<!-- Submenu -->
<div id="subnav">
<ul>
<li><a href="index.html">NUnit 2.4.7</a></li>
<ul>
<li><a href="getStarted.html">Getting&nbsp;Started</a></li>
<li><a href="assertions.html">Assertions</a></li>
<li><a href="attributes.html">Attributes</a></li>
<li><a href="nunit-console.html">Console&nbsp;Runner</a></li>
<li><a href="nunit-gui.html">Gui&nbsp;Runner</a></li>
<ul>
<li><a href="guiCommandLine.html">Command-Line</a></li>
<li><a href="mainMenu.html">Main&nbsp;Menu</a></li>
<li><a href="contextMenu.html">Context&nbsp;Menu</a></li>
<li id="current"><a href="optionsDialog.html">Options&nbsp;Dialog</a></li>
<li><a href="addinsDialog.html">Addins&nbsp;Dialog</a></li>
<li><a href="testProperties.html">Test&nbsp;Properties</a></li>
<li><a href="configEditor.html">Configuration&nbsp;Editor</a></li>
<li><a href="projectEditor.html">Project&nbsp;Editor</a></li>
</ul>
<li><a href="features.html">Other&nbsp;Features</a></li>
<li><a href="releaseNotes.html">Release&nbsp;Notes</a></li>
<li><a href="samples.html">Samples</a></li>
<li><a href="license.html">License</a></li>
</ul>
</ul>
</div>
<!-- End of Submenu -->


<!-- Standard Footer for NUnit.org -->
<div id="footer">
  Copyright &copy; 2008 Charlie Poole. All Rights Reserved.
</div>
<!-- End of Footer -->

</body>
</html>