~ubuntu-branches/debian/sid/nunit/sid

« back to all changes in this revision

Viewing changes to doc/projectEditor.html

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2014-09-16 13:43:36 UTC
  • mfrom: (1.1.5)
  • Revision ID: package-import@ubuntu.com-20140916134336-kjxz48tty6lx2ja5
Tags: 2.6.3+dfsg-1
* [c7bd1b5] Imported Upstream version 2.6.3+dfsg
* [bcb4bf8] Move nunit-console-runner to GAC-installed libnunit2.6, 
  don't treat it as a private lib. This lib is signed, and treated 
  as a GAC lib by consumers such as MonoDevelop.
* [7f08e99] Bump version to 2.6.3 as required
* [84535eb] Refreshed patches
* [8479f61] Split package up into per-assembly packages. This makes 
  ABI tracking easier in the future, as we can meaningfully have GAC 
  policy for cases where ABI isn't truly bumped, and no policy for 
  cases where it is. For example, if nunit.framework bumps ABI but 
  nunit.core does not, previously we would need to rebuild everything 
  using NUnit, but under the new split packaging, that rebuild would 
  not be needed for apps only using nunit.core.
* [17a7dc7] Add missing nunit.mocks.dll to nunit.pc

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!-- saved from url=(0014)about:internet --><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
2
 
<html>
3
 
<!-- Standard Head Part -->
4
 
<head>
5
 
<title>NUnit - ProjectEditor</title>
6
 
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
7
 
<meta http-equiv="Content-Language" content="en-US">
8
 
<meta name="norton-safeweb-site-verification" content="tb6xj01p4hgo5x-8wscsmq633y11-e6nhk-bnb5d987bseanyp6p0uew-pec8j963qlzj32k5x9h3r2q7wh-vmy8bbhek5lnpp5w4p8hocouuq39e09jrkihdtaeknua" />
9
 
<link rel="stylesheet" type="text/css" href="nunit.css">
10
 
<link rel="shortcut icon" href="favicon.ico">
11
 
</head>
12
 
<!-- End Standard Head Part -->
13
 
 
14
 
<body>
15
 
 
16
 
<!-- Standard Header for NUnit.org -->
17
 
<div id="header">
18
 
  <a id="logo" href="http://www.nunit.org"><img src="img/logo.gif" alt="NUnit.org" title="NUnit.org"></a>
 
1
<!-- saved from url=(0014)about:internet --><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
 
2
<html>
 
3
<!-- Standard Head Part -->
 
4
<head>
 
5
<title>NUnit - ProjectEditor</title>
 
6
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
 
7
<meta http-equiv="Content-Language" content="en-US">
 
8
<meta name="norton-safeweb-site-verification" content="tb6xj01p4hgo5x-8wscsmq633y11-e6nhk-bnb5d987bseanyp6p0uew-pec8j963qlzj32k5x9h3r2q7wh-vmy8bbhek5lnpp5w4p8hocouuq39e09jrkihdtaeknua" />
 
9
<link rel="stylesheet" type="text/css" href="nunit.css">
 
10
<link rel="shortcut icon" href="favicon.ico">
 
11
</head>
 
12
<!-- End Standard Head Part -->
 
13
 
 
14
<body>
 
15
 
 
16
<!-- Standard Header for NUnit.org -->
 
17
<div id="header">
 
18
  <a id="logo" href="http://www.nunit.org"><img src="img/logo.gif" alt="NUnit.org" title="NUnit.org"></a>
19
19
  <div id="nav">
20
20
    <a href="http://www.nunit.org">NUnit</a>
21
21
    <a class="active" href="index.html">Documentation</a>
22
 
  </div>
23
 
</div>
24
 
<!-- End of Header -->
25
 
 
26
 
<div id="content">
27
 
 
28
 
<h2>Project Editor</h2>
29
 
 
30
 
<p>Beginning with NUnit 2.6, the Project Editor is a separate program, which may be executed
31
 
directly or run through the Project | Edit dropdown menu of the NUnit GUI. The editor now
32
 
provides two main views of the project: a property-oriented view based on the Project Editor
33
 
that was built into earlier versions of the NUnit GUI and an xml view, which allows direct
34
 
