Update file README.md

README.md

-# but3
+# TP CICD : GitLab CI + SonarQube + PHPUnit
 
 
+## Etape 1 : Création de l'environnement
 
-## Getting started
+### Préparation de la machine virtuelle
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+Créer une VM avec les caractèristiques suivantes : 
+   - hostname : <group>-cicd01
+   - disque : 40 Go
+   - cpu : 2 socket, 2 cores
+   - OS : [Ubuntu Server 22.04 LTS](https://releases.ubuntu.com/22.04.3/ubuntu-22.04.3-live-server-amd64.iso)
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
 
-## Add your files
+### Installer les paquets supplémentaires
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+Configurer vos proxy pour aller récupérer les paquets apt sur les dépots internet.
+Editer le fichier /etc/apt/apt.conf.d/proxy.conf :
+  ```
+  Acquire::http::Proxy "http://<user>:<password>@<proxyserver>:<proxyport>/";
+  Acquire::https::Proxy "http://<user>:<password>@<proxyserver>:<proxyport>/";
+  ```
+
+
+Vérifier que vous pouvez bien installer vos paquets : 
+```
+# apt -y update
+# apt -y upgrade
+```
+
+Installer les packages docker : 
+```
+# apt -y install docker.io 
+```
+
+Configurer les proxy pour dockerd en créant le fichier /etc/systemd/system/docker.service.d/http-proxy.conf :
+```
+[Service]
+Environment="HTTP_PROXY=http://<user>:<password>@<proxyserver>:<proxyport>/"
+Environment="HTTPS_PROXY=http://<user>:<password>@<proxyserver>:<proxyport>/"
+```
+
+### Lancer SonarQube et vérifier qu'il est opérationnel 
+
+Nous allons utiliser l'image docker sonarqube:lts disponible sur [DockerHub](https://hub.docker.com/_/sonarqube/)
+
+```
+docker run -d --name sonarqube \
+    -e SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true \
+    -p 9000:9000 \
+    sonarqube:lts
+```
+
+Vérifier que vous accèder bien à l'interface de SonarQube à l'URL suivante ou <ip> est l'IP de votre VM <group>-cicd01 :
+http://<ip>:9000/
+
+### Lancer GitLab-runner et vérifier qu'il est opérationnel 
+
+Nous allons utiliser l'image docker gitlab-runner:latest disponible sur [DockerHub](https://hub.docker.com/r/gitlab/gitlab-runner)
+
+```
+# mkdir -p /srv/gitlab-runner/config
+# docker run -d --name gitlab-runner \ 
+    --restart always \
+    -v /srv/gitlab-runner/config:/etc/gitlab-runner  \
+    -v /var/run/docker.sock:/var/run/docker.sock \
+    gitlab/gitlab-runner:latest
+```
+
+### Validation étape 1
+
+A faire valider : 
+
+- [ ] Machine virtuelle OK
+```
+# hostname 
+# free
+# df -h
+```
+- [ ] Container docker gitlab-runner & sonarqube OK 
+```
+# docker ps
+```
+- [ ] Accès à l'interface SonarQube OK
+
+
+## Etape 2 : Configuration du projet GitLab & SonarQube
+
+### Créer un compte sur gilab.com 
+
+Créer votre compte [Gitlab.com](https://gitlab.com/users/sign_in)
+Puis communiquer votre identifiant afin d'être autoriser à accéder au groupe [Projects](https://gitlab.com/asrsi/cicd/projects)
 
+### Créer un projet sur gitlab.com
+
+Créer un projet dans le groupe [Projets](https://gitlab.com/asrsi/cicd/projects).
+avec le nom : php-<groupe>
+
+### Enregistrer le gitlab-runner sur votre projet
+
+Désactiver les "shared runner" pour votre projet.
+Créer un runner dédié pour votre projet avec les propriétés suivantes : 
+  - tag : but-<groupe>
+  - description : but-runner-<groupe>
+  - Locked for current projet
+Récupérer le RUNNER_TOKEN associé 
+
+```
+# docker run --rm -v /srv/gitlab-runner/config:/etc/gitlab-runner gitlab/gitlab-runner register \
+  --non-interactive \
+  --url "https://gitlab.com/" \
+  --token "<RUNNER_TOKEN>" \
+  --executor "docker" \
+  --docker-image alpine:latest \
+  --description "docker-runner"
+```
+
+Vérifier que votre runner est bien activé sur votre projet (point vert dans l'interface).
+
+### Configurer SonarQube sur votre projet
+
+Créer un [Personnal AccessToken GitLab](https://gitlab.com/-/user_settings/personal_access_tokens) avec les caractèristiques suivantes : 
+ - nom : sonar
+ - scopes : api, read_api, read_user, read_repository, read_registry
+
+
+Se connecter sur l'interface SonarQube.
+Créer un projet basé sur gitlab avec les caractèristiques suivantes :
+  - nom : php-<groupe>
+
+Renseigner votre Personnal Access Token qui vous permettra de lié votre projet SonarQube avec votre projet gitlab
+
+Suivre le tutoriel qui devrait vous amener à : 
+  - Créer des variables d'environnement dans votre projet : 
+    -   SONAR_HOST_URL qui contient l'URL de votre SonarQube
+    -   SONAR_TOKEN qui contient un token d'accès à votre SonarQube 
+  - Créer 2 fichiers dans le dépot de votre projet: 
+    -   sonar-project.properties
+    -   gitlab-ci.yaml
+
+### Execution de la pipeline Gitlab
+
+Lors de la modification du fichier gitlab-ci.yaml cela lance automatiquement la pipeline GitLab de votre projet.
+
+### Validation étape 2
+
+A faire valider : 
+
+- [ ] Projet gitlab OK
+- [ ] Runner attaché à votre projet OK
+- [ ] Projet SonarQube OK
+- [ ] Pipeline GitLab OK
+
+## Etape 3 : Population de votre dépot
+
+### Ajouter les fichiers suivants dans votre dépot
+
+Average.php : Fichier contenant le code réalisé
+
+Fichier src/but/Average.php :
 ```
-cd existing_repo
-git remote add origin https://gitlab.com/alex.linte/but3.git
-git branch -M main
-git push -uf origin main
+<?php
+
+namespace but;
+
+class Average
+{
+    /**
+     * Calculate the mean average
+     * @param array $numbers Array of numbers
+     * @return float Mean average
+     */
+    public function mean(array $Numbers)
+    {
+        $variable = "but";
+        return array_sum($Numbers) / count($Numbers);
+    }
+
+    /**
+     * Calculate the median average
+     * @param array $numbers Array of numbers
+     * @return float Median average
+     */
+    public function median(array $numbers)
+    {
+        sort($numbers);
+        $size = count($numbers);
+        if ($size % 2) {
+            return $numbers[$size / 2];
+        } else {
+            return $this->mean(
+                array_slice($numbers, ($size / 2) - 1, 2)
+            );
+        }
+    }
+}
+
 ```
 
-## Integrate with your tools
+### Verifier le statut de votre projet 
 
-- [ ] [Set up project integrations](https://gitlab.com/alex.linte/but3/-/settings/integrations)
+Vérifier le statut de votre pipeline CI
+Vérifier le statut de votre projet dans SonarQube
 
-## Collaborate with your team
+### Correction de problèmes 
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+Corriger le fichier Average.php afin de corriger les problèmes identifié par SonarQube.
 
-## Test and Deploy
+### Validation étape 3
 
-Use the built-in continuous integration in GitLab.
+A faire valider : 
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+- [ ] Statut de votre projet dans SonarQube
+- [ ] Corrections apportées
 
-***
 
-# Editing this README
+## Etape 4 : Tests automatiques avec PHPUnit
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+### Ajouter les fichiers à votre dépots
 
-## Suggestions for a good README
+boostrap.php : fichier permettant d'inclure les classes présentent dans le répertoire src
+AverageTest.php : fichier contenant les tests unitaires des fonctions la classe Average.
 
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+Fichier tests/bootstrap.php
+```
+<?php
+
+function loader($class): void
+{
+    $class_path = str_replace('\\', '/', $class);
+    $file =  'src/' . $class_path . '.php';
+    if (file_exists($file)) {
+        require_once $file;
+    }
+}
+
+spl_autoload_register('loader');
+```
 
-## Name
-Choose a self-explaining name for your project.
+Fichier tests/but/AverageTest.php :
+```
+<?php
+
+use but\Average;
+use PHPUnit\Framework\TestCase;
+
+class AverageTest extends TestCase
+{
+    protected $Average;
+
+    public function setUp() : void
+    {
+        $this->Average = new Average();
+    }
+
+    public function testCalculationOfMean()
+    {
+        $numbers = [3, 7, 6, 1, 5];
+        $this->assertEquals(4.4, $this->Average->mean($numbers));
+    }
+
+    public function testCalculationOfMedian()
+    {
+        $numbers = [3, 7, 6, 1, 5];
+        $this->assertEquals(5, $this->Average->median($numbers));
+    }
+}
+```
+
+Les tests sont développés à l'aide d'un framework de test : [PHPUnit](https://phpunit.de/)
+
+### Modifier le fichier de configuration SonarQube 
+
+Afin que SonarQube intégre la structure du dépot modifié le fichier sonar-project.properties :
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+```
+sonar.projectKey=<votre_project_key>
+sonar.qualitygate.wait=true
+sonar.tests=tests
+sonar.sources=src
+```
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+### Lancer les tests unitaires dans votre pipeline
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+Modifier le fichier gitlab-ci.yaml afin d'y intégrer le lancement des TU avant le lancement des tests SonarQube avec phpunit.
+Pensez à vous aider de l'image docker [php:8.1](https://hub.docker.com/_/php) et de cet exemple [PHPunit/Gitlab CI](https://docs.gitlab.com/ee/ci/examples/php.html).
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+Fichier de configuration de phpunit :
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="tests/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd">
+    <testsuites>
+        <testsuite name="Project Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage>
+        <include>
+            <directory>src</directory>
+        </include>
+        <exclude>
+            <directory>tests</directory>
+        </exclude>
+    </coverage>
+</phpunit>
+```
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+Vérifier que votre pipeline execute corretement les tests PHPUnit puis les tests SonarQube
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+### Génération des rapports de test
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+Faire en sorte que PHPunit génère 2 rapports :
+  - rapport de test (format junit) : build/rapport-test.xml
+  - rapport de coverage (format clover) :  build/rapport-coverage.xml
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+### Upload des artefacts 
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+Définir les rapport de test en temps qu'artefact gitlab- CI.
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+### Intégration des rapport à SonarQube
 
-## License
-For open source projects, say how it is licensed.
+Intégrer vos rapports de coverage et de tests à SonarQube.
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+## Etape 5 : Quality Gate SonarQube