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 /// PropertyAttribute is used to attach information to a test as a name/value pair..
38 [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Assembly, AllowMultiple=true, Inherited=true)]
39 public class PropertyAttribute : NUnitAttribute, IApplyToTest
41 private PropertyBag properties = new PropertyBag();
44 /// Construct a PropertyAttribute with a name and string value
46 /// <param name="propertyName">The name of the property</param>
47 /// <param name="propertyValue">The property value</param>
48 public PropertyAttribute(string propertyName, string propertyValue)
50 this.properties.Add(propertyName, propertyValue);
54 /// Construct a PropertyAttribute with a name and int value
56 /// <param name="propertyName">The name of the property</param>
57 /// <param name="propertyValue">The property value</param>
58 public PropertyAttribute(string propertyName, int propertyValue)
60 this.properties.Add(propertyName, propertyValue);
64 /// Construct a PropertyAttribute with a name and double value
66 /// <param name="propertyName">The name of the property</param>
67 /// <param name="propertyValue">The property value</param>
68 public PropertyAttribute(string propertyName, double propertyValue)
70 this.properties.Add(propertyName, propertyValue);
74 /// Constructor for derived classes that set the
75 /// property dictionary directly.
77 protected PropertyAttribute() { }
80 /// Constructor for use by derived classes that use the
81 /// name of the type as the property name. Derived classes
82 /// must ensure that the Type of the property value is
83 /// a standard type supported by the BCL. Any custom
84 /// types will cause a serialization Exception when
87 protected PropertyAttribute( object propertyValue )
89 string propertyName = this.GetType().Name;
90 if ( propertyName.EndsWith( "Attribute" ) )
91 propertyName = propertyName.Substring( 0, propertyName.Length - 9 );
92 this.properties.Add(propertyName, propertyValue);
96 /// Gets the property dictionary for this attribute
98 public IPropertyBag Properties
100 get { return properties; }
103 #region IApplyToTest Members
106 /// Modifies a test by adding properties to it.
108 /// <param name="test">The test to modify</param>
109 public virtual void ApplyToTest(Test test)
111 foreach (string key in Properties.Keys)
112 foreach(object value in Properties[key])
113 test.Properties.Add(key, value);