Abstract
In the context of Open Source Software (OSS), the lack of project documentation is one of the most challenging problems that slows down the widespread diffusion of OSS products. The difficulty of providing up-to-date and reasonable documentation for OSS products relates to two main reasons. First, documenting development activities and technological issues is viewed as a tedious and unrewarding task. Second, data and information about an OSS project (such as source code, project plans, testing requirements, etc.) are scattered and shared via unstructured channels such as unofficial forums and mailing lists.
In this paper, we focus on technical documentation related to testing activities. In this context, the lack of documentation is exacerbated due to the use of the available testing methods that drastically increase code fragmentation. We propose T-doc, a tool that simplifies the generation of testing documentation. In particular, T-doc supports (1) the automatic generation of test cases documentation, (2) the generation of reports about test case results, and (3) the archiving of testing documents in central repositories. The automatic generation of documentation is facilitated by the adoption of built-in testing methods that simplify the aggregation of testing data.
We apply the tool to the OSS RealEstate Java application to show the applicability and the real benefits of our solution.
Chapter PDF
Similar content being viewed by others
References
MacXim: a static code analysis tool. Web published: http://qualipso.dscpi.uninsubria.it/macxim/ (Accessed: December 2009)
The RealEstate demo application. Web published, http://agile.csc.ncsu.edu/SEMaterials/realestate/ (Accessed: December 2009)
Beydeda, S.: Research in testing COTS components - built-in testing approaches. In: Proceedings of the ACM/IEEE International Conference on Computer Systems and Applications (AICCSA), pp. 101–104 (2005)
Mao, C., Lu, Y., Zhang, J.: Regression testing for component-based software via built-in test design. In: Proceedings of the ACM Symposium on Applied Computing (SAC), pp. 1416–1421 (2007)
Orso, A., Harrold, M.J., Rosenblum, D.S., Rothermel, G., Soffa, M.L., Do., H.: Using component metacontent to support the regression testing of component-based software. In: Proceedings of the IEEE International Conference on Software Manintenance (ICSM), pp. 716–725 (2001)
Pezzè, M., Young, M.: Software Testing And Analysis. Process, Principles, and Techniques. Wiley, Chichester (2007)
Suliman, D., Paech, B., Borner, L., Atkinson, C., Brenner, D., Merdes, M., Malaka, R.: The MORABIT approach to runtime component testing. In: Proceedings of the International Computer Software and Applications Conference (COMPSAC), pp. 171–176 (2006)
Vincent, J., King, G., Lay, P., Kinghorn, J.: Principles of built-in-test for run-time-testability in component-based software systems. Software Quality Control 10(2), 115–133 (2002)
Wang, Y., King, G., Wickburg, H.: A method for built-in tests in component-based software maintenance. In: Proceedings of the IEEE European Conference on Software Maintenance and Reengineering (CSMR), pp. 186–192 (1999)
Author information
Authors and Affiliations
Editor information
Editors and Affiliations
Rights and permissions
Copyright information
© 2010 IFIP
About this paper
Cite this paper
Morasca, S., Taibi, D., Tosi, D. (2010). T-DOC: A Tool for the Automatic Generation of Testing Documentation for OSS Products. In: Ågerfalk, P., Boldyreff, C., González-Barahona, J.M., Madey, G.R., Noll, J. (eds) Open Source Software: New Horizons. OSS 2010. IFIP Advances in Information and Communication Technology, vol 319. Springer, Berlin, Heidelberg. https://doi.org/10.1007/978-3-642-13244-5_16
Download citation
DOI: https://doi.org/10.1007/978-3-642-13244-5_16
Publisher Name: Springer, Berlin, Heidelberg
Print ISBN: 978-3-642-13243-8
Online ISBN: 978-3-642-13244-5
eBook Packages: Computer ScienceComputer Science (R0)