editing of the .nunit file.
35
 
 
36
 
<h2>Property View</h2>
37
 
 
38
 
<p>This view consists of a common area and two tabs, as seen in the image below.</p>
39
 
 
40
 
<div class="screenshot-left">
41
 
<img src="img/generalTab.jpg"></div>
42
 
 
43
 
<h3>Common Area</h3>
44
 
 
45
 
<p>The common area of the Project Editor contains information pertaining to
46
 
   the project as a whole. Information that applies to a particular configuration
47
 
   is displayed in the General and Assemblies tabs.
48
 
   
49
 
<h4>Project Path</h4>
50
 
<p>This label shows the full path to the project file. In the case of a 
51
 
   wrapper project, the path is set to the same directory as the assembly
52
 
   that was initially opened.
53
 
   
54
 
<h4>Application Base</h4> 
55
 
<p>This TextBox allows the user to change the project AppBase, which defaults to 
56
 
   the directory of the project file. The button to the right of the TextBox
57
 
   allows the user to browse and select a directory.
58
 
   
59
 
<h4>Process Model</h4>
60
 
<p>This dropdown list allows you to specify how operating system processes are
61
 
   used in loading and running the tests in this project. Four settings are
62
 
   defined:
63
 
   <ul>
64
 
   <li>The <b>Default</b> setting refers to the option selected by the user
65
 
       on the Assembly Isolation page of the NUnit Settings Dialog.
66
 
   <li><b>Single</b> means that tests are run in a test domain in the
67
 
           same process as NUnit. This is the way previous versions of NUnit
68
 
           ran tests.
69
 
   <li><b>Separate</b> means that all the tests are run in a separate process 
70
 
       that NUnit creates.
71
 
   <li><b>Multiple</b> means that NUnit will create a separate process for
72
 
       each test assembly in the project and run its tests there.
73
 
   </ul>
74
 
   
75
 
<h4>Domain Usage</h4>
76
 
<p>This dropdown list allows you to specify how tests are loaded into
77
 
   AppDomains by NUnit. Three settings are defined:
78
 
   <ul>
79
 
   <li>The <b>Default</b> setting refers to the option selected by the user
80
 
       on the Assembly Isolation page of the NUnit Settings Dialog.
81
 
   <li><b>Single</b> means that all tests will run in a single test domain
82
 
       created by NUnit. This was the way versions of NUnit prior to 2.4
83
 
           ran tests.
84
 
   <li><b>Multiple</b> means that each test assembly is loaded into a
85
 
       separate AppDomain. This setting is not available when Multiple
86
 
           processes are selected in the Process Model dropown.
87
 
   </ul>
88
 
   
89
 
<h4>Configuration</h4>
90
 
<p>This dropdown list allows you to select the particular configuration
91
 
   within a project that is displayed in the bottom part of the dialog.
92
 
   
93
 
<h4>Edit Configs...</h4>
94
 
<p>This button opens the  
95
 
   <a href="configEditor.html">Configuration Editor</a>,
96
 
   which allows you to add, delete or rename configs and set the
97
 
   active configuration.
98
 
 
99
 
<h3>General Tab</h3>
100
 
 
101
 
<p>The General tab allows setting a number of options pertaining to the selected configuration, all of
102
 
which will be stored in the NUnit project file as attributes of the <config> xml node.</p>
103
 
 
104
 
<h4>Runtime</h4>
105
 
<p>This dropdown allows you to select a particular runtime framework to be used
106
 
   for loading and running tests under the current configuration. Currently,
107
 
   only Microsoft .NET and Mono are supported. If <b>Any</b> is selected, the 
108
 
   tests will be run under the same runtime that NUnit itself is currently using.
109
 
 
110
 
<h4>Version</h4>
111
 
<p>This ComboBox allows you to select the particular version of the runtime framework
112
 
   to be used for loading and running tests under the current configuration. The
113
 
   dropdown list contains entries for
114
 
   <ul>
115
 
   <li>Default
116
 
   <li>1.0
117
 
   <li>1.1
118
 
   <li>2.0
119
 
   <li>4.0
120
 
   </ul>
121
 
   
122
 
<p>If you select "Default" the assemblies in the project are examined to determine  
123
 
   the version that is required.
