On the Rationale and Use of Assertion Messages in Test Code: Insights from Software Practitioners

TL;DR

This study surveys software practitioners to understand their use, perceptions, and challenges related to assertion messages in unit tests, providing guidelines for best practices and tool improvements.

Contribution

It offers empirical insights into assertion message usage, perceptions, and challenges, and proposes guidelines for improving their quality and integration in testing tools.

Findings

Majority find assertion messages valuable for troubleshooting and documentation

Not all practitioners consistently include assertion messages

Guidelines for crafting high-quality assertion messages

Abstract

Unit testing is an important practice that helps ensure the quality of a software system by validating its behavior through a series of test cases. Core to these test cases are assertion statements, which enable software practitioners to validate the correctness of the system's behavior. To aid with understanding and troubleshooting test case failures, practitioners can include a message (i.e., assertion message) within the assertion statement. While prior studies have examined the frequency and structure of assertion messages by mining software repositories, they do not determine their types or purposes or how practitioners perceive the need for or the usage of various types of assertion messages. In this paper, we survey 138 professional software practitioners to gather insights into their experience and views regarding assertion messages. Our findings reveal that a majority of survey respondents find assertion messages valuable for troubleshooting failures, improving test understandability, and serving as documentation. However, not all respondents consistently include messages in their assertion methods. We also identified common considerations for constructing effective assertion messages, challenges in crafting them, maintenance techniques, and their integration into debugging processes. Our results contribute to the understanding of current practices and provide guidelines for authoring high-quality assertion messages, serving as a foundation for best practices and coding standards. Furthermore, the insights can guide the improvement of automated unit testing tools by incorporating checks for the presence and quality of assertion messages and providing real-time feedback to practitioners.