Projet MVC-CD Mise en place de l environnement de développement

Transcription

1 Projet MVC-CD Mise en place de l environnement de développement Créé par S. Berberat, le 18 décembre 2013 Modifié par S. Berberat, le 14 septembre 2015 Page 1 sur 30

2 Table des matières 1 Préambule Installation d Eclipse Procédure simplifiée Procédure complète Téléchargement d Eclipse Configuration du proxy Installation du client SVN Configuration de l espace de travail Sélection de la perspective Ajout de la vue «Tasks» Ajout de la vue «SVN Repositories» Ajout de la référence vers le serveur SVN Installation du projet MVC-CD dans Eclipse Récupération d un projet non versionné Récupération d une copie locale versionnée Connexion au serveur Récupération du projet Vérification des paramètres du projet Eclipse Mise en place du plug-in VP pour Eclipse Fonctionnement général Installation du plug-in Ajout des vues nécessaires Versionning du référentiel VP Récupération du référentiel VP Exclusion du référentiel VP du SVN des sources Migration d un référentiel VP existant vers Eclipse Références Page 2 sur 30

3 1 Préambule L environnement de développement retenu est Eclipse. Ses avantages sont notamment son large support sur Internet, son nombre conséquent de plug-ins existant ainsi que la possibilité d y intégrer l environnement Visual Paradigm, ce qui permet de développer le plug-in MVC-CD pour Visual Paradigm selon l approche MDA. 2 Installation d Eclipse C est Eclipse IDE for Java EE Developpers qui est retenu, en version Juno. L édition 64 bits est choisie. Il existe deux façons d installer Eclipse pour l environnement de développement MVC-CD. La première est une procédure simplifiée, qui consiste à récupérer une archive déjà prête du logiciel et de son environnement. La seconde consiste à récupérer Eclipse sur le site Internet et à lui installer les plug-ins et paramètres nécessaires. L installation d Eclipse a été prévue pour l environnement Windows Procédure simplifiée Vous devez être connecté au réseau de la HE-Arc pour réaliser cette procédure. Dirigez-vous sur le disque réseau «GES» à cette adresse : O:\Formation\010-Bachelor\Informatique de gestion\etudiants\lecture\berberat Steve\ MVC-CD\Environnement de développement Récupérez en local le fichier «eclipse.zip». Décompressez l archive et placez le répertoire «eclipse» dans «C:\Program Files». Modifiez les propriétés de «eclipse.exe» et activer le démarrage en mode «Administrateur». Page 3 sur 30

4 2.2 Procédure complète Téléchargement d Eclipse Réalisez les points suivants pour disposer de l IDE Eclipse. 1. Récupérer la dernière version de Juno : La dernière Release peut être récupérée sans problèmes, les dernières mises à jour consistant à corriger des bogues et non à apporter de nouvelles fonctionnalités potentiellement incompatibles avec d anciennes versions. 2. Décompressez l archive et placez le répertoire «eclipse» dans «C:\Program Files». 3. Créez un raccourci de l exécutable «eclipse.exe» là où vous le souhaitez. 4. Modifiez les propriétés de «eclipse.exe» et activer le démarrage en mode «Administrateur» : 5. Démarrez Eclipse. Page 4 sur 30

5 2.2.2 Configuration du proxy Actuellement, il n est plus nécessaire de passer par le proxy HE-Arc pour accéder à Internet. Il n est donc plus nécessaire de configurer le proxy. En cas de besoins, les points suivants permettent de configurer tout de même le proxy, comme cela était nécessaire auparavant. Cette configuration était obligatoire pour la simple raison qu Eclipse ne reprend pas la configuration du proxy faite pour Windows mais réintègre sa propre configuration. 1. Ouvrez le menu «Window» «Preferences» 2. Recherchez le terme «proxy» dans le champ de recherche. 3. Ouvrez «Network Connections» et adaptez les paramètres selon la capture ci-après. Notez l importance de l exception «*.he-arc.ch», qui est nécessaire si nous souhaitons que l IDE puisse ultérieurement se connecter à un serveur de version interne. Page 5 sur 30

