← Back to branch summary

~mandel/ubuntuone-windows-installer/fix_null_pointer_start

« back to all changes in this revision

Viewing changes to tools/Nant/doc/help/tasks/nunit.html

  • Committer: Manuel de la Pena
  • Date: 2010-07-08 13:22:59 UTC
  • Revision ID: mandel@themacaque.com-20100708132259-y1jgyuyqfe9stt8u
Updated build script to run tests and added all the required tools so far.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/Nant/doc/help/tasks/nunit.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
  <!-- Documenting T:NAnt.NUnit1.Tasks.NUnitTask-->
 
4
  <head>
 
5
    <meta http-equiv="Content-Language" content="en-ca" />
 
6
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
7
    <link rel="stylesheet" type="text/css" href="../style.css" />
 
8
    <title>&lt;nunit&gt; Task</title>
 
9
  </head>
 
10
  <body>
 
11
    <table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
 
12
      <tr>
 
13
        <td class="NavBar-Cell">
 
14
          <a href="http://nant.sourceforge.net">
 
15
            <b>NAnt</b>
 
16
          </a>
 
17
          <img alt="-&gt;" src="../images/arrow.gif" />
 
18
          <a href="../index.html">Help</a>
 
19
          <img alt="-&gt;" src="../images/arrow.gif" />
 
20
          <a href="../tasks/index.html">Task Reference</a>
 
21
          <img alt="-&gt;" src="../images/arrow.gif" /> &lt;nunit&gt;</td>
 
22
        <td class="NavBar-Cell" align="right">
 
23
                        v0.90</td>
 
24
      </tr>
 
25
    </table>
 
26
    <h1>&lt;nunit&gt;</h1>
 
27
    <p>
 
28
      <i>(Deprecated)</i>
 
29
    </p>
 
30
    <p> Runs tests using the NUnit V1.0 framework. </p>
 
31
    <p> See the <a href="http://nunit.sf.net">NUnit home page</a> for more information. </p>
 
32
    <p> The <code>haltonfailure</code> or <code>haltonerror</code> attributes are only used to stop more than one test suite to stop running. If any test suite fails a build error will be thrown. Set <code>failonerror</code> to <b>false</b> to ignore test errors and continue build. </p>
 
33
    <h3>Parameters</h3>
 
34
    <div class="table">
 
35
      <table>
 
36
        <tr>
 
37
          <th>Attribute</th>
 
38
          <th style="text-align: center;">Type</th>
 
39
          <th>Description</th>
 
40
          <th style="text-align: center;">Required</th>
 
41
        </tr>
 
42
        <tr>
 
43
          <td valign="top">haltonerror</td>
 
44
          <td style="text-align: center;">bool</td>
 
45
          <td> Stops running tests when a test causes an error. The default is <b>false</b>. </td>
 
46
          <td style="text-align: center;">False</td>
 
47
        </tr>
 
48
        <tr>
 
49
          <td valign="top">haltonfailure</td>
 
50
          <td style="text-align: center;">bool</td>
 
51
          <td> Stops running tests if a test fails (errors are considered failures as well). The default is <b>false</b>. </td>
 
52
          <td style="text-align: center;">False</td>
 
53
        </tr>
 
54
        <tr>
 
55
          <td valign="top">timeout</td>
 
56
          <td style="text-align: center;">int</td>
 
57
          <td> Cancel the individual tests if they do not finish in the specified time (measured in milliseconds). Ignored if fork is disabled. </td>
 
58
          <td style="text-align: center;">False</td>
 
59
        </tr>
 
60
        <tr>
 
61
          <td valign="top">failonerror</td>
 
62
          <td style="text-align: center;">bool</td>
 
63
          <td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
 
64
          <td style="text-align: center;">False</td>
 
65
        </tr>
 
66
        <tr>
 
67
          <td valign="top">if</td>
 
68
          <td style="text-align: center;">bool</td>
 
69
          <td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
 
70
          <td style="text-align: center;">False</td>
 
71
        </tr>
 
72
        <tr>
 
73
          <td valign="top">unless</td>
 
74
          <td style="text-align: center;">bool</td>
 
75
          <td> Opposite of <code>if</code>. If <b>false</b> then the task will be executed; otherwise, skipped. The default is <b>false</b>. </td>
 
76
          <td style="text-align: center;">False</td>
 
