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
29 using NUnit.Framework.Internal;
31 namespace NUnit.Framework.Interfaces
34 /// The ITestCaseBuilder interface is exposed by a class that knows how to
35 /// build a test case from certain methods.
38 /// This interface is not the same as the ITestCaseBuilder interface in NUnit 2.x.
39 /// We have reused the name because the two products don't interoperate at all.
41 public interface ITestCaseBuilder
44 /// Examine the method and determine if it is suitable for
45 /// this builder to use in building a TestCase to be
46 /// included in the suite being populated.
48 /// Note that returning false will cause the method to be ignored
49 /// in loading the tests. If it is desired to load the method
50 /// but label it as non-runnable, ignored, etc., then this
51 /// method must return true.
53 /// <param name="method">The test method to examine</param>
54 /// <param name="suite">The suite being populated</param>
55 /// <returns>True is the builder can use this method</returns>
56 bool CanBuildFrom(IMethodInfo method, Test suite);
59 /// Build a TestCase from the provided MethodInfo for
60 /// inclusion in the suite being constructed.
62 /// <param name="method">The method to be used as a test case</param>
63 /// <param name="suite">The test suite being populated, or null</param>
64 /// <returns>A TestCase or null</returns>
65 Test BuildFrom(IMethodInfo method, Test suite);