Click here to Skip to main content
15,885,065 members
Articles / Desktop Programming / Windows Forms

Traceract

Rate me:
Please Sign up or sign in to vote.
3.69/5 (9 votes)
3 Sep 20059 min read 98.5K   1.6K   37  
A prototype debug tracer with an added dimension.
/*
(c) 2005, Marc Clifton
All Rights Reserved
 
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 

Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution. 

Neither the name of the Marc Clifton, "Advanced Unit Test", "AUT", nor the names
of its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

using System;
using System.Diagnostics;

namespace Vts.UnitTest
{
	public class AssertionException : Exception
	{
		public AssertionException(string message) : base(message)
		{
		}
	}

	public class Assertion
	{
		/// <summary>
		/// Causes a test to fail
		/// </summary>
		public static void Fail() { Fail(""); }
		/// <summary>
		/// Causes a test to fail
		/// </summary>
		/// <param name="message">a message in case of failure</param>
		public static void Fail(string message) 
		{
			throw new AssertionException(message);
		}

		/// <summary>
		/// Calls IsTrue
		/// </summary>
		/// <param name="mustBeTrue"></param>
		/// <param name="message"></param>
		public static void Assert(bool mustBeTrue, string message)
		{
			Assertion.IsTrue(mustBeTrue, message);
		}

		/// <summary>
		/// Asserts that a given expression is true
		/// </summary>
		/// <param name="expression">expression to validate</param>
		public static void IsTrue(bool expression) { IsTrue(expression, ""); }
		/// <summary>
		/// Asserts that a given expression is true
		/// </summary>
		/// <param name="expression">expression to validate</param>
		/// <param name="message">a message in case of failure</param>
		public static void IsTrue(bool expression, string message) 
		{
			if (!expression)
			{
				Trace.Write(message);
				throw(new AssertionException(message));
			}
		}

		/// <summary>
		/// Asserts that a given expression is false
		/// </summary>
		/// <param name="expression">expression to validate</param>
		public static void IsFalse(bool expression) { IsFalse(expression, ""); }
		/// <summary>
		/// Asserts that a given expression is false
		/// </summary>
		/// <param name="expression">expression to validate</param>
		/// <param name="message">a message in case of failure</param>
		public static void IsFalse(bool expression, string message) 
		{
			IsTrue(!expression, message);
		}

		/// <summary>
		/// Asserts that a given object reference is null
		/// </summary>
		/// <param name="obj">object to validate</param>
		public static void IsNull(object obj) { IsNull(obj, ""); }
		/// <summary>
		/// Asserts that a given object reference is null
		/// </summary>
		/// <param name="obj">object to validate</param>
		/// <param name="message">a message in case of failure</param>
		public static void IsNull(object obj, string message) 
		{
			IsTrue(obj == null, message);
		}

		/// <summary>
		/// Asserts that a given object reference is not null
		/// </summary>
		/// <param name="obj">object to validate</param>
		public static void IsNotNull(object obj) { IsNotNull(obj, ""); }
		/// <summary>
		/// Asserts that a given object reference is not null
		/// </summary>
		/// <param name="obj">object to validate</param>
		/// <param name="message">a message in case of failure</param>
		public static void IsNotNull(object obj, string message) 
		{
			IsFalse(obj == null, message);
		}

		/// <summary>
		/// Asserts that two values are equal
		/// </summary>
		/// <param name="expected">expected value</param>
		/// <param name="actual">actual value</param>
		public static void AreEqual(object expected, object actual) { AreEqual(expected, actual, ""); }
		/// <summary>
		/// Asserts that two values are equal.
		/// </summary>
		/// <param name="expected">expected value</param>
		/// <param name="actual">actual value</param>
		/// <param name="message">a message in case of failure</param>
		public static void AreEqual(object expected, object actual, string message) 
		{
			IsTrue(expected.Equals(actual), message);
		}

		/// <summary>
		/// Asserts that two values are not equal.
		/// </summary>
		/// <param name="firstValue">first value</param>
		/// <param name="secondValue">second value</param>
		public static void AreNotEqual(object firstValue, object secondValue) { AreNotEqual(firstValue, secondValue, ""); }
		/// <summary>
		/// Asserts that two values are not equal.
		/// </summary>
		/// <param name="firstValue">first value</param>
		/// <param name="secondValue">second value</param>
		/// <param name="message">a message in case of failure</param>
		public static void AreNotEqual(object firstValue, object secondValue, string message) 
		{
			IsFalse(firstValue.Equals(secondValue), message);
		}
	}
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
Architect Interacx
United States United States
Blog: https://marcclifton.wordpress.com/
Home Page: http://www.marcclifton.com
Research: http://www.higherorderprogramming.com/
GitHub: https://github.com/cliftonm

All my life I have been passionate about architecture / software design, as this is the cornerstone to a maintainable and extensible application. As such, I have enjoyed exploring some crazy ideas and discovering that they are not so crazy after all. I also love writing about my ideas and seeing the community response. As a consultant, I've enjoyed working in a wide range of industries such as aerospace, boatyard management, remote sensing, emergency services / data management, and casino operations. I've done a variety of pro-bono work non-profit organizations related to nature conservancy, drug recovery and women's health.

Comments and Discussions