A propos de la configuration d'un pipeline CI/CD

Commencez par obtenir votre API prête. Vous devez au moins définir ses adresses et télécharger l'échafaudage qu'OMC génère pour vous. L'élément scaffold représente une application minimale que vous pouvez utiliser pour vous assurer que votre processus CI/CD fonctionne correctement avant d'écrire et de tester le code de l'API personnalisée.

Lorsque votre API est prête et que vous pouvez propager les modifications vers le référentiel Git de votre projet Developer Cloud Service, il est temps de configurer le CI/CD du projet.

Configurer l'API dans Oracle Mobile Hub

Créez un échafaudage d'API en définissant les adresses REST auxquelles vos applications se connectent. Une fois que vous avez terminé, vous pouvez télécharger la définition à utiliser comme point de départ pour votre code d'API.

Lorsque vous définissez les méthodes HTTP pour vos adresses, vous pouvez ajouter des exemples de réponse. De façon stricte, les exemples de réponse ne sont pas requis car vous écrivez le code plus tard afin d'obtenir les réponses réelles. Cependant, vous pouvez entrer des exemples de réponses pour tester l'API avant que votre code personnalisé soit prêt.

  1. Connectez-vous à Oracle Mobile Hub et ouvrez le panneau de navigation.
  2. Dans la section Applications du panneau de navigation, cliquez sur API.
  3. Cliquez sur Nouvelle API et, dans le menu qui s'ouvre, cliquez sur API.
    La fenêtre Nouvelle API apparaît.
  4. Dans les champs Nom d'affichage d'API et Nom d'API, saisissez un nom approprié pour l'API.
  5. Dans le champ Brève description, entrez une description appropriée.
  6. Si votre API contient un document RAML, téléchargez-le ici.
  7. Cliquez sur Créer et la page de la nouvelle API s'ouvre.
  8. Ajoutez des ressources HTTP. Si vous avez téléchargé un document RAML, vous pouvez ignorer cette étape.
    1. Cliquez sur Adresses, puis sur Nouvelle ressource pour créer la première adresse et définir ses méthodes HTTP.
    2. Poursuivez la définition des adresses et des méthodes HTTP pour votre API jusqu'à ce que toutes les adresses soient définies.
  9. Cliquez sur Enregistrer.

Configurer le back-end

Créez le back-end que votre API utilisera. Le back-end achemine les demandes de vos applications vers l'API et fournit les services d'authentification.

  1. Dans le panneau de navigation Oracle Mobile Hub, cliquez sur Backends, qui ouvre la page Backends.
  2. Cliquez sur Nouveau back-end et, dans la fenêtre qui apparaît, entrez un nom approprié dans le champ Nom, puis cliquez sur Créer.
    La page de configuration du back-end apparaît. Elle comporte son propre panneau de navigation, qui est ouvert sur la page Paramètres.
  3. Dans le panneau de navigation de la page de configuration, cliquez sur API, puis sur Sélectionner des API pour ouvrir le catalogue d'API.
  4. Dans le catalogue, recherchez la carte correspondant à l'API que vous avez créée et cliquez sur le bouton +. Cela associe cette API à ce back-end.

Informations d'enregistrement sur le back-end et les détails d'instance

Enregistrez les informations dont vous aurez besoin lorsque vous configurez l'outil de développement.

Ces informations sont utilisées dans un fichier nommé toolsConfig.json et sont requises pour l'authentification. Il permet à un script de se connecter à Oracle Mobile Hub et de lui fournir des artefacts de code.

  1. Dans le panneau de navigation Oracle Mobile Hub, cliquez sur Backends, qui ouvre la page Backends.
  2. Sélectionnez votre back-end et cliquez sur Ouvrir.
  3. Dans le panneau de navigation, cliquez sur Paramètres.
  4. Enregistrez les informations suivantes et copiez-les dans un fichier texte ou à un autre endroit où vous pouvez les récupérer facilement ultérieurement :
    • ID de client
    • Clé secrète du client
    • ID de back-end
    • Nom de back-end
    • Version back-end
    • Clé anonyme
  5. Dans le panneau de navigation, cliquez sur Développement pour ouvrir la page principale, puis cliquez sur Détails de l'instance pour ouvrir le panneau Détails de l'instance.
  6. Enregistrez les informations suivantes et conservez les informations de back-end enregistrées à l'étape précédente :
    • ID client de l'application membre de l'équipe
    • Clé secrète du client de l'application membre de l'équipe

