Microsoft Cloud Authors: Janakiram MSV, Yeshim Deniz, David H Deans, Andreas Grabner, Stackify Blog

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.

public class UserTest
public void VerifyRoleRetrieval()
User user = new User();

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
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.

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
Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive ov...
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
"Digital transformation - what we knew about it in the past has been redefined. Automation is going to play such a huge role in that because the culture, the technology, and the business operations are being shifted now," stated Brian Boeggeman, VP of Alliances & Partnerships at Ayehu, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Synametrics Technologies will exhibit at SYS-CON's 22nd International Cloud Expo®, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Synametrics Technologies is a privately held company based in Plainsboro, New Jersey that has been providing solutions for the developer community since 1997. Based on the success of its initial product offerings such as WinSQL, Xeams, SynaMan and Syncrify, Synametrics continues to create and hone inn...
"Evatronix provides design services to companies that need to integrate the IoT technology in their products but they don't necessarily have the expertise, knowledge and design team to do so," explained Adam Morawiec, VP of Business Development at Evatronix, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
The 22nd International Cloud Expo | 1st DXWorld Expo has announced that its Call for Papers is open. Cloud Expo | DXWorld Expo, to be held June 5-7, 2018, at the Javits Center in New York, NY, brings together Cloud Computing, Digital Transformation, Big Data, Internet of Things, DevOps, Machine Learning and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding busin...
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
Recently, REAN Cloud built a digital concierge for a North Carolina hospital that had observed that most patient call button questions were repetitive. In addition, the paper-based process used to measure patient health metrics was laborious, not in real-time and sometimes error-prone. In their session at 21st Cloud Expo, Sean Finnerty, Executive Director, Practice Lead, Health Care & Life Science at REAN Cloud, and Dr. S.P.T. Krishnan, Principal Architect at REAN Cloud, discussed how they built...
SYS-CON Events announced today that Evatronix 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. Evatronix SA offers comprehensive solutions in the design and implementation of electronic systems, in CAD / CAM deployment, and also is a designer and manufacturer of advanced 3D scanners for professional applications.
With tough new regulations coming to Europe on data privacy in May 2018, Calligo will explain why in reality the effect is global and transforms how you consider critical data. EU GDPR fundamentally rewrites the rules for cloud, Big Data and IoT. In his session at 21st Cloud Expo, Adam Ryan, Vice President and General Manager EMEA at Calligo, examined the regulations and provided insight on how it affects technology, challenges the established rules and will usher in new levels of diligence arou...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
DevOps at Cloud Expo – being held June 5-7, 2018, at the Javits Center in New York, NY – announces that its Call for Papers is open. Born out of proven success in agile development, cloud computing, and process automation, DevOps is a macro trend you cannot afford to miss. From showcase success stories from early adopters and web-scale businesses, DevOps is expanding to organizations of all sizes, including the world's largest enterprises – and delivering real results. Among the proven benefits,...
@DevOpsSummit at Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, is co-located with 22nd Cloud Expo | 1st DXWorld Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait...
SYS-CON Events announced today that T-Mobile exhibited at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. As America's Un-carrier, T-Mobile US, Inc., is redefining the way consumers and businesses buy wireless services through leading product and service innovation. The Company's advanced nationwide 4G LTE network delivers outstanding wireless experiences to 67.4 million customers who are unwilling to compromise on qua...