When writing a JUnit test for non-covered legacy code - how important is it to understand the original scenarios?

by hawkeye   Last Updated January 10, 2017 08:02 AM

A Tech Lead in my team said:

We're going to use sonar on our (500KLoc) codebase so that everytime you do a commit, it will check the classes you've touched against the coverage goals. If you don't meet the coverage goals for your commit, the build will break.

Another developer responded:

No that has no value. The classes were written against a specification with particular test scenarios in mind. It's not possible to discover what those test scenarios were from the code. You can't write a useful JUnit test on legacy code because you don't understand the original intent.

The first tech lead responded:

You can infer the requirements from the codebase, and the user experience of the software. All the JUnit test does, even if it does capture the original test scenarios, is demonstrate that a working path exists in the code. You can't say that JUnit tests represent a proof, but providing coverage of the code is extremely valuable.

My question is: When writing a JUnit test for non-covered legacy code - how important is it to understand the original scenarios?

EDIT: Note that this is different to the linked question because it is about intent or inferred requirements as input to the JUnit tests on the legacy code.

Answers 2

So as a consequence, if I make a trivial change in some legacy class, in addition to the trivial change, and the code reviews, and any manual testing done, I also have to write a gazillion of unit tests for twenty year old code.

It's easy enough. The effect is that my estimate for doing the task goes up from half a day to three weeks. If my team leader's boss thinks that this is good value for money for the company, so be it. If my team leader's boss it is a waste of three weeks of working time, then not.

You can also ask me for an estimate to write useful unit tests, which means I must understand what the code is supposed to do, which means my estimate goes up even more.

January 10, 2017 10:12 AM

It is true that you cannot write useful tests if you don't understand the requirements for the code.

But you can learn about the requirements while writing tests - either by reading documentation, or by trying to extract them from the code itself and documenting them through the tests themselves.

And you'll have to do that anyway - you really cannot do any substantial changes at all on existing code without understanding the requirements.

Michael Borgwardt
Michael Borgwardt
January 10, 2017 10:27 AM

Related Questions

Does Code Coverage improve code quality?

Updated November 15, 2016 08:02 AM

Should one test generated code?

Updated May 03, 2017 18:05 PM

Good cross-check metrics for software quality!

Updated February 17, 2017 12:05 PM