Configurer un projet dans Oracle Developer Cloud Service

Créez un projet qui inclut un référentiel Git. Par la suite, vous configurerez le projet pour exécuter un build chaque fois que vous transmettez (commit) le référentiel.

Créer un projet

Créez un projet qui inclut un référentiel Git.

  1. Connectez-vous à la console Oracle Developer Cloud Service, puis cliquez sur Nouveau projet.
  2. Sur la page Détails du projet, entrez le nom du projet et cliquez sur Suivant.
  3. Sur la page Modèle, sélectionnez Référentiel initial et cliquez sur Suivant.
  4. Dans la page Propriétés de projet, acceptez les valeurs par défaut et cliquez sur Terminer pour démarrer le processus de provisionnement.

Une fois que le projet est provisionné, votre écran doit ressembler à l'image suivante :


Page Récapitulatif du projet

Cloner et configurer le référentiel Git

Cloner le référentiel vers le système de développement local.

  1. Connectez-vous à Oracle Developer Cloud Service et accédez à la page de votre projet.
  2. Copiez l'adresse HTTP dans le champ du référentiel pour Git.
  3. Ouvrez une fenêtre de terminal (sur Linux ou Mac) ou le terminal Git Bash (sous Windows), puis créez un répertoire dans un emplacement pratique sur le disque dur. Utilisez un nom pour le répertoire approprié à votre projet.
     mkdir <your-directory-name>
  4. Sélectionnez le répertoire et clonez le référentiel en remplaçant l'adresse de référentiel dans l'exemple par le vôtre.
    cd <your-directory-name>
    git clone <your-repo-url>

    Lorsque vous êtes invité à saisir un mot de passe, utilisez ce dernier pour vous connecter à Oracle Developer Cloud Service.

  5. Remplacez le répertoire créé par le processus de clonage.
    cd <your-directory-name>
  6. Définissez votre nom et votre adresse électronique pour ce projet, et configurez Git pour stocker vos informations d'identification.
    git config user.name "<your-name>"
    git config user.email "<your-email-address>"
    git config credential.helper store

Créer un travail de build

Créez un travail qui sera exécuté chaque fois que vous propagez du code dans le référentiel Git du projet.

  1. Connectez-vous à Oracle Developer Cloud Service et accédez à la page de votre projet.
  2. Dans le panneau de navigation, cliquez sur Créer, puis sur Nouveau travail dans la page qui apparaît.
  3. Entrez un nom et sélectionnez un modèle de logiciel, puis cliquez sur Créer un travail.
  4. Cliquez sur Ajouter le contrôle de source et sélectionnez Git.
  5. Dans la liste déroulante Référentiel, sélectionnez le référentiel Git à utiliser.
  6. Facultatif : si vous êtes le seul développeur qui transmet le code au référentiel, sélectionnez Effectuer automatiquement la construction sur la validation (commit) SCM.

    Si plusieurs personnes travaillent sur le projet et transmettent du code dans le référentiel, ne sélectionnez pas cette option. A la place, vous pouvez configurer un déclencheur d'interrogation SCM, une fois le travail de build terminé.

  7. Cliquez sur Enregistrer.

Configurer le déclencheur d'interrogation SCM

Vous pouvez configurer un sondage qui recherche les modifications apportées au référentiel Git sur une programmation que vous définissez. Si des modifications sont détectées, un build démarre.

