Formation Arvida›Digital.ai Release›Cas d'usage Nexapay›Module 206

Sommaire
ARVIDA OFFRE DE SERVICE Digital.ai Release · OFR0004-206

M206 (Spécifique ACOSS) : Automatiser et dynamiser vos releases

Une release qui agit dans les autres outils et se complète elle-même

Créer le ticket Redmine, merger vers la production, et générer une release par composant avec un court script.

Durée 1 h 30Exercice 45 minJour 2

Ce que vous allez faire

Votre release s'arrête encore deux fois pour que quelqu'un agisse dans un autre outil. Vous lui faites créer le ticket Redmine et merger vers la production elle-même. Puis vous écrivez un court script qui génère des tâches à la volée : une release par composant à déployer.

Votre point de départ

Vous reprenez la release laissée au gate à la fin du module 303, et votre template Deploy guestbook, ou Deploy guestbook (301 done). Le template Deploy composant est déjà dans votre folder : il simule le déploiement d'un composant. La variable de folder folder.redmineUrl porte l'adresse du Redmine de formation.

Appeler un outil : la tâche Webhook

La tâche Webhook, JSON webhook envoie une requête à une API et lit sa réponse. Elle suffit pour la plupart des intégrations, sans écrire de script.

ChampCe qu'on y met
URLL'adresse de l'API, avec des variables
MethodGET pour lire, POST pour créer
BodyLe contenu envoyé, en JSON, avec des variables
Username, PasswordLe compte technique et son jeton, en variable de type Password
JSON path expressionLe chemin de la valeur à extraire de la réponse
ResultLa variable qui reçoit cette valeur

La règle à retenir

Une tâche produit une valeur, la suivante la consomme : le ticket créé par la première tâche se retrouve dans le titre des releases générées, la pull request trouvée par une tâche est mergée par la suivante. C'est la variable qui fait le lien.

Jython en cinq minutes

Quand aucune tâche prête à l'emploi ne convient, une tâche Script, Jython Script exécute quelques lignes au milieu de la release. Vous en utilisez déjà : Définir l'environnement dev est un script d'une ligne, et la condition de l'attente du module 301 en est un autre.

  • C'est du Python 2.7, exécuté dans le serveur Release.
  • Le script voit la release par des objets que Release lui fournit.
  • Ce qu'il affiche avec print apparaît dans le commentaire de la tâche. Une erreur fait échouer la tâche, avec le numéro de ligne.
  • Il tourne avec le compte technique du module 202 et n'a que ses droits. Les appels réseau directs depuis un script sont bloqués sur la plateforme : pour appeler un outil, on passe par une tâche Webhook.
ObjetCe qu'il donneExemple
releaseVariablesLes variables de la release, en lecture et en écriturereleaseVariables['composants']
folderVariables, globalVariablesLes variables de folder et globales, en lecturefolderVariables['folder.repoUrl']
getCurrentRelease(), getCurrentPhase()La release et la phase en coursgetCurrentPhase().tasks
taskApi, phaseApi, releaseApiAjouter ou modifier une tâche, une phase, la releasetaskApi.addTask(...)
templateApiRetrouver un templatetemplateApi.getTemplates('titre')

Pour d'autres exemples à adapter, la communauté tient une bibliothèque de scripts : xlr-jython-code-snippets. Vous y trouverez comment renommer une release, ajouter des tags, créer des tâches depuis une liste, planifier une tâche ou produire un tableau d'état.

Exercice 8.1 · La release qui agit, et qui se complète elle-même

45 minutes, chacun sur sa plateforme, en trois temps de 15 minutes.

Premier temps : créer le ticket Redmine.

  1. Ajouter la tâche. En tête de la phase dev de votre template, ajoutez une tâche Webhook, JSON webhook nommée Créer le ticket Redmine :
    ChampValeur
    URL${folder.redmineUrl}/issues.json
    MethodPOST
    Body{"issue":{"subject":"Livraison ${application}","description":"${release.title}"}}
    JSON path expressionissue.id
    Result${ticketRedmine} : acceptez la création de la variable
  2. Rendre le ticket visible. Dans la description du gate Go / No Go, ajoutez Ticket Redmine : ${ticketRedmine}.

