Hello! Let’s continue our series on unit tests by discussing their relation with documentation.
When we think about documentation, we think about comments, README files, or tools like Notion or Confluence. Yet, we often forget about one form of documentation that exists within the code itself: unit tests. Indeed, unit tests do more than just validating our code works as expected; they also serve as living documentation explaining how our code behaves.
Let’s discuss the three main reasons why unit tests are such a powerful tool for documenting our codebase:
Unit tests explain code behavior: A unit test usually validates the behavior of a function or method. When a unit test is written correctly, it provides a clear and concise explanation of how a piece of code is supposed to work.
Unit tests are always in sync with the code: One of the biggest challenges with traditional documentation is that they can easily become outdated as the code evolves. However, unit tests are tightly coupled with the code they test. If the behavior of a code changes, its corresponding unit tests should evolve, too. That makes unit tests always up-to-date.
Unit tests cover edge cases: Documentation is also about covering edge cases, such as unexpected inputs. Good unit tests should also cover these cases, which provides valuable documentation insights that may not be captured elsewhere.
To maximize the effectiveness of unit tests as documentation, it’s important to follow some best practices:
Descriptive test name: Make sure the test name clearly conveys what is being tested and the expected outcome.
Atomic: Each test should focus on a single aspect of the function behavior. This makes the test easier to read and ensures it serves as clear documentation.
Keep tests simple: If possible, avoid overly complex tests that require too many steps and can be hard to follow. Make sure an external reader should be able to understand the tested behavior.
Keep tests independent: Make sure unit tests do not depend on each other. Keeping isolated tests also helps readers to understand our tests.
Unit tests are more than just a way to validate our code. When written properly, they act as documentation that reflects the behavior of our code. Therefore, let’s make sure our tests are as readable and understandable as possible. Note also that I’m not suggesting that unit tests should replace any form of documentation but rather that they should complement and enrich it.
Tomorrow, you will receive your weekly recap on unit tests.