124
 
   See <a href="runtimeSelection.html">Runtime Selection</a> for 
125
 
   more information on how NUnit selects the version to be used.
126
 
 
127
 
<p>In special cases, you may wish to enter a version number that is not listed
128
 
   in the list box. You may specify the version using two, three or four
129
 
   components. The version you provide will be saved as you enter it. Leaving
130
 
   the text box blank is equivalent to selecting "Default." 
131
 
   
132
 
<p><b>Note:</b> Running tests under a different runtime or version from the one that NUnit
133
 
   is currently using will force them to run in a separate process.
134
 
   
135
 
<p><b>Note:</b> To conform with normal usage, specifying Mono as the runtime
136
 
   with "1.0" as the version results in use of the Mono 1.0 profile, equating
137
 
   to version 1.1.4322.
138
 
   
139
 
<h4>ApplicationBase</h4>
140
 
<p>The ApplicationBase defaults to the directory containing the project file. Beginning
141
 
with NUnit 2.2.3, it may be set to any location that is desired.</p>
142
 
 
143
 
<h4>Configuration File Name</h4>
144
 
<p>The configuration file defaults to the name of the test project with the extension changed
145
 
from .nunit to .config. The user may substitute another name.</p>
146
 
 
147
 
<h4>PrivateBinPath</h4>
148
 
<p>By default, the PrivateBinPath is generated from the assembly locations specified on the
149
 
Assemblies Tab. For those applications requiring a different level of control, it may be
150
 
specified manually or using this editor or placed in the configuration file.</p>
151
 
 
152
 
<h3>Assemblies Tab</h3>
153
 
 
154
 
<p>The assemblies tab contains the list of assemblies that form part of this test project.</p>
155
 
 
156
 
<p>Note: Although the dialog shows the location of assemblies as absolute paths, they are always
157
 
persisted in the NUnit project file as paths relative to the application base. This allows moving
158
 
projects as a whole to a different directory location.</p>
159
 
 
160
 
<div class="screenshot-left">
161
 
<img src="img/assembliesTab.jpg"></div>
162
 
 
163
 
<h4>Add...</h4>
164
 
<p>Opens a dialog allowing adding an assembly to this configuration. If Visual
165
 
Stuio support is enabled, you may also select and add a VS project.</p>
166
 
 
167
 
<h4>Remove</h4>
168
 
<p>After confirmation, removes the selected assembly from this configuration.</p>
169
 
 
170
 
<h4>Assembly Path</h4>
171
 
<p>This text box displays the full path to the selected assembly. You may edit
172
 
the contents to change the path to the assembly.
173
 
 
174
 
<h2>XML View</h2>
175
 
 
176
 
<p>This view simply displays the XML from the project file, as seen here. You may
177
 
edit the XML directly.</p>
178
 
 
179
 
<div class="screenshot-left">
180
 
<img src="img/xmlView.jpg"></div>
181
 
 
182
 
<p><b>Note:</b> In this version of NUnit, the XML editor is somewhat primitive.
183
 
Errors in XML formatting are caught and an error message displayed. However,
184
 
the values of attributes are not validated as they are in the property-based
185
 
view and it is possible to create a project file, which NUnit is unable to
186
 
load. Improvements, including intellisense and better error handling, are
187
 
planned in future versions of the Project Editor.
188
 
 
189
 
 
190
 
 
191
 
</div>
192
 
 
193
 
<!-- Submenu -->
194
 
<div id="subnav">
195
 
<ul>
196
 
<li><a href="index.html">NUnit 2.6</a></li>
197
 
<ul>
198
 
<li><a href="getStarted.html">Getting&nbsp;Started</a></li>
199
 
<li><a href="writingTests.html">Writing&nbsp;Tests</a></li>
200
 
<li><a href="runningTests.html">Running&nbsp;Tests</a></li>
201
 
<ul>
202
 
<li><a href="nunit-console.html">Console&nbsp;Runner</a></li>
203
 
<li><a href="nunit-gui.html">Gui&nbsp;Runner</a></li>
204
 
<li><a href="pnunit.html">PNUnit&nbsp;Runner</a></li>
205
 
