🚀 API Unit Tests with Continuous Integration Pipeline

🔥 Software Systems Testing project 🚀

🎨 State of the art

1. Testarea unitara¹
   • reprezinta testarea unei bucati mici de cod, cum ar fi o functie
2. Testarea unitara a API-urilor²
   • ne asigura ca parametrii sunt folositi corect de catre endpoint si ca acesta ne ofera un HTTP response la care ne asteptam, care poate fi o serie de date sau o eroare, de obicei in format JSON
   • ne ajuta sa ne asiguram ca payload-ul este scris corect, de exemplu: trimitem un POST request catre server, iar in payload am scris city in loc de City care este numele cunoscut de baza de date
3. Integrarea continua ³
   • este o tehnica folosita in dezvoltarea software prin care codul este incarcat intr-un repository abia dupa ce a fost rulat cu succes un build si dupa ce a trecut de o serie de teste, garantand calitatea codului si minimizand numarul de bug-uri din aplicatie

📦 ☁️ Servicii si resurse

1. Express⁴: framework web pe care il voi folosi pentru a face request-urile HTTP si a configura rutele
2. Jest⁵: framework de testare pentru JS, pe care il voi folosi pentru testele unitare
3. Supertest⁶: framework de testare pentru request-uri HTTP, care ne scuteste de necesitatea de a avea un server pornit cand ruleaza testele
4. MongoDB Atlas⁷: platforma cloud prin care accesez o baza de date non-relationala deja populata⁸ si ma conectez la aceasta printr-un server hostat pe Azure
5. dotenv⁹: un secret manager pe care il folosesc sa pastrez secret connection string-ul pentru baza de date intr-un fisier .env
6. GitHub Actions¹⁰: platforma care ne ajuta sa automatizam integrarea continua a aplicatiei
7. Swagger¹¹: unealta care ne ajuta sa vizualizam in detaliu toate endpoint-urile unui API si ne permite si sa testam manual
8. Postman¹²: unealta prin care putem face request-uri si vedea apoi response-ul pentru testarea manuala a API-ului

🛠️ Configuratie Hardware

• CPU: Intel Core i5-1135G7
• GPU: Intel TigerLake-LP GT2
• RAM: 16 GB
• Stocare: SSD 512GB

🖥️ Configuratie Software

• SO: Fedora Linux 41 in dual boot
• IDE: JetBrains WebStorm 2024.3.5

Baza de date

Baza de date non-relationala pre-populata de la MongoDB Atlas, pe modelul Airbnb: https://www.mongodb.com/docs/atlas/sample-data/sample-airbnb/

Testarea unitara

Au fost testate unitar 3 endpoint-uri:

1. GET /airbnb/id
2. GET /airbnb/with-facility
3. GET /airbnb/best-by-location

Rularea testelor din command-line

Rularea testelor din IDE

Testarea manuala

API-ul poate fi testat si manual, cu ajutorul Postman si Swagger:

1. Postman

   

2. Swagger

   

Integrare continua

Integrarea continua cu GitHub Actions

Script-ul de integrare continua

● Rulează pe o mașină virtuală cu Ubuntu

● Instaleaza pachetele din npm cu ‘npm ci’, mai eficienta decat ‘npm install’ in acest context

● Rulează build-ul programului cu npm run build

● Rulează testele unitare cu npm test

● Variabilele necesare pentru conectarea la baza de date sunt stocate ca secrete in GitHub Actions

Raport despre folosirea Deepseek

Footnotes

1. https://aws.amazon.com/what-is/unit-testing/ ↩

2. https://www.postman.com/api-platform/api-testing/ ↩

3. https://aws.amazon.com/devops/continuous-integration/ ↩

4. https://expressjs.com/ ↩

5. https://jestjs.io/ ↩

6. https://www.accelq.com/blog/supertest/#tab_67efd0ec331db ↩

7. https://www.mongodb.com/atlas ↩

8. https://www.mongodb.com/docs/atlas/sample-data/sample-airbnb/ ↩

9. https://www.dotenv.org/blog/2023/03/13/how-to-use-dotenv.html ↩

10. https://docs.github.com/en/actions/about-github-actions/understanding-github-actions ↩

11. https://petstore.swagger.io/ ↩

12. https://www.postman.com/ ↩