mcs/nunit20/framework/Documentation/en/NUnit.Framework/Assertion.xml

   1 <Type Name="Assertion" FullName="NUnit.Framework.Assertion">
   2   <TypeSignature Language="C#" Value="public class Assertion" Maintainer="auto" />
   3   <AssemblyInfo>
   4     <AssemblyName>nunit.framework</AssemblyName>
   5     <AssemblyPublicKey>
   6     </AssemblyPublicKey>
   7     <AssemblyVersion>2.1.4.0</AssemblyVersion>
   8     <AssemblyVersion>2.2.0.0</AssemblyVersion>
   9   </AssemblyInfo>
  10   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  11   <Base>
  12     <BaseTypeName>System.Object</BaseTypeName>
  13   </Base>
  14   <Interfaces />
  15   <Attributes>
  16     <Attribute>
  17       <AttributeName>System.Obsolete("Use Assert class instead")</AttributeName>
  18     </Attribute>
  19   </Attributes>
  20   <Docs>
  21     <summary>
  22     The class Assertion is used to make assertions in methods flaged as a Test in a class flages as a TestFixture.
  23     </summary>
  24     <remarks>
  25       <para>
  26     Note: It is not mandatory to inherit from Assertion,
  27     but if you do, the code becomes a little more clear and you will save some typing.
  28     Assertion.AssertionEquals (...) vs AssertionEquals (...)
  29     </para>
  30       <para>
  31     A good idea is to tag your Test with the name of the test and a number.
  32     That information can be used when generating bug reports.
  33     </para>
  34       <example>
  35         <code lang="C#">
  36     using NUnit.Framework;
  37
  38     [TestFixture]
  39     public class MyUnitTest : Assertion {
  40
  41         string foo;
  42
  43         [SetUp]
  44         public void GetReady()
  45         {
  46                 foo = "Foobar";
  47         }
  48
  49         [Test]
  50         public void TestLength()
  51         {
  52                 AssertEquals ("(1) Length", 6, foo.Length);
  53         }
  54     }
  55     </code>
  56       </example>
  57     </remarks>
  58   </Docs>
  59   <Members>
  60     <Member MemberName=".ctor">
  61       <MemberSignature Language="C#" Value="public Assertion ();" />
  62       <MemberType>Constructor</MemberType>
  63       <ReturnValue />
  64       <Parameters />
  65       <Docs>
  66         <summary>Creates an Assertion object</summary>
  67         <remarks>Should not be used, all methods are static</remarks>
  68       </Docs>
  69       <AssemblyInfo>
  70         <AssemblyVersion>2.2.0.0</AssemblyVersion>
  71       </AssemblyInfo>
  72     </Member>
  73     <Member MemberName="Assert">
  74       <MemberSignature Language="C#" Value="public static void Assert (bool condition);" />
  75       <MemberType>Method</MemberType>
  76       <ReturnValue>
  77         <ReturnType>System.Void</ReturnType>
  78       </ReturnValue>
  79       <Parameters>
  80         <Parameter Name="condition" Type="System.Boolean" />
  81       </Parameters>
  82       <Docs>
  83         <param name="condition">The condition</param>
  84         <summary>Asserts that a condition is true</summary>
  85         <remarks>To be added.</remarks>
  86       </Docs>
  87       <AssemblyInfo>
  88         <AssemblyVersion>2.2.0.0</AssemblyVersion>
  89       </AssemblyInfo>
  90     </Member>
  91     <Member MemberName="Assert">
  92       <MemberSignature Language="C#" Value="public static void Assert (string message, bool condition);" />
  93       <MemberType>Method</MemberType>
  94       <ReturnValue>
  95         <ReturnType>System.Void</ReturnType>
  96       </ReturnValue>
  97       <Parameters>
  98         <Parameter Name="message" Type="System.String" />
  99         <Parameter Name="condition" Type="System.Boolean" />
 100       </Parameters>
 101       <Docs>
 102         <param name="message">A message</param>
 103         <param name="condition">The condition</param>
 104         <summary>Asserts that a condition is true</summary>
 105         <remarks>To be added</remarks>
 106       </Docs>
 107       <AssemblyInfo>
 108         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 109       </AssemblyInfo>
 110     </Member>
 111     <Member MemberName="AssertEquals">
 112       <MemberSignature Language="C#" Value="public static void AssertEquals (int expected, int actual);" />
 113       <MemberType>Method</MemberType>
 114       <ReturnValue>
 115         <ReturnType>System.Void</ReturnType>
 116       </ReturnValue>
 117       <Parameters>
 118         <Parameter Name="expected" Type="System.Int32" />
 119         <Parameter Name="actual" Type="System.Int32" />
 120       </Parameters>
 121       <Docs>
 122         <param name="expected">The expected</param>
 123         <param name="actual">The actual</param>
 124         <summary>Asserts that two ints are equal</summary>
 125         <remarks>To be added.</remarks>
 126       </Docs>
 127       <AssemblyInfo>
 128         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 129       </AssemblyInfo>
 130     </Member>
 131     <Member MemberName="AssertEquals">
 132       <MemberSignature Language="C#" Value="public static void AssertEquals (object expected, object actual);" />
 133       <MemberType>Method</MemberType>
 134       <ReturnValue>
 135         <ReturnType>System.Void</ReturnType>
 136       </ReturnValue>
 137       <Parameters>
 138         <Parameter Name="expected" Type="System.Object" />
 139         <Parameter Name="actual" Type="System.Object" />
 140       </Parameters>
 141       <Docs>
 142         <param name="expected">The expected object</param>
 143         <param name="actual">The actual object</param>
 144         <summary>Asserts that two objects are Equal</summary>
 145         <remarks>To be added.</remarks>
 146       </Docs>
 147       <AssemblyInfo>
 148         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 149       </AssemblyInfo>
 150     </Member>
 151     <Member MemberName="AssertEquals">
 152       <MemberSignature Language="C#" Value="public static void AssertEquals (double expected, double actual, double delta);" />
 153       <MemberType>Method</MemberType>
 154       <ReturnValue>
 155         <ReturnType>System.Void</ReturnType>
 156       </ReturnValue>
 157       <Parameters>
 158         <Parameter Name="expected" Type="System.Double" />
 159         <Parameter Name="actual" Type="System.Double" />
 160         <Parameter Name="delta" Type="System.Double" />
 161       </Parameters>
 162       <Docs>
 163         <param name="expected">The expected</param>
 164         <param name="actual">The actual</param>
 165         <param name="delta">The delta difference allowed</param>
 166         <summary>Asserts that two doubles are equal, accepting some difference expresed by the delta</summary>
 167         <remarks>To be added.</remarks>
 168       </Docs>
 169       <AssemblyInfo>
 170         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 171       </AssemblyInfo>
 172     </Member>
 173     <Member MemberName="AssertEquals">
 174       <MemberSignature Language="C#" Value="public static void AssertEquals (float expected, float actual, float delta);" />
 175       <MemberType>Method</MemberType>
 176       <ReturnValue>
 177         <ReturnType>System.Void</ReturnType>
 178       </ReturnValue>
 179       <Parameters>
 180         <Parameter Name="expected" Type="System.Single" />
 181         <Parameter Name="actual" Type="System.Single" />
 182         <Parameter Name="delta" Type="System.Single" />
 183       </Parameters>
 184       <Docs>
 185         <param name="expected">The expected</param>
 186         <param name="actual">The actual</param>
 187         <param name="delta">The delta difference allowed</param>
 188         <summary>Asserts that two floats are equal, accepting some difference expresed by the delta</summary>
 189         <remarks>To be added.</remarks>
 190       </Docs>
 191       <AssemblyInfo>
 192         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 193       </AssemblyInfo>
 194     </Member>
 195     <Member MemberName="AssertEquals">
 196       <MemberSignature Language="C#" Value="public static void AssertEquals (string message, int expected, int actual);" />
 197       <MemberType>Method</MemberType>
 198       <ReturnValue>
 199         <ReturnType>System.Void</ReturnType>
 200       </ReturnValue>
 201       <Parameters>
 202         <Parameter Name="message" Type="System.String" />
 203         <Parameter Name="expected" Type="System.Int32" />
 204         <Parameter Name="actual" Type="System.Int32" />
 205       </Parameters>
 206       <Docs>
 207         <param name="message">A message</param>
 208         <param name="expected">The expected</param>
 209         <param name="actual">The actual</param>
 210         <summary>Asserts that two ints are equal</summary>
 211         <remarks>To be added.</remarks>
 212       </Docs>
 213       <AssemblyInfo>
 214         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 215       </AssemblyInfo>
 216     </Member>
 217     <Member MemberName="AssertEquals">
 218       <MemberSignature Language="C#" Value="public static void AssertEquals (string message, object expected, object actual);" />
 219       <MemberType>Method</MemberType>
 220       <ReturnValue>
 221         <ReturnType>System.Void</ReturnType>
 222       </ReturnValue>
 223       <Parameters>
 224         <Parameter Name="message" Type="System.String" />
 225         <Parameter Name="expected" Type="System.Object" />
 226         <Parameter Name="actual" Type="System.Object" />
 227       </Parameters>
 228       <Docs>
 229         <param name="message">A message</param>
 230         <param name="expected">The expected object</param>
 231         <param name="actual">The actual object</param>
 232         <summary>Asserts that two objects are Equal</summary>
 233         <remarks>To be added.</remarks>
 234       </Docs>
 235       <AssemblyInfo>
 236         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 237       </AssemblyInfo>
 238     </Member>
 239     <Member MemberName="AssertEquals">
 240       <MemberSignature Language="C#" Value="public static void AssertEquals (string message, double expected, double actual, double delta);" />
 241       <MemberType>Method</MemberType>
 242       <ReturnValue>
 243         <ReturnType>System.Void</ReturnType>
 244       </ReturnValue>
 245       <Parameters>
 246         <Parameter Name="message" Type="System.String" />
 247         <Parameter Name="expected" Type="System.Double" />
 248         <Parameter Name="actual" Type="System.Double" />
 249         <Parameter Name="delta" Type="System.Double" />
 250       </Parameters>
 251       <Docs>
 252         <param name="message">A message</param>
 253         <param name="expected">The expected</param>
 254         <param name="actual">The actual</param>
 255         <param name="delta">The delta difference allowed</param>
 256         <summary>Asserts that two doubles are equal, accepting some difference expresed by the delta</summary>
 257         <remarks>To be added.</remarks>
 258       </Docs>
 259       <AssemblyInfo>
 260         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 261       </AssemblyInfo>
 262     </Member>
 263     <Member MemberName="AssertEquals">
 264       <MemberSignature Language="C#" Value="public static void AssertEquals (string message, float expected, float actual, float delta);" />
 265       <MemberType>Method</MemberType>
 266       <ReturnValue>
 267         <ReturnType>System.Void</ReturnType>
 268       </ReturnValue>
 269       <Parameters>
 270         <Parameter Name="message" Type="System.String" />
 271         <Parameter Name="expected" Type="System.Single" />
 272         <Parameter Name="actual" Type="System.Single" />
 273         <Parameter Name="delta" Type="System.Single" />
 274       </Parameters>
 275       <Docs>
 276         <param name="message">A message</param>
 277         <param name="expected">The expected</param>
 278         <param name="actual">The actual</param>
 279         <param name="delta">The delta difference allowed</param>
 280         <summary>Asserts that two floats are equal, accepting some difference expresed by the delta</summary>
 281         <remarks>To be added.</remarks>
 282       </Docs>
 283       <AssemblyInfo>
 284         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 285       </AssemblyInfo>
 286     </Member>
 287     <Member MemberName="AssertNotNull">
 288       <MemberSignature Language="C#" Value="public static void AssertNotNull (object anObject);" />
 289       <MemberType>Method</MemberType>
 290       <ReturnValue>
 291         <ReturnType>System.Void</ReturnType>
 292       </ReturnValue>
 293       <Parameters>
 294         <Parameter Name="anObject" Type="System.Object" />
 295       </Parameters>
 296       <Docs>
 297         <param name="anObject">The object</param>
 298         <summary>Asserts that an object do not reference null</summary>
 299         <remarks>To be added.</remarks>
 300       </Docs>
 301       <AssemblyInfo>
 302         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 303       </AssemblyInfo>
 304     </Member>
 305     <Member MemberName="AssertNotNull">
 306       <MemberSignature Language="C#" Value="public static void AssertNotNull (string message, object anObject);" />
 307       <MemberType>Method</MemberType>
 308       <ReturnValue>
 309         <ReturnType>System.Void</ReturnType>
 310       </ReturnValue>
 311       <Parameters>
 312         <Parameter Name="message" Type="System.String" />
 313         <Parameter Name="anObject" Type="System.Object" />
 314       </Parameters>
 315       <Docs>
 316         <param name="message">A message</param>
 317         <param name="anObject">The object</param>
 318         <summary>Asserts that an object do not reference null</summary>
 319         <remarks>To be added.</remarks>
 320       </Docs>
 321       <AssemblyInfo>
 322         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 323       </AssemblyInfo>
 324     </Member>
 325     <Member MemberName="AssertNull">
 326       <MemberSignature Language="C#" Value="public static void AssertNull (object anObject);" />
 327       <MemberType>Method</MemberType>
 328       <ReturnValue>
 329         <ReturnType>System.Void</ReturnType>
 330       </ReturnValue>
 331       <Parameters>
 332         <Parameter Name="anObject" Type="System.Object" />
 333       </Parameters>
 334       <Docs>
 335         <param name="anObject">The object</param>
 336         <summary>Asserts that an object references null</summary>
 337         <remarks>To be added.</remarks>
 338       </Docs>
 339       <AssemblyInfo>
 340         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 341       </AssemblyInfo>
 342     </Member>
 343     <Member MemberName="AssertNull">
 344       <MemberSignature Language="C#" Value="public static void AssertNull (string message, object anObject);" />
 345       <MemberType>Method</MemberType>
 346       <ReturnValue>
 347         <ReturnType>System.Void</ReturnType>
 348       </ReturnValue>
 349       <Parameters>
 350         <Parameter Name="message" Type="System.String" />
 351         <Parameter Name="anObject" Type="System.Object" />
 352       </Parameters>
 353       <Docs>
 354         <param name="message">A message</param>
 355         <param name="anObject">The object</param>
 356         <summary>Asserts that an object references null</summary>
 357         <remarks>To be added.</remarks>
 358       </Docs>
 359       <AssemblyInfo>
 360         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 361       </AssemblyInfo>
 362     </Member>
 363     <Member MemberName="AssertSame">
 364       <MemberSignature Language="C#" Value="public static void AssertSame (object expected, object actual);" />
 365       <MemberType>Method</MemberType>
 366       <ReturnValue>
 367         <ReturnType>System.Void</ReturnType>
 368       </ReturnValue>
 369       <Parameters>
 370         <Parameter Name="expected" Type="System.Object" />
 371         <Parameter Name="actual" Type="System.Object" />
 372       </Parameters>
 373       <Docs>
 374         <param name="expected">The expected object</param>
 375         <param name="actual">The actual object</param>
 376         <summary>Assert that two references refers to the same object</summary>
 377         <remarks>To be added.</remarks>
 378       </Docs>
 379       <AssemblyInfo>
 380         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 381       </AssemblyInfo>
 382     </Member>
 383     <Member MemberName="AssertSame">
 384       <MemberSignature Language="C#" Value="public static void AssertSame (string message, object expected, object actual);" />
 385       <MemberType>Method</MemberType>
 386       <ReturnValue>
 387         <ReturnType>System.Void</ReturnType>
 388       </ReturnValue>
 389       <Parameters>
 390         <Parameter Name="message" Type="System.String" />
 391         <Parameter Name="expected" Type="System.Object" />
 392         <Parameter Name="actual" Type="System.Object" />
 393       </Parameters>
 394       <Docs>
 395         <param name="message">A message</param>
 396         <param name="expected">The expected object</param>
 397         <param name="actual">The actual object</param>
 398         <summary>Assert that two references refers to the same object</summary>
 399         <remarks>To be added.</remarks>
 400       </Docs>
 401       <AssemblyInfo>
 402         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 403       </AssemblyInfo>
 404     </Member>
 405     <Member MemberName="Fail">
 406       <MemberSignature Language="C#" Value="public static void Fail ();" />
 407       <MemberType>Method</MemberType>
 408       <ReturnValue>
 409         <ReturnType>System.Void</ReturnType>
 410       </ReturnValue>
 411       <Parameters />
 412       <Docs>
 413         <summary>Fails a Test</summary>
 414         <remarks>To be added.</remarks>
 415       </Docs>
 416       <AssemblyInfo>
 417         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 418       </AssemblyInfo>
 419     </Member>
 420     <Member MemberName="Fail">
 421       <MemberSignature Language="C#" Value="public static void Fail (string message);" />
 422       <MemberType>Method</MemberType>
 423       <ReturnValue>
 424         <ReturnType>System.Void</ReturnType>
 425       </ReturnValue>
 426       <Parameters>
 427         <Parameter Name="message" Type="System.String" />
 428       </Parameters>
 429       <Docs>
 430         <param name="message">The message</param>
 431         <summary>Fails a Test with a message</summary>
 432         <remarks>To be added.</remarks>
 433       </Docs>
 434       <AssemblyInfo>
 435         <AssemblyVersion>2.2.0.0</AssemblyVersion>
 436       </AssemblyInfo>
 437     </Member>
 438   </Members>
 439 </Type>