Development and Implementation of Static Analysis Tools to Improve Code Quality

Abstract

[CA] Este Treball de Fi de Grau, que es desenvolupa en l'àmbit de pràctiques en l'empresa Medtronic, consistix en l'automatització de regles i guies de codi (guidelines). La seua intenció principal és mantindre uns estàndards de qualitat i consistència en el codi i estalviar valuosos recursos en la fase de testing i assegurament de qualitat, ja que el nombre de regles a comprovar en les revisions de codi serà molt de menor. Per a això, s'utilitzaran ferramentes existents com Clang-tidy, Clang-format, Coverity o diversos compiladors, investigant la seua documentació i implementant els arxius de configuració i les integracions en el sistema necessàries per al seu funcionament. Una vegada finalitzada esta solució, els desenvolupadors podran comprovar localment, abans de compartir el codi, el compliment d'estes regles i guies de codi tant mitjançant una extensió en el seu entorn de desenvolupament favorit, com mitjançant un script executable. Per a cobrir les regles que no poden ser verificades amb solucions existents, es desenvoluparà una solució interna, escrita en Python. Este programa s'integrarà com a comprovació addicional realitzada pel sistema de control de versions prèvia a la pujada de codi, utilitzant el procediment conegut com a Integració Contínua. Gràcies a este treball, un gran percentatge de regles, prèviament no forçades i que havien de ser comprovades manualment, quedarà automatitzat. Este enfocament no sols optimitza recursos en testing i assegurament de qualitat, sinó que també millora l'eficiència dels desenvolupadors en validar el compliment de normatives abans de les revisions de codi.

[ES] Este Trabajo de Fin de Grado, que se desarrolla en el ámbito de prácticas en la empresa Medtronic, consiste en la automatización de reglas y guías de código (guidelines). Su intención principal es mantener unos estándares de calidad y consistencia en el código y ahorrar valiosos recursos en la fase de testing y aseguramiento de calidad, puesto que el número de reglas a comprobar en las revisiones de código será mucho menor. Para ello, se utilizarán herramientas existentes como Clang-tidy, Clang-format, Coverity o varios compiladores, investigando su documentación e implementando los archivos de configuración y las integraciones en el sistema necesarias para su funcionamiento. Una vez finalizada esta solución, los desarrolladores podrán comprobar localmente, antes de compartir el código, el cumplimiento de estas reglas y guías de código tanto mediante una extensión en su entorno de desarrollo favorito, como mediante un script ejecutable. Para cubrir las reglas que no pueden ser verificadas con soluciones existentes, se desarrollará una solución interna, escrita en Python. Este programa se integrará como comprobación adicional realizada por el sistema de control de versiones previa a la subida de código, utilizando el procedimiento conocido como Integración Continua. Gracias a este trabajo, un gran porcentaje de reglas, previamente no forzadas y que debían ser comprobadas manualmente, quedará automatizado. Este enfoque no solo optimiza recursos en testing y aseguramiento de calidad, sino que también mejora la eficiencia de los desarrolladores al validar el cumplimiento de normativas antes de las revisiones de código.

[EN] This Final Degree Thesis, which is developed in the context of an internship at the company Medtronic, consists of the automation of rules and coding guidelines. Its main intention is to maintain quality standards and consistency in the code and save valuable resources in the testing and quality assurance phase, since the number of rules to check in code reviews will be much smaller. For this purpose, existing tools such as Clang-tidy, Clang-format, Coverity or various compilers will be used, researching their documentation and implementing the configuration files and system integrations required for their operation. Once this solution is completed, developers will be able to check locally, before sharing the code, the compliance with these rules and code guidelines either through an extension in their favorite development environment or through an executable script. To cover rules that cannot be checked with existing solutions, an internal solution, written in Python, will be developed. This program will be integrated as an additional check performed by the version control system prior to code upload, using the procedure known as Continuous Integration. Thanks to this work, a large percentage of rules, previously unforced and that had to be checked manually, will be automated. This approach not only optimizes resources in testing and quality assurance, but also improves developer efficiency by validating compliance before code reviews.