Création d'un projet Adélia build
La création s'effectue en plusieurs étapes décrites ci-après :
Sur la machine où est installé Adélia, créez un répertoire qui contiendra le projet,
Copiez les fichiers du répertoire %ADELIWS%\Build\adelia project template dans le répertoire nouvellement créé,
Dans une fenêtre de commande DOS exécutée en tant qu'administrateur, placez-vous dans le répertoire du projet.
Créez le projet via la commande gradlew.bat -PadelAppName=XXX adelAppCreate en remplaçant XXX par le nom de l'application à builder (valeur alphanumérique de 30 caractères maximum et sans espaces) :
En cas de succès, un répertoire du nom de l'application à builder est créé ainsi que les fichiers Gradle build.gradle , gradle.properties et adelAppSettings.gradle.
Ce répertoire est initialement vide et sera enrichi lors de la phase d'initialisation du projet :
Configuration d'un projet Adélia build
Après avoir créé un projet, il est nécessaire de le configurer avant de pouvoir l'exécuter.
La configuration et l'initialisation d'un projet de build se basent sur les paramètres renseignés dans le fichier gradle.properties, à savoir :
Paramètres généraux
adelAppName (obligatoire)
Chaîne alphanumérique (30 caractères maximum et sans espaces) représentant le nom de l'application à builder.
Une valeur initiale est pré-renseignée lors de la phase de création du projet.
adelEnvName (obligatoire)
Chaîne alphanumérique représentant le nom de l'environnement Adélia contenant l'application à builder.
adelLstAppArea (obligatoire)
Liste des noms des domaines Adélia contenant les composants applicatifs.
Les noms doivent être saisis sur une seule ligne et séparés par au moins un caractère espace.
adelWinClientEntryPoints (optionnel)
Liste des noms de fichier objet (noms des fichiers .EXE) des programmes VAdélia batch et intéractifs générés en Windows constituant les artéfacts de type WinClient.
Les noms doivent être saisis sur une seule ligne et séparés par au moins un caractère espace.
Si ce paramètre n'est pas renseigné, tous les fichiers .EXE générés seront présents dans les artéfacts WinClient.
adelCreateSourceFilesArtifacts (optionnel)
Permet de construire, en plus des artéfacts contenant les binaires de l'application, des artéfacts contenant les sources L3G de l'application. La valeur Y autorise la création de tels artéfacts ; tandis que la valeur par défaut N fixée à ce paramètre exclut cette création. Le contenu d'un artéfact de sources L3G dépend du type de plateforme de génération :
- Windows : L'artéfact contient les fichiers sources générés ayant les extensions .c et .h. Le fichier conteneur de cet artéfact est au format ZIP,
- Java (Standard et Cloud) : L'artéfact contient les fichiers sources générés ayant l'extension .java. Le fichier conteneur de cet artéfact est au format JAR.
Le tableau 4 décrit en détail le nom de chaque artéfact de sources produit.
Version (obligatoire)
Chaîne alphanumérique représentant le numéro de version de l'application.
Chaque artéfact construit aura le même numéro de version. On distingue plusieurs types de version :
Les versions release (ou finales) représentant les versions officielles de l'application (ex : 1.0.0),
Les versions snapshot (ou instantanées) représentant les versions en cours de développement de l'application (ex : 1.0.1-SNAPSHOT),
Les versions pré-release (ou release-candidate) représentant les versions candidates à être les versions finales (ex : 1.0.1-RC01).
Group (obligatoire)
Chaîne alphanumérique représentant l'identifiant du groupe ou de l'organisation à l'origine du projet.
La valeur suit les mêmes règles de nommage que les packages Java (ex : com.hardis), et on choisit généralement comme valeur le nom du top package du projet. ↑ Haut de page
Paramètres de génération Adélia
Le processus de build s'appuie sur la génération Adélia pour la production des artéfacts.
Les chemins de génération d'objets définis dans les paramètres d'environnement Adélia sont modifiés pour créer ces objets dans le répertoire du projet Adélia build.
adelGenErrMsg (optionnel)
Configuration de la génération des messages d'erreurs Adélia.
Il est possible de distinguer la génération des messages suivant leur appartenance à un environnement ou un domaine Adélia.
De plus, pour chaque niveau d'appartenance, il est possible de spécifier la liste des types de génération parmi :
ADELIA400,
VADELIA_WINDOWS,
VADELIA_JAVA,
VADELIA_CLOUD,
ADELIA_WEB,
WINDOWS_SERVER,
JAVA_SERVER,
AS400_SERVER
La syntaxe de la configuration est la suivante : niveau d'appartenance (*REPOSITORY pour environnement ou nom du domaine Adélia), suivi par la liste des types de génération entre crochets.
Exemple 1 : adelGenErrMsg=*REPOSITORY[ADELIA400 VADELIA_WINDOWS]
Configure une génération des messages de l'environnement pour les types Adélia 400 et Visual Adélia Windows.
Exemple 2 : adelGenErrMsg=*REPOSITORY[VADELIA_CLOUD] APP_AREA_1[VADELIA_CLOUD] APP_AREA_2[VADELIA_CLOUD]
Configure une génération des messages de l'environnement et des domaines APP_AREA_1 et APP_AREA_2 pour le type Visual Adélia Cloud.
adelGenDebugMode (optionnel)
Définit le type de génération debug ou release des objets générés.
La valeur Y force la génération en mode debug.
La valeur N force la génération en mode release. Si ce paramètre n'est pas renseigné, alors le mode de génération est déduit des attributs de l'environnement Adélia (onglet Génération L3G).
De plus, la génération debug produit pour chaque programme Adélia un fichier XML nécessaire au débogage du code L4G. Ces fichiers sont regroupés dans un artéfact de debug. Le fichier conteneur de cet artéfact est au format ZIP. Le tableau 5 décrit en détail le nom de chaque artéfact de debug produit.
adelGenIncremental (obligatoire)
Définit la stratégie de génération des objets Adélia lors de l'exécution du build. Il existe deux modes possibles :
Mode global : activé avec la valeur N.
A chaque exécution d'un build, l'ensemble des objets Adélia appartenant aux domaines spécifiés sont générés.
La génération est forcée même si un objet n'a pas été modifié entre deux exécutions successives d'un build.Mode incrémental : activé avec la valeur Y.
A chaque exécution d'un build, seuls les objets modifiés (entre le build précédent et le build en cours) sont régénérés.
Si ce mode est activé lors du premier build d'une application alors tous les objets Adélia sont générés (le mode global est appliqué).
Il est préférable d'utiliser le mode incrémental seulement dans le cas de construction d'artéfacts en version snapshot (en cours de développement), car ce mode réduit le temps d'exécution du build.
adelGenNbThreads (optionnel)
Valeur numérique définissant le nombre de travaux de génération d'objets Adélia pouvant s'exécuter en concurrence.
Si ce paramètre n'est pas renseigné, il est calculé à l'exécution du build en fonction de la puissance du processeur du poste (égal à la variable système Windows NUMBER_OF_PROCESSORS).
adelGenLogDir (optionnel)
Chaîne alphanumérique (250 caractères maximum) définissant le chemin où les rapports de chaque génération en erreur sont conservés. Dans ce cas, le rapport global de build ne contient plus les rapports de génération en erreur mais fait référence aux fichiers générés dans le répertoire indiqué dans adelGenLogDir.
Ce chemin peut être absolu ou relatif au répertoire où se trouve le fichier gradle.properties.
Si ce paramètre n'est pas renseigné, le rapport global de build contient les rapports de génération en erreur.
Paramètres de génération AS400
Le processus de build utilise un certain nombre de paramètres propres lors de la génération Adélia d'objets AS400.
Ces paramètres sont optionnels et ne sont à renseigner que dans le cadre d'une génération AS400.
adelGenAS400.as400Server.genLib
Liste des noms des bibliothèques AS400 servant de stockage des objets binaires issus de la génération AS400 des programmes SAdélia et des parties serveur des programmes Visual Adélia.
Il est possible de distinguer les bibliothèques pour les objets Adélia de visibilité publique (de niveau référentiel) et de visibilité privée (de niveau domaine).
La syntaxe de la configuration est la suivante : niveau de visibilité (*REPOSITORY pour une visibilité publique ou nom du domaine Adélia pour une visibilité privée), suivi par le nom de la bibliothèque AS400.
Exemple 1 : adelGenAS400.as400Sever.genLib=*REPOSITORY LIB_PUBLIC
Définit la bibliothèque LIB_PUBLIC comme stockage des objets de visibilité publique (niveau environnement).
Exemple 2 : adelGenAS400.as400Sever.genLib=*REPOSITORY LIB_PUBLIC, APP_AREA_1 LIBRARY_1, APP_AREA_2 LIBRARY_2
Définit la bibliothèque LIB_PUBLIC comme stockage des objets de visibilité publique (niveau environnement), LIBRARY_1 comme stockage des objets de visibilité privée appartenant au domaine APP_AREA_1 et LIBRARY_2 comme stockage des objets de visibilité privée appartenant au domaine APP_AREA_2.
adelGenAS400.as400Adelia.genLib
Liste des noms des bibliothèques AS400 servant de stockage des objets binaires issus de la génération AS400 des programmes Adélia Interactif et Batch appartenant à un même domaine.
Il est possible de distinguer les bibliothèques pour les objets Adélia de visibilité publique (de niveau référentiel) et de visibilité privée (de niveau domaine).
La syntaxe de la configuration est la suivante : niveau de visibilité (*REPOSITORY pour une visibilité publique ou nom du domaine Adélia pour une visibilité privée), suivi par le nom de la bibliothèque AS400.
Exemple 1 : adelGenAS400.as400Adelia.genLib=*REPOSITORY LIB_PUBLIC
Définit la bibliothèque LIB_PUBLIC comme stockage des objets de visibilité publique (niveau environnement).
Exemple 2 : adelGenAS400.as400Adelia.genLib=*REPOSITORY LIB_PUBLIC, APP_AREA_1 LIBRARY_1, APP_AREA_2 LIBRARY_2.
Définit la bibliothèque LIB_PUBLIC comme stockage des objets de visibilité publique (niveau environnement), LIBRARY_1 comme stockage des objets de visibilité privée appartenant au domaine APP_AREA_1 et LIBRARY_2 comme stockage des objets de visibilité privée appartenant au domaine APP_AREA_2.
adelGenAS400.as400Server.versionOSSAVF
Chaîne alphanumérique indiquant la version d'OS400 des fichiers SAVF produits lors de la création des artéfacts de type As400Server.
Valeurs possibles :
*CURRENT : indique la version de l'OS400 de la machine qui crée le fichier SAVF,
*PRV : indique la version précédente de la version de l'OS400 de la machine qui crée le fichier SAVF,
VxRxMx : indique une version ou Vx est le numéro de version, Rx le numéro de release et Mx le niveau de modification (ex : V5R3M0).
Si aucune valeur n'est spécifiée alors la version est fixée par la commande CRTSAVF qui crée le fichier SAVF.
adelGenAS400.as400Adelia.versionOSSAVF
Chaîne alphanumérique indiquant la version d'OS400 des fichiers SAVF produits lors de la création des artéfacts de type As400Adelia.
Valeurs possibles :
*CURRENT : indique la version de l'OS400 de la machine qui crée le fichier SAVF,
*PRV : indique la version précédente de la version de l'OS400 de la machine qui crée le fichier SAVF,
VxRxMx : indique une version ou Vx est le numéro de version, Rx le numéro de release et Mx le niveau de modification (ex : V5R3M0).
Si aucune valeur n'est spécifiée alors la version est fixée par la commande CRTSAVF qui crée le fichier SAVF.
adelGenAS400.language
Configuration du support de la génération multilangue AS400.
Ce paramètre permet de définir pour chaque langue Adélia supportée la bibliothèque servant au stockage des messages d'erreur et des constantes Adélia traduites.
Il est possible de distinguer les bibliothèques pour les messages d'erreur de visibilité publique (de niveau référentiel) et de visibilité privée (de niveau domaine).
La syntaxe de la configuration est la suivante : nom de langue Adélia suivi du couple niveau de visibilité (*REPOSITORY pour une visibilité publique ou nom du domaine Adélia pour une visibilité privée) / nom de la bibliothèque AS400 entre crochets.
Exemple 1 : adelGenAS400.language=ENGLISH[*REPOSITORY LIB_EN_REP, APP_AREA_1 LIB_EN_1]
Définit pour la langue anglaise la bibliothèque LIB_EN_REP comme stockage des objets de visibilité publique (niveau environnement) et la bibliothèque LIB_EN_1 comme stockage des objets de visibilité privée associés au domaine APP_AREA_1.
Exemple 2 : adelGenAS400.language=ITALIAN[*REPOSITORY LIB_IT_REP, APP_AREA_1 LIB_IT_1], GERMAN[*REPOSITORY LIB_DE_REP, APP_AREA_2 LIB_DE_2]
Définit les bibliothèques pour les langues Adélia suivantes : Italien et Allemand. ↑ Haut de page
Paramètres Gradle
Il est possible de paramétrer l'exécution du build Gradle.
org.gradle.java.home (optionnel)
Définit le chemin du JDK Java utilisé pour exécuter le build Gradle.
Si le JDK 8 installé sur le poste est référencé via la variable d'environnement JAVA_HOME, il n'est pas nécessaire de renseigner ce paramètre.
org.gradle.jvmargs (optionnel)
Définit les options de lancement de la JVM exécutant le build Gradle.
Pour plus de détails, voir https://docs.gradle.org/current/userguide/build_environment.html et https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html.
org.gradle.daemon (obligatoire)
Force le lancement de l'exécution d'un build gradle au travers d'un processus démon (voir https://docs.gradle.org/current/userguide/gradle_daemon.html).
L'utilisation d'un démon permet de diminuer le temps de lancement d'un build Gradle.
Comme le build de composants Adelia nécessite des droits Administrateur, pour fixer ce paramètre à "true", il est nécessaire de s'assurer que les démons Gradle démarrés le sont avec ces droits.
javaCompile.compileOptions.forkOptions.memoryInitialSize (optionnel)
Définit la taille initiale de mémoire utilisée au démarrage du processus de compilation de fichier source Java.
javaCompile.compileOptions.forkOptions.memoryMaximumSize (optionnel)
Définit la taille maximale de mémoire utilisée au cours de l'exécution du processus de compilation de fichier source Java. ↑ Haut de page
Paramètres des gestionnaires de référentiels
L'utilisation des référentiels d'artéfacts lors de l'exécution d'un build Adélia se fait lors des phases suivantes :
Dans la phase de compilation des sources / transformation des ressources, le build utilise un référentiel pour télécharger (référentiel de download) les artéfacts système nécessaires à la construction des artéfacts de l'application,
Dans la phase finale de stockage des artéfacts construits, il est possible de définir un référentiel pour transférer (référentiel d'upload) ces artéfacts versionnés. En fonction du type de version (release ou snapshot), il est possible de définir le référentiel associé.
downloadArtifactsRepo (obligatoire)
URL d'accès au référentiel de download des artéfacts dépendants nécessaires au build.
Par défaut, le référentiel est fourni par Hardis. Nous recommandons fortement de définir à la place votre propre référentiel privé et de configurer celui-ci comme proxy au référentiel Hardis.
Cette URL est celle du champ "Repository path" associé au référentiel de download listé dans la vue "Repositories" du Nexus (voir les prérequis d'architecture d'intégration continue).
downloadArtifactsRepo.username / downloadArtifactsRepo.password (optionnels)
Définit le profil utilisateur et le mot de passe utilisés pour la connexion au référentiel de download.
Par défaut, ces identifiants sont ceux du référentiel de download Hardis mais nous vous recommandons fortement de les remplacer par ceux de votre propre référentiel privé (cf. downloadArtifactsRepo ci-dessus).
Comme ce référentiel est accédé en lecture seule, Nexus autorise une connexion anonyme. Dans ce cas, donc, laissez les champs "username" et "password" non renseignés.
uploadArchivesReleaseRepo (optionnel)
URL d'accès au référentiel d'upload utilisé pour le stockage des artéfacts construits avec une version release.
Ce référentiel permettra de mettre à disposition les artéfacts en version finale (voir les prérequis d'architecture d'intégration continue).
uploadArchivesReleaseRepo.username / uploadArchivesReleaseRepo.password (optionnels)
Définit le profil utilisateur et le mot de passe utilisés pour la connexion au référentiel d'upload des artéfacts en version release.
uploadArchivesSnapshotRepo (optionnel)
URL d'accès au référentiel d'upload utilisé pour le stockage des artéfacts construits avec une version snapshot.
Ce référentiel permettra de mettre à disposition les artéfacts en cours de développement (voir les prérequis d'architecture d'intégration continue).
uploadArchivesSnapshotRepo.username / uploadArchivesSnapshotRepo.password (optionnels)
Définit le profil utilisateur et le mot de passe utilisés pour la connexion au référentiel d'upload des artéfacts en version snapshot.