/src/NUnit/interfaces/Extensibility/ITestCaseData.cs

 1// ****************************************************************
 2// Copyright 2008, Charlie Poole
 3// This is free software licensed under the NUnit license. You may
 4// obtain a copy of the license at http://nunit.org
 5// ****************************************************************
 6
 7using System;
 8
 9namespace NUnit.Framework
10{
11    /// <summary>
12    /// The ITestCaseData interface is implemented by a class
13    /// that is able to return complete testcases for use by
14    /// a parameterized test method.
15    /// 
16    /// NOTE: This interface is used in both the framework
17    /// and the core, even though that results in two different
18    /// types. However, sharing the source code guarantees that
19    /// the various implementations will be compatible and that
20    /// the core is able to reflect successfully over the
21    /// framework implementations of ITestCaseData.
22    /// </summary>
23    public interface ITestCaseData
24    {
25        /// <summary>
26        /// Gets the argument list to be provided to the test
27        /// </summary>
28        object[] Arguments { get; }
29
30        /// <summary>
31        /// Gets the expected result
32        /// </summary>
33        object Result { get; }
34
35        /// <summary>
36        ///  Gets the expected exception Type
37        /// </summary>
38        Type ExpectedException { get; }
39
40        /// <summary>
41        /// Gets the FullName of the expected exception
42        /// </summary>
43        string ExpectedExceptionName { get; }
44
45        /// <summary>
46        /// Gets the name to be used for the test
47        /// </summary>
48        string TestName { get; }
49
50        /// <summary>
51        /// Gets the description of the test
52        /// </summary>
53        string Description { get; }
54
55        /// <summary>
56        /// Gets a value indicating whether this <see cref="ITestCaseData"/> is ignored.
57        /// </summary>
58        /// <value><c>true</c> if ignored; otherwise, <c>false</c>.</value>
59        bool Ignored { get; }
60
61        /// <summary>
62        /// Gets the ignore reason.
63        /// </summary>
64        /// <value>The ignore reason.</value>
65        string IgnoreReason { get; }
66    }
67}