Territory Service

🔍 Sumary

• Territory Service
  • Project Structure
  • Tech Stack
  • Build
  • How to run the project
  • Test strategy
  • CI/CD

---

Territory Service

This service was created to support Mapeando Quilombos website. The frontEnd repository is here: https://github.com/dfernandos/mapeando-quilombos-web-app

Mapeando Quilombos

O propósito do Mapeando Quilombos é contribuir para o compartilhamento de saberes sobre a cultura e história afro-brasileira através do conhecimento sobre os territórios quilombolas da cidade de Porto Alegre/RS. Através dessa iniciativa, busca-se ampliar a compreensão e valorização desses espaços, compartilhando informações relevantes e promovendo a conscientização sobre a importância histórica e cultural dos quilombos na sociedade brasileira.

O público-alvo deste projeto são os professores e alunos da educação básica, bem como qualquer pessoa interessada nessa temática. Por meio dessa iniciativa, os professores terão a oportunidade de ampliar seus conhecimentos sobre o tema e compartilhar essas informações com os alunos em sala de aula. Link para o site: https://mapeando-quilombos.netlify.app/

Este projeto foi criado para a disciplina de Trabalho de Conclusão II para a obtenção do grau de Tecnólogo em Sistemas para internet pelo Instituto Federal do Rio Grande do Sul - IFRS Campus Porto Alegre.

Tech Stack

• 
• 
• 
• 

Build

• Install:

  • Java

  • Maven

  • MongoDB

  • Project dependency setup

    • cd territory-svc
    • ./mvnw install

How to run the project

• Run ./mvnw spring-boot:run

Test strategy

How to run the tests

• In the project directory:

  • Run ./mvnw test

• Unit tests for the service class

• Component tests for controller class

• Once you run the tests you can check the test report generated by Jacoco in directory target/site/index.html

• Test scenarios

  • For testing the the TerritoryService class:

    • Create a territory successfully
    • Get a all territories successfully
    • Should delete a territory successfully
    • Should get a territory by Id Successfully
    • Should update a territory sucessfully

  • For testing the the TerritoryController class:

    • Create a territory successfully and return 201
    • Validate if an error is throwed in case there is a issue
    • Get all territories successfully and return 200
    • Should delete a territory successfully and return 200
    • Should get a territory by Id Successfully and return 200
    • Should return not founf when a territory is not found and return 404
    • Should update a territory sucessfully and return 200
    • Should get all territory successfully and return 200

CI/CD

• You can check the CI/CD status in the menu Actions on GitHub
• The pipeline has 2 steps:
  • Build
  • Tests