Aller au contenu principal

GitHub tests et PRs

Objectifs​

  • Configurer une action de test sur GitHub
  • Ajouter un test unitaire
  • Protéger une branche pour obliger les PRs et le succès du test
  • Faire une PR

Étapes​

  • Le travail se fait en équipe pour apprendre à configurer votre projet.
  • Commencer par créer un fork de ce projet qui est simplement une projet de base WebAPI.
alt text
  • Configurer une action de tests GitHub, comme c'est expliqué dans ici

Ici, on peut voir que l'action est en train d'être exécutée

alt text

L'action passe présentement, mais notre projet n'a pas encore de tests! (On va en ajouter bientôt)

alt text
  • Configurer une règle de protection pour la branche main, comme c'est expliqué ici

    • Il faut demander un Pull Request, avec un moin 1 approval
  • Maintenant, on va faire un petit changement dans le code, simplement ajouter un commentaire dans un fichier et essayer de faire un commit directement dans la branche main

attention

Le commit devrait fonctionner, mais pas le Push!

  • On va maintenant faire une petite manipulation de branches!

  • On commence par renommer notre branche main en test (Mais seulement la branche local!)

alt text
alt text
danger

Ne choisissez PAS l'option: Also rename origin/main

  • On va ENSUITE choisir une nouvelle destination pour la branche sur GitHub en cliquant sur Custom...
alt text
  • On accepte le nom par défaut test

  • Et on va maintenant faire un Push (Git Hub a maintenant cette nouvelle branche aussi)

  • On va maintenant faire un Pull Request de notre branche test vers la branche main

Comme on a fait un commit récemment, il y a un moyen rapide de créer le Pull Request. Directement dans la section code, GitHub nous le propose!

alt text

On peut voir qu'il manque un review. C'est le moment d'ajouter un collaborateur à votre projet. Vous pouvez ajouter un collègue ou votre enseignant et leur demander de faire le review.

alt text

Faites un review qui approve

alt text

On peut maintenant intégrer la branche test dans la branche main!

alt text

Protection avec les tests​

  • Toujours dans la branche test, ajouter des tests unitaires pour la méthode Index du HomeController
  • Il y a les instructions dans la sections sur les test unitaires.
info

Le test que vous ajouté doit simplement faire Assert.Fail(). On veut simplement tester comment github va réagir à ce test qui fail.

  • Faire un commit/push du projet dans notre branche test

  • Faire un nouveau Pull Request vers la branche main

  • On devrait avoir un échec pour le moment! (Si ce n'est pas le cas, assurez-vous d'avoir bien ajouté au moins un test qui Fail et d'avoir fait votre push!)

  • On va maintenant retirer le Assert.Fail() de notre test et faire un autre commit/push.

  • Normalement, le test devrait maintenant passer et le pull request être valid (il faut simplement un autre review pour ce changement)

  • Une fois que tout est vert, c'est possible d'exécuter le Pull Request!