Utilisation de SonarCloud avec GitHub dans une CI/CD (40 minutes)

Prérequis matériels et logiciels

• Ordinateur portable avec accès à Internet.
• Navigateur web (Chrome, Firefox, Edge, etc.).
• Compte GitHub : si vous n'en avez pas, créez-en un gratuitement ici.
• Compte SonarCloud : peut être créé pendant l'atelier.

---

Déroulé de l'atelier pratique

Étape 1 : Forker le dépôt GitHub

Forker le dépôt

• Cliquez sur le bouton "Fork" en haut à droite de la page du dépôt.
• Sélectionnez votre compte personnel pour créer une copie du dépôt dans votre espace GitHub.

---

Étape 2 : Créer un compte SonarCloud et configurer une organisation

Créer un compte SonarCloud avec votre compte GitHub

• Rendez-vous sur sonarcloud.io.
• Cliquez sur "Sign up with GitHub" ou utilisez ce lien direct : Inscription SonarCloud via GitHub.
• Autorisez SonarCloud à accéder à votre compte GitHub si demandé.

Créer une organisation avec le plan gratuit

• Une fois connecté sur SonarCloud, cliquez sur "Create Organization".
• Sélectionnez "Choose an organization on GitHub".
• Choisissez votre nom d'utilisateur GitHub comme organisation.
• Choisissez le plan gratuit ("Free plan") lorsque cela est proposé.

---

Étape 3 : Lancer la première analyse de code

Importer le projet GitHub dans SonarCloud

• Dans SonarCloud, après avoir créé l'organisation, cliquez sur "Analyze new project".
• Sélectionnez le dépôt que vous avez forké (par exemple, votre-nom-utilisateur/DiiageCustomerApp).
• Cliquez sur "Set Up" pour commencer la configuration du projet.

Configurer le projet SonarCloud

• Nom du projet : laissez le nom par défaut ou personnalisez-le.
• Clé du projet : laissez la valeur par défaut.
• Cliquez sur "Continue".

Choisir la méthode d'analyse

• Sur la page "Choose how to analyze your project", sélectionnez "With GitHub Actions".

Suivre les instructions de SonarCloud pour configurer l'analyse

• SonarCloud va vous fournir un fichier YAML préconfiguré pour GitHub Actions.

Ajouter le jeton comme secret dans votre dépôt GitHub

• Allez sur votre dépôt forké sur GitHub.
• Cliquez sur "Settings" (Paramètres) > "Secrets and variables" > "Actions" > "New repository secret".
• Nom du secret : SONAR_TOKEN
• Valeur du secret : collez le jeton SonarCloud que vous avez généré.
• Cliquez sur "Add secret".

Créer le fichier GitHub Actions pour l'analyse SonarCloud

• Dans votre dépôt GitHub, cliquez sur "Actions" en haut.
• Vous pouvez voir des workflows suggérés ; nous allons créer un workflow personnalisé.
• Cliquez sur "New workflow", puis sur "set up a workflow yourself".
• Nom du fichier : .github/workflows/sonarcloud.yml

---

Étape 4 : Vérifier l'exécution de l'analyse

Déclencher le workflow GitHub Actions

• Le fait de committer le fichier de workflow déclenche automatiquement l'exécution du workflow.
• Allez dans l'onglet "Actions" de votre dépôt pour voir le workflow en cours d'exécution.
• Vous pouvez cliquer sur le workflow pour voir les détails et suivre l'exécution des étapes.

Vérifier les résultats sur SonarCloud

• Une fois le workflow terminé, retournez sur SonarCloud.
• Dans votre tableau de bord, cliquez sur votre projet pour voir les résultats de l'analyse.
• Vous verrez des métriques telles que les Bugs, les Vulnérabilités, les Code Smells, la Couverture de code, etc.

---

Étape 5 : Mise en place de Sonar sur l’un de vos projets

Intégrez une analyse statique de code à l’un de vos dépôts GitHub existants afin de procéder à son analyse en suivant les étapes du TP.
Si vous ne disposez pas d’un dépôt GitHub, vous pouvez choisir la stack de votre choix à partir du projet RealWorld App disponible à l'URL suivante : RealWorld App.

Ensuite, reproduisez les étapes précédentes sur ce nouveau projet.