Outil de développement à code ouvert
Savoir où intervenir dans le code.
crapkit croise la complexité du code, la couverture des tests et l’historique des modifications pour aider les développeurs et les agents de programmation à décider quoi améliorer en priorité.
$ crapkit worklist
classifycalc/grade.py:7La complexité et la couverture des tests, à l’échelle d’une fonction.
Le problème de départ
Le code peut être facile à générer, mais difficile à modifier en toute confiance. Des tests qui passent ou un taux de couverture global ne permettent pas de repérer les fonctions dont la logique complexe se conjugue à des lacunes dans les tests.
J’ai créé crapkit pour repérer ce travail à l’échelle de chaque fonction et rendre les mêmes données exploitables par les développeurs, les agents de programmation et les contrôles automatisés.
01
Combiner la complexité cyclomatique et la couverture des tests à l’aide de la métrique CRAP existante. Lorsque la couverture n’est pas disponible, présenter la complexité seule, sans laisser croire que les tests ont été mesurés.
02
S’appuyer sur l’historique des modifications pour établir les priorités. Une fonction complexe qui change souvent ne demande pas la même attention qu’un code rarement modifié.
03
Enregistrer la dette technique existante comme point de départ, puis vérifier les modifications par rapport à cette référence. Le mécanisme de cliquet permet aux scores enregistrés de s’améliorer, mais les empêche d’augmenter.
Utilisez crapkit en ligne de commande, connectez un agent de programmation par MCP ou intégrez-le à un flux de travail GitHub Actions. L’analyse et le calcul des scores s’exécutent localement, sans télémétrie; les commandes de test et les autres commandes configurées conservent leur propre comportement.
Un exemple reproductible
Huit fonctions. Le même code. Davantage de tests aux limites.
Ce petit exemple public en Python compte au départ quatre cas de test qui réussissent. J’ai ajouté 25 cas couvrant les seuils de classement, les entrées vides, les valeurs manquantes et les branches du rapport. Le code de l’application est resté identique. Le tableau présente les mesures de crapkit avant et après cet ajout.
Mesuré le avec Python 3.11 sous Windows; code source et outil fixés à la révision 8ff0fab87899.
Faites défiler le tableau horizontalement pour voir toutes les mesures.
| Fonction | Complexité | Couverture avant | Couverture après | CRAP avant | CRAP après |
|---|---|---|---|---|---|
grade( score )calc/grade.py | 3 | 0 % | 100 % | 12 | 3 |
summarize( rows )calc/grade.py | 2 | 0 % | 100 % | 6 | 2 |
coerce( word )calc/parse.py | 5 | 66,67 % | 100 % | 5,93 | 5 |
read_row( line , cols )calc/parse.py | 6 | 66,67 % | 100 % | 7,33 | 6 |
parse( text , cols )calc/parse.py | 3 | 100 % | 100 % | 3 | 3 |
tally( rows , low , high )calc/report.py | 4 | 100 % | 100 % | 4 | 4 |
render( bins , width )calc/report.py | 2 | 100 % | 100 % | 2 | 2 |
banner( bins , total )calc/report.py | 4 | 0 % | 100 % | 20 | 4 |
La couverture est mesurée dans chaque fonction : couverture des branches lorsqu’il y en a, sinon couverture des lignes. CRAP combine cette proportion avec la complexité cyclomatique. Lorsque la couverture mesurée atteint 100 %, le score devient égal à la complexité; l’ajout de tests n’a donc pas simplifié le code.
Le total correspond à la somme des scores des huit fonctions, appelée crap_load dans crapkit. Il n’estime ni les heures économisées ni le nombre de tests nécessaires. La cible de 6 est le seuil configuré pour cet exemple. Le tableau arrondit les valeurs; le CSV conserve la précision des mesures.
Alberto Savoia et Bob Evans ont introduit la métrique CRAP en 2007. Ma contribution est l’outillage de crapkit pour effectuer les mesures et contrôler les changements.
La métrique d’origine et ses limites · Documentation de crapkit à cette révision
Téléchargez et décompressez le fichier, puis choisissez un nouvel environnement Python 3.11 ou plus récent, avec Git disponible. Installez-y les dépendances fixées dans le fichier fourni et lancez le script. Le fichier README contient les commandes pour Windows et macOS/Linux.
python -m pip install -r requirements-reproduce.txt
python reproduce.py --output resultsLe script n’installe rien et refuse d’utiliser un répertoire de sortie existant. Il exécute l’exemple public fourni, ajoute les tests et compare les mesures aux valeurs publiées.
Le fichier comprend le code d’origine, les tests ajoutés, la licence MIT, le script de reproduction, les dépendances fixées et les résultats vérifiés.
Consulter le code public d’origine ↗Les questions derrière les outils
Mes articles explorent le pouvoir d’agir, l’intention et la responsabilité. crapkit aborde un aspect concret du développement logiciel : rendre plus faciles à examiner les données qui éclairent les modifications du code.