Intégration Continue (CI) > GitHub + AppVeyor + SonarQube (cloud) + BadgeIt

Intégration Continue (CI) > GitHub + AppVeyor + SonarQube (cloud) + BadgeIt

2018-09-24 0 By Nordes

Voici un premier article sur de l’intégration continue. Pour ceci, nous allons utiliser tous les outils “gratuit” disponible sur le web. Dans le futur, nous allons sans doute aussi traiter de GitLab. GitLab comprend déjà 2 des points mentionné dans le titre. C’est-à-dire la gestion du code source, le “build” ainsi que le déploiement.

Pour le moment, concentrons nous sur le scénario suivant:

  • GitHub : Gestion de code source
  • AppVeyor : Build automatisé tout particulièrement pour les application .Net, sinon comme alternative, vous pouvez utiliser Travis. Travis est plutôt bien, mais j’ai eu quelques problème par le passé concernant les applications .Net. Peut-être que c’est revenu à la normal depuis le temps.
  • SonarQube (Cloud) : Ici on prend la version cloud, cependant, vous pouvez l’installer sur un serveur local tout dépendant de votre usage.
  • BadgeIt : Projet créé par HoNoSoFt qui à pour but d’utiliser l’API de SonarQube ainsi que Shields.io afin de générer vos badges.
  • #Slack (Optionel) : Envoie des notifications avec Webhook lors de fin de build et d’analyse.

GitHub – Création de votre repo.

Si vous n’avez pas déjà un compte Github, shame on you :). Enfin, je dis ça, mais c’est plutôt pour vous aider à faire les étapes suivantes où vous n’aurez qu’un login ;). Du coup créez votre compte et continuez les étapes.

  1. Une fois connecté, allez sur votre image en haut et cliquez sur “Your repositories”
  2. De là simplement cliquer sur “New” après avoir bien entendu remplis le champ contenant le nom de votre projet.
    • Alternativement, dans le cas où vous êtes très paresseux, simplement dupliquer un projet existant que vous voulez faire le build et ajouter peut-être quelques fonctionnalités, pourquoi pas.
  3. Si vous avez créer votre nouveau repository, veuillez suivres les étapes afin d’ajouter votre code déjà existant. Ce sera d’ailleurs indiqué par défaut sur la page de tout votre nouveau projet.

Une fois complété, ça ressemblera à ce qui suit:

#Slack – Configuration de notification

Dans cet article, nous utiliserons Slack. Cependant, dans la vrai vie, n’importe quel system comportant un Webhook peut être utilisé. Étant donné que Slack est déjà prêt à être utilisé par toutes les applications de cet article, utilisons le. Si vous désirez, vous pouvez choisir un autre outil.

  1. Aller sur le site de #Slack
  2. Créer votre espace, ou bien utiliser un déjà existant
  3. Connectez vous à votre espace (web ou par l’application windows)
  4. Créez vous un channel qui s’appelle par exemple #ContinuousIntegration et invitez vos amis ;). Très utile si vous travaillez à plusieurs sur un projet.
  5. Sur le menu à gauche, vous trouverez une options appelé “Apps”. Appuyez sur ce bouton
  6. Dans la recherche, veuillez indiquer “Webhook” et sélectionnez “Incoming Webhook“
  7. Ajoutez le Webhook et changez la configuration à bon vous semble, cependant veuillez prendre en note le “Webhook URL“. Cet URL est utilisé afin de poussez vos notifications sur votre channel #Slack.

AppVeyor – Création de votre premier build, ou peut-être pas

Peut-être que vous avez déjà quelques build sur cette plateforme. Si c’est le cas, veuillez sauter dans la prochaine section, ou tout simplement lire en diagonale.