<li><a href="nunit-agent.html">NUnit&nbsp;Agent</a></li>
206
 
<li id="current"><a href="projectEditor.html">Project&nbsp;Editor</a></li>
207
 
<li><a href="runtimeSelection.html">Runtime&nbsp;Selection</a></li>
208
 
<li><a href="assemblyIsolation.html">Assembly&nbsp;Isolation</a></li>
209
 
<li><a href="configFiles.html">Configuration&nbsp;Files</a></li>
210
 
<li><a href="multiAssembly.html">Multiple&nbsp;Assemblies</a></li>
211
 
<li><a href="vsSupport.html">Visual&nbsp;Studio&nbsp;Support</a></li>
212
 
</ul>
213
 
<li><a href="extensibility.html">Extensibility</a></li>
214
 
<li><a href="releaseNotes.html">Release&nbsp;Notes</a></li>
215
 
<li><a href="samples.html">Samples</a></li>
216
 
<li><a href="license.html">License</a></li>
217
 
</ul>
218
 
<li><a href="vsTestAdapter.html">NUnit&nbsp;Test&nbsp;Adapter&nbsp;0.90</a></li>
219
 
<ul>
220
 
<li><a href="vsTestAdapterLicense.html">License</a></li>
221
 
</ul>
222
 
<li><a href="&r=2.6.html"></a></li>
223
 
<li><a href="&r=2.6.html"></a></li>
224
 
</ul>
225
 
</div>
226
 
<!-- End of Submenu -->
227
 
 
228
 
 
229
 
<!-- Standard Footer for NUnit.org -->
230
 
<div id="footer">
231
 
  Copyright &copy; 2012 Charlie Poole. All Rights Reserved.
232
 
</div>
233
 
<!-- End of Footer -->
234
 
 
235
 
</body>
236
 
</html>
 
22
  </div>
 
23
</div>
 
24
<!-- End of Header -->
 
25
 
 
26
<div id="content">
 
27
 
 
28
<h2>Project Editor</h2>
 
29
 
 
30
<p>Beginning with NUnit 2.6, the Project Editor is a separate program, which may be executed
 
31
directly or run through the Project | Edit dropdown menu of the NUnit GUI. The editor now
 
32
provides two main views of the project: a property-oriented view based on the Project Editor
 
33
that was built into earlier versions of the NUnit GUI and an xml view, which allows direct
 
34
editing of the .nunit file.
 
35
 
 
36
<h2>Property View</h2>
 
37
 
 
38
<p>This view consists of a common area and two tabs, as seen in the image below.</p>
 
39
 
 
40
<div class="screenshot-left">
 
41
<img src="img/generalTab.jpg"></div>
 
42
 
 
43
<h3>Common Area</h3>
 
44
 
 
45
<p>The common area of the Project Editor contains information pertaining to
 
46
   the project as a whole. Information that applies to a particular configuration
 
47
   is displayed in the General and Assemblies tabs.
 
48
   
 
49
<h4>Project Path</h4>
 
50
<p>This label shows the full path to the project file. In the case of a 
 
51
   wrapper project, the path is set to the same directory as the assembly
 
52
   that was initially opened.
 
53
   
 
54
<h4>Application Base</h4> 
 
55
<p>This TextBox allows the user to change the project AppBase, which defaults to 
 
56
   the directory of the project file. The button to the right of the TextBox
 
57
   allows the user to browse and select a directory.
 
58
   
 
59
<h4>Process Model</h4>
 
60
<p>This dropdown list allows you to specify how operating system processes are
 
61
   used in loading and running the tests in this project. Four settings are
 
62
   defined:
 
63
   <ul>
 
64
   <li>The <b>Default</b> setting refers to the option selected by the user
 
65
       on the Assembly Isolation page of the NUnit Settings Dialog.
 
66
   <li><b>Single</b> means that tests are run in a test domain in the
 
67
           same process as NUnit. This is the way previous versions of NUnit
 
68
           ran tests.
 
69
   <li><b>Separate</b> means that all the tests are run in a separate process 
 
70
       that NUnit creates.
 
71
   <li><b>Multiple</b> means that NUnit will create a separate process for
 
72
       each test assembly in the project and run its tests there.
 
73
   </ul>
 
