Unit Testing a Private Method

So on a lark, I threw my hat into the ring for, I didn't expect to get accepted, there were already a few sessions on unit testing and nunit but I figured, what the heck, let's gear it for beginners, and do it in VB.Net.  Now I'm in the process of getting ready and I figured I should blog about things and or techniques as they came up.

For my first trick, testing a private method.

First rule of thumb: Don't do this.

No really, Don't.

You are locking the internals of your code down with your unit test, if you are having to test a private method, then chances are that method should be public on a different class.

However, if you are sitting in a situation where that kind of refactoring is just not going to be allowed and you still really-really-need-to-get-this-under-test, then this simple process can help.

Given

Private Function Add2Integers(byval x as integer, byval y as integer) as integer

    return x + y

End Function

You want to get this under test, but you want this to be a refactor (which is NOT another word for maintenance, it's a word for code clean up, not feature changing) which means no changes as far as the users are concerned.

Try this, wrap the code in a compiler conditional, and then just call the function, and then pass the value back out.

Now your unit tests can access the private method.

#If DEBUG Then

Public Function public_Add2Integers(byval x as integer, byval y as integer) as integer

     return Add2Integers( x, y) as integer

End Function

One more time, really, don't do this, if you are not REALLY careful, this will come back and bite you hard.

This article is part of the GWB Archives. Original Author: Malcolm Anderson

New on Geeks with Blogs

  • We Won The One Award I Actually Care About

    Full Scale made the Inc. 5000 for the fifth year straight, the 12th listing across my three companies. Here is why the one award you cannot buy is worth stopping for.

  • Your Customers Build the Features Now

    I let a tool I liked sit dead for a year rather than build the features I wanted. An MCP server meant I never had to, and your customers can do the same to your product.

  • Get the Size of a Directory in Linux the Easy Way

    du -sh for the quick answer, ncdu for the cleanup, df for the disk itself: every command for checking directory size in Linux, plus why du and df never agree.

  • Vim Search and Replace: The Ultimate Guide

    One :%s command replaces every match in a file before a find dialog would even open. The Vim substitute patterns worth the muscle memory: flags, ranges, capture groups, and multi-file edits.