6 2.2.3 Installation du client SVN Le code source est situé sur un serveur SVN, ce qui garantit la traçabilité des modifications apportées. En standard, Eclipse ne dispose pas de client SVN. Nous allons installer «Subversive SVN», qui semble être le plus populaire pour cet environnement. 1. Ouvrez le menu «Help» «Install new software». 2. Dans la liste déroulante, sélectionnez la source «Juno». Déroulez «Collaboration» et cochez «Subversive SVN Team Provider». 3. Suivez les instructions de l assistant puis patientez pendant l installation. Page 6 sur 30

7 5. Eclipse demande un redémarrage. Acceptez. 6. Au redémarrage, une fenêtre vous propose d installer des «Connectors». Cochez le connecteur «SVN Kit x.x.x» dans la version la plus récente proposée, puis appuyez sur «Finish». Page 7 sur 30

8 7. Une nouvelle fenêtre propose deux éléments d installation. Laissez les deux éléments cochés et poursuivez l assistant afin de démarrer l installation. 8. Patientez pendant l installation. 9. Durant l installation, Eclipse nous met en garde sur le fait que le produit installé contient des éléments non-signés. Faites «OK». 10. Eclipse demande un nouveau redémarrage que vous devez réaliser. Page 8 sur 30

9 3 Configuration de l espace de travail Tous les éléments réalisés dans ce chapitre s appliquent à l espace de travail que vous avez sélectionné. Dans Eclipse, vous pouvez passer d un espace de travail à un autre à l aide du menu «File» «Switch workspace». 3.1 Sélection de la perspective En premier lieu, il est nécessaire de vérifier que notre environnement se trouve dans la bonne perspective. Une perspective est un ensemble de vues disposées selon notre choix. Assurez-vous d avoir l icône «l IDE.» sélectionné dans les perspectives à disposition en haut à droite de la fenêtre de Cet icône correspond à la perspective «JavaEE» actionnée par défaut lors de l installation d Eclipse. Cette vérification semble toutefois nécessaire car, lors de l installation de plug-ins ou composants, il se peut qu une autre perspective soit automatiquement activée. 3.2 Ajout de la vue «Tasks» Nous allons ajouter la vue «Tasks», qui permet de recenser tous les commentaires «TODO» posés au sein du code source. 1. Ouvrez le menu «Window» «Show view» «Other» 2. Recherchez «Tasks», sélectionnez-le et validez. 3. Déplacez la vue à un emplacement convenable. Page 9 sur 30

10 3.3 Ajout de la vue «SVN Repositories» Pour faciliter la gestion du code source versionné, nous allons ajouter une vue «SVN Repositories». Elle permet de naviguer directement au sein du référentiel de sources du serveur, sans nécessairement disposer d une version locale d un projet Eclipse. 1. Ouvrez le menu «Window» «Show view» «Other». 2. Recherchez et sélectionnez «SVN Repositories». 3. Déplacez la vue à un emplacement convenable, par exemple dans la zone inférieur de la fenêtre. Cette vue ne dispose d aucun élément pour l instant : Page 10 sur 30

11 3.4 Ajout de la référence vers le serveur SVN Nous allons ajouter la référence vers le répertoire SVN qui comprend les différents projets Eclipse ayant attrait à MVC-CD. 1. Réalisez un clic droit dans la zone blanche de la vue «SVN Repositories», et choisissez «New» «Repository Location». 2. Renseignez le formulaire selon les indications suivantes : a. URL : b. Label : «Use the repository URL as the label» c. Le nom d utilisateur et le mot de passe seront ajoutés ultérieurement. Pour l instant, n inscrivez rien. d. Validez en cliquant sur «Finish». Page 11 sur 30

12 e. On vous demande d insérer le nom d utilisateur et le mot de passe. Appuyez sur «Cancel». On vous informe alors que l authentification a été annulée, puis on vous demande si l on conserve tout de même la référence vers le serveur. Appuyez sur OK. Page 12 sur 30