Ici on prendra pour acquis que vous allez builder une application .Net Core 2.1. Si vous avez un autre type d’application à bâtir, veuillez changer les choix afin de mieux vous accommoder.

  1. Accéder le site d’AppVeyor
  2. Vous connecter en utilisant votre compte GitHub
  3. Ajouter un projet existant (le bouton est plutôt évident et si vous n’avez pas trouvé, contactez moi je modifierai l’article).
  4. Avant de lancer votre build, vous devez impérativement configurer ce dernier.
    • Si vous n’êtes pas déjà sur votre projet, veuillez y accéder
    • Choisir le menu “Settings” > Onglet “General” sur la gauche (défaut)
      • Validez que le nom de votre projet est bien le bon ainsi que les options suivantes
    • Choisir le menu “Settings” > “Build”
      • Modifiez la configuration à “Release” si votre build est pour les mises en productions
      • Modifiez le “Before build script” et choisissez “CMD”
        • Insérrer “dotnet restore” (Sinon, votre restauration Nuget ne fonctionnera pas).
      • Appuyez sur “Save“
    • Choisir le menu “Settings” > “Environment”
      • Choisir Visual Studio 2017 au lieu du choix par défaut Visual Studio 2015
      • Appuyez sur “Save”
    • Choisir le menu “Settings” > “Notifications”
      • Choisir comme nouvelle notification “Slack“.
        • Insérez votre “Webhook URL” récupéré dans l’étape précédente (#Slack).
        • Choisir les événements désiré (Succès, …)
      • Appuyez sur “Save“
  5. Revenir sur le menu “Latest build”
    1. Lancer le “Build” en appuyant sur “New Build“
    2. Si le résultat est bon ou mauvais, vous devriez recevoir votre notification sur #Slack

Résultat une fois le build complété avec succès (notez le vert sur la gauche)

Résultat sur #Slack

SonarQube (Cloud) – Intégration pour valider votre qualité de code

Pour cette partie, je vais intégrer une partie de l’article AppVeyor+SonarQube disponible sur le site officiel de AppVeyor. Notez que SonarQube Cloud est gratuit pour les projet qui sont “publique” sur “GitHub”.

Important: Avec SonarCloud sous la version gratuite, les résultats seront publique et tout le monde pourra y accéder. Dans la plupart des scénario d’entreprise, ce ne sera pas le cas et vous aurez des soucis pour afficher les badges. Par soucis de sécurité, la prochaine section sera pour vous. Les badges pouvant être généré par votre propre système ou du moins sur votre réseau privé (subnet privé sur azure par exemple). Vous comprenez sans doutes où je veux en venir ;).

  1. Accéder au site de SonarQube Cloud
  2. Connectez-vous avec votre compte Github (pour la simplicité de la chose)
  3. Une fois connecté, veuillez aller sur votre profil (icône en haut à droite) et choisir “My account“
  4. Choisissez le menu “Security” afin de créer un nouveau Token qui sera ensuite utilisé par l’application BadgeIt.
    • Donnez un nom à votre token, e.g. “BadgeIt“
    • Appuyez sur “Generate“
    • Copiez et collez votre Token dans un fichier local sécuritaire ou un endroit afin de ne pas perdre cette information. Elle ne sera accessible qu’une fois, sinon vous devrez régénérer un nouveau Token.
  5. Créer un nouveau projet
  6. À ce moment, vous avez 2 choix, utiliser une nouvelle clé pour pouvoir pousser les résultats ou bien utiliser une clé existante. Je vous conseille ici de créer une clé seulement pour AppVeyor. Du coup, votre clé sera seulement pour cette application et la clé précédemment créé sera utilisé par la section qui suivre (BadgeIt).
    • Notez le nouveau Token
  7. Retour vers AppVeyor pour terminer la configuration du build.

Re-AppVeyor

Retour vers AppVeyor, allons re-configurer les événements de build ainsi que d’ajouter des variables d’environnement.

  1. Retour sur votre Project -> Settings -> Environment
  2. Ajoutez les 3 variables suivantes. Elles seront utilisé pour un script powershell. Ça évitera d’afficher publiquement certaines informations privées.
    • sonar_project_key: Déterminé lors de la création du projet dans SonarCloud. Cette clé doit normalement être unique.
    • solution: Nom de votre solution (peut contenir un “path” et non seulement le nom de la solution. Dans mon cas, c’est à la racine de mon repo. git)
    • sonar_api_key: Créé lors de l’étape précédente. Seulement coller votre valeur ici. N’oubliez pas de sauvegarder une fois que c’est fait ;).

Vous avez enfin les variables d’environnements, maintenant retournons sur la page de configuration du build.

  1. Retour sur votre Project -> Settings -> Build
  2. Allez au bas de la page de configuration et ensuite entrer ce qui suit dans “After build script“. Choisissez PS Core (ou powershell). 
    • choco install "msbuild-sonarqube-runner" -y

# Votre-organization vient aussi de SonarCloud. Du coup, veuillez renseigner le champ. Dans un SonarQube normal, vous n'aurez pas besoin de cette configuration.
# Vous pouvez aussi ajouter cette variable d'environnement en tant que variable globale d'environnement sur AppVeyor
$cmd = "MSBuild.SonarQube.Runner.exe begin /k:""${env:sonar_project_key}"" /d:sonar.organization=""VOTRE-ORGANISATION"" /d:""sonar.host.url=https://sonarcloud.io"" /d:""sonar.login=${env:sonar_api_key}"""
Invoke-Expression $cmd