Deuxième temps : merger vers la production.

  1. Créer la variable du jeton. Menu Variables du template : variable giteaToken, type Password, Required et Show on Create Release form décochés. Sa valeur est le jeton du compte de service, donné par le formateur. Si elle existe déjà dans votre template, passez à l'étape suivante.
  2. Trouver la pull request. Dans la phase prod, après le gate, remplacez Merger int vers main par une tâche JSON webhook nommée Trouver la PR int vers main :
    ChampValeur
    URLhttps://gitea.tulipe.arvida.tech/api/v1/repos/${folder.argoProject}/guestbook/pulls/main/int
    MethodGET
    Usernamesvc-xlr-${folder.argoProject}
    Password${giteaToken}
    JSON path expressionnumber
    Result${prNumber}
  3. La merger. Juste après, une seconde tâche JSON webhook nommée Merger la PR int vers main, même compte et même mot de passe :
    ChampValeur
    URLhttps://gitea.tulipe.arvida.tech/api/v1/repos/${folder.argoProject}/guestbook/pulls/${prNumber}/merge
    MethodPOST
    Body{"Do":"merge","delete_branch_after_merge":false}

Troisième temps : générer une release par composant.

  1. Créer la liste. Menu Variables du template : variable composants, type List, valeurs frontend, api, base, demandée au démarrage.
  2. Écrire le script. À la fin de la phase int, ajoutez une tâche Script, Jython Script nommée Générer les déploiements des composants. Recopiez le script ci-dessous et complétez les deux lignes marquées :
    phase = getCurrentPhase()
    modeles = templateApi.getTemplates('Deploy composant')
    if not modeles:
        raise Exception('Template Deploy composant introuvable')
    
    for composant in releaseVariables['composants']:
        tache = taskApi.newTask('xlrelease.CreateReleaseTask')
        tache.title = ...   # le titre de la tache, avec le nom du composant
        tache.newReleaseTitle = '%s - ticket %s' % (composant, releaseVariables['ticketRedmine'])
        tache.templateId = modeles[0].id
        tache.folderId = modeles[0].id.rsplit('/', 1)[0]
        ...   # la release creee doit demarrer toute seule
        taskApi.addTask(phase.id, tache)
        print('Tache ajoutee pour %s' % composant)
  3. Essayer. Dans Gitea, ouvrez une pull request de int vers main : la release la cherchera. Démarrez ensuite une release depuis votre template avec New release, terminez l'attente du merge vers int avec Complete, cochez le gate et laissez faire.

Le script complet, pour vous corriger :

phase = getCurrentPhase()
modeles = templateApi.getTemplates('Deploy composant')
if not modeles:
    raise Exception('Template Deploy composant introuvable')

for composant in releaseVariables['composants']:
    tache = taskApi.newTask('xlrelease.CreateReleaseTask')
    tache.title = 'Deployer %s' % composant
    tache.newReleaseTitle = '%s - ticket %s' % (composant, releaseVariables['ticketRedmine'])
    tache.templateId = modeles[0].id
    tache.folderId = modeles[0].id.rsplit('/', 1)[0]
    tache.startRelease = True
    taskApi.addTask(phase.id, tache)
    print('Tache ajoutee pour %s' % composant)

Ce que vous devez observer

À la fin de la phase int, trois tâches Deployer frontend, Deployer api et Deployer base apparaissent, qui n'existent pas dans le template. Chacune crée et démarre une release Deploy composant dont le titre porte le numéro du ticket. Après le gate, la pull request est mergée par le compte de service et guestbook arrive en production.

Preuve attendue : le numéro du ticket Redmine dans la description du gate, les trois releases de composants dans la liste des releases, et la pull request mergée par svc-xlr dans Gitea.

  • Le ticket est créé par la release et son numéro est gardé dans une variable.
  • Le merge vers main est faite par la release, avec le compte de service.
  • Le script génère une tâche Create Release par composant de la liste.
  • Changer la liste au démarrage change le nombre de releases générées.

Bonus · Un quatrième composant

Facultatif, 5 minutes.

  1. Démarrez une release en ajoutant cache à la liste composants dans le formulaire de démarrage.
  2. Vérifiez qu'une quatrième tâche apparaît, sans avoir touché au template ni au script.

Support d'exercices de l'offre de service Digital.ai Release - Administration (ACOSS) (OFR0004). Le cas Nexapay est fictif et l'outil Redmine est simulé pour la formation. Une erreur, une suggestion ? Écris à William Gravier, wgravier@arvida.fr.

🔒 Propriété d'ARVIDA SAS · Support réservé aux participants de la formation OFR0004, toute reproduction ou diffusion interdite.