main
1<?xml version="1.0" encoding="utf-8" ?>
2
3<helpItems xmlns="http://msh" schema="maml">
4
5 <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
6 <command:details>
7 <command:name>
8 Run-Gallio
9 </command:name>
10 <maml:description>
11 <maml:para>Runs tests using Gallio.</maml:para>
12 </maml:description>
13 <maml:copyright>
14 <maml:para>Copyright © 2005-2008 Gallio Project - http://www.gallio.org/</maml:para>
15 </maml:copyright>
16 <command:verb>Run</command:verb>
17 <command:noun>Gallio</command:noun>
18 <dev:version></dev:version>
19 </command:details>
20 <maml:description>
21 <maml:para>The Run-Gallio cmdlet runs tests using Gallio.</maml:para>
22 </maml:description>
23 <command:syntax>
24
25 <!--
26
27 Description of the properties used in the command:parameter elements:
28
29 # Required
30 * If true, the parameter must appear in all commands that use the parameter set.
31 * If false, the parameter is optional in all commands that use the parameter set.
32
33 # Position
34 * If named, the parameter name is required.
35 * If positional, the parameter name is optional. When it is omitted, the parameter value must be in the specified position in the command. For example, if the value is position="1", the parameter value must be the first or only unnamed parameter value in the command.
36
37 # Pipeline Input
38 * If true (ByValue), you can pipe input to the parameter. The input is associated with ("bound to") the parameter even if the property name and the object type do not match the expected type. The Microsoft® Windows® PowerShell parameter binding components try to convert the input to the correct type and fail the command only when the type cannot be converted. Only one parameter in a parameter set can be associated by value.
39 * If true (ByPropertyName), you can pipe input to the parameter. However, the input is associated with the parameter only when the parameter name matches the name of a property of the input object. For example, if the parameter name is Path, objects piped to the cmdlet are associated with that parameter only when the object has a property named path.
40 * If true (ByValue, ByPropertyName), you can pipe input to the parameter either by property name or by value. Only one parameter in a parameter set can be associated by value.
41 * If false, you cannot pipe input to this parameter.
42
43 # Globbing
44 * If true, the text that the user types for the parameter value can include wildcard characters.
45 * If false, the text that the user types for the parameter value cannot include wildcard characters.
46
47 # VariableLength
48
49 * It looks this property is meaningless, at least in PowerShell 1.0:
50
51 ============================================================================
52 Hi Keith
53
54 This attribute is not consumed by our Help formatter in the current release.
55 This is added to comply with MAML command schema.
56
57 Thanks
58 Krishna[MSFT]
59 Windows PowerShell Team
60 Microsoft Corporation
61 This posting is provided "AS IS" with no warranties, and confers no rights.
62 ============================================================================
63 -->
64
65 <command:syntaxItem>
66
67 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
68 <maml:name>ApplicationBaseDirectory</maml:name>
69 <maml:description>
70 <maml:para>The relative or absolute path of the application base directory.</maml:para>
71 </maml:description>
72 <dev:defaultValue>String.Empty</dev:defaultValue>
73 </command:parameter>
74
75 <maml:name>Run-Gallio</maml:name>
76 <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1">
77 <maml:name>Assemblies</maml:name>
78 <maml:description>
79 <maml:para>The list of relative or absolute paths of test assembly files to execute.</maml:para>
80 </maml:description>
81 </command:parameter>
82
83 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
84 <maml:name>DoNotRun</maml:name>
85 <maml:description>
86 <maml:para>Sets whether to load the tests but not run them. This option may be used to produce a report that contains test metadata for consumption by other tools.</maml:para>
87 </maml:description>
88 <dev:defaultValue>false</dev:defaultValue>
89 </command:parameter>
90
91 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
92 <maml:name>Filter</maml:name>
93 <maml:description>
94 <maml:para>Sets the filter expression to apply, which consists of one or more filter rules that may be combined using 'and', 'or', and 'not' and grouped with parentheses. A filter rule consists of a filter key followed by one or more comma-delimited matching values in the form 'key: value, "quoted value", /regular expression/'.</maml:para>
95 </maml:description>
96 <dev:defaultValue>*</dev:defaultValue>
97 </command:parameter>
98
99 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
100 <maml:name>HintDirectories</maml:name>
101 <maml:description>
102 <maml:para>The list of directories used for loading assemblies and other dependent resources.</maml:para>
103 </maml:description>
104 </command:parameter>
105
106 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
107 <maml:name>NoEchoResults</maml:name>
108 <maml:description>
109 <maml:para>Sets whether to echo results to the screen as tests finish. If this option is specified only the final summary statistics are displayed. Otherwise test results are echoed to the console in varying detail depending on the current verbosity level.</maml:para>
110 </maml:description>
111 <dev:defaultValue>false</dev:defaultValue>
112 </command:parameter>
113
114 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
115 <maml:name>PluginDirectories</maml:name>
116 <maml:description>
117 <maml:para>Additional Gallio plugin directories to search recursively.</maml:para>
118 </maml:description>
119 </command:parameter>
120
121 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
122 <maml:name>ReportDirectory</maml:name>
123 <maml:description>
124 <maml:para>Sets the name of the directory where the reports will be put.</maml:para>
125 </maml:description>
126 <dev:defaultValue>String.Empty</dev:defaultValue>
127 </command:parameter>
128
129 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
130 <maml:name>ReportNameFormat</maml:name>
131 <maml:description>
132 <maml:para>Sets the format string to use to generate the reports filenames.</maml:para>
133 </maml:description>
134 <dev:defaultValue>test-report-{0}-{1}</dev:defaultValue>
135 </command:parameter>
136
137 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
138 <maml:name>ReportTypes</maml:name>
139 <maml:description>
140 <maml:para>A list of the types of reports to generate, separated by semicolons.</maml:para>
141 </maml:description>
142 <dev:defaultValue>String.Empty</dev:defaultValue>
143 </command:parameter>
144
145 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
146 <maml:name>RunnerType</maml:name>
147 <maml:description>
148 <maml:para>Sets the type of test runner to use (LocalAppDomain, IsolatedAppDomain or IsolatedProcess, but more could be available as plugins).</maml:para>
149 </maml:description>
150 <dev:defaultValue>IsolatedProcess</dev:defaultValue>
151 </command:parameter>
152
153 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
154 <maml:name>ShadowCopy</maml:name>
155 <maml:description>
156 <maml:para>
157 Enables shadow copying when set to true. Shadow copying allows the original assemblies to be modified while the tests are running. However, shadow copying may occasionally cause some tests to fail if they depend on their original location.
158 </maml:para>
159 </maml:description>
160 <dev:defaultValue>false</dev:defaultValue>
161 </command:parameter>
162
163 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
164 <maml:name>ShowReports</maml:name>
165 <maml:description>
166 <maml:para>Sets whether to open the generated reports once execution has finished.</maml:para>
167 </maml:description>
168 <dev:defaultValue>false</dev:defaultValue>
169 </command:parameter>
170
171 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
172 <maml:name>WorkingDirectory</maml:name>
173 <maml:description>
174 <maml:para>
175 The relative or absolute path of the working directory. If relative, the path is based on the current working directory, so a value of "" (an empty string) causes the current working directory to be used.
176 </maml:para>
177 </maml:description>
178 <dev:defaultValue>String.Empty</dev:defaultValue>
179 </command:parameter>
180
181 </command:syntaxItem>
182 </command:syntax>
183
184 <command:parameters>
185
186 <!-- This section is a copy paste of the syntax parameter. The only difference between both sections
187 is that here the parameters can appear only once, whereas in the syntax section they can appear in
188 different parameter sets. -->
189
190 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
191 <maml:name>ApplicationBaseDirectory</maml:name>
192 <maml:description>
193 <maml:para>The relative or absolute path of the application base directory.</maml:para>
194 </maml:description>
195 <dev:defaultValue>String.Empty</dev:defaultValue>
196 </command:parameter>
197
198 <maml:name>Run-Gallio</maml:name>
199 <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1">
200 <maml:name>Assemblies</maml:name>
201 <maml:description>
202 <maml:para>The list of relative or absolute paths of test assembly files to execute.</maml:para>
203 </maml:description>
204 </command:parameter>
205
206 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
207 <maml:name>DoNotRun</maml:name>
208 <maml:description>
209 <maml:para>Sets whether to load the tests but not run them. This option may be used to produce a report that contains test metadata for consumption by other tools.</maml:para>
210 </maml:description>
211 <dev:defaultValue>false</dev:defaultValue>
212 </command:parameter>
213
214 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
215 <maml:name>Filter</maml:name>
216 <maml:description>
217 <maml:para>Sets the filter expression to apply, which consists of one or more filter rules that may be combined using 'and', 'or', and 'not' and grouped with parentheses. A filter rule consists of a filter key followed by one or more comma-delimited matching values in the form 'key: value, "quoted value", /regular expression/'.</maml:para>
218 </maml:description>
219 <dev:defaultValue>*</dev:defaultValue>
220 </command:parameter>
221
222 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
223 <maml:name>HintDirectories</maml:name>
224 <maml:description>
225 <maml:para>The list of directories used for loading assemblies and other dependent resources.</maml:para>
226 </maml:description>
227 </command:parameter>
228
229 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
230 <maml:name>NoEchoResults</maml:name>
231 <maml:description>
232 <maml:para>Sets whether to echo results to the screen as tests finish. If this option is specified only the final summary statistics are displayed. Otherwise test results are echoed to the console in varying detail depending on the current verbosity level.</maml:para>
233 </maml:description>
234 <dev:defaultValue>false</dev:defaultValue>
235 </command:parameter>
236
237 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
238 <maml:name>PluginDirectories</maml:name>
239 <maml:description>
240 <maml:para>Additional Gallio plugin directories to search recursively.</maml:para>
241 </maml:description>
242 </command:parameter>
243
244 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
245 <maml:name>ReportDirectory</maml:name>
246 <maml:description>
247 <maml:para>Sets the name of the directory where the reports will be put.</maml:para>
248 </maml:description>
249 <dev:defaultValue>String.Empty</dev:defaultValue>
250 </command:parameter>
251
252 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
253 <maml:name>ReportNameFormat</maml:name>
254 <maml:description>
255 <maml:para>Sets the format string to use to generate the reports filenames.</maml:para>
256 </maml:description>
257 <dev:defaultValue>test-report-{0}-{1}</dev:defaultValue>
258 </command:parameter>
259
260 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
261 <maml:name>ReportTypes</maml:name>
262 <maml:description>
263 <maml:para>A list of the types of reports to generate, separated by semicolons.</maml:para>
264 </maml:description>
265 <dev:defaultValue>String.Empty</dev:defaultValue>
266 </command:parameter>
267
268 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
269 <maml:name>RunnerType</maml:name>
270 <maml:description>
271 <maml:para>Sets the type of test runner to use: Local, IsolatedAppDomain, IsolatedProcess, or others that may be provided by plugins.</maml:para>
272 </maml:description>
273 <dev:defaultValue>IsolatedProcess</dev:defaultValue>
274 </command:parameter>
275
276 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
277 <maml:name>RunnerExtensions</maml:name>
278 <maml:description>
279 <maml:para>Specifies the type, assembly, and parameters of custom test runner extensions to use during the test run in the form: '[Namespace.]Type,Assembly[;Parameters]. eg. 'FancyLogger,MyExtensions.dll;ColorOutput,FancyIndenting'</maml:para>
280 </maml:description>
281 </command:parameter>
282
283 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
284 <maml:name>ShadowCopy</maml:name>
285 <maml:description>
286 <maml:para>
287 Enables shadow copying when set to true. Shadow copying allows the original assemblies to be modified while the tests are running. However, shadow copying may occasionally cause some tests to fail if they depend on their original location.
288 </maml:para>
289 </maml:description>
290 <dev:defaultValue>false</dev:defaultValue>
291 </command:parameter>
292
293 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
294 <maml:name>ShowReports</maml:name>
295 <maml:description>
296 <maml:para>Sets whether to open the generated reports once execution has finished.</maml:para>
297 </maml:description>
298 <dev:defaultValue>false</dev:defaultValue>
299 </command:parameter>
300
301 <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
302 <maml:name>WorkingDirectory</maml:name>
303 <maml:description>
304 <maml:para>
305 The relative or absolute path of the working directory. If relative, the path is based on the current working directory, so a value of "" (an empty string) causes the current working directory to be used.
306 </maml:para>
307 </maml:description>
308 <dev:defaultValue>String.Empty</dev:defaultValue>
309 </command:parameter>
310
311 </command:parameters>
312
313 <command:examples>
314 <command:example>
315 # Makes the Gallio commands available
316 Add-PSSnapIn Gallio
317 # Runs TestAssembly1.dll
318 Run-Gallio "[Path-to-assembly1]\TestAssembly1.dll" -f Category:UnitTests -rd C:\build\reports -rf html
319 </command:example>
320 </command:examples>
321
322 </command:command>
323
324</helpItems>