Sur SAP il y a souvent plusieurs manières de faire… la bonne et les autres. Des outils peuvent aider à confirmer que ton code est correct, alors pourquoi ne pas les utiliser ?
Backend
Quand on dit “backend” sur SAP, on pense ABAP. C’est vrai, mais cela englobe aussi les vues CDS et plus récemment les frameworks ABAP RESTful Application Programming Model (RAP) et Cloud Application Programming Model (CAP). Voyons quels outils de contrôle existent pour tout ça !
ABAP Test Cockpit
Un bon outil pour contrôler la qualité de son code backend est l’ABAP Test Cockpit, abrégé en “ATC”. Paramétrable depuis la transaction ATC, l’ABAP Test Cockpit consiste à lancer des variantes de contrôle. Ces variantes sont une série de règles qui concerne la syntaxe, la cohérence et la performance de ton code. SAP délivre certaines variantes standards tout à fait pertinentes mais il est possible de créer tes propres règles de contrôles : pratique pour vérifier les règles de nommage propre à ton contexte.
Après l’exécution d’une variante de contrôle sur un périmètre de ton choix (un programme, une classe, un package complet, …), tu peux afficher les résultats en cliquant sur Gérer les résultats dans le menu ATC. Cela te permet de consulter la liste des problèmes dans ton code, classés par priorité (de 1 à 3). Tu peux ainsi les traiter un par un, du plus au moins critique. A partir d’une ligne du rapport ATC, tu peux accéder facilement à la ligne de code concernée en double cliquant dessus..
SAP fournit également un lien vers la documentation expliquant le problème, qu’il soit de syntaxe ou autre. Tu peux aussi exécuter l’ATC directement sur un programme via la transaction SE38 ou sur une classe avec SE24.
Concernant les vues CDS ou le framework RAP qui sont créés dans Eclipse, il suffit de sélectionner l’onglet Run > Run As > ABAP Test Cockpit. Eclipse affiche alors la liste des problèmes, accompagnée des détails et de la documentation associée.
CDS Lint
Dans le framework CAP, un outil standard pour garantir la qualité de tes modèles est le CDS Lint, composé du plugin ESLint dédié @sap/eslint-plugin-cds et de la commande de lancement « cds lint ». Cet outil te confirme que tu as respecté, ou pas, les bonnes pratiques CAP.. Facile à installer grâce à la commande « cds add lint », il s’intègre parfaitement à Visual Studio Code ou Business Application Studio, l’analyse s’exécute directement dans l’éditeur. Tout comme pour l’ATC, tu peux personnaliser les règles via le fichier « .eslintrc ».
Frontend
Côté frontend, on parle évidemment de ton code SAPUI5. Tu peux utiliser un linter. C’est un outil qui effectue une analyse statique du code, directement dans vos fichiers, sans nécessiter de compilation. Le linter met en avant des erreurs qui bloquent l’exécution du code, ainsi que des avertissements qui te conseillent sur la manière d’améliorer ta syntaxe ou de suivre les bonnes pratiques.
ESLint
ESLint est un linter déjà intégré dans les éditeurs de code Web IDE et Business Application Studio, c’est un des linter les plus populaire en javascript. Il analyse en temps réel les erreurs de syntaxe et applique les bonnes pratiques de développement pour les applications Fiori. De plus, il est possible de personnaliser les règles d’ESLint en modifiant le fichier « .eslintrc », afin de les adapter aux besoins spécifiques de ton projet.
SAP propose aussi linter open-source dédié à SAPUI5 : UI5 linter.
Que propose ce linter SAPUI5 ?
- Détection des éléments obsolètes : il souligne toutes les méthodes, API ou bibliothèques qui sont dépréciées. Comme le linter est régulièrement mis à jour, tu es sûr de maintenir un code conforme aux dernières normes SAPUI5.
- Problèmes de performance et variables globales : il identifie les problèmes qui pourraient impacter la performance ou détecte l’utilisation inappropriée de variables globales.
Préparation aux mises à jour : en adoptant un code SAPUI5 robuste et respectant les bonnes pratiques UI5, vous facilitez la montée en version future, comme SAPUI5 2.x.
Voici un package npm pour installer et configurer ce linter très complet : ui5plugin-linter. Pour le configurer, édite le fichier package.json et sélectionne les problèmes que tu veux voir signalés par le linter.
Conclusion
Nous avons présenté ici des outils d’analyse pour le développement backend et frontend.. À vous de les utiliser et de les adapter selon vos besoins ! Personnalisez les avec vos variantes et configurations pour obtenir un code en béton armé et qui résistera aux montées de versions SAP. 😉