Si vous êtes le seul développeur qui transmet le code au référentiel, il est probable qu'une construction immédiate soit appropriée. Toutefois, lorsque plusieurs personnes transmettront du code, vous pouvez configurer un déclencheur d'interrogation qui vérifie régulièrement les modifications apportées au référentiel avant de démarrer un build.

Pour configurer le déclencheur d'interrogation SCM, utilisez le format crontab pour définir une programmation d'interrogation. Si vous ne connaissez pas le format crontab, vous pouvez utiliser l'interface graphique pour créer la programmation.

La programmation par défaut est de 30 minutes, représentées par 0/30 * * * *. Pour définir l'exécution de la programmation sur 30 minutes après chaque heure, utilisez 30 * * * *.

  1. Connectez-vous à la console Oracle Developer Cloud Service et ouvrez votre projet.
  2. Dans le panneau de navigation, cliquez sur Créer, puis sélectionnez le build pour lequel vous souhaitez définir les paramètres.
    La page Paramètres de construction apparaît.
  3. Cliquez sur Configurer.
    La page Configuration de travail apparaît.
  4. Cliquez sur l'icône représentant un engrenageL'icône des paramètres ressemble à une paire d'engrenages., puis sur Déclencheurs pour ouvrir le panneau Configurer les déclencheurs de construction.
  5. Cliquez sur la liste déroulante Ajouter un déclencheur et sélectionnez Déclencheur d'interrogation SCM.
  6. Définissez la programmation et cliquez sur Enregistrer.

Configurer les paramètres de construction

Configurez un paramètre de chaîne et un paramètre de mot de passe pour contenir le nom utilisateur et le mot de passe de votre compte Oracle Mobile Hub.

Suivez les noms de ces paramètres car vous en aurez besoin ultérieurement lorsque vous configurez l'outil de développement.

  1. Connectez-vous à la console Oracle Developer Cloud Service et ouvrez votre projet.
  2. Dans le panneau de navigation, cliquez sur Créer, puis sélectionnez le build pour lequel vous souhaitez définir les paramètres.
    La page Paramètres de construction apparaît.
  3. Cliquez sur Configurer.
    La page Configuration de travail apparaît.
  4. Cliquez sur l'onglet Paramètres de construction.
  5. Cliquez sur la liste déroulante Ajouter un paramètre de construction (Add Build Parameter ) et sélectionnez Paramètre de chaîne (String Parameter).
  6. Saisissez le nom du paramètre de nom utilisateur. Par exemple,devUser.
  7. Dans le champ Valeur par défaut, entrez votre nom d'utilisateur Oracle Mobile Hub. Par exemple, samir.developer@example.com.
  8. Cliquez sur la liste déroulante Ajouter un paramètre de construction et sélectionnez Paramètre de mot de passe.
  9. Entrez le nom du paramètre de mot de passe tel que devPassword.
  10. Dans le champ Valeur par défaut, entrez le mot de passe de votre nom utilisateur Oracle Mobile Hub.
  11. Cliquez sur Enregistrer.

Configurer le générateur de shell Unix

Le générateur de shells est un script Bash exécuté sur le système de construction à chaque lancement d'un build. Il installe les dépendances, puis transmet votre code à Oracle Mobile Hub.

Le script est exécuté par rapport à la source à partir du référentiel Git que vous configurez lorsque vous avez créé le projet dans Oracle Developer Cloud Service. Si le script échoue à tout moment, il se ferme avec une erreur et aucun code n'est déployé.

  1. Connectez-vous à la console Oracle Developer Cloud Service et ouvrez votre projet.
  2. Dans le panneau de navigation, cliquez sur Créer, puis sélectionnez le build pour lequel vous souhaitez définir les paramètres.
    La page Paramètres de construction apparaît.
  3. Cliquez sur Configurer.
    La page Configuration de travail apparaît.
  4. Cliquez sur l'onglet Constructeurs.
  5. Cliquez sur la liste déroulante Ajouter un générateur et sélectionnez Générateur de shell Unix.
  6. Dans le champ Script, entrez le script suivant :
    export NODE_PATH=node-configurations/8.9/node_modules
    npm install
    cd omce-tools
    npm install
    cd node-configurations/8.9
    npm install
    cd ../..
    node omce-deploy ../toolsConfig.json -u $devUser -p $devPassword
  7. Cliquez sur Enregistrer.

