Home > Articles > Programming > Windows Programming

Debugging .NET with NUnit

  • Print
  • + Share This
With an open source product called NUnit, you can write automated tests and perform complex regression testing on your assemblies while you go have a microbrew. Paul Kimmel demonstrates how to use NUnit to automate testing for .NET applications.
Like this article? We recommend

Like this article? We recommend

What is NUnit? NUnit is a testing concept based on JUnit. Originally a concept for testing that wraps an interface around code, permitting testing tools to call into that code checking for pass and fail conditions. The result is automated testing extraordinaire.

I am working on a project in Oregon that is using NUnit version 2.0 (available from http://www.nunit.org). This open source product has been updated to use the best of .NET for implementing automated and regression tests. You can download, extend, and use NUnit for free.

The product uses custom attributes to guide the tests. In addition, the code being tested is loaded into its own application domain. As a result, the NUnit tool can load and reload the .NET assemblies you are testing without restarting the NUnit tool. The benefit is that NUnit version 2.0 looks for changes to the test assemblies and will reload them automatically to ensure that the latest binary assembly is being tested. As a developer, this means you can perform code and test development cycles, running NUnit with loaded assemblies to be tested after each compilation without restarting and loading test fixtures.

The net result is that NUnit integrates easily into unit testing and .NET in general, and is an excellent tool for system and regression testing. With the simple pass-fail user interface, there is no mistaking tests that failed and tests that passed. Because tests are written in .NET, analysts, programmers, and testers can codify tests and capture them as simple .NET algorithms that can be ascertained to validate the business rules.

In this article, I will introduce the fundamental concepts of .NET and NUnit testing. I also will show you one hint that we—Joe Shook and I—learned the hard way that will help you test even very complex applications.

Implementing a Test

One of the benefits of writing is that you get to state an opinion. The purpose of a stated opinion is sometimes to provide the correct information and other times to provoke a dialog. Here is my provocation: Programmers make the best testers, especially when they act as friendly adversaries that did not write the code being tested. Other professionals have this opinion, too. The reason I restate it here is because the authors of the code were the only testers on more than 75% of the projects I have been on. I have begun to believe that the lack of autonomous testers is both commonplace and an egregious mistake made by managers and budget commandos.

If the originating author tests the code, you will probably get all positive test cases based on assumptions and foreknowledge. These are called unit tests, and if all that is happening is unit testing, some buggy code is getting shipped.

Beneficially, what NUnit does is provide us all with a common tool for testing. Analysts can write both positive and negative test cases, which can be captured and codified in .NET by programmers who did not write the code, and the code either passes or fails. A second huge benefit is that the authors of the code can run the same tests during unit testing, getting a head start on bug-free code. As friendly adversaries, it is the tester's job to keep adding twists. Now your testers get started writing tests about the same time your coders do. Polish all this off with quality assurance—proofreading, formatting, fit and finish—and some great software will get shipped.

To demonstrate how all of this can and will work, I have included a trivial Windows Forms application, a class library representing business rules, and a test assembly that uses NUnit. Let's start with the pseudo-business rules and finish with the test assembly.

Building Sample Business Rules

Test code needs to be in a .DLL assembly, which is representative of the middleware part of your code commonly referred to as business rules. Because our emphasis is on testing, we can use just about any code, so I created a Class Library project containing a class named Arithmetic. Arithmetic performs simple verbose addition for integer and double numeric types (see Listing 1). To create a negative test, I wanted to check overflow errors—when an arithmetic operation causes a number to exceed its maximum value, for example, 3,000,000,000 assigned to an integer contains more than 32 bits. To test an arithmetic overflow, I turned "Check for Arithmetic Overflow/Underflow" on in the Property Pages|Configuration Properties|Build (see Figure 1).

Figure 1Figure 1 Enabling checks for arithmetic underflow and overflow.

Listing 1: Sample business rules we will be testing with NUnit.

using System;
namespace MyMath
{
 public class Arithmetic
 {
  public static int Add(int a, int b)
  {
   return a + b;
  }
 
  public static double Add(double a, double b)
  {
   return a + b;
  }
 }
}

The code contains two static addition methods.

TIP

Another good reason for using NUnit is implied. Because we can load class libraries only in NUnit testing, it forces a good separation between the presentation layer (GUI) and business rules. This is a good thing.

The key to testing is defining a test that supports a business rule regardless of the code we are testing; hence we need to ensure an accurate result for addition.

Building a GUI Application

For our purposes, the GUI simply demonstrates how to use the Arithmetic class and represents our presentation layer. The form I created contained three TextBox controls, three labels, and a button. Enter a numeric value in each of the first two TextBoxes, click the button, and the sum is returned in the third TextBox. The MyMath assembly is referenced by the Windows Forms application, and the arithmetic is invoked in the following manner:

textBox3.Text = Arithmetic.Add(Convert.ToInt32(textBox1.Text), 
Convert.ToInt32(textBox2.Text));

Configuring NUnit

We now have some code to test. We will need to download and install NUnit and then build our test fixture. You can download NUnit from http://www.nunit.org and use all the default values for installation. This will install the source code and binaries in C:\Program Files\NUnit V2.0 by default.

Implementing the Test Assembly

Writing the tests represents the new information for us, so we'll take our time here.

NOTE

Recall that I said that testers should be programmers, but not the authors of the code. Well, it is possible to deviate a little bit when using NUnit. Suitable conditions that permit programmers and testers to be in the same corpus are when an analyst or analysts have defined both positive and negative tests without knowledge of the code. Under these circumstances, the tests aren't directed by the programmer, and you will get good results.

A test is implemented as a Class Library. The test library references your business rules code and invokes operations on that code, just as your presentation layer will be doing.

The way that NUnit works is to load the test .DLL into an AppDomain object, relying on attributes and Reflection to determine which code represents tests. What we must do is apply attributes that NUnit will be looking for and write the tests appropriately. Listing 2 contains some tests I wrote for the MyMath.Arithmetic, followed by an explanation of each of the attributes and the way the tests were written.

Listing 2: Test fixture for MyMath.Airthmetic.

1: using System;
2: using NUnit.Framework;
3: using MyMath;
4: 
5: namespace Test
6: {
7:  [TestFixture()]
8: public class TestArithmetic
9: {
10: 
11:  //[SetUp()]
12:  public void Init()
13:  {
14:   // Initialization for each test method here!!!
15:  }
16:   
17:  [TearDown()]
18:  public void Deinit()
19:  {
20:   // De-initialization for each test method here!!
21:  }
22:  
23:  [Test()]
24:  public void AddIntegerPass()
25:  {
26:   Assertion.AssertEquals("Integer arithmetic passed",
27:    true, Arithmetic.Add(10, 5) == 15);    
28:  }
29:   
30:  [Test()]
31:  public void AddDoublePass()
32:  { 33:   Assertion.AssertEquals("Floating-point arithmetic passed",
34:    true, Arithmetic.Add(1.3, 2.5) == 3.8);
35:  }
36:   
37:  [Test(), ExpectedException(typeof(OverflowException))]
38:  public void AddIntegerFailed()
39:  {
40:   int a = 2147483647;
41:   int b = 5;
42:   Assertion.AssertEquals("Integer overflow expected", 
43:    true, Arithmetic.Add((int)a, (int)b) > 2147483647);
44:  }
45:   
46:  [Ignore("not ready")]
47:  public void AddDoubleFailed()
48:  {
49:   // not ready!
50:  }
51:   
52: }
53: }

NUnit attributes and classes that we will be defining are contained in C:\Program Files\NUnit V2.0\bin\NUnit.Framework.dll. We will need to add a reference to NUnit.Framework.dll and MyMath.dll—the code we will be testing. For convenience, I added a using clause to their respective namespaces as well.

To indicate that a class is a test fixture, apply the TestFixtureAttribute to the class, as shown on line 7.

If you need initialization and deinitialization code, add two methods to the test fixture. I named these Init and Deinit, but they can be anything. It is the SetUpAttribute—case-sensitive—and TearDownAttribute that points NUnit at these two methods. It is important to note that each of these methods will be called once before every method attributed with TestAttribute is called.

Next, we need some tests. Tests are adorned with the TestAttribute. Each test is a method that takes no arguments and returns void. Reflection is used to invoke these methods. Technically, return values and parameters can be invoked using Reflection; they would have to be contrived by NUnit because NUnit is running the test. However, it isn't the test method you are testing; it is the code in the test method. Because you write the test code, you can supply the arguments. I defined two positive tests AddIntegerPass and AddDoublePass, on lines 23 through 28, and on lines 31 through 35, respectively. Each of these tests uses the assertion class defined by NUnit. I invoked Assertion.AssertEquals on each of lines 26 and 33. The first argument is a message; the second argument is the value returned by the third argument. For example, line 27 evaluates an Add equal to 15. This should return true. We could also have used 15 as the second argument and the Arithmetic.Add method as the third, rewriting the lines 26 and 27 as Assertion.AssertEquals(message, 15, Arithmetic.Add(10, 5)).

There are several testing tools in the NUnit framework. The online documentation, source, and experimentation will have to be your guide for now. Perhaps because NUnit is open source, some diligent person will contribute help documentation.

Lines 27 through 44 incorporate a second attribute: ExpectedExceptionAttribute. Passing the type record of an exception class, you can test to ensure that a test throws an expected exception. In the example, I intentionally create an overflow condition and want to ensure an exception is thrown.

Finally, the last attribute demonstrated is on lines 46 through 50. The IgnoreAttribute can be used to indicate a test that shouldn't be run by NUnit, perhaps because it isn't quite baked yet.

The way tests are defined are up to you. A great approach is to make testing analysis a deliverable, reviewable aspect of the project. Users can describe good and bad behavior, analysts can record them, and programmers can codify these behaviors. In this manner, testing results are verifiable.

  • + Share This
  • 🔖 Save To Your Account

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