Skip to content
Snippets Groups Projects
Commit a4b52d88 authored by Mazertula2's avatar Mazertula2
Browse files

Initialize project structure with Express API, task management service, and testing setup

parents
No related branches found
No related tags found
No related merge requests found
{
"env": {
"commonjs": true,
"es2021": true,
"node": true,
"jest": true
},
"extends": "eslint:recommended",
"rules": {
"indent": ["error", 4],
"quotes": ["error", "single"],
"semi": ["error", "always"]
}
}
\ No newline at end of file
node_modules
logs
coverage
.env
README.md 0 → 100644
### **README – TP Polytech Marseille 2025 (FISA & FISE)**
**Projet Node.js avec GitLab CI, Tests et Gestion de Code**
---
## **Introduction**
Ce projet a pour objectif de vous familiariser avec :
- L’utilisation de Git et GitLab (gestion des branches, merge requests).
- L’écriture de tests unitaires et d’intégration.
- L’intégration continue via GitLab CI/CD.
- Les bonnes pratiques de développement en équipe.
Vous travaillerez sur **une API REST de gestion de tâches** (*Todo List*), en la faisant évoluer progressivement.
---
## **1. Récupération du projet et première exploration**
1. Clonez le projet de base depuis le dépôt GitLab fourni :
```bash
git clone <URL_DU_REPO>
cd polytech-todo-api
```
2. **Explorez le code source** :
- `src/index.js` → Point d’entrée de l’application (serveur web).
- `src/todoService.js` → Contient la logique de gestion des tâches.
- `data/tasks.json` → Stocke les tâches initiales.
- `tests/` → Contient des tests unitaires et d’intégration.
- `.gitignore` → Fichiers à exclure du versioning Git.
- `.eslintrc.json` → Configuration du linter ESLint.
---
## **2. Exécution et tests locaux**
### **Installation des dépendances**
Avant toute chose, installez les dépendances du projet :
```bash
npm install
```
Cela télécharge et installe toutes les bibliothèques nécessaires définies dans `package.json`.
---
### **Vérification du fonctionnement de l'application**
Lancez le serveur :
```bash
npm start
```
Cela démarre l’API sur `http://localhost:3000`. Vérifiez que l’endpoint suivant répond bien :
```bash
curl http://localhost:3000/status
```
Réponse attendue :
```json
{"status":"ok"}
```
---
### **Analyse du linter (ESLint)**
Le linter sert à garantir que votre code respecte des règles de style et de bonnes pratiques.
Exécutez :
```bash
npm run lint
```
- En cas d’erreur, ESLint vous indiquera les corrections à apporter.
- Consultez `.eslintrc.json` pour comprendre les règles définies.
---
### **Exécution des tests**
Le projet contient des **tests unitaires** (sur `todoService.js`) et des **tests d’intégration** (sur les endpoints).
Lancez tous les tests avec :
```bash
npm run test
```
- **Tests unitaires** : Vérifient que les fonctions du service renvoient les bonnes données.
- **Tests d’intégration** : Vérifient que l’API répond correctement aux requêtes.
Si un test échoue, analysez son message pour comprendre la cause.
---
## **3. Mise en place de votre projet GitLab**
### **Création de votre dépôt personnel**
1. **Sur GitLab**, créez un **nouveau dépôt** privé nommé `polytech-todo-api-votreNom`.
2. Supprimez le remote existant et ajoutez le vôtre :
```bash
git remote remove origin
git remote add origin https://gitlab.com/votreCompte/polytech-todo-api-votreNom.git
```
3. Poussez votre code sur GitLab :
```bash
git push -u origin main
```
### **Gestion des branches**
- **Main** : Contient la version stable (ne jamais pousser directement dessus).
- **Develop** : Branche principale pour le développement.
- **Feature branches** : Chaque nouvelle fonctionnalité doit être développée sur une branche dédiée.
Créez `develop` :
```bash
git checkout -b develop
git push -u origin develop
```
Puis, dans **GitLab > Settings > Repository** :
- Protégez `main` et `develop` pour empêcher les pushs directs.
- Activez l’option "Merge Request obligatoire".
---
## **4. Évolutions à implémenter**
### **1️⃣ Récupération d'une tâche par ID**
Ajoutez un nouvel **endpoint** :
- Route : `GET /api/tasks/:id`
- Retourne :
```json
{"id": 1, "description": "Faire les courses", "done": false}
```
- Réponse `404` si l'ID n'existe pas.
Modifiez `todoService.js` :
```javascript
function getTaskById(id) {
// Implémentez la logique ici
}
```
Ajoutez les **tests unitaires** et **tests d’intégration** associés.
---
### **2️⃣ Ajout d'une tâche**
Ajoutez un **endpoint** pour ajouter une tâche :
- Route : `POST /api/tasks`
- Reçoit :
```json
{"description": "Nouvelle tâche"}
```
- Génère un nouvel `id` et retourne :
```json
{"id": 3, "description": "Nouvelle tâche", "done": false}
```
Modifiez `todoService.js` :
```javascript
function addTask(description) {
// Implémentez la logique ici
}
```
Ajoutez **les tests correspondants**.
---
### **3️⃣ Suppression d'une tâche**
Ajoutez un **endpoint** pour supprimer une tâche :
- Route : `DELETE /api/tasks/:id`
- Répond `204 No Content` si OK, ou `404 Not Found` si l’ID est introuvable.
Modifiez `todoService.js` :
```javascript
function deleteTask(id) {
// Implémentez la logique ici
}
```
Ajoutez les **tests unitaires et d’intégration**.
---
## **5. Mise en place de GitLab CI/CD**
Créez un fichier `.gitlab-ci.yml` pour automatiser :
- **Linting**
- **Tests unitaires**
- **Tests d’intégration**
- **Exécution seulement sur `develop` et `main`**
### **Mots-clés à utiliser dans le fichier `.gitlab-ci.yml`**
Au lieu de donner un fichier complet, voici les éléments à inclure et pourquoi :
| **Mot-clé** | **Explication** |
|------------|---------------|
| `image: node:16` | Utilise une image Docker avec Node.js 16, identique à votre VM. |
| `stages:` | Définit les étapes de la CI (`install`, `lint`, `test`). |
| `cache:` | Permet de réutiliser `node_modules` pour accélérer les jobs. |
| `script:` | Liste les commandes à exécuter (`npm install`, `npm run test`, etc.). |
| `only:` | Restreint l'exécution de certains jobs aux branches `develop` et `main`. |
| `before_script:` | Exécute `npm install` avant chaque étape. |
| `artifacts:` | Sauvegarde les fichiers de sortie utiles après l’exécution d’un job. |
Ajoutez ces éléments dans votre `.gitlab-ci.yml`, poussez et vérifiez que la CI s’exécute correctement.
---
## **6. Processus de validation finale**
1. **Assurez-vous que votre pipeline GitLab CI fonctionne**.
2. **Faites une Merge Request** de `develop` vers `main`.
3. **Ajoutez votre professeur comme reviewer**.
4. **Lors du merge sur `main`**, un script externe vérifiera la validité des tests.
5. **Si tout est OK, votre Merge Request sera validée**.
---
## **🎯 Récapitulatif des livrables attendus**
- Une API fonctionnelle avec les endpoints demandés.
- Un projet GitLab bien structuré (`main`, `develop`, branches protégées).
- Un `.gitlab-ci.yml` opérationnel.
- Des tests unitaires et d’intégration pour chaque fonctionnalité.
- Un merge propre vers `main` validé par la CI.
Bonne chance ! 🚀
\ No newline at end of file
module.exports = {
testEnvironment: 'node',
testMatch: ['**/tests/**/*.test.js'],
verbose: true
};
This diff is collapsed.
{
"name": "polytech-todo-api",
"version": "1.0.0",
"description": "TP Polytech Marseille 2025 – FISA & FISE",
"main": "src/index.js",
"scripts": {
"start": "node src/index.js",
"lint": "eslint src/**/*.js",
"test": "jest"
},
"dependencies": {
"express": "^4.18.2"
},
"devDependencies": {
"eslint": "^8.57.0",
"jest": "^29.7.0",
"supertest": "^6.3.4"
}
}
\ No newline at end of file
// Code pour lancer le serveur express et définir les endpoints
//import de la librairie express
const express = require('express');
//import du service de gestion des tâches
const taskService = require('./taskService');
//création de l'application express
const app = express();
app.use(express.json());
//définition du port d'écoute
const port = process.env.PORT || 3000;
// Endpoint de vérification que l'app fonctionne
app.get('/status', (req, res) => res.json({ status: 'ok' }));
// Endpoint pour récupérer toutes les tâches
app.get('/api/tasks', (req, res) => {
const tasks = taskService.getAllTasks();
res.json(tasks);
});
// Fonction pour démarrer le serveur
const startServer = () => {
const server = app.listen(port, () => {
console.log(`Server listening on port ${port}`);
});
return server;
};
// Démarrer le serveur seulement si ce fichier est exécuté directement
// et non pas importé pour les tests
if (require.main === module) {
startServer();
}
//export de l'application pour les tests
module.exports = { app, startServer };
//service de gestion des tâches
//import des tâches
const tasks = require('../tasks.json');
//fonction de récupération de toutes les tâches
function getAllTasks() {
return tasks;
}
//export des fonctions
module.exports = {
getAllTasks
};
[
{"id": 1, "description": "Apprendre Git", "done": false},
{"id": 2, "description": "Configurer GitLab CI", "done": false},
{"id": 3, "description": "Faire le TP Polytech", "done": false}
]
\ No newline at end of file
// Description: Test des endpoints de base de l'application.
// Import de la librairie de test des endpoints
const request = require('supertest');
// Import de l'application
const { app } = require('../../src/index');
// Test des endpoints de base
describe('Endpoints de base', () => {
// Test de l'endpoint de status
test('GET /status devrait retourner status ok', async () => {
const res = await request(app).get('/status');
expect(res.statusCode).toEqual(200);
expect(res.body).toEqual({ 'status': 'ok' });
});
// Test de l'endpoint de récupération de toutes les tâches
test('GET /api/tasks devrait retourner toutes les tâches', async () => {
const res = await request(app).get('/api/tasks');
expect(res.statusCode).toEqual(200);
expect(Array.isArray(res.body)).toBe(true);
expect(res.body.length).toBeGreaterThan(0);
});
});
//test unitaire des fonctions de service
// Import de la fonction à tester
const { getAllTasks } = require('../../src/taskService');
//Test de la fonction de récupération de toutes les tâches.
test('should return all tasks', () => {
const tasks = getAllTasks();
expect(Array.isArray(tasks)).toBe(true);
expect(tasks.length).toBeGreaterThan(0);
});
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment