Tutorial :Where do you put unit tests for private methods?



Question:

Where do you put unit tests for private functions in C# classes?

An article in Wikipedia suggests:

  • Putting tests in the same class as the members they're testing
  • Using partial classes

Personally, neither of these methods seem appropriate, and I much prefer to have unit tests located in a separate project altogether.

Any thoughts on this?

(I know there's a fair amount of debate on whether private methods should be tested at all. I'd like to hear both sides of the argument.)


Solution:1

Private methods do not necessarily need to be tested directly. You can determine their validity based on tests of public methods that utilize those private methods.

However, you should take care to ensure that your public methods can easily inject mock dependencies into your private methods to facilitate testing and simulate all reasonable scenarios.

Edit: As for where your other tests should be located, I suggest a separate subdirectory within your project to handle your tests. When writing tests for PHP applications, I have a tests directory in the root of my project whose directory structure is identical to that of my real application directory structure. In it, I have a test class for each real class.

Just don't compile your test classes with the rest of your project when releasing to production (or in the case of an interpretted language like PHP, don't deploy the test classes to the production webserver).


Solution:2

Do not unit test private methods. Unit tests are for testing the visible (so public and protected) interface of a class. The private methods are implementation details and writing unit tests for them is unnecessary (their behavior should be implicitly tested by the tests on the visible methods), leads to brittle tests (as the implementation details could change) and is a barrier to refactoring.

If you have a private method that you feel you need to unit test, that is a big hint that maybe it should be factored out into a public method on another class.

Where do you put unit tests for private functions in C# classes?

Nowhere. They don't exist.

In general, my unit tests are in separate projects.


Solution:3

I also personally like to have unit tests in a separate project. If you want to unit test a private method, you could make the private method internal instead. You can then make internal methods visible to your unit tests to call directly by adding the following to AssemblyInfo.cs:

[assembly: InternalsVisibleTo("MyAssembly.UnitTests")]  


Solution:4

You should do what works for you; here's what works for me:

My unit is a class: that's what I'm trying to test. Not a method. I'm trying to do object-oriented programming, so I put my attention on objects.

If I find myself tempted to test a private method, I need to refactor. I only want to test a private method directly because there is too much other code between it and the tests, and because the private method itself is complex enough to need testing attention. So, I'll usually Extract Class to pull that private method, and other related members in to a new class.

My classes tend to be quite small. They're easy to read and understand. My methods, of course, are also very small and easy to understand.

Making the transition to this way of working required me to rethink many of my assumptions and habits about programming. What once seemed radical now seems commonplace.


Solution:5

I agree that private methods shouldn't be tested, in general, because you should only test the public interfaces.

That being said, there are reasons why you might want to test private methods:

  1. You are using TDD, and you have to develop a complex private method. Creating test methods for the private method may be necessary to keep your write test- write code - test cycle at the right granularity.

  2. You may be part of a team where others may need to modify the private method, and you want tests to ensure that the changes don't create problems.

Some solutions:

  1. Declare some methods that are public that delegate to the private method and are used only for testing purposes. These could be prefixed e.g. with TestFoo1, TestFoo2 etc.

  2. Use internal

http://msdn.microsoft.com/en-us/library/7c5ka91b(VS.80).aspx


Solution:6

Your question title and first sentence are different. :)

I'm not sure about where to place your tests. That would depend on language and C# is not something I'm familiar with but I imagine that a substantial part of your code is inside private methods. I'd feel uncomfortable if that was not tested. Code coverage would drop quite a bit.


Solution:7

We use private accessors in Visual Studio to test private methods. This means that that the test classes can live in a separate project.

However, we try to really limit the numbers of these because:

  • a private method that can stand alone can be pulled out as a public method in another class
  • private methods that don't do anything particularly useful outside of the class can be tested through the public methods of that class


Solution:8

absolutely yes. private methods should be tested anyway. and mbunit unit test framework can access private member.

see this blog: testing private methods


Note:If u also have question or solution just comment us below or mail us on toontricks1994@gmail.com
Previous
Next Post »