Skip to main content

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.

Solutions

Test Helpers

A 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 Phrases

Descriptive 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 will still use literals or value objects, but each test can provide just the differences it needs in order to execute. The key point regardless of how DAMP tests are implemented is to favor readability over anything else, while still eliminating duplication where possible.

The example shows a typical arrange aspect of a test written in the DAMP style. The end result of this builder is we will have the ability to now act and assert against the result - a controller instance. If further tests were required we could use the same setup but simply provide different order dates for example. Additionally we could add or remove further chained calls. Behind the scenes the implementation of these builders is straightforward.

I tend to introduce this pattern after the third time of seeing duplication between tests. There is a bit of an overhead otherwise, the builder itself requires implementation and careful construction. Once you go past three tests the overhead pays itself off by allowing you to rapidly add new tests and make large, structural changes.

Beware the builders becoming too big or complex. If this starts to happen you may wish to refactor as there may be missing abstractions in your design. DAMP tests have numerous advantages, but they should be applied where required rather than for every scenario. Tests for objects that are lower in the dependency graph tend to fit into the more traditional testing patterns, while higher up your stack DAMP tests can prove useful.

Comments

Popular posts from this blog

Constant Object Anti Pattern

Most constants are used to remove magic numbers or variables that lack context. A classic example would be code littered with the number 7. What does this refer to exactly? If this was replaced with DaysInWeek or similar, much clarity is provided. You can determine that code performing offsets would be adding days, rather than a mysterious number seven.Sadly a common pattern which uses constants is the use of a single constant file or object. The beauty of constants is clarity, and the obvious fact such variables are fixed. When a constant container is used, constants are simply lumped together. These can grow in size and often become a dumping ground for all values within the application.A disadvantage of this pattern is the actual value is hidden. While a friendly variable name is great, there will come a time where you will want to know the actual value. This forces you to navigate, if only to peek at the value within the constant object. A solution is to simple perform a refactor …

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.