74
   
 
75
<h4>Domain Usage</h4>
 
76
<p>This dropdown list allows you to specify how tests are loaded into
 
77
   AppDomains by NUnit. Three settings are defined:
 
78
   <ul>
 
79
   <li>The <b>Default</b> setting refers to the option selected by the user
 
80
       on the Assembly Isolation page of the NUnit Settings Dialog.
 
81
   <li><b>Single</b> means that all tests will run in a single test domain
 
82
       created by NUnit. This was the way versions of NUnit prior to 2.4
 
83
           ran tests.
 
84
   <li><b>Multiple</b> means that each test assembly is loaded into a
 
85
       separate AppDomain. This setting is not available when Multiple
 
86
           processes are selected in the Process Model dropown.
 
87
   </ul>
 
88
   
 
89
<h4>Configuration</h4>
 
90
<p>This dropdown list allows you to select the particular configuration
 
91
   within a project that is displayed in the bottom part of the dialog.
 
92
   
 
93
<h4>Edit Configs...</h4>
 
94
<p>This button opens the  
 
95
   <a href="configEditor.html">Configuration Editor</a>,
 
96
   which allows you to add, delete or rename configs and set the
 
97
   active configuration.
 
98
 
 
99
<h3>General Tab</h3>
 
100
 
 
101
<p>The General tab allows setting a number of options pertaining to the selected configuration, all of
 
102
which will be stored in the NUnit project file as attributes of the <config> xml node.</p>
 
103
 
 
104
<h4>Runtime</h4>
 
105
<p>This dropdown allows you to select a particular runtime framework to be used
 
106
   for loading and running tests under the current configuration. Currently,
 
107
   only Microsoft .NET and Mono are supported. If <b>Any</b> is selected, the 
 
108
   tests will be run under the same runtime that NUnit itself is currently using.
 
109
 
 
110
<h4>Version</h4>
 
111
<p>This ComboBox allows you to select the particular version of the runtime framework
 
112
   to be used for loading and running tests under the current configuration. The
 
113
   dropdown list contains entries for
 
114
   <ul>
 
115
   <li>Default
 
116
   <li>1.0
 
117
   <li>1.1
 
118
   <li>2.0
 
119
   <li>4.0
 
120
   </ul>
 
121
   
 
122
<p>If you select "Default" the assemblies in the project are examined to determine  
 
123
   the version that is required.
 
124
   See <a href="runtimeSelection.html">Runtime Selection</a> for 
 
125
   more information on how NUnit selects the version to be used.
 
126
 
 
127
<p>In special cases, you may wish to enter a version number that is not listed
 
128
   in the list box. You may specify the version using two, three or four
 
129
   components. The version you provide will be saved as you enter it. Leaving
 
130
   the text box blank is equivalent to selecting "Default." 
 
131
   
 
132
<p><b>Note:</b> Running tests under a different runtime or version from the one that NUnit
 
133
   is currently using will force them to run in a separate process.
 
134
   
 
135
<p><b>Note:</b> To conform with normal usage, specifying Mono as the runtime
 
136
   with "1.0" as the version results in use of the Mono 1.0 profile, equating
 
137
   to version 1.1.4322.
 
138
   
 
139
<h4>ApplicationBase</h4>
 
140
<p>The ApplicationBase defaults to the directory containing the project file. Beginning
 
141
with NUnit 2.2.3, it may be set to any location that is desired.</p>
 
142
 
 
143
<h4>Configuration File Name</h4>
 
144
<p>The configuration file defaults to the name of the test project with the extension changed
 
145
from .nunit to .config. The user may substitute another name.</p>
 
146
 
 
147
<h4>PrivateBinPath</h4>
 
148
<p>By default, the PrivateBinPath is generated from the assembly locations specified on the
 
149
Assemblies Tab. For those applications requiring a different level of control, it may be
 
150
specified manually or using this editor or placed in the configuration file.</p>
 
151
 
 
152
<h3>Assemblies Tab</h3>
 
153
 
 
154
<p>The assemblies tab contains the list of assemblies that form part of this test project.</p>
 
155
 
 
156
<p>Note: Although the dialog shows the location of assemblies as absolute paths, they are always
 