13 4 Installation du projet MVC-CD dans Eclipse En fonction de vos besoin, vous pouvez, à choix, suivre le chapitre «4.1» si vous souhaitez installer le projet MVC-CD dans Eclipse à partir d une archive «zip», ou, selon vos possibilités, parcourir le chapitre «4.2» pour récupérer une copie locale versionnée des sources à partir du serveur SVN. Cette deuxième option nécessite un compte d utilisateur et, bien entendu, l aval du directeur de projet. 4.1 Récupération d un projet non versionné Un accès au réseau de la HE-Arc s avère nécessaire pour récupérer le projet Eclipse non versionné. Dirigez-vous sur le disque réseau «GES» à l adresse suivante : O:\Formation\010-Bachelor\Informatique de gestion\etudiants\lecture\berberat Steve\ MVC-CD\Sources À l intérieur se trouve un répertoire différent pour chaque version du projet. Choisissez celle qui vous convient. Si vous n avez aucune instruction particulière quant à ce niveau, préférez la dernière version disponible. Récupérez en local l archive «zip» contenue dans le répertoire choisi. Décompressez-là dans votre workspace, c est-à-dire à l emplacement où vous souhaitez avoir votre projet. L image ci-dessous montre le contenu d un workspace qui ne comprenait encore aucun projet. À l aide d Eclipse, faites «File» «Import» puis choisissez «Existing Project into Workspace». Page 13 sur 30

14 Sélectionnez alors le répertoire racine «MVC-CD-1» du projet décompressé et faites «Finish». Le projet doit maintenant être présent dans votre espace «Project Explorer». Page 14 sur 30

15 4.2 Récupération d une copie locale versionnée Vous pouvez suivre ce chapitre uniquement si vous disposez des accès au SVN Connexion au serveur À l aide de la vue «SVN Repositories», ouvrez le répertoire SVN «VPPlugins». On vous demande alors le nom d utilisateur et le mot de passe d accès au répertoire. Le propriétaire du compte d accès décidera lui-même s il souhaite mémoriser le mot de passe ou non. Attention! Pour information, il est arrivé plusieurs fois où, même si la case n était pas cochée, le mot de passe se mémorisait. Dans un tel cas, il est nécessaire de supprimer manuellement le cache contenant les mots de passes du client SVN une fois que le nécessaire est réalisé. Le cache correspond au fichier suivant : C:\Users\[username]\AppData\Roaming\Subversion\auth\svn.simple Plus d informations sont disponibles à l adresse suivante : Page 15 sur 30

16 4.2.2 Récupération du projet La connexion vers le serveur de versions étant paramétré, nous pouvons à présent récupérer une version locale d un projet Eclipse. 1. Ouvrez le menu «File» «New» «Other» puis, sous l entrée «SVN», choisissez «Project from SVN». 2. Dans la liste des serveurs proposés, sélectionnez celui que nous avons créé. Page 16 sur 30

17 3. Sur la fenêtre suivante, utilisez le bouton «Browse» pour sélectionner le projet voulu. Vous devez ouvrir le projet souhaité et sélectionner le répertoire «trunk» s y trouvant. Voici, par exemple, un projet Eclipse sélectionné : 4. Lorsque vous avez validé l assistant, une nouvelle fenêtre vous demande dans quel répertoire local vous souhaitez placer le projet récupéré. Choisissez la 4 e option, ce qui permet de créer un nouveau répertoire local. 5. Faites «Finish». Page 17 sur 30

18 5 Vérification des paramètres du projet Eclipse Lorsque vous avez ajouté le projet «MVC-CD-1» à votre espace de travail Eclipse, vous pouvez parcourir ce chapitre dans le but de vérifier la configuration du projet. En général, ces paramètres devraient automatiquement être récupérés avec le projet en lui-même ; cependant, il peut arriver que ce ne soit pas le cas. a. Ouvrez les propriétés du projet à l aide du menu contextuel. b. Dans «Builders», vérifiez qu il existe une tâche «MVC-CD_Ant_Builder». c. En double-cliquant sur ce «builder», vous devriez avoir une configuration semblable à ceci : Page 18 sur 30

19 d. Sous l onglet «Targets», la configuration doit ressembler à l image ci-après. Elle permet d indiquer à l IDE à quels moments les tâches ANT doivent être exécutées. Pour plus d information sur le script ANT créé, veuillez vous référer au document [RF-1]. Page 19 sur 30