msbuild $env:solution
$cmd = "MSBuild.SonarQube.Runner.exe end /d:""sonar.login=${env:sonar_api_key}"""
Invoke-Expression $cmd
    • Notez que le script peut aussi être modifié afin d’ajouter le numéro de version automatiquement et du coup synchronisez vos versions entre Sonar et AppVeyor.
  3. Sauvegarder

Relancer votre build et voilà, au rafraîchissement de la page Sonar vous devriez voir apparaître quelque chose comme ce qui suit:

Mon projet n’est pas parfait, mais ce n’est pas bien grave. Là plupart des “erreurs” sont dû à du HTML/JavaScript ou du code mort créé lors de refactoring récent. Je corrigerai, mais pour le moment ça montre que les chiffres ne sont pas tous à 0 et que ça a bien marché! 😀

BadgeIt – Configuration

Ici vous avez plusieurs choix. Je vous recommande votre environnement locale, mais SI vous ne pouvez pas, tournez vous vers votre hébergement favoris (Google, AWS, Azure, Heroku ou autre). Je vais donner quelques détails pour Azure, cependant ici nous allons nous attarder à la façon Heroku histoire de montrer comment déployer .Net Core 2.1 sous un container.

Azure (WebApp)

Pour ceux qui désire prendre le choix Azure, ce sera trivial:

  • Déploiement dans sur une WebApp ou similaire
  • Affecter les variables d’environnements
    • SonarQubeApi.ApiKey: Votre clée d’API créé lors de l’étape SonarQube (Cloud) et qui porte le nom de BadgeIt.
    • SonarQubeApi.BaseUri: Dans le cas ici présent: “https://sonarcloud.io/api/” ou sinon ce sera votre SonarQube privé.
    • BadgeApi.BaseUri: Par défaut, je vous recommande “https://img.shields.io/badge/”, mais si vous voulez un peu plus d’intimité et de performance, veuillez tout simplement installer le serveur Shields.IO localement. Veuillez vous référer au site Github de Shields.IO afin d’obtenir plus de détails.
  • Démarrer votre WebApp et voilà, vous pourrez suivre un peu plus loin comment utiliser l’API, sinon tout simplement charger la page principale de la WebApp, vous aurez un exemple et vous pourrez tester.

Azure (Docker container)

Veuillez suivre l’article MSDN afin de déployer votre application.

Heroku

Si vous n’avez pas déjà un compte Heroku, créez en un. Vous devrez aussi installer Heroku-Cli, car ce sera à partir de cette application que votre déploiement se fera. Sinon en générale, ce sera plutôt trivial. (Article Heroku à ce sujet)

  • Cloner le repo. HoNoSoFt.BadgeIt.SonarQube
  • Validez que vous avez bien le fichier “Dockerfile” dans le répertoire de l’application web (Dans notre cas: HoNoSoFt.BadgeIt.SonarQube.Web).
  • Connectez-vous au serveur de conteneurs Heroku
    • > heroku container:login
      • OU
    • > docker login –username=_ –password=$(heroku auth:token) registry.heroku.com
  • Poussez votre image
    • heroku container:push <process-type>
      • OU, si votre image existe déjà (tag plus push)
      • Exemple: > heroku container:push web –recursive -a badgeit
        • Important: La commande d’exécution doit absolument passer par CMD et non ENTRYPOINT.
    • docker tag <imageregistry.heroku.com/<app>/<process-type>
  • Vous pouvez ensuite faire une release de votre image
    • Exemple > heroku container:release web -a badgeit
  • N’oubliez pas d’aller configurer votre application heroku, car vous devrez mettre à jour les variables d’environnements.
    • Exemple:

Résultat:

Et voilà! Vous avez le tout de fonctionnel. Ce n’est pas bien de ne pas tout avoir dans le vert, mais ce n’est qu’une première version.

Possibilité de faire mieux (Oui, évidemment ;))

Petit exercice au cas où vous voulez vous amuser:

  1. Créer un docker-compose
    • Ajouter l’image de conteneur de Badgeit
    • Ajouter l’image de conteneur de Shields.io
    • Configurez le tout
    • Et testez
  2. Changer le message après le build afin d’envoyer un message personalisé à Slack en utilisant une image de votre badge service (badgeIt) ou autre.

À la prochaine!

CategoryC# Intégration Continue (CI) Programmation
Tags

Leave a Reply

Your email address will not be published. Required fields are marked *