Découvrez comment fonctionne le test de qualité du code des pipelines et comment il peut améliorer la qualité de vos déploiements.
Le test de qualité du code évalue le code de votre application en fonction d’un ensemble de règles de qualité. Il s’agit de l’objectif principal d’un pipeline dédié uniquement à la qualité du code. Cette étape est exécutée immédiatement après l’étape de création dans tous les pipelines, aussi bien en production que hors production.
Voir Configuration de votre pipeline CI-CD pour en savoir plus sur les différents types de pipelines.
Les tests de qualité du code analysent le code source afin de s’assurer qu’il répond à certains critères de qualité. Cette analyse est implémentée par une combinaison de SonarQube et d’examens au niveau du package de contenu à l’aide d’OakPAL. Il existe plus de 100 règles combinant des règles Java génériques et des règles spécifiques à AEM. Certaines des règles spécifiques à AEM sont créées en fonction des bonnes pratiques de l’équipe d’ingénierie AEM et sont appelées Règles de qualité du code personnalisé.
Vous pouvez télécharger la liste complète des règles via ce lien.
Les problèmes identifiés par le test de qualité du code sont affectés à l’une des trois catégories.
Critique - il s’agit des problèmes qui entraînent une défaillance immédiate du pipeline.
Important - il s’agit des problèmes qui entraînent la mise en pause du pipeline. Un responsable de déploiement, un responsable de projet ou un propriétaire d’entreprise peuvent soit contourner les problèmes, auquel cas le pipeline continue, soit accepter les problèmes, auquel cas le pipeline s’arrête avec un échec.
Informations - Il s’agit des problèmes fournis uniquement à titre d’information et qui n’ont aucune incidence sur l’exécution du pipeline
Dans un pipeline uniquement axé sur la qualité du code, les échecs importants du point de contrôle Qualité du code ne peuvent pas être ignorés car l’étape de test de qualité du code est la dernière étape du pipeline.
Les résultats de cette étape sont fournis sous forme de notes.
Le tableau suivant résume les notes et les seuils d’échec pour chacune des catégories Critique, Important et Informations.
Nom | Définition | Catégorie | Seuil d’échec |
---|---|---|---|
Note de sécurité | A = Aucune vulnérabilité B = au moins 1 vulnérabilité mineure C = au moins 1 vulnérabilité majeure D = au moins 1 vulnérabilité critique E = au moins 1 vulnérabilité bloquante |
Critique | < B |
Note de fiabilité | A = Aucun bug B = au moins 1 bug mineur C = au moins 1 bug majeur D = au moins 1 bug critique E = au moins 1 bug bloquant |
Critique | < D |
Note de maintenabilité | Défini par le coût de remédiation en suspens pour les code smells, comme un pourcentage du temps qui a déjà été consacré à l’application.
|
Important | < A |
Couverture | Défini par un mélange de couverture de ligne de test unitaire et de couverture de condition à l’aide de la formule : Coverage = (CT + CF + LC)/(2*B + EL)
|
Important | < 50 % |
Tests unitaires ignorés | Nombre de tests unitaires ignorés | Infos | > 1 |
Problèmes en cours | Types de problèmes généraux – Vulnérabilités, bogues et smells de code | Infos | > 0 |
Lignes dupliquées | Défini comme le nombre de lignes impliquées dans les blocs dupliqués. Un bloc de code est considéré comme dupliqué dans les conditions suivantes. Projets non Java :
|
Infos | > 1 % |
Compatibilité Cloud Service | Nombre de problèmes de compatibilité Cloud Service identifiés | Infos | > 0 |
Voir Définitions des mesures de SonarQube pour des définitions plus détaillées.
Pour en savoir plus sur les règles de qualité du code personnalisé exécutées par Cloud Manager, voir Règles de qualité du code personnalisé.
Le processus d’analyse de qualité n’est pas parfait et identifiera parfois de manière incorrecte des problèmes qui ne sont pas réellement problématiques. On parle alors de faux positif.
Dans ces cas, le code source peut être annoté avec l’annotation standard Java @SuppressWarnings
en spécifiant l’ID de la règle comme attribut d’annotation. Par exemple, un faux positif courant est que la règle de SonarQube permettant de détecter les mots de passe codés en dur peut être agressive sur la façon dont un mot de passe codé en dur est identifié.
Le code suivant est assez courant dans un projet AEM, qui comporte du code pour se connecter à un service externe.
@Property(label = "Service Password")
private static final String PROP_SERVICE_PASSWORD = "password";
SonarQube lèvera alors une vulnérabilité de blocage. Mais après avoir examiné le code, vous identifiez qu’il ne s’agit pas d’une vulnérabilité et vous pouvez l’annoter avec l’identifiant de règle approprié.
@SuppressWarnings("squid:S2068")
@Property(label = "Service Password")
private static final String PROP_SERVICE_PASSWORD = "password";
Cependant, si le code était en fait ceci :
@Property(label = "Service Password", value = "mysecretpassword")
private static final String PROP_SERVICE_PASSWORD = "password";
La bonne solution consiste alors à supprimer le mot de passe codé en dur.
Bien qu’il soit recommandé d’effectuer l’opération @SuppressWarnings
annotation aussi spécifique que possible, c’est-à-dire annoter uniquement l’instruction ou le bloc spécifique à l’origine du problème, il est possible d’annoter au niveau de la classe.
Bien qu’il n’existe pas d’étape de test de sécurité explicite, des règles de qualité du code liées à la sécurité sont évaluées à l’étape de qualité du code. Voir Présentation de la sécurité pour AEM as a Cloud Service pour en savoir plus sur la sécurité en Cloud Service.
Dans le cadre du processus d’analyse de la qualité, Cloud Manager effectue une analyse des packages de contenu générés par la version Maven. Cloud Manager propose des optimisations pour accélérer ce processus, qui sont efficaces lorsque certaines contraintes de conditionnement sont observées. La plus importante est l’optimisation effectuée pour les projets qui génèrent un seul package de contenu, généralement appelé package « all », qui contient un certain nombre d’autres packages de contenu générés par la version, qui sont marqués comme étant ignorés. Lorsque Cloud Manager détecte ce scénario, plutôt que de décompresser le package « all », les packages de contenu individuels sont analysés directement et triés en fonction des dépendances. Par exemple, considérez la sortie de génération suivante.
all/myco-all-1.0.0-SNAPSHOT.zip
(package de contenu)ui.apps/myco-ui.apps-1.0.0-SNAPSHOT.zip
(package de contenu ignoré)ui.content/myco-ui.content-1.0.0-SNAPSHOT.zip
(package de contenu ignoré)Si les seuls éléments à l’intérieur myco-all-1.0.0-SNAPSHOT.zip
sont les deux packages de contenu ignorés, puis les deux packages incorporés sont analysés au lieu du package de contenu "all".
Pour les projets qui produisent des dizaines de packages incorporés, il a été démontré que cette optimisation permet de gagner jusqu’à 10 minutes par exécution de pipeline.
Un cas particulier peut se produire lorsque le package de contenu « all » contient une combinaison de packages de contenu ignorés et de lots OSGi. Par exemple, si myco-all-1.0.0-SNAPSHOT.zip
contenait les deux packages incorporés mentionnés précédemment et un ou plusieurs lots OSGi, puis un nouveau package de contenu minimal est construit avec uniquement les lots OSGi. Ce package est toujours nommé cloudmanager-synthetic-jar-package
et les lots contenus sont placés dans /apps/cloudmanager-synthetic-installer/install
.