20 6 Mise en place du plug-in VP pour Eclipse Cette partie résume et complémente ce qui est décrit dans le tutoriel de Visual Paradigm s agissant de l intégration avec un IDE [RF-2]. Cette référence ne pas doit nécessairement être lue pour comprendre ou réaliser ce chapitre. 6.1 Fonctionnement général Le développement de notre plug-in se réalise en se basant sur le principe MDE. Concrètement, nous réalisons les spécifications de nos classes de programmation dans des diagrammes de classes UML et nous générons ensuite la structure de ces classes dans des fichiers Java. Pour ce faire, nous utilisons Visual Paradigm qui offre ces possibilités. Il existe trois fonctionnalités permettant de faire cela : Instant Generator : Depuis Visual Paradigm, cette fonctionnalité va générer les classes Java en écrasant celles qui existent déjà. L implémentation des méthodes se fait depuis le référentiel Visual Paradigm, c est-à-dire dans le champ «Code» de l onglet «Operation Code Details» se trouvant dans les propriétés d une opération d une classe UML. Round-Trip Java : Egalement depuis Visual Paradigm, cette fonctionnalité permet de réaliser relativement le même travail que «Instant Generator», à la différence près que la différence avec les classes Java existantes sera prise en compte. Uniquement les différences seront appliquées lors de la génération. Ainsi, l implémentation des méthodes se réalise cette fois à l aide de l IDE après que les fichiers aient été générés ou mis à jour. Update Code : Cette fonctionnalité est possible uniquement si l on installe le plug-in de Visual Paradigm pour Eclipse. Ce plug-in est inclus comme fonctionnalité dans toutes les versions de Visual Paradigm. Il permet de disposer du référentiel de Visual Paradigm directement au sein d Eclipse. La modélisation des diagrammes de classes ainsi que la génération des classes Java se fait dès lors dans le même environnement que celui qui nous permet d écrire le code source de notre plug-in MVC-CD. Nous avons tout d abord utilisé l Instant Generator, puis nous avons migrés vers la troisième option que nous utilisons actuellement. C est elle qui dispose du plus haut niveau d intégration. En outre, Page 20 sur 30

21 elle nous permet également de réaliser un Update Model, ce qui a pour effet de mettre à jour notre référentiel Visual Paradigm en fonction de nos développements faits au sein du code source et ce en gérant l itératif et incrémental. Les chapitres qui suivent décrivent ainsi comment mettre en place ce plug-in dans Eclipse. 6.2 Installation du plug-in L intégration du plug-in Visual Paradigm au sein d Eclipse se fait à partir de Visual Paradigm. Démarrez donc ce dernier en mode administrateur. Lancer l option «IDE Integration» à l aide du menu «Tools». Dans l assistant, cochez «Eclipse Integration». Notez que, sur la capture d écran ci-dessus, «Eclipse Integration» et «NetBeans Integration» sont déjà cochés et grisés. La raison est que, à ce moment-là, le plug-in a déjà été installé au moins une fois dans un de ces environnements. Page 21 sur 30

22 Parcourez votre disque et renseignez le chemin d accès au répertoire racine de votre Eclipse. Une fois l installation terminée, lancez Eclipse en mode administrateur. En faisant un clic-droit sur un projet Eclipse, vous devriez voir apparaître une option «Open VP-UML». En actionnant cette action, l environnement Visual Paradigm se charge en mémoire. Dès lors, le menu «Modeling» déroule un certain nombre de fonctionnalités. Du moment que l environnement Visual Paradigm a été ouvert pour un projet Eclipse, tout le référentiel Visual Paradigm sera stocké dans le répertoire «vpproject», plus précisément dans le fichier «vpp» portant le même nom que le projet Eclipse. Page 22 sur 30

23 6.3 Ajout des vues nécessaires Nous allons ajouter les vues «Diagramm Navigator» et «Model Explorer» pour nous permettre de naviguer au sein du référentiel Visual Paradigm comme nous le faisions habituellement hors d Eclipse. Pour cela, dirigez-vous dans le menu «Window» «Show View» «Other». Sous la nouvelle entrée «Visual Paradigm for UML» qui apparaît, sélectionnez les deux vues qui nous intéressent. Il nous est maintenant possible de naviguer dans notre référentiel. Page 23 sur 30

