62 lines
3.1 KiB
TeX
62 lines
3.1 KiB
TeX
\chapter{Fiabilité, évolutivité et maintenabilité}
|
|
|
|
\begin{quote}
|
|
The primary cost of maintenance is in spelunking and risk
|
|
\cite[139]{clean_architecture}
|
|
|
|
--- Robert C. Martin
|
|
\end{quote}
|
|
|
|
\section{Complexité cyclomatique}
|
|
|
|
La \href{https://fr.wikipedia.org/wiki/Nombre_cyclomatique}{complexité cyclomatique} (ou complexité de McCabe) peut s'apparenter à mesure de difficulté de compréhension du code, en fonction du nombre d'embranchements trouvés dans une même section.
|
|
Quand le cycle d'exécution du code rencontre une condition, cette condition peut être évalue à VRAI ou à FAUX.
|
|
L'exécution du code dispose donc de deux embranchements, correspondant chacun à un résultat de cette condition.
|
|
|
|
Le code suivant a une complexité cyclomatique 1; il s'agit du cas le plus simple que nous pouvons implémenter: l'exécution du code rentre dans la fonction (il y a un seul embranchement), et aucun bloc conditionnel n'est présent sur son chemin.
|
|
La complexité reste de 1.
|
|
|
|
\begin{listing}[hbpt]
|
|
\begin{minted}{Python}
|
|
from datetime import date
|
|
|
|
def print_current_date():
|
|
print(date.today())
|
|
\end{minted}
|
|
\end{listing}
|
|
|
|
Si nous complexifions cette fonction en vérifiant (par exemple) le jour de la semaine, nous aurons notre embranchement initial (l'impression à l'écran de la date du jour), mais également un second embranchement qui vérifiera si cette date correspond à un lundi:
|
|
|
|
\begin{listing}
|
|
\begin{minted}{Python}
|
|
from datetime import date
|
|
|
|
def print_current_date_if_monday():
|
|
if date.today().weekday() == 0:
|
|
print("Aujourd'hui, c'est lundi!")
|
|
print(date.today())
|
|
\end{minted}
|
|
\end{listing}
|
|
|
|
La complexité cyclomatique d'un bloc est évaluée sur base du nombre d'embranchements possibles; par défaut, sa valeur est de 1.
|
|
Si nous rencontrons une condition, elle passera à 2, etc.
|
|
Cette complexité est liée à deux concepts:
|
|
|
|
\begin{itemize}
|
|
\item \textbf{La lisibilité du code}: au plus la complexité cyclomatique sera élevée, au plus le code sera compliqué à comprendre en première instance. Il sera composé de plusieurs conditions, éventuellement imbriquées, il débordera probablement de la hauteur que votre écran sera capable d'afficher
|
|
\item \textbf{Les tests unitaires}: pour nous assurer d'une couverture de code correcte, il sera nécessaire de couvrir tous les embranchements présentés. Connaître la complexité permet de savoir combien de tests devront être écrits pour assurer une couverture complète de tous les cas pouvant se présenter.
|
|
\end{itemize}
|
|
|
|
\subsection{Tests unitaires}
|
|
|
|
Le nombre de tests unitaires nécessaires à la couverture d'un bloc fonctionnel est au minimum égal à la complexité cyclomatique de ce bloc.
|
|
Une possibilité pour améliorer la maintenance du code est de faire baisser ce nombre, et de le conserver sous un certain seuil.
|
|
Certains recommandent de le garder sous une complexité de 10; d'autres de 5.
|
|
|
|
\subsection{Lisibilité du code}
|
|
|
|
Il est important de noter que refactoriser un bloc pour en extraire une méthode n'améliorera pas la complexité cyclomatique globale de
|
|
l'application.
|
|
Nous visons ici une amélioration \textbf{locale}.
|
|
|