Procédure de configuration d'un environnement de développement

Ce guide présente la procédure afin de configurer l'environnement de développement de Constellio.

1. Installer Git

Aller sur https://git-scm.com/book/fr/v2/D%C3%A9marrage-rapide-Installation-de-Git et installer Git.

2. Check-out du projet Git (à faire par ligne de commande)

1. Créer un dossier (Exemple : dev-constellio);
2. Dans ce dossier, cloner les projets en utilisant la ligne de commande : 
   1. Ouvrir la console Git et se placer dans le répertoire créé à l'étape 1.
   2. Exécuter la commande « git clone <URL> » pour le projet : https://github.com/doculibre/constellio
3. Copier les fichiers build.gradle.main et settings.gradle.main du dossier « constellio » vers le dossier principal;
4. Renommer le fichier build.gradle.main pour build.gradle et le fichier settings.gradle.main pour settings.gradle. 

3. Installer de Gradle 3.4.1

1. Télécharger l'archive « binary only » de Gradle 3.4.1. (https://gradle.org/releases)
2. Décompresser l'archive zip.

4. Installation de Solr

1. Installer JDK 8 et mettre dans la variable d'environnement JAVA_HOME;
2. Prendre la dernière version 5 en zip. (http://archive.apache.org/dist/lucene/solr/);
3. Décompresser l'archive zip obtenue;
4. Remplacer le contenu de : solr/server/solr par celui dans Git : constellio/solrHome5
5. Changer la valeur des headers : dans solr/server/etc/jetty.xml
   <Set name="requestHeaderSize"><Property name="solr.jetty.request.header.size" default="8192"/></Set>
   PAR :
   <Set name="requestHeaderSize"><Property name="solr.jetty.request.header.size" default="40960"/></Set> (ou ajouter ce paramètre pour <Call name="addConnector"> de la section Set connectors)
6. Dans une console en ligne de commande, se rendre dans le répertoire bin de Solr, et entrer « solr start »;
7. Valider que Solr fonctionne en allant sur  http://localhost:8983/solr/#/records.

5. Installation de IntelliJ IDEA Community

1. Télécharger l'installateur : https://www.jetbrains.com/idea/download/#section=windows
2. Exécuter l'installateur;
3. Modifier le fichier bin/idea.properties, ajouter idea.gradle.prefer.idea_test_runner=true
4. Modifier le fichier idea.exe.vmoptions, modifier -Xmx512, pour -Xmz2048m
5. Démarrer IntelliJ;
6. Sélectionner le thème de l'interface;
7. Dans le choix des plugins de départ, conserver les plugins par défaut, simplement passer à la prochaine étape;
8. Terminer l'installation (Start using IntelliJ IDEA);
9. Dans file>new, sélectionner Project from existing sources
10. Dans la fenêtre de création du projet, sélectionner « Import project ».
11. Sélectionner le répertoire du projet Git constellio
12. Sélectionner « import project from external model », puis « Gradle ».
13. Sélectionner les options d'import
    1. Use auto-import.
    2. Coché l'option « Create separate » module per source set.
    3. Indiquer le répertoire d'installation de Gradle 3.4.1
    4. Gradle JVM doit être un JDK 8
14. Après l'import s'assurer que le VCS est enregistré dans IntelliJ;
    
15. Dans File > Project Structure > Project, indiquer le chemin du répertoire d'installation de votre JDK, et configurer le champ « Project language level » à la version 1.8;
16. Dans File > Settings > Build, Execution, Deployment > Compiler > Java Compiler, configurer le champ « Use compiler » à « Javac », et configurer « Project bytecode version » à la version 1.7;
17. Valider qu'il n'y a aucune erreur de compilation;

Si erreur : 

• de compilation avec import
  org.artofsolving.jodconverter.OfficeDocumentConverter
  • Copier toutes les libs de app vers libs de date
• avec @PluginImplementation
  • Ajouter jspf au classpath (choisir correction proposée par intelliJ)
• de 'java.lang.RuntimeException:constellio/sdk/sdk.properties' does not exist in project 'sdk'
  • Créer le fichier sdk.properties au même endroit que sdk.properties.all et avec le même contenu.

6. Roulement des tests

Le fichier sdk.properties (automatiquement créé lors du premier lancement) permet de configurer quels tests sont lancés.

Premier lancement : 

• Avant de lancer les tests : Aller sur bouton Master en bas à droite > Checkout Tag or Revision, puis entrer le nom du dernier tag (pour obtenir le dernier tag, aller sur github > tags puis chercher le tag le plus récent, Exemple : 7.7.2)
• Sélectionner constellio > sdk > Run Test in 'sdk'

Si l'erreur suivante apparaît : Command line is too long. Shorten command line for All in sdk_test or also for JUnit default configuration.

• Cliquer sur default > Shorten command line et sélectionner « JAR manifest » puis rouler les tests de nouveau

7. Construire le war

1. Créer un fichier avec le nom « version » dans le dossier Constellio;
2. Écrire dans le corps du fichier la version de Constellio (Exemple : 7.7.3);
3. Aller à View > Tool Windows > Gradle
4. Dans Gradle, aller à constellio > Tasks > build et cliquer sur build.

L'opération peut durer longtemps, mais le fichier .war se crée quelques minutes après le lancement de build.

Après sa création, le fichier .war se trouve dans le chemin constellio > build > libs

L'opération peut être suspendue une fois le fichier créé.