Skip to main content

The Importance of Tools

One of the most influential books I've read on software development has been The Pragmatic Programmer.

One of the key points raised within the book is that of automation and tooling. For example, automating the build process is a very worthwhile undertaking. You should be able to check out some code and execute a script that will set up your machine, compile, test and deploy the code base in question.

The key benefit of automating even trivial tasks such as automatically pulling down the latest code daily is that unlike developers, automating tooling will never perform the task wrong. Nor will they forget to do it. Ultimately this prevents the dreaded "works on my machine" issue.

I've become such a fan of this approach to automating away any manual steps that some of the most used code I've written has been small scripts that execute hundreds of times a day. From a development point of view, the likes of good practices, SOLID, OO etc.. are usually void, such scripts simply get the job done, allowing myself to focus on the more important tasks such as delivering business value else where.

There is not a lot else to say on the subject of tooling. The best tools should be composable, proven solutions where possible. In other words, rather than something that must be configured via a GUI, opt for something that can be automated. Also ensure that you are not re-inventing the wheel unnecessarily. Save your time and energy on creating the custom tooling you can't get "off the shelf".

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.

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…