Home > Articles > Programming > Windows Programming

Like this article? We recommend

Like this article? We recommend

Using NUnit To Debug .NET Code

What does NUnit have to do with TraceListeners? That's a good question. Let me start by telling you what NUnit is and what it does.

NUnit is an open source test application suite from http://www.nunit.org. It's very well designed, and uses natural features in .NET, permitting you and me to do a bang-up job with testing .NET code. The basic idea is that you download NUnit from the web site, create a new class library with some references to the code you want to test, and add a few attributes and some test-case methods. NUnit then dynamically loads and runs classes tagged with these specific attributes and uses a three-color coded system to tell you the outcome of the tests:

  • Red: The test failed.

  • Green: The test passed.

  • Yellow: The test was ignored. (You mark tests that you haven't finished writing with an IgnoreAttribute for yellow tests.)

Trust me—NUnit is so easy to use that nonprogrammers can learn how to write test cases with it, and everyone can easily discern which tests passed and which failed.

Financially, I'm a non-interested party in NUnit; therefore, I can tell you without reservation that if you're using .NET you should incorporate NUnit into your software development process.

Tapping into Trace Statements with NUnit

Perhaps you just started religiously using trace statements in your code. Well, since we're on the topic of religion, why not start religiously writing test cases? I'm not advocating losing the extremely valuable data logged with trace statements. You can have both. By combining trace statements, TraceListeners, and NUnit, it's possible (and highly desirable) to create test cases that verbosely tell you what your code is doing. This is an invaluable strategy for robust software development. And, because these two tools—.NET and NUnit—make it easy to do, it takes the guesswork out of writing and testing code.

Creating a Sample Application

Let's demonstrate. The sample application can be anything. Because we don't have unlimited time and space here, however, I've created a class library in C# that contains one method to test. It's worth noting that you can test code that's used with Remoting, COM+, and ASP.NET just as easily. (I know; I've done it.)

The simple class library is shown in Listing 1 without elaboration.

Listing 1 A Sample Class in a Class Library

using System;
using System.Diagnostics;

namespace Sample
{
 public class PleaseTestMe
 {
  public string Name
  {
   get
   { 
    Trace.WriteLine("PleaseTestMe.get_Name called");
    return "PleaseTestMe"; 
   }
  }
 }
}

Testing with NUnit

Assuming that you've downloaded and installed the latest version of NUnit (I'm using NUnit 2.1), the next step is to add a class library containing the test cases. Granted, the sample class is easy, but you can use just about any code, and the tests can be simple or complex.

To create and run the tests, add the code for the test class library (see Listing 2) to the second class library and follow these steps:

  1. In the new class library, add a reference to the nunit.framework.dll assembly. (If you installed NUnit, this assembly should be listed in the Add Reference dialog box's .NET tab.)

  2. Add a reference to the class library to be tested. (This is our sample class from Listing 1.)

  3. Add a using statement—Imports for Visual Basic .NET—to the class module in the test library, and write the test code (see Listing 2).

  4. Add a using statement for the Sample class's namespace.

  5. Start an instance of NUnit.

  6. Load the .dll assembly containing the tests.

  7. Click the Run button.

Listing 2 An NUnit Test To Test Our Sample Class

using System;
using NUnit.Framework;
using Sample;

namespace Tests
{
 [TestFixture]
 public class Test
 {
  [Test]
  public void PleaseTestMeTest()
  {
   PleaseTestMe obj = new PleaseTestMe();
   Assertion.AssertEquals("PleaseTestMe", obj.Name);
  }
 }
}

Here's a synopsis of the test code:

  • The NUnit.Framework namespace simplifies access to NUnit capabilities.

  • The Sample namespace simplifies access to the code we want to test.

  • The TestFixtureAttribute ([TestFixture]) is used by NUnit to figure out which class or classes to load dynamically—that is, which classes contain tests—in order to run those tests. This is done with Reflection, an ultra-cool and powerful runtime type engine in .NET.

  • Finally, test methods—methods that take no arguments and return nothing—are tagged with the TestAttribute (dropping the Attribute suffix is a convention).

NOTE

The reason for the method signature is that NUnit designers had no way of knowing in advance what arguments to pass to or receive from your test methods.

Now we're ready to write some code. As long as that code runs without an exception, or passes the Assertion tests we write, the test passes. In the example, we're simply asserting that the object's name matches a predetermined value. This is representative of any test.

TIP

These tests can be very complex; for example, I've written multithreaded and asynchronous tests against COM+ objects and SQL Server databases easily.

Eavesdropping with a TraceListener

The final step is to eavesdrop on our trace messages in our test code. For this step we'll need to implement a TraceListener, add an instance of that listener to the Trace.Listeners collection, and tell the overridden methods to send the trace information to NUnit's Console.Out tab. This isn't as hard as it might seem. Listing 3 shows the revised code, with the new stuff in bold.

Listing 3 An NUnit Test with a Custom TraceListener

using System;
using NUnit.Framework;
using Sample;
using System.Diagnostics;

namespace Tests
{
 public class MyListener : TraceListener
 {
  public override void Write(string message)
  {
   Console.Write(message);
  }

  public override void WriteLine(string message)
  {
   Console.WriteLine(message);
  }
 }

 [TestFixture]
 public class Test
 {
  public static MyListener listener = new MyListener();

  [SetUp()]
  public void Init()
  {
   Trace.Listeners.Add(listener);
  }

  [TearDown()]
  public void Deinit()
  {
   Trace.Listeners.Remove(listener);
  }

  [Test]
  public void PleaseTestMeTest()
  {
   PleaseTestMe obj = new PleaseTestMe();
   Assertion.AssertEquals("PleaseTestMe", obj.Name);
  }
 }
}

The new using statement adds easy access to the System.Diagnostics namespace. The new class, MyListener, implements a custom TraceListener by defining the minimum-required methods, Write and WriteLine. These methods simply forward output to NUnit's Console (see Figure 1). Finally, we create a static instance of the new TraceListener, adding it to the Trace.Listeners collection when a test is initialized and removing it when the test has finished. Methods marked with the SetUpAttribute and TearDownAttribute denote test initialization and finalization methods, respectively. When we run the test, we should see the output as depicted in the figure.

Figure 1Figure 1 The trace statement as it appears when forwarded to NUnit by the Trace class.

A Final Word on Strategy

Personally, I don't want to write the TraceListener custom class every time I create a test, and professionally I can't afford to do so. The solution is to create a new .NET project template that contains all the stubbed-out references and code for the listening NUnit test solution. .NET supports extending the available project templates with an existing wizard vsWizard.dll and a simple text editor. Unfortunately, we don't have time to do that here, but you can learn how to create project and element templates for .NET in my book Visual Basic .NET Power Coding (Addison-Wesley, 2003, ISBN 0672324075).

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020