Welcome!

Microsoft Cloud Authors: Yeshim Deniz, Janakiram MSV, Andreas Grabner, Stackify Blog, Liz McMillan

Related Topics: Microsoft Cloud

Microsoft Cloud: Article

Derek Ferguson on "Pragmatic Unit Testing" An Introduction to NMock

I differentiate what I like to call 'pragmatic unit testing' from the two alternate approaches

I have staunchly advocated what I like to call "pragmatic unit testing" at every client I have been at for the past year. I differentiate pragmatic unit testing from the two alternate approaches to unit testing that I have seen at organizations. The first "alternate approach," which I have seen at 95 percent of .NET organizations, is best referred to as "no time for quality." The other approach, which I have mainly seen at J2EE organizations, can be labeled "quality, even if it puts us out of business."

Between these two extremes, I have tried to follow a path where I use unit tests to accomplish my daily work. I try to build as much resilience and reusability into these unit tests only as my immediate deadlines allow. This means that after a project is finished, I often have a decent-sized set of unit tests that have been created without costing my client anything in terms of development time.

The downside to this approach is: because I haven't spent any extra time in abstracting these unit tests away from their dependencies (since those dependencies happened to exist at precisely the moment of their creation), half of my unit tests typically wind up broken shortly after release, through no cause other than the application's standard usage.

Let me clarify this rather difficult-to-explain but easy-to-see phenomenon with a simple example. I have spent the last couple of months creating a fairly straightforward Windows application that is intended to store and retrieve data from a database, as well as perform some calculations on that data using Visual Studio Tools for Office and an Excel spreadsheet back end. For unit testing the calculations and the Excel back end, I have simply hard-coded specific data into my unit tests, which have exercised all of the spreadsheet's various functions. This has worked well and my unit tests are serving their purpose wonderfully.

For the database interactions, however, I have faced some difficult issues in creating appropriate unit tests. On one hand I have a frequently changing data model. This breaks my unit tests a lot but, on the whole, this is fine because I would specifically like my unit tests to alert me to breaking changes in the database structure.

On the other hand, many of my unit tests are not specifically testing database interactions, but instead test functionality, which is so complex that it is highly dependent upon the data that happens to be in the database and its structure. As a result, when the data in the database changes, my unit tests - which are expecting results that are specific to the state of the data when they were written - break. I then have to go in, examine the failed assertions, and change them to match the new data in the database. Eventually, the data changes again and they fail again.

Enter Mock Objects
I have been familiar with mock objects for several years. I've realized that they could provide solutions to my problems. However, at my former employer, there was a developer who used to spend hours, days, and even weeks creating elaborate mock infrastructures to have perfect unit tests - often at the cost of actually shipping software on time. Having seen this I, of course, was none-too-enthusiastic about mock objects.

Then, a colleague at Magenic posted to our internal technical lists about NMock. NMock, it seemed, held the potential to allow me to create mock objects to solve my problems without having to spend lots of time in their creation. "Cool," thought I.

Thus, the first thing to understand about NMock is that it is free. Well, the license says that you have to keep the copyright notice, but it looks to me (though I am not a lawyer) as though you can redistribute it and use it in various other products, including commercial ones, so I would call that free.

The second thing to understand is that NMock creates mock objects at run time, rather than doing pre-generation. This went against the way I had envisioned a mock object generator would work before I had ever seen one, so I was a little surprised by this. The creators say that this makes mock objects created with NMock more resilient and avoids a pre-usage compilation step. I guess I can see that.

Taking It for a Test Drive
Therefore, for my first crack at using mock objects, I decided to choose one of my existing unit tests that had been breaking. The test had to do with authorization of users into my system. It was intended to find a user in the database, retrieve a number of facts about that user, and then assert that those facts matched the facts of which I have a priori knowledge.


[TestFixture]
public class UserTest
{
[Test]
public void VerifyRoleRetrieval()
{
User user = new User();
user.Authorize("derek");

Assert.AreEqual(5, user.Roles.Count);
}
}
As you see in the above test, I begin by creating a new User object. I then call "Authorize" on the object, which causes it to populate itself with data about the requested user (in this case, myself). Finally, I assert that the number of roles associated with my own user account is five, because I know in advance that that is how many roles will be on the user object, if the population has been correctly done.

Unfortunately, as you may have guessed, the number of roles associated with my account on our system varied continually during development, which made this test difficult to maintain, at best. Once the system went into production it wasn't quite as bad, but it still wasn't ideal.


public class User
{
ArrayList roles;

public void Authorize()
{
ArrayList roles = new ArrayList();
// IP for populating roles removed here
}

public ArrayList Roles
{
get
{
return roles;
}
}
}
The code above shows - more or less - what happens inside of the User class to make the authorization and role-recollection functionality work. I had to remove some code from the Authorize method to protect my client's Intellectual Property but, nevertheless, you can see that a simple ArrayList is used to contain the roles. The code I removed was tied too closely to an actual database, thus making it difficult to unit test.

Following the approach documented right on NMock's home page, I adapted my user class to take a reference to an "Authorizer" class. The Authorizer class would contain my DB logic in the real application, but in my unit tests, it is what will be mocked. For this reason I have declared it as an interface in Listing 1, which different classes can implement depending upon the circumstances (test or production).

The code in Listing 2 shows my first cut at amending my tests to use an automatically generated unit test. This compiled and ran but, unfortunately, it did not pass since there is nothing to tell NMock to actually return an ArrayList with five members as a part of this test.

Listing 3 shows the modifications I had to make in order to finally build a good unit test for my User class's Authorization functionality. In my unit test I had to create an artificial unit test for my User class to return. I then had to change my call to the "Expect" method on the dynamically generated mock to be "ExpectAndReturn," passing in the value for it to return, in addition to my expectations about the way that the Authorize method should be called.

