Ratio de deuda técnica
| Sigla | TDR |
| Aspecto | «Mantenibilidad» |
| Se mide en | fichero, componente o aplicación (la deuda se agrega sumando; el ratio se recalcula en cada nivel) |
| Tipo de valor | ratio (porcentaje, mínimo 0 %, sin máximo) |
| Dirección | más alto es peor |
| Umbrales de referencia | calificación de SonarQube: A hasta el 5 %, B hasta el 10 %, C hasta el 20 %, D hasta el 50 %, E desde el 50 % |
| Origen | método SQALE, Jean-Louis Letouzey, 2010-2012; metáfora de la deuda, Ward Cunningham, 1992 |
| Stau Metro | no la calcula |
En pocas palabras
Cada problema del código que dificulta mantenerlo (un método demasiado complejo, un bloque copiado, una excepción tragada) se puede arreglar con un esfuerzo estimado en minutos. La deuda técnica es la suma de todos esos minutos. El ratio la compara con lo que costaría escribir el código desde cero: un 5 % quiere decir que arreglarlo todo costaría la vigésima parte de haberlo escrito.
Qué mide
La deuda técnica es una metáfora de Ward Cunningham (1992): entregar código en su primera versión es como endeudarse. Un poco de deuda acelera el desarrollo si se paga pronto reescribiendo el código, pero «cada minuto que se dedica a código que no es del todo correcto cuenta como interés de esa deuda». La metáfora no traía una forma de medirla.
El método SQALE (Software Quality Assessment based on Lifecycle Expectations), de Jean-Louis Letouzey, la convierte en un número:
- La organización escribe su definición de «código correcto»: una lista de requisitos verificables (no hay bloques de código comentado, no hay dependencias cíclicas entre paquetes, ningún método supera cierta complejidad…).
- Cada requisito lleva una función de remedio: cuánto cuesta corregir una infracción (2 minutos por un bloque comentado, 1 hora por cada dependencia entre ficheros que haya que cortar para romper un ciclo…).
- Las herramientas buscan las infracciones. La deuda técnica es la suma del coste de remedio de todas.
Así, la deuda sale en unidades de tiempo (o de dinero) y se puede sumar entre ficheros, componentes y aplicaciones. Pero 40 días de deuda no dicen lo mismo en un programa de 5000 líneas que en uno de 2 millones. El ratio lo corrige dividiendo entre el tamaño, expresado como coste de desarrollo.
Cómo se calcula
Es la definición de SonarQube, donde el coste por línea es de 30 minutos por defecto y se puede cambiar. El numerador y el denominador están en minutos, así que el resultado es adimensional y se da en porcentaje.
El artículo de Letouzey e Ilkiewicz (2012) propone la misma idea: dividir la deuda entre el tamaño del código, «expresado, por ejemplo, en puntos de función o en miles de líneas», para obtener una densidad de deuda con la que comparar equipos u organizaciones.
Qué entra en el numerador depende de qué reglas tenga activas la herramienta y de la función de remedio de cada una. Dos herramientas, o la misma con dos perfiles de reglas distintos, dan deudas distintas para el mismo código.
Ejemplo
El ejemplo usa los valores por defecto de SonarQube (30 minutos por línea).
Proyecto A. 10 000 líneas de código y 1200 minutos de deuda (20 horas):
Calificación A.
Proyecto B. 20 000 líneas y 96 000 minutos de deuda (1600 horas):
Calificación C.
Para ver de dónde salen esos minutos, toma la tabla de requisitos de ejemplo de Letouzey e Ilkiewicz: «no hay bloques de instrucciones comentados» cuesta 2 minutos por infracción, y «ningún método con complejidad ciclomática mayor que 12», 1 hora por infracción si la complejidad no llega a 24 y 2 horas si la pasa. Veinte bloques comentados y diez métodos con complejidad entre 13 y 23 suman minutos.
Cómo interpretarla
La calificación de mantenibilidad de SonarQube se apoya en este ratio:
| Calificación | Ratio de deuda técnica |
|---|---|
| A | hasta el 5 % |
| B | del 5 % al 10 % |
| C | del 10 % al 20 % |
| D | del 20 % al 50 % |
| E | 50 % o más |
Son valores por defecto de la herramienta, no umbrales con respaldo empírico. Leídos en su propia escala, un 50 % significa que corregir los problemas costaría la mitad de reescribir el código.
Qué hacer con un ratio alto. No intentes bajarlo entero. SQALE propone dos órdenes de pago:
- El técnico: SQALE ordena sus ocho características de calidad de forma cronológica, de abajo arriba: capacidad de prueba (testability), fiabilidad, facilidad de cambio, eficiencia, seguridad, mantenibilidad, portabilidad y reutilización. Un requisito que afecta a varias características se asigna a la más baja, y la deuda se paga de abajo arriba: no tiene sentido hacer fiable un componente que no se puede probar.
- El de negocio: cada infracción lleva también un coste de no remediarla (lo que puede costar dejarla). Se empieza por las que más impacto evitan por minuto invertido.
En la práctica, lo más útil es vigilar la deuda del código nuevo: SonarQube calcula el mismo ratio solo sobre el código añadido o modificado, y es ahí donde un equipo puede actuar sin una campaña de limpieza.
Cuándo un ratio alto es aceptable. Cuando la deuda es deliberada y está acotada: un prototipo, código que se va a retirar, una parte del sistema que nadie toca. La deuda solo cobra interés en el código que se modifica.
Ojo. El ratio mide la deuda que las reglas activas saben ver. Un diseño equivocado, una abstracción que no encaja o una arquitectura que obliga a tocar diez módulos por cada cambio no aparecen. Un ratio del 1 % no es un código sano; es un código que cumple esas reglas.
Para profundizar
De dónde viene SQALE. Letouzey lo desarrolló en la consultora DNV ITGS, después inspearit, y lo publicó como método abierto y libre de derechos; la versión 1.0 de la definición es de enero de 2012. Se presentó en el Third International Workshop on Managing Technical Debt (2012) y en IEEE Software ese mismo año. El método define, además de la deuda (el SQALE Quality Index, SQI), un índice de impacto de negocio (SQALE Business Impact Index, SBII), una pirámide que reparte la deuda por característica y un mapa de deuda que cruza deuda e impacto para decidir qué pagar primero.
Por qué se puede sumar. Letouzey e Ilkiewicz, apoyándose en Letouzey y Coq (2010), sostienen que los costes están en una escala de razón y no ordinal, de modo que se pueden agregar sumando sin contradecir la teoría de la medición (ver «Teoría de la medición»).
Críticas y límites.
- Las funciones de remedio son estimaciones. Que corregir una infracción cueste 10 o 40 minutos es una convención de quien escribe la regla. El propio artículo de 2012 recomienda calibrarlas en proyectos piloto.
- Coste de desarrollo ficticio. El denominador supone que cada línea cuesta lo mismo, sea un getter o un algoritmo. Cambiar el coste por línea cambia el ratio sin tocar el código.
- Las reglas de estilo inflan la deuda. Miles de infracciones de formato de 2 minutos pueden pesar más que un ciclo entre paquetes. Por eso SQALE clasifica las infracciones por impacto y no solo por coste.
- Dependencia de la herramienta. No hay un catálogo de reglas estándar; Letouzey señalaba en 2012 que lo que la comunidad seguía esperando era «una definición estandarizada de código correcto».
Relación con otras métricas
- «Índice de mantenibilidad» (
MI): el enfoque anterior, una fórmula sobre métricas; la deuda técnica suma infracciones concretas y por eso dice qué arreglar. - «Densidad de defectos»: otra densidad, pero de fallos reales, no de infracciones de reglas.
- «Densidad de líneas duplicadas»: la duplicación es una fuente típica de deuda; en SQALE los bloques clonados son un requisito con su función de remedio.
- «Complejidad ciclomática» y «complejidad cognitiva»: las reglas que limitan la complejidad de un método son de las que más deuda generan.
- «Dependencias cíclicas» (
Cyclic): «no hay ciclos entre paquetes» es uno de los requisitos de ejemplo de SQALE. - «Número de comentarios TODO» (
TODO): la deuda que los propios programadores dejan anotada. - «Puntos de función» (
FP): SQALE admite expresar el tamaño del denominador en ellos.
En las herramientas
Stau Metro no la calcula: no tiene un catálogo de reglas con costes de remedio. Lo más cercano es el
«número de comentarios TODO» (TODO), que su ayuda presenta como «una
aproximación a la deuda técnica que se ha señalado explícitamente en comentarios». Es otra cosa: cuenta marcas, no
estima minutos, y no ve la deuda que nadie anotó. Varias de sus métricas, con sus umbrales de referencia, cubren
parte de lo que vigilan las reglas de una herramienta de deuda (complejidad, tamaño, ciclos), pero el plugin no las
convierte en coste.
SonarQube. Define la deuda técnica como «la suma de los costes de remedio de los problemas de mantenibilidad»
(en la interfaz clásica, de los code smells), con el coste de cada problema en minutos. El ratio es
sqale_debt_ratio y la calificación sqale_rating, con la tabla de arriba; en el modo de calidades de software
aparecen como software_quality_maintainability_debt_ratio y software_quality_maintainability_rating. Las variantes
new_… calculan lo mismo sobre el código nuevo. El coste de desarrollar una línea es de 30 minutos por defecto y se
puede configurar.
Referencias
- Cunningham, W. (1993). «The WyCash Portfolio Management System». ACM SIGPLAN OOPS Messenger, 4(2), 29-30. Informe de experiencia de OOPSLA '92.
- Letouzey, J.-L. (2012). «The SQALE Method for Evaluating Technical Debt». Third International Workshop on Managing Technical Debt (MTD 2012), 31-36.
- Letouzey, J.-L. e Ilkiewicz, M. (2012). «Managing Technical Debt with the SQALE Method». IEEE Software, 29(6), 44-51.
- Letouzey, J.-L. y Coq, T. (2010). «The SQALE Analysis Model: An Analysis Model Compliant with the Representation Condition for Assessing the Quality of Software Source Code». VALID 2010.
- SonarQube, definición de métricas (mantenibilidad): https://docs.sonarsource.com/sonarqube-server/latest/user-guide/code-metrics/metrics-definition/