19 Technical note patterns for quick error recovery
This chapter covers
- Including supplementary contextual information with a failed assertion
- Hierarchical test logs that cover all layers of the test automation solution
- Embedding application log entries directly into the test log
- Unexpected application warnings
- Detecting incorrect context setup
The patterns described in this chapter support development and maintenance by facilitating early error detection and providing adequate runtime information. Since teams that follow a continuous integration (CI) approach prioritize the fixing of build errors, it’s crucial that, during development, they invest in making it as easy as possible to diagnose and fix any errors that do occur.
The director of a play or movie will often give notes after a rehearsal. A Technical Note is mechanical and covers things like maintaining continuity with a prop, ensuring that a sound effect has the right volume, or making sure that actors are correctly located on the stage. These notes are typically delivered after a rehearsal, so they must be accompanied by sufficient context for the actors and stagehands to know exactly when and how the issue occurred. During automated testing, technical notes are delivered by our assertion framework.