The Authorize method populates the internal roles variable in the User class so that a little Assert test that expects five members will succeed.

Conclusion
My conclusion after using NMock for about an hour is that it is definitely a good way to help create unit tests that will serve well beyond the initial creation of your code. My other realization was that in some ways, seeing that your code requires re-architecture in order to support easy mocking can be an indication that one hasn't architected one's initial code with the greatest possible degree of flexibility, to begin with.

I anticipate adding NMock to my bag of tricks and using it extensively going forward. To read about my further experiences with unit testing, please read my blog at http://derek.dotnetdevelopersjournal.com/.

More Stories By Derek Ferguson

Derek Ferguson, founding editor and editor-in-chief of .Net Developer's Journal, is a noted technology expert and former Microsoft MVP.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@ThingsExpo Stories
"We provide IoT solutions. We provide the most compatible solutions for many applications. Our solutions are industry agnostic and also protocol agnostic," explained Richard Han, Head of Sales and Marketing and Engineering at Systena America, in this SYS-CON.tv interview at @ThingsExpo, held June 6-8, 2017, at the Javits Center in New York City, NY.
"We've been engaging with a lot of customers including Panasonic, we've been involved with Cisco and now we're working with the U.S. government - the Department of Homeland Security," explained Peter Jung, Chief Product Officer at Pulzze Systems, in this SYS-CON.tv interview at @ThingsExpo, held June 6-8, 2017, at the Javits Center in New York City, NY.
SYS-CON Events announced today that Calligo, an innovative cloud service provider offering mid-sized companies the highest levels of data privacy and security, has been named "Bronze Sponsor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Calligo offers unparalleled application performance guarantees, commercial flexibility and a personalised support service from its globally located cloud plat...
Internet of @ThingsExpo, taking place October 31 - November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 21st Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devic...
"The Striim platform is a full end-to-end streaming integration and analytics platform that is middleware that covers a lot of different use cases," explained Steve Wilkes, Founder and CTO at Striim, in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
SYS-CON Events announced today that DXWorldExpo has been named “Global Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Digital Transformation is the key issue driving the global enterprise IT business. Digital Transformation is most prominent among Global 2000 enterprises and government institutions.
SYS-CON Events announced today that Datera, that offers a radically new data management architecture, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Datera is transforming the traditional datacenter model through modern cloud simplicity. The technology industry is at another major inflection point. The rise of mobile, the Internet of Things, data storage and Big...
"We are focused on SAP running in the clouds, to make this super easy because we believe in the tremendous value of those powerful worlds - SAP and the cloud," explained Frank Stienhans, CTO of Ocean9, Inc., in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
DX World EXPO, LLC., a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
"MobiDev is a Ukraine-based software development company. We do mobile development, and we're specialists in that. But we do full stack software development for entrepreneurs, for emerging companies, and for enterprise ventures," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
While the focus and objectives of IoT initiatives are many and diverse, they all share a few common attributes, and one of those is the network. Commonly, that network includes the Internet, over which there isn't any real control for performance and availability. Or is there? The current state of the art for Big Data analytics, as applied to network telemetry, offers new opportunities for improving and assuring operational integrity. In his session at @ThingsExpo, Jim Frey, Vice President of S...
SYS-CON Events announced today that DXWorldExpo has been named “Global Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Digital Transformation is the key issue driving the global enterprise IT business. Digital Transformation is most prominent among Global 2000 enterprises and government institutions.
In his opening keynote at 20th Cloud Expo, Michael Maximilien, Research Scientist, Architect, and Engineer at IBM, discussed the full potential of the cloud and social data requires artificial intelligence. By mixing Cloud Foundry and the rich set of Watson services, IBM's Bluemix is the best cloud operating system for enterprises today, providing rapid development and deployment of applications that can take advantage of the rich catalog of Watson services to help drive insights from the vast t...
SYS-CON Events announced today that EnterpriseTech has been named “Media Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. EnterpriseTech is a professional resource for news and intelligence covering the migration of high-end technologies into the enterprise and business-IT industry, with a special focus on high-tech solutions in new product development, workload management, increased effic...
SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...
SYS-CON Events announced today that Cloud Academy named "Bronze Sponsor" of 21st International Cloud Expo which will take place October 31 - November 2, 2017 at the Santa Clara Convention Center in Santa Clara, CA. Cloud Academy is the industry’s most innovative, vendor-neutral cloud technology training platform. Cloud Academy provides continuous learning solutions for individuals and enterprise teams for Amazon Web Services, Microsoft Azure, Google Cloud Platform, and the most popular cloud com...
SYS-CON Events announced today that Cloudistics, an on-premises cloud computing company, has been named “Bronze Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Cloudistics delivers a complete public cloud experience with composable on-premises infrastructures to medium and large enterprises. Its software-defined technology natively converges network, storage, compute, virtualization, and ...
SYS-CON Events announced today that CHEETAH Training & Innovation will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct. 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. CHEETAH Training & Innovation is a cloud consulting and IT training firm specializing in improving clients cloud strategies and infrastructures for medium to large companies.
SYS-CON Events announced today that Datanami has been named “Media Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Datanami is a communication channel dedicated to providing insight, analysis and up-to-the-minute information about emerging trends and solutions in Big Data. The publication sheds light on all cutting-edge technologies including networking, storage and applications, and thei...
The current age of digital transformation means that IT organizations must adapt their toolset to cover all digital experiences, beyond just the end users’. Today’s businesses can no longer focus solely on the digital interactions they manage with employees or customers; they must now contend with non-traditional factors. Whether it's the power of brand to make or break a company, the need to monitor across all locations 24/7, or the ability to proactively resolve issues, companies must adapt to...