O projeto tem como propósito disponibilizar uma API através da qual seja possível enviar notificações em uma data/hora definida pelo cliente. A notificação pode ser entregue através de diferentes canais de comunicação: e-mail, sms, push e Whatsapp.
O canal de comunicação também é definido pelo cliente ao enviar a requisição.

O projeto foi construído baseado no conceito de Arquitetura Limpa.

A qualidade da aplicação é garantida através dos testes unitários e integrados. Utiliza o JaCoCo para validação de cobertura mínima e o PIT Mutation para testar mutações de código. Também é realizada uma análise estática com o SonarCloud.

A aplicação utiliza o bando de dados MySQL, inclusive nos testes integrados utilizando Test Containers.

Para configurar a URL de conexão crie uma variável de ambiente como abaixo com a string de conexão adequada:

SPRING_DATASOURCE_URL=jdbc:mysql://localhost:3306/notification

O root path da API é /

A API é documentada utilizando OpenAPI e pode ser acessada via navegador através do path /swagger-ui/index.html

Por padrão a API é totalmente aberta. Existem dois profiles que ativam segurança via JWT: "secure-api" e "secure-api-jwk".

Ativando o profile "secure-api" a API passa a ser protegida por autenticação via JWT com assinatura simétrica via chave secreta.
Para ativar o profile é necessária a variável de ambiente abaixo:

SPRING_PROFILES_ACTIVE=secure-api

Para verificar a validade do token é necessário informar a chave secreta utilizada para assinar o JWT. Ela deve ser configurada através da variável de ambiente abaixo:

SECURITY_JWT_SIGNATURE_SECRET=<my-secret>

O algoritmo utilizado por padrão é o HmacSHA256 e pode ser customizado através da variável de ambiente abaixo:

SECURITY_JWT_SIGNATURE_ALGORITHM=<signature-algorithm>

Ativando o profile "secure-api-jwk" a api passa a ser protegida por autenticação via JWT com assinatura assimétrica (par de chaves pública/privada). Para ativar o profile é necessária a variável de ambiente abaixo:

SPRING_PROFILES_ACTIVE=secure-api-jwk

Para verificar a validade do token é necessário informar a URI para obtenção das chaves públicas do authorization server (JWK). Ela deve ser configurada através da variável de ambiente abaixo:

SECURITY_JWT_SIGNATURE_JWK-SET-URI=<jwk-set-uri>

Veremos algumas formas para executar a aplicação. Para todas elas é importante observar as configurações via variável de ambiente.

Para executar a aplicação na IDE basta importar o projeto e executar a classe com.github.paulosalonso.notification.application.NotificationSchedulerApplication como uma aplicação Java.

mvn spring-boot:run

mvn clean package
java -jar target/research.jar

Para rodar um container Docker da aplicação a partir da última versão disponível da imagem no Docker Hub, acesse o diretório .docker e rode o comando abaixo:

docker-compose up -d

O docker-compose padrão não ativa a segurança da API. Para subir a API protegida, use o comando abaixo:

docker-compose -f docker-compose-secure-api.yml up -d

Para fazer a autenticação é utilizado o Keycloak. Um container será executado e já é iniciado com as seguintes configurações:

• realm: notification-scheduler
• client: openapi
• client secret: 8cda22cb-27a0-4afb-a594-4dbb0e9adf6f
• usuário: adm
• senha: 123456

É possível obter um token com o comando curl abaixo:

curl --location --request POST 'http://localhost:8050/auth/realms/notification-scheduler/protocol/openid-connect/token' \
--header 'Authorization: Basic b3BlbmFwaTo4Y2RhMjJjYi0yN2EwLTRhZmItYTU5NC00ZGJiMGU5YWRmNmY=' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username=adm' \
--data-urlencode 'password=123456' \
--data-urlencode 'client_id=openapi'

Importe a coleção e os ambientes do postman presentes no projeto para consumir a API.
Há requisições com e sem autenticação. Também há a requisição para obtenção do token no Keycloak local (Docker).
O ambiente local é configurado de acordo com as configurações do docker-compose.

Collection
Local Environment
Heroku Environment

Também é possível consumir a API via Swagger.

Swagger local (baseado no docker-compose): http://localhost:8080/swagger-ui/index.html
Swagger no Heroku - Homologação
Swagger no Heroku - Produção

Os logs são gerenciados pelo SLF4J, e utiliza o Logback como implementação.

Localmente os logs podem ser visualizados pelo terminal, com o comando abaixo:

docker-compose logs notification-scheduler

A aplicação utiliza do Spring Actuator para expor dados sobre sua execução.

O docker-compose existente no projeto inclui o Prometheus e o Grafana.
O Prometheus consome os dados fornecidos pela aplicação (actuator), e o Grafana consome esses mesmos dados do Prometheus.
O Grafana é exposto na porta 3000 com usuário admin e senha 123456. Ao logar, será exibido um dashboard com as métricas da aplicação.

A cada entrega de código (push) os testes são executados e a verificação estática de código é realizada.
O novo código só é incorporado (merge) a branch main se tudo for realizado com sucesso.

A cada release é criada uma imagem Docker da versão no Docker Hub.

O deploy no ambiente de homologação do Heroku é realizado ao criar uma pre-release.
O deploy no ambiente de produção do Heroku é realizado ao criar uma release.

URL de homologação: https://notification-scheduler-hom.herokuapp.com URL de produção: https://notification-scheduler-prod.herokuapp.com