157
persisted in the NUnit project file as paths relative to the application base. This allows moving
 
158
projects as a whole to a different directory location.</p>
 
159
 
 
160
<div class="screenshot-left">
 
161
<img src="img/assembliesTab.jpg"></div>
 
162
 
 
163
<h4>Add...</h4>
 
164
<p>Opens a dialog allowing adding an assembly to this configuration. If Visual
 
165
Stuio support is enabled, you may also select and add a VS project.</p>
 
166
 
 
167
<h4>Remove</h4>
 
168
<p>After confirmation, removes the selected assembly from this configuration.</p>
 
169
 
 
170
<h4>Assembly Path</h4>
 
171
<p>This text box displays the full path to the selected assembly. You may edit
 
172
the contents to change the path to the assembly.
 
173
 
 
174
<h2>XML View</h2>
 
175
 
 
176
<p>This view simply displays the XML from the project file, as seen here. You may
 
177
edit the XML directly.</p>
 
178
 
 
179
<div class="screenshot-left">
 
180
<img src="img/xmlView.jpg"></div>
 
181
 
 
182
<p><b>Note:</b> In this version of NUnit, the XML editor is somewhat primitive.
 
183
Errors in XML formatting are caught and an error message displayed. However,
 
184
the values of attributes are not validated as they are in the property-based
 
185
view and it is possible to create a project file, which NUnit is unable to
 
186
load. Improvements, including intellisense and better error handling, are
 
187
planned in future versions of the Project Editor.
 
188
 
 
189
 
 
190
 
 
191
</div>
 
192
 
 
193
<!-- Submenu -->
 
194
<div id="subnav">
 
195
<ul>
 
196
<li><a href="index.html">NUnit 2.6.3</a></li>
 
197
<ul>
 
198
<li><a href="getStarted.html">Getting&nbsp;Started</a></li>
 
199
<li><a href="writingTests.html">Writing&nbsp;Tests</a></li>
 
200
<li><a href="runningTests.html">Running&nbsp;Tests</a></li>
 
201
<ul>
 
202
<li><a href="nunit-console.html">Console&nbsp;Runner</a></li>
 
203
<li><a href="nunit-gui.html">Gui&nbsp;Runner</a></li>
 
204
<li><a href="pnunit.html">PNUnit&nbsp;Runner</a></li>
 
205
<li><a href="nunit-agent.html">NUnit&nbsp;Agent</a></li>
 
206
<li id="current"><a href="projectEditor.html">Project&nbsp;Editor</a></li>
 
207
<li><a href="runtimeSelection.html">Runtime&nbsp;Selection</a></li>
 
208
<li><a href="assemblyIsolation.html">Assembly&nbsp;Isolation</a></li>
 
209
<li><a href="configFiles.html">Configuration&nbsp;Files</a></li>
 
210
<li><a href="multiAssembly.html">Multiple&nbsp;Assemblies</a></li>
 
211
<li><a href="vsSupport.html">Visual&nbsp;Studio&nbsp;Support</a></li>
 
212
</ul>
 
213
<li><a href="extensibility.html">Extensibility</a></li>
 
214
<li><a href="releaseNotes.html">Release&nbsp;Notes</a></li>
 
215
<li><a href="samples.html">Samples</a></li>
 
216
<li><a href="license.html">License</a></li>
 
217
</ul>
 
218
<li><a href="vsTestAdapter.html">NUnit&nbsp;Test&nbsp;Adapter</a></li>
 
219
<ul>
 
220
<li><a href="vsTestAdapterLicense.html">License</a></li>
 
221
<li><a href="vsTestAdapterReleaseNotes.html">Release&nbsp;Notes</a></li>
 
222
</ul>
 
223
<li><a href="&r=2.6.3.html"></a></li>
 
224
<li><a href="&r=2.6.3.html"></a></li>
 
225
</ul>
 
226
</div>
 
227
<!-- End of Submenu -->
 
228
 
 
229
 
 
230
<!-- Standard Footer for NUnit.org -->
 
231
<div id="footer">
 
232
  Copyright &copy; 2012 Charlie Poole. All Rights Reserved.
 
233
</div>
 
234
<!-- End of Footer -->
 
235
 
 
236
</body>
 
237
</html>