← Back to branch summary

~nunit-core/nunitv2/2.5

« back to all changes in this revision

Viewing changes to src/NUnitCore/core/ITest.cs

  • Committer: charliepoole
  • Date: 2006-01-06 01:08:17 UTC
  • Revision ID: vcs-imports@canonical.com-20060106010817-z6xazs4kd89zj8j1
Move core from under NUnitFramework to NUnitCore directory

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/NUnitCore/core/ITest.cs
 
1
#region Copyright (c) 2002-2003, James W. Newkirk, Michael C. Two, Alexei A. Vorontsov, Charlie Poole, Philip A. Craig
 
2
/************************************************************************************
 
3
'
 
4
' Copyright � 2002-2003 James W. Newkirk, Michael C. Two, Alexei A. Vorontsov, Charlie Poole
 
5
' Copyright � 2000-2003 Philip A. Craig
 
6
'
 
7
' This software is provided 'as-is', without any express or implied warranty. In no 
 
8
' event will the authors be held liable for any damages arising from the use of this 
 
9
' software.
 
10
' 
 
11
' Permission is granted to anyone to use this software for any purpose, including 
 
12
' commercial applications, and to alter it and redistribute it freely, subject to the 
 
13
' following restrictions:
 
14
'
 
15
' 1. The origin of this software must not be misrepresented; you must not claim that 
 
16
' you wrote the original software. If you use this software in a product, an 
 
17
' acknowledgment (see the following) in the product documentation is required.
 
18
'
 
19
' Portions Copyright � 2003 James W. Newkirk, Michael C. Two, Alexei A. Vorontsov, Charlie Poole
 
20
' or Copyright � 2000-2003 Philip A. Craig
 
21
'
 
22
' 2. Altered source versions must be plainly marked as such, and must not be 
 
23
' misrepresented as being the original software.
 
24
'
 
25
' 3. This notice may not be removed or altered from any source distribution.
 
26
'
 
27
'***********************************************************************************/
 
28
#endregion
 
29
 
 
30
using System.Collections;
 
31
 
 
32
namespace NUnit.Core
 
33
{
 
34
        /// <summary>
 
35
        /// Common interface supported by all representations
 
36
        /// of a test. Only includes informational fields.
 
37
        /// The Run method is specifically excluded to allow
 
38
        /// for data-only representations of a test.
 
39
        /// </summary>
 
40
        public interface ITest
 
41
        {
 
42
                /// <summary>
 
43
                /// Name of the test
 
44
                /// </summary>
 
45
                string Name     { get; }
 
46
                
 
47
                /// <summary>
 
48
                /// Full Name of the test
 
49
                /// </summary>
 
50
                string FullName { get; }
 
51
 
 
52
                /// <summary>
 
53
                /// Key used to locate a test. Although the
 
54
                /// ID alone would be sufficient, we combine it with the
 
55
                /// FullName for ease in debugging and for use in messages.
 
56
                /// </summary>
 
57
                string UniqueName { get; }
 
58
 
 
59
                /// <summary>
 
60
                /// The test ID is a quasi-unique identifier for tests. It supports
 
61
                /// over four billion test nodes in a single runner tree.
 
62
                /// </summary>
 
63
                int ID { get; }
 
64
 
 
65
                /// <summary>
 
66
                /// Whether or not the test should be run
 
67
                /// </summary>
 
68
                bool ShouldRun { get; set; }
 
69
 
 
70
                /// <summary>
 
71
                /// Reason for not running the test, if applicable
 
72
                /// </summary>
 
73
                string IgnoreReason { get; set; }
 
74
                
 
75
                /// <summary>
 
76
                /// Count of the test cases ( 1 if this is a test case )
 
77
                /// </summary>
 
78
                int CountTestCases();
 
79
 
 
80
                /// <summary>
 
81
                /// For a test suite, the child tests or suites
 
82
                /// Null if this is not a test suite
 
83
                /// </summary>
 
84
                ArrayList Tests { get; }
 
85
 
 
86
                /// <summary>
 
87
                /// Categories available for this test
 
88
                /// </summary>
 
89
                IList Categories { get; }
 
90
 
 
91
                bool HasCategory( string name );
 
92
 
 
93
                bool HasCategory( IList names );
 
94
 
 
95
                /// <summary>
 
96
                /// True if this is a suite
 
97
                /// </summary>
 
98
                bool IsSuite { get; }
 
99
 
 
100
                /// <summary>
 
101
                /// True if this is a TestFixture
 
102
                /// </summary>
 
103
                bool IsFixture { get; }
 
104
 
 
105
                /// <summary>
 
106
                /// True if this is a TestCase
 
107
                /// </summary>
 
108
                bool IsTestCase { get; }
 
109
 
 
110
                /// <summary>
 
111
                /// Return the description field. 
 
112
                /// </summary>
 
113
                string Description { get; set; }
 
114
 
 
115
                /// <summary>
 
116
                /// True if this should only be run explicitly - that is
 
117
                /// if it was marked with the ExplicitAttribute.
 
118
                /// </summary>
 
119
                bool IsExplicit { get; set; }
 
120
        }
 
121
}
 
122