Skip to main content

Learning Tests

At the last Agile Staffordshire I attended the task was to complete the string calculator with constraints. The group worked in pairs and everything was running smoothly. Until I heard a few guys behind struggling with something.

I'd worked with one of the developers previously, so they called me over to take a look. What he found was pretty shocking - they had found a bug in the .NET framework. The string class of all things. Bugs exist in all code. Bugs in the substring method though are probably rarer given how exhaustively used this particular bit of code is.

The problem was how they expected the method to behave. When creating a substring they were getting confused with how the offests worked.

This is an easy mistake. Different languages or frameworks can have different methods to do similar tasks. I take no shame in not knowing of the top of my head whether the offest of the substring method is an offset of the index, or an offset from the start of the string.

I managed to spot the issue very quickly but never let on. Instead I decided to share a technique which I use regularly to great effect.

Rather than painfully using the debugger and stepping through the code line by line I suggested he write a simple test around the single line of code they were convinced was misbehaving.

After a couple of more tests it was clear how the substring method worked in .NET. Once this was cleared up, we deleted the tests we just wrote and modified the production code to use the correct offset. This whole process took less than sixty seconds.

I explained afterwards that such a technique of writing learning tests or scaffholding tests is incredibly valuable. The feedback cycle here is very quick. Quicker than explaining to another developer what is wrong; Quicker than "Googling" the problem; Quicker than looking at the reference implementation and certainly quicker than using the debugger.

My rules are pretty explicit when dealing with learning tests. They should be short lived. Testing implementation details is often a bad idea, but that is the whole point of such style of testing. Therefore if you do decided to check these tests in tagging them so they are only run as part of CI builds is worthwhile. In other words, just like real world scaffholding, they are temporary. Don't feel bad about writing some tests, only to delete them minutes later.

Learning tests have another nice side effect. They give static languages which have a slower feedback cycle a form of REPL. It's a lot quicker to write a test method and execute than it would be to spin up a new project in languages such as C# or Java to just try something out.

Next time you're stuck, try writing a test.


Popular posts from this blog

Three Steps to Code Quality via TDD

Common complaints and problems that I've both encountered and hear other developers raise when it comes to the practice of Test Driven Development are: Impossible to refactor without all the tests breakingMinor changes require hours of changes to test codeTest setup is huge, slow to write and difficult to understandThe use of test doubles (mocks, stubs and fakes is confusing)Over the next three posts I will demonstrate three easy steps that can resolve the problems above. In turn this will allow developers to gain one of the benefits that TDD promises - the ability to refactor your code mercifully in order to improve code quality.StepsStop Making Everything PublicLimit the Amount of Dependencies you Use A Unit is Not Always a Method or ClassCode quality is a tricky subject and highly subjective, however if you follow the three guidelines above you should have the ability to radically change implementation details and therefore improve code quality when needed.

DRY vs DAMP in Tests

In the previous post I mentioned that duplication in tests is not always bad. Sometimes duplication becomes a problem. Tests can become large or virtually identically excluding a few lines. Changes to these tests can take a while and increase the maintenance overhead. At this point, DRY violations need to be resolved.SolutionsTest HelpersA common solution is to extract common functionality into setup methods or other helper utilities. While this will remove and reduce duplication this can make tests a bit harder to read as the test is now split amongst unrelated components. There is a limit to how useful such extractions can help as each test may need to do something slightly differently.DAMP - Descriptive and Meaningful PhrasesDescriptive and Meaningful Phrases is the alter ego of DRY. DAMP tests often use the builder pattern to construct the System Under Test. This allows calls to be chained in a fluent API style, similar to the Page Object Pattern. Internally the implementation wil…

Coding In the Real World

As a student when confronted with a problem, I would end up coding it and thinking - how do the professionals do this?For some reason I had the impression that once I entered the industry I would find enlightenment. Discovering the one true way to write high quality, professional code.It turns out that code in industry is not too far removed from the code I was writing back when I knew very little.Code in the real world can be:messy or cleanhard or easy to understandsimple or complexeasy or hard to changeor any combination of the aboveVery rarely will you be confronted with a problem that is difficult. Most challenges typically are formed around individuals and processes, rather than day to day coding. Years later I finally have the answer. Code in the real world is not that much different to code we were all writing when we first started out.If I could offer myself some advice back in those early days it would be to follow KISS, YAGNI and DRY religiously. The rest will fall into plac…

Feature Toggles

I'm a fan of regular releasing. My background and experience leads me to release as regularly as possible. There are numerous benefits to regular releases; limited risk, slicker release processes and the ability to change as requirements evolve.The problem with this concept is how can you release when features are not functionally complete?SolutionIf there is still work in progress, one solution to allow frequent releases is to use feature toggles. Feature toggles are simple conditional statements that are either enabled or disabled based on some condition.This simple example shows a feature toggle for an "Edit User" feature. If the boolean condition is false, then we only show the "New User" feature and the "Admin" feature. This boolean value will be provided by various means, usually a configuration file. This means at certain points we can change this value in order to demonstrate the "Edit User" functionality. Our demo environment could …

Reused Abstraction Principle

This is the second part of my series on abstractions.Part 1 - AbstractionsPart 3 - Dependency Elimination PrincipleThe Reused Abstraction Principle is a simple in concept in practice, but oddly rarely followed in typical enterprise development. I myself have been incredibly guilty of this in the past.Most code bases have a 1:1 mapping of interfaces to implementations. Usually this is the sign of TDD or automated testing being applied badly. The majority of these interfaces are wrong. 1:1 mappings between interfaces and implementations is a code smell.Such situations are usually the result of extracting an interface from an implementation, rather than having the client drive behaviour.These interfaces are also often bad abstractions, known as "leaky abstractions". As I've discussed previously, these abstractions tend to offer nothing more than simple indirection.ExampleApply the "rule of three". If there is only ever one implementation, then you don't need …