24 6.4 Versionning du référentiel VP Dans le cadre de la réalisation du plug-in MVC-CD, le référentiel Visual Paradigm intégré au projet Eclipse est lui-même versionné. L outil «Teamwork» permet de réaliser cela. Cet outil apporte ses propres commandes «commit» et «update» qui sont, elles, capables d analyser le contenu d un référentiel Visual Paradigm, autrement dit du fichier «.vpp». Avec cette infrastructure, deux «commit» ou «update» différents sont donc nécessaires lorsque nous souhaitons sauvegarder nos modifications locales ou récupérer les mises à jour du serveur : le premier portant sur les sources Java, et le second sur le référentiel Visual Paradigm. Selon les recommandations de Visual Paradigm, un répertoire SVN a été créé pour chacun d eux. SVN (Code source Java) SVN (Référentiel VP) Commit du projet Eclipse Commit avec Teamwork Projet Eclipse Code source Java Référentiel VP (répertoire vpplugins) Le chapitre décrit comment charger le référentiel VP pour la première fois dans son environnement Eclipse local, alors que le chapitre montre comment exclure le référentiel VP local des sources à sauvegarder lorsque l on réalise un «commit» sur le projet Eclipse. En effet, en regard de la figure ci-dessus, sans cette configuration, le répertoire «vpplugins» serait inclus dans le «commit» réalisé sur le projet Eclipse, ce que nous souhaitons éviter. Seul le code source Java doit l être. Page 24 sur 30

25 6.4.1 Récupération du référentiel VP Nous partons du postulat que, à ce stade, nous disposons déjà du projet Eclipse en local. À l aide du menu contextuel du projet Eclipse «MVC-CD», ouvrez le «Teamwork Client». Dans le menu «Session» «Login», remplissez les informations nécessaires selon l image cidessous. Page 25 sur 30

26 Dans le menu «Project», ouvrez «Manage Project» puis ouvrez le répertoire versionné de façon à faire apparaître le fichier «.vpp». Amenez ce dernier dans la liste de droite et validez. Dès lors, sélectionnez-le dans la liste de gauche et actionnez «Checkout». Si votre explorateur de modèle comporte désormais de nouveaux éléments, alors l importation sur votre environnement local a bien fonctionné. Page 26 sur 30

27 6.4.2 Exclusion du référentiel VP du SVN des sources Il est primordial d exclure le répertoire «vpplugins» du client SVN d Eclipse. Pour ce faire, faites un clic-droit sur le répertoire en question et choisissez «Add to svn:ignore». Si l option est déjà grisée comme sur la capture d écran présentée, c est que le répertoire est probablement déjà ignoré. Pour vous en assurer, modifiez un élément de votre référentiel VP et tentez de réaliser un «commit» sur votre projet Eclipse. Dans la liste des éléments à envoyer, ni ce répertoire ni les éléments qu il contient à l intérieur ne doit apparaître. Page 27 sur 30

28 6.5 Migration d un référentiel VP existant vers Eclipse Ce sous-chapitre décrit la procédure nécessaire que nous avons utilisée pour migrer le référentiel d un projet Visual Paradigm vers le projet Eclipse comprenant lui-même un référentiel Visual Paradigm de par l installation du plug-in. Initialement, nous avions donc 2 référentiels : un provenant d un projet Visual Paradigm utilisé de manière «seul», où l outil «Instant Générator» était utilisé pour créer de manière écrasante les classes Java vers le projet Eclipse, et un autre référentiel Visual Paradigm présent au sein même du projet Eclipse. Ce second comprenait déjà des parties du modèle sur lequel nous nous appuyons pour réaliser nos développements, car les deux solutions ont été utilisées parallèlement durant une période de tests. L objectif est donc de migrer ce premier référentiel en l intégrant à ce second, la difficulté principale résidant dans le fait que l outil «Instant Générator» utilisé au premier abord n a pas exactement le même comportement que la fonction «Update Code» proposé par le plug-in Visual Paradigm pour Eclipse en ce qui concerne la façon de générer le code. Ci-dessous se trouve, point par point, la procédure permettant de réaliser la migration. Le référentiel provenant de Visual Paradigm «seul» sera désigné comme étant le «référentiel VP», alors que l autre sera nommé «référentiel Eclipse», bien que ce soit, fondamentalement, aussi un référentiel Visual Paradigm. Commençons par synchroniser tous les référentiels avec les serveurs de versions de façon à ce que les sources et les modèles soient identiques d une part et d autre. Dans le référentiel VP, il faut maintenant supprimer les paquetages de références vides dont la source se situe dans le référentiel Eclipse, de façon à éviter des conflits de paquetage déjà existants lors de la fusion des deux référentiels. Dans le référentiel VP, nous supprimons les attributs «instance» pour les classes Singleton de même que les relations réflexives pouvant provenir de ces attributs, puis recréons les Singleton en réalisant le lien réflexif et en modifiant la spécification «Owned By» du rôle «instance» de façon à faire apparaître l attribut au sein de la classe. Enfin, nous paramétrons le scope de cet attribut en «Classifier». Voici un exemple de Singleton tel qu il devrait être, sans quoi, la migration provoquerait des effets de bord : Page 28 sur 30