Télécharger le Scaffold JavaScript

Une fois que vous avez créé le squelette d'API, le système crée un échafaudage pour le code d'API que vous pouvez télécharger dans un fichier ZIP.

L'élément scaffold contient la structure initiale et les fichiers pour l'implémentation de l'API, que vous utiliserez comme point de départ pour vos personnalisations. Vous devez extraire les fichiers et les placer dans votre répertoire de travail.

  1. Dans Oracle Mobile Hub, ouvrez l'API pour laquelle vous voulez effectuer l'échafaudage.
  2. Dans le panneau de navigation API, cliquez sur Implémentation.
  3. Cliquez sur Scaffold JavaScript pour télécharger le fichier scaffold sur votre ordinateur.
  4. Extrayez le fichier package.json, toolsConfig.json et le fichier.js de votre API vers votre répertoire de travail. Il s'agit du répertoire créé lorsque vous clonez le référentiel Git et qui contient le répertoire.git.

Installer et configurer des outils de développement

Oracle fournit des outils permettant de télécharger vos implémentations d'API personnalisées vers Oracle Mobile Hub à partir de la ligne de commande. Ajoutez les outils à votre référentiel Git pour qu'ils soient disponibles dans votre script de build sur Oracle Developer Cloud Service.

Les outils font partie d'un téléchargement contenant également une API Oracle Mobile Hub que vous pouvez utiliser pour tester et déboguer les implémentations d'API personnalisées sur votre système de développement. L'API n'est pas obligatoire pour l'utilisation du pipeline CI/CD. Reportez-vous au fichier Lisez-moi dans le répertoire omce-tools pour obtenir des instructions sur l'utilisation de l'API, qui est appelée OracleMobileAPI.

Les outils prennent en charge deux versions de Node.js : 6.10.0 et 8.9.x. Dans cette procédure, vous utilisez la version 8.9.4 ou une version supérieure.

Pour installer et configurer l'outil, procédez comme suit :

  1. Accédez à https://www.oracle.com/technetwork/topics/cloud/downloads/amce-downloads-4478270.html et téléchargez les outils de test de code personnalisé version 18.3.1 ou supérieure. Les noms de fichier sur cette page suivent toujours les noms de produit hérités, mais le code qu'ils contiennent est à jour avec la dernière version. De même, pour les noms des outils du téléchargement.
  2. Ouvrez le fichier que vous avez téléchargé et extrayez le contenu du répertoire omce-tools/omce-tools dans votre répertoire de travail, celui qui contient le répertoire.git. Par exemple, si votre répertoire de travail est test-project, extrayez le contenu d'omce-tools/omce-tools vers test-project/omce-tools.
  3. Installer la configuration du noeud : sélectionnez le répertoire omce-tools/node-configurations/8.9 et exécutez npm install.
  4. Installer omce-tools sur votre système : accédez au répertoire omce-tools et exécutez npm install -g.
  5. Créez une variable d'environnement nommée NODE_PATH et définissez-la sur node-configurations/8.9/node_modules.
  6. Assurez-vous que les outils sont correctement installés. Dans le répertoire omce-tools, exécutez node omce-test --version. Le résultat doit être 18.3.1.
  7. Mettez à jour toolsConfig.json. Lorsque vous avez téléchargé l'échafaudage, il inclut le fichier de configuration toolsConfig.json. Utilisez les informations enregistrées à partir du back-end pour remplacer le texte de réserve dans toolsConfig.json.