Merge pull request 'documentation' (#13) from documentation into main

Reviewed-on: #13

.drone.yml

@@ -7,40 +7,78 @@ trigger:
     - push
 
 steps:
-  - name: build
-    image: mcr.microsoft.com/dotnet/sdk:6.0
-    volumes:
-      - name: docs
-        path: /docs
-    commands:
-      - cd Sources/
-      - dotnet restore Solution.sln
-      - dotnet build Solution.sln -c Release --no-restore
-      - dotnet publish Solution.sln -c Release --no-restore -o CI_PROJECT_DIR/build/release
-
-  - name: tests
-    image: mcr.microsoft.com/dotnet/sdk:6.0
-    commands:
-      - cd Sources/
-      - dotnet restore Solution.sln
-      - dotnet test Solution.sln --no-restore
-    depends_on: [build]
-
-  - name: generate-and-deploy-docs
-    image: hub.codefirst.iut.uca.fr/thomas.bellembois/codefirst-docdeployer
-    failure: ignore
-    volumes:
-      - name: docs
-        path: /docs
-    commands:
-      #- cd Documentation/doxygen
-      #- doxygen Doxyfile
-      - /entrypoint.sh
-    when:
-      branch:
-        - master
-    depends_on: [ build ]
+    - name: build
+      image: mcr.microsoft.com/dotnet/sdk:6.0
+      volumes:
+        - name: docs
+          path: /docs
+      commands:
+        - cd Sources/
+        - dotnet restore Solution.sln
+        - dotnet build Solution.sln -c Release --no-restore
+        - dotnet publish Solution.sln -c Release --no-restore -o CI_PROJECT_DIR/build/release
+
+    - name: tests
+      image: mcr.microsoft.com/dotnet/sdk:6.0
+      commands:
+        - cd Sources/
+        - dotnet restore Solution.sln
+        - dotnet test Solution.sln --no-restore
+      depends_on: [ build ]
+
+    - name: code-analysis
+      image: hub.codefirst.iut.uca.fr/thomas.bellembois/codefirst-dronesonarplugin-dotnet6
+      commands:
+        - cd Sources/
+        - dotnet restore Solution.sln
+        - dotnet sonarscanner begin /k:BowlingScoreApp /d:sonar.host.url=$${PLUGIN_SONAR_HOST} /d:sonar.coverageReportPaths="coveragereport/SonarQube.xml" /d:sonar.coverage.exclusions="Tests/**,BowlingApp/**,BowlingEF/**,Business/**,BowlingMaping/**,BowlingStub/**" /d:sonar.login=$${PLUGIN_SONAR_TOKEN}
+        - dotnet build Solution.sln -c Release --no-restore
+        - dotnet test Solution.sln --logger trx --no-restore /p:CollectCoverage=true /p:CoverletOutputFormat=cobertura --collect "XPlat Code Coverage"
+        - reportgenerator -reports:"**/coverage.cobertura.xml" -reporttypes:SonarQube -targetdir:"coveragereport"
+        - dotnet publish Solution.sln -c Release --no-restore -o CI_PROJECT_DIR/build/release
+        - dotnet sonarscanner end /d:sonar.login=$${PLUGIN_SONAR_TOKEN}
+      secrets: [ SECRET_SONAR_LOGIN ]
+      settings:
+        # accessible en ligne de commande par ${PLUGIN_SONAR_HOST}
+        sonar_host: https://codefirst.iut.uca.fr/sonar/
+        # accessible en ligne de commande par ${PLUGIN_SONAR_TOKEN}
+        sonar_token:
+          from_secret: SECRET_SONAR_LOGIN
+      depends_on: [ tests ]
+
+    - name: generate-and-deploy-docs
+      image: hub.codefirst.iut.uca.fr/thomas.bellembois/codefirst-docdeployer
+      failure: ignore
+      volumes:
+        - name: docs
+          path: /docs
+      commands:
+        - cd Documentation/doxygen
+        - doxygen Doxyfile
+        - /entrypoint.sh
+      when:
+        branch:
+          - master
+      depends_on: [ build ]
+      
+    - name: docker-build
+      image: plugins/docker
+      settings:
+        dockerfile: Sources/Dockerfile
+        context: .
+        registry: hub.codefirst.iut.uca.fr
+        repo: hub.codefirst.iut.uca.fr/victor_perez.ngounou/bowlingapi
+        username:
+          from_secret: SECRET_REGISTRY_USERNAME
+        password:
+          from_secret: SECRET_REGISTRY_PASSWORD
+      when:
+        branch:
+          - master
+        depends_on: [ tests ]
 
 volumes:
 - name: docs
   temp: {}
+  
+  

Sources/BowlingRepository/Interface/IEquipeRepository.cs

@@ -2,11 +2,39 @@
 
 namespace BowlingRepository.Interface;
 
+/// <summary>
+/// Interface de gestion des équipes
+/// </summary>
 public interface IEquipeRepository
 {
+    /// <summary>
+    /// Méthode d'ajout d'une équipe
+    /// </summary>
+    /// <param name="equipe">l'équipe à ajouter</param>
     public void Add(EquipeEntity equipe);
+    
+    /// <summary>
+    /// Méthode de mise à jour d'une équipe
+    /// </summary>
+    /// <param name="equipe">l'équipe à mettre à jour</param>
     public void Update(EquipeEntity equipe);
+    
+    /// <summary>
+    /// Méthode de suppression d'une équipe
+    /// </summary>
+    /// <param name="equipe">l'équipe à supprimer</param>
     public void Delete(EquipeEntity equipe);
+    
+    /// <summary>
+    /// Méthode de récupération d'une équipe
+    /// </summary>
+    /// <param name="id">l'id de l'équipe à récupérer</param>
+    /// <returns>l'équipe</returns>
     public Task GetEquipe(int id);
+    
+    /// <summary>
+    /// Méthode de récupération de toutes les équipes
+    /// </summary>
+    /// <returns>la liste des équipes</returns>
     public IEnumerable<EquipeEntity> GetAllEquipes();
 }

Sources/BowlingRepository/Interface/IJoueurRepository.cs

@@ -2,12 +2,49 @@ using BowlingEF.Entities;
 
 namespace BowlingRepository.Interface;
 
+/// <summary>
+/// Interface de gestion des joueurs
+/// </summary>
 public interface IJoueurRepository
 {
+    /// <summary>
+    /// Méthode d'ajout d'un joueur
+    /// </summary>
+    /// <param name="joueur">le joueur à ajouter</param>
+    /// <returns>le joueur ajouté</returns>
     public Task<JoueurEntity> Add(JoueurEntity joueur);
+    
+    /// <summary>
+    /// Méthode de suppression d'un joueur
+    /// </summary>
+    /// <param name="id">l'id du joueur à supprimer</param>
+    /// <returns>le joueur supprimé</returns>
     public Task<bool> Delete(long id);
+    
+    /// <summary>
+    /// Méthode de mise à jour d'un joueur
+    /// </summary>
+    /// <param name="joueur">le joueur à mettre à jour</param>
+    /// <returns>le joueur mis à jour</returns>
     public Task<bool> Update(JoueurEntity joueur);
+    
+    /// <summary>
+    /// Méthode de récupération d'un joueur
+    /// </summary>
+    /// <param name="id">l'id du joueur à récupérer</param>
+    /// <returns>le joueur</returns>
     public Task<JoueurEntity> GetJoueur(long id);
+    
+    /// <summary>
+    /// Méthode de récupération de tous les joueurs
+    /// </summary>
+    /// <returns>la liste des joueurs</returns>
     public Task<IEnumerable<JoueurEntity>> GetAllJoueur();
+    
+    /// <summary>
+    /// Méthode de récupération d'un joueur par son nom
+    /// </summary>
+    /// <param name="nom">le nom du joueur à récupérer</param>
+    /// <returns>le joueur</returns>
     public Task<JoueurEntity> GetJoueurByNom(string nom);
 }

Sources/BowlingRepository/Interface/IpartieRepository.cs

@@ -3,8 +3,16 @@ using BowlingEF.Entities;
 
 namespace BowlingRepository.Interface
 {
+    /// <summary>
+    /// Interface de gestion des parties
+    /// </summary>
 	public interface IpartieRepository
     {
+        /// <summary>
+        /// Méthode d'ajout d'une partie
+        /// </summary>
+        /// <param name="_partie">la partie à ajouter</param>
+        /// <returns></returns>
       public  Task<PartieEntity> Add(PartieEntity _partie);
       public  Task<bool> Delete(long id);
       public Task<bool> Update(PartieEntity _partie);

Sources/Mapper/FrameProfile.cs

@@ -4,6 +4,9 @@ using DTOs;
 
 namespace Mapper;
 
+/// <summary>
+/// Profile de mapping entre les FrameDTOs et les FrameEntity
+/// </summary>
 public class FrameProfile:Profile
 {
     public FrameProfile()

Sources/Mapper/JoueurProfile.cs

@@ -4,6 +4,9 @@ using DTOs;
 
 namespace Mapper;
 
+/// <summary>
+/// Profile de mapping entre les JoueurDTOs et les JoueurEntity
+/// </summary>
 public class JoueurProfile:Profile
 {
     public JoueurProfile()

Sources/Mapper/PartieProfile.cs

@@ -4,6 +4,9 @@ using DTOs;
 
 namespace Mapper;
 
+/// <summary>
+/// Profile de mapping entre les PartieDTOs et les PartieEntity
+/// </summary>
 public class PartieProfile:Profile
 {
     public PartieProfile()