29 Toujours dans le référentiel VP, nous supprimons tous les attributs d un type provenant d une énumération et créons une association unidirectionnelle de la classe vers cette énumération. Enfin, nous donnons un nom au rôle de l énumération pour cette association et modifions la propriété «Owned by» de façon à faire apparaître l attribut dans la classe. Voici un exemple : Nous ouvrons le référentiel Eclipse non pas avec Eclipse mais avec Visual Paradigm. Il se trouve à la racine du projet Eclipse dans le répertoire «vpproject». Le fichier porte le même nom que le projet Eclipse et a pour extension «vpp». Bien entendu, Eclipse doit être fermé pour libérer l accès au fichier. Dans le référentiel Eclipse ouvert avec Visual Paradigm, nous supprimons les stéréotypes présents à la racine et qu on retrouve aussi dans le référentiel VP. Pour ce faire, réalisez un clic droit sur le projet depuis l explorateur de modèles et choisissez «Viewless Model Elements». Dans notre cas, il s agit de supprimer «enumeration» et «Constant». Egalement dans le référentiel Eclipse, nous supprimons tous les paquetages vides et éléments de références qui se trouvent dans le référentiel VP, de façon à éviter les conflits lors de la fusion des deux référentiels. Toujours dans le référentiel Eclipse, nous renommons le paquetage racine «ch» en «ch2». Cela permettra d éviter un conflit de même nom lors de la fusion des deux référentiels. Depuis le référentiel Eclipse ouvert avec Visual Paradigm, nous allons importer le référentiel VP. Pour cela, nous faisons «File» «Import» «VP-UML Project». Nous déplaçons tous les éléments du paquetage «ch2» dans le paquetage importé «ch», puis supprimons «ch2». Vérifions l état des diagrammes. Ceux-ci doivent être corrects. Il s agit notamment de remplacer les liens «use2» par des liens «use». Nous remettons également les stéréotypes «enumeration» et «Constant» qui ont été supprimés des diagrammes provenant du référentiel Eclipse initial. Nous sauvegardons et fermons Visual Paradigm. Le référentiel Eclipse constitue maintenant la fusion des deux référentiels initiaux. À l aide d Eclipse, il s agit maintenant d ouvrir le projet en utilisant la commande «Open VP- UML». Afin de faire le lien entre le nouveau référentiel et les classes Java, il est nécessaire de réaliser une nouvelle génération du code. Un «update modèle» aurait pu fonctionner mais Page 29 sur 30

30 trop d effets de bords seraient à corriger. Pour garantir le même comportement que lors des précédentes générations de code réalisées depuis le référentiel VP, il convient ici d utiliser la l outil «Instant Generator» depuis Eclipse. Attention aux options qui doivent être redéfinies et attention également à ne sélectionner que les paquetages qui proviennent du référentiel VP initial, de façon à ne pas écraser d implémentations de méthodes. Lorsque la génération a été faite, des erreurs peuvent être présentes dans le code source. Il convient alors de les corriger à la main. Il est opportun de réaliser la commande «Update Model» pour re-synchroniser les classes avec le référentiel. Il est alors également utile de vérifier les diagrammes et d apporter des corrections si nécessaire. Par exemple, il sera nécessaire de recréer les liens d agrégation. Dès lors, nous réalisons un «Update Code» du paquetage «ch». Si nécessaire, nous vérifions à nouveau le code source. Réalisez des «commit» des sources puis du référentiel de Visual Paradigm intégré dans Eclipse à l aide de Teamwork. Sur toutes les autres copies locales, réalisez des «update» de ces deux éléments également. 7 Références [RF-1] Amélioration du processus de tests lors du développement, Steve Berberat [RF-2] IDE Integration User s Guide, Visual Paradigm Page 30 sur 30