1 // ***********************************************************************
2 // Copyright (c) 2007 Charlie Poole
4 // Permission is hereby granted, free of charge, to any person obtaining
5 // a copy of this software and associated documentation files (the
6 // "Software"), to deal in the Software without restriction, including
7 // without limitation the rights to use, copy, modify, merge, publish,
8 // distribute, sublicense, and/or sell copies of the Software, and to
9 // permit persons to whom the Software is furnished to do so, subject to
10 // the following conditions:
12 // The above copyright notice and this permission notice shall be
13 // included in all copies or substantial portions of the Software.
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 // ***********************************************************************
25 #define NUNIT_FRAMEWORK
30 using NUnit.Framework.Interfaces;
31 using NUnit.Framework.Internal;
33 namespace NUnit.Framework
36 /// ExplicitAttribute marks a test or test fixture so that it will
37 /// only be run if explicitly executed from the gui or command line
38 /// or if it is included by use of a filter. The test will not be
39 /// run simply because an enclosing suite is run.
41 [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Assembly, AllowMultiple=false, Inherited=false)]
42 public class ExplicitAttribute : NUnitAttribute, IApplyToTest
44 private string _reason;
47 /// Default constructor
49 public ExplicitAttribute()
54 /// Constructor with a reason
56 /// <param name="reason">The reason test is marked explicit</param>
57 public ExplicitAttribute(string reason)
62 #region IApplyToTest members
65 /// Modifies a test by marking it as explicit.
67 /// <param name="test">The test to modify</param>
68 public void ApplyToTest(Test test)
70 if (test.RunState != RunState.NotRunnable && test.RunState != RunState.Ignored)
72 test.RunState = RunState.Explicit;
74 test.Properties.Set(PropertyNames.SkipReason, _reason);