Sur la base de l'article Learning Software Engineering Principles Using Open Source Software qui présente cet enseignement au Canada, nous nous proposons d'aborder l'analyse de code.

Nous travaillerons cependant sur un exemple plus simple, les classes de graphes issues des cours en ligne de Polytechnique que nous avons déjà utilisé, mais qui vous sont données ici dans leur ensemble : src.zip.

Ceux qui le veulent peuvent faire le même exercice mais sur les codes de Junit, dans ce cas se reporter à la fin de ce TD pour le téléchargement des codes.

Question :

1. Télécharger les codes sur lesquels nous allons faire de l'analyse de code.

Une fois les codes téléchargés et placés dans Eclipse, nous allons utiliser pour l'instant les outils standard pour parcourir ces codes.

1. Placez vous dans une perspective “java”: Window → open perspective → Java …
2. Comprenez les hiérarchies des classes en utilisant la vue dédiée
   • Quelles sont les sous-classes de la classe Graphe?
3. En utilisant la vue package explorer, regarder les classes du package grapheX. Est-ce que les noms des classes sont explicites? avez vous une idée de l'intérêt de ces classes?
4. En utilisant “Outline View”, examiner la classe “Arc”. Le code est-il autodescriptif? Pouvez-vous expliquer son intérêt sans trop de difficulté?
5. En utilisant “Outline View”, examiner les méthodes non-triviales de la classe Graphe. Le code est-il autodescriptif? Pouvez-vous expliquer son intérêt sans trop de difficulté?
6. Retrouver les méthodes qui appelent la méthode voisins de la classe Graphe
7. Faîtes la même chose à partir de la classe Graphe pour visualiser tous les appels à son constructeur.

1. Placez vous dans une perspective java
2. Nous allons ouvrir une autre vue (Extrait de http://metrics.sourceforge.net/).
   • To start using the Metrics View, use Windows → Show View → Other and navigate to the Metrics View, as shown in the next image.
   • Un message vous signale que vous devez calculer les métriques et pour cela “permettre ces calculs”.
3. Clique droit sur le projet, puis Properties → Metrics → utiliser les métriques (cf. Figure EnableMetrics) → Apply
4. Si l'affichage ne se fait pas, vous devez faire un clean du projet (Projet→ clean/Build).
5. Vous pouvez double-cliquer sur les métriques pour les voir en détail en particulier pour visualiser les valeurs maximales. Les éléments enfants à chaque niveau sont triés par ordre décroissant métrique (maximum ).
6. Etudiez les valeurs des métriques obtenues.
   • Sont-elles dans les limites souhaitées?
     • Dans quel cas, ne sont-elles pas dans la limite souhaitée? Est-ce une méthode publique? Qu'en pensez-vous?
   • Que pensez-vous de la classe Graphe :
     • Nombre de lignes de code des méthodes? Quelle est la méthode qui a le plus de lignes de codes? Qu'en pensez-vous?
     • Comparer le nombre de lignes à sa complexité Cyclomatic.
     • Que pensez-vous du nombre de méthodes dans cette classe? Est-ce que cela vous gêne?
7. Les valeurs seuils ne sont pour la plupart pas définies. Pour les définir, aller dans le menu Preference de Eclipse puis sous Metric, configurer les valeurs seuils à votre convenance et regarder à nouveau les codes. (En savoir plus)
8. Avez-vous bien compris ce que représentent les différents métriques?

Notre objectif dans cette partie est de comprendre

1. les notions de normes de codage
2. comment préciser vos propres règles de nommage.

1- Activer CheckStyle dans le projet

2- Afficher la vue “Checkstyle Violation”

3- Configurer les règles pour votre projet

a- Dans Eclipse → preference → CheckStyle

Vous visualisez alors les règles par défaut de tous les projets.

b- Pour votre projet, il est utile de définir votre propre configuration : sélection du projet → properties, puis checkstyle

c- Sélectionner Local Check Configuration → New

d- sélectionner la configuration puis faire configure

Vous choisissez à présent les règles que vous voulez vérifier dans votre projet.

• la duplication de code
• le nommage des variables
• le nommage des packages, mais vous le modifiez pour forcer le nom des packages à se terminer par “pk”.

e- effacer les violations précédentes (projet → checkstyle → clear checkstyle violation

si cela ne fonctionne pas, désélectionner “use simple configuration” puis Add

Vous visualisez les règles rangées par catégorie.

X- Visualiser les erreurs sur un graphique

Sélectionner juste à côté de la vue Checkstyle la visualisation graphique (les 4 couleurs)

Leur donner les conventions Sun

Quand vous travaillez à plusieurs sur des codes vous pouvez être amenés à définir vos propres règles de nommage par exemple, tous les noms de packages se terminent par pk, …

questions:

• Consider the coding conventions for line length in the Sun document. Browse your application source code and determine if this coding convention has been consistently followed.
• Consider the coding conventions for line wrapping in the Sun document. Browse your application source code and determine if this coding convention has been consistently followed.
• Consider the coding conventions for various types of

comments – block, single line, trailing, end-of-line, and documentation – in the Sun document. Browse your Session application source code and determine if this coding convention has been consistently followed.

• Consider the coding conventions for declarations – number per line, placement, and initialization – in the

Sun document. Browse your application source code and determine if this coding convention has been consistently followed.

• Consider the coding conventions for statements – while,

switch, and try-catch – in the Sun document. Browse your application source code and determine if this coding convention has been consistently followed.

• Pour cela vous limitez à la partie source du code (dans la vue Problems→ Configure Contents (cf. Configure Contents),

• puis Error/warnings on Selection (cf. ErrorWarningOnSelection)….

After answering the above questions qualitatively, the project teams ran Checkstyle plug-in on their source code base. Next, they carefully interpreted the results produced by the plug-in with their qualitative assessment of the source code base by visual examination.

Attention c'est des recommandations seulement. Par exemple, dans les tests certaines valeurs ne doivent évidemment pas être définies comme des constantes.

On peut en effet se poser la question car il existe beaucoup d'outils similaires. Le choix fait CETTE année dans le cadre de CE module est motivé par :

• Il est reconnu et utilisé par beaucoup de projets Java, et ceci en particulier dans les entreprises qui emploient les étudiants de licence professionnelle;
• Il est simple d'utilisation et se présente comme un plugin pour Eclipse, or nous visons dans le cadre de cet enseignement à minimiser les environnements de programmation.
• “Il couvre un large spectre, en termes de contrôle (de la convention de nommage au calcul de complexité cyclomatique) et il fournit, en standard, près de 300 règles « prêtes à l'emploi » ”

En savoir plus sur le choix : (cf. http://connect.ed-diamond.com/GNU-Linux-Magazine/GLMF-105/Verifier-votre-code-Java-avec-PMD)

1- Fabriquons un exemple pour être sûr d'avoir des erreurs à analyser ¹⁾ :

package test.pmd;
 
//PMD Eclipse Tutorial
public class PMDTest {
  public static void main(String args[]) {
    PMDTest.CALL_METHOD("hello");
    PMDTest.CallHello();
  }
 
  public static void CALL_METHOD(String INPUT_PARAMETER) {
    System.out.println(INPUT_PARAMETER);
  }
 
  public static void CallHello() {
    System.out.println("Hello PMD World!");
  }
}

2- Clique droit sur le projet puis PMD vérifier le projet

3- Pour mieux voir les erreurs, ouvrir une nouvelle vue PMD

4- Générer le rapport PMD

5- Etudier les erreurs relevées dans la nouvelle classe, dans les codes existants et dans vos propres codes.

Pour comprendre les erreurs pensez à cliquer sur l'erreur et visualiser la règle

1- Sélectionner eclipse → Preferences → PMD

2- Visualiser les règles associées au nommage.

• Ouvrir la vue Synthese des alertes PMD
  • Ne visualiser que les erreurs les plus graves (Ne garder que le petit drapeau rouge sélectionné! cf. figure
    • Etudier certaines des erreurs uniquement dans la partie main du code et les comprendre : POURQUOI? (chercher les explications dans http://pmd.sourceforge.net/pmd-5.1.2/rules/index.html#Basic (penser à utiliser la recherche dans la page)), par exemple : AvoidThrowingRawExceptionTypes: Avoid throwing certain exception types. Rather than throw a raw RuntimeException, Throwable,Exception, or Error, use a subclassed exception or et aller plus loin si besoin).
      • src/main/java/junit/framework/JUnit4TestAdapterCache.java:15: Variables that are final and static should be all capitals, 'fInstance' is not all capitals.
      • Pour s'y retrouver il peut etre utile de générer le rapport d'erreurs.
  • voir GodClassPMD (pour comprendre lire : http://pmd.sourceforge.net/pmd-5.1.2/rules/index.html#Basic)
  • La classe Theorie.java est notée comme une GOD Class ? Pourquoi ? (trop de méthodes)

Appliquer PMD sur vos propres codes.

• http://pmd.sourceforge.net/pmd-5.1.2/
• http://connect.ed-diamond.com/GNU-Linux-Magazine/GLMF-105/Verifier-votre-code-Java-avec-PMD
• Quelles règles? http://pmd.sourceforge.net/pmd-5.1.2/rules/index.html#Basic

Creer un nouveau projet. Limiter l'importation à la partie main du projet

1. Generate a package diagram
   • Vous aurez besoin de la vue (volet) “Aperçu des diagrammes) pour … y voir quelque chose!
   • La vue n'apporte pas vraiment d'information éttant donné la taille du projet… Décevant. Néanmoins ce type de visualisation peut etre utile, surtout sur des projets que l'on maîtrise. Appliquer le sur un de vos projets, s'il contient des packages et faîtes-vous une première idée.
2. Generate class diagrams
   • Cette visualisation doit se faire sur une sous-partie. Sélectionner quelques classes qu'il vous semble intéressant de visualiser.
3. Generate sequence or collaboration diagrams

Nous allons travailler sur le projet JUNIT comme base pour prendre en main l'environnement et découvrir quelques bases de l'analyse des codes.

Etape 1: Charger les codes à partir du répertoire SVN https://github.com/junit-team/junit

Extrait du tutoriel http://www.ibm.com/developerworks/opensource/library/os-ecl-subversion/

From Eclipse's File menu, choose Import to display the import manager (see Figure X). Choose Checkout Projects from SVN, then click Next.

On the Select/Create Location panel (see Figure 8), we need to create a new location (since we don't have any configured yet), so click Next to continue.

voir figure X

Attention, nous n'avons pas pour objectif dans ce TD de “corriger” les codes de JUnit mais seulement de regarder des codes existants pour apprendre à les analyser.

Selectionner trunk cela est bien suffisant pour nos tests (et déjà très gros!).

Mais on a quand même 14,9Mo…