77
        </tr>
 
78
        <tr>
 
79
          <td valign="top">verbose</td>
 
80
          <td style="text-align: center;">bool</td>
 
81
          <td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
 
82
          <td style="text-align: center;">False</td>
 
83
        </tr>
 
84
      </table>
 
85
    </div>
 
86
    <h3>Nested Elements:</h3>
 
87
    <!--Array-->
 
88
    <!--NestedElementArray=T:NAnt.NUnit1.Types.NUnitTest-->
 
89
    <h4>
 
90
      <a id="test">
 
91
      </a>
 
92
                    &lt;test&gt;
 
93
                </h4>
 
94
    <div class="nested-element"> Tests to run. <p> Represents a test element of an <a href="../tasks/nunit.html">&lt;nunit&gt;</a> task. </p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">assembly</td><td style="text-align: center;">string</td><td> Assembly to load the test from. </td><td style="text-align: center;">True</td></tr><tr><td valign="top" class="required">class</td><td style="text-align: center;">string</td><td> Class name of the test. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">appconfig</td><td style="text-align: center;">string</td><td> The application configuration file to use for the NUnit test domain. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">fork</td><td style="text-align: center;">bool</td><td> Run the tests in a separate <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemAppDomainClassTopic.asp">AppDomain</a>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">haltonerror</td><td style="text-align: center;">bool</td><td> Stop the build process if an error occurs during the test run. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">haltonfailure</td><td style="text-align: center;">bool</td><td> Stop the build process if a test fails (errors are considered failures as well). </td><td style="text-align: center;">False</td></tr><tr><td valign="top">outfile</td><td style="text-align: center;">string</td><td> Base name of the test result. The full filename is determined by this attribute and the extension of formatter. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">todir</td><td style="text-align: center;">string</td><td> Directory to write the reports to. </td><td style="text-align: center;">False</td></tr></table></div></div>
 
95
    <h4>
 
96
      <a id="test">
 
97
      </a>
 
98
                    &lt;/test&gt;
 
99
                </h4>
 
100
    <!--Array-->
 
101
    <!--NestedElementArray=T:NAnt.NUnit.Types.FormatterElement-->
 
102
    <h4>
 
103
      <a id="formatter">
 
104
      </a>
 
105
                    &lt;formatter&gt;
 
106
                </h4>
 
107
    <div class="nested-element"> Formatters to output results of unit tests. <p> Represents the FormatterElement of the NUnit task. </p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">type</td><td style="text-align: center;"><a href="../enums/NAnt.NUnit.Types.FormatterType.html">FormatterType</a></td><td> Type of formatter. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">extension</td><td style="text-align: center;">string</td><td> Extension to append to the output filename. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">outputdir</td><td style="text-align: center;">directory</td><td> Specifies the directory where the output file should be written to, if <code>usefile</code> is <b>true</b>. If not specified, the output file will be written to the directory where the test module is located. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">usefile</td><td style="text-align: center;">bool</td><td> Determines whether output should be persisted to a file. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
 
108
    <h4>
 
109
      <a id="formatter">
 
110
      </a>
 
111
                    &lt;/formatter&gt;
 
112
                </h4>
 
113
    <h3>Examples</h3>
 
114
    <ul class="examples">
 
115
      <li>
 
116
        <p> Run tests in the <code>MyProject.Tests.dll</code> assembly. </p>
 
117
        <p> The test results are logged in <code>results.xml</code> and <code>results.txt</code> using the <code>Xml</code> and <code>Plain</code> formatters, respectively. </p>
 
118
        <pre class="code">
 
119
&lt;nunit basedir="build" verbose="false" haltonerror="true" haltonfailure="true"&gt;
 
120
    &lt;formatter type="Xml" /&gt;
 
121
    &lt;formatter type="Plain" /&gt;
 
122
    &lt;test name="MyProject.Tests.AllTests" assembly="MyProject.Tests.dll" outfile="results"/&gt;
 
123
&lt;/nunit&gt;
 
124
    </pre>
 
125
      </li>
 
126
    </ul>
 
127
    <h3>Requirements</h3>
 
128
    <div style="margin-left: 20px;">
 
129
      <b>Assembly:</b> NAnt.NUnit1Tasks (0.90.3780.0)
 
130
            </div>
 
131
  </body>
 
132
</html>
 
 
b'\\ No newline at end of file'