fiap-tech-challenge-api

Justificativa do Padrão SAGA escolhido:

Optamos por usar o padrão SAGA Coreografado pois como a implementação foi de baixa complexidade, e apenas uma mensagem foi enviada por um microsserviço e escutada por outro, e segundo o que foi dito nas aulas SAGA's com poucas chamadas não teriam a necessidade de utilizar algo orquestrado, a nossa escolha foi de usar o padrão de coreografia no serviço SQS da AWS.

OWASP ZAP:

Como executamos o relatório e nenhuma vulnerabilidade alta foi encontrada, executamos o mesmo apenas uma vez, segue o link do mesmo:

https://github.com/victorts1991/fiap-tech-challenge-api/blob/main/ZAP-Report.html

RIPD:

https://github.com/victorts1991/fiap-tech-challenge-api/blob/main/RIPD.pdf

Desenho da Arquitetura:

https://miro.com/app/board/uXjVKus1xAY=/

Tech Challenge 4 e 5:

Passos para homologação dos professores da Fiap

1. Faça o login na plataforma da AWS;
2. Crie um repositório privado no ECR da AWS chamado fiap-tech-challenge-api;
3. Acesse IAM->Usuários e crie um novo usuário chamado Github;
4. Com esse usuário criado, vá até a listagem de usuários e acesse os detalhes do mesmo;
5. No menu Permissões que irá aparecer na tela de detalhes, clique no botão "Adicionar permissões" que aparece no canto direito;
6. Na tela que irá aparecer, selecione a opção "Anexar políticas diretamente";
7. Pesquise pela permissão "AmazonEC2ContainerRegistryPowerUser" e adicione ela;
8. Após isso, de volta a tela de detalhes do usuário, clique na aba "Credenciais de Segurança", e no bloco "Chaves de acesso", clique em "Criar chave de acesso";
9. Na tela que irá se abrir, selecione a opção "Command Line Interface (CLI)" e clique em próximo;
10. No valor da etiqueta, coloque o valor "github actions" ou qualquer um que prefira para identificar posteriormente;
11. Copie os valores dos campos "Chave de acesso" e "Chave de acesso secreta";
12. Na plataforma do Github, acesse o menu "Settings" do projeto, na tela que se abrir, clique no menu Security->Secrets and variables->Actions;
13. Adicione uma "repository secret" chamada AWS_ACCESS_KEY_ID com o valor copiado de "Chave de acesso", e crie outra "repository secret" chamada AWS_SECRET_ACCESS_KEY com o valor copiado de "Chave de acesso secreta";
14. Vincule este projeto no Sonar Cloud:

https://sonarcloud.io/

15. Acesse seu projeto no Sonar Cloud e vá até o menu Administration->Analisys Method e desmarque a opção "Automatic Analysis";
16. Depois vá até o menu Administration->Update Key e copie o valor de Project Key;
17. No menu Account que está no canto superior direito com a foto de seu usuário, acesse o menu My Organizations e copie o valor da Organization Key;
18. Depois novamente no menu Account, acesse My Account->Security e crie um novo token e copie o seu valor;
19. Retorne até o menu Settings do seu projeto do Github e cadastre novas "repository secret" conforme explicado abaixo:

SONAR_PROJECT_KEY=Valor copiado no passo 16
SONAR_ORGANIZATION=Valor copiado no passo 17
SONAR_TOKEN=Valor copiado no passo 18

20. Após isso qualquer commit neste repositório que for para a branch "main", irá subir uma imagem desta api no ECR da AWS;

Evidência da cobertura dos testes unitários

Tech Challenge 3:

Passos para homologação dos professores da Fiap

1. Faça o login na plataforma da AWS;
2. Crie um repositório privado no ECR da AWS chamado fiap-tech-challenge-api;
3. Acesse IAM->Usuários e crie um novo usuário chamado Github;
4. Com esse usuário criado, vá até a listagem de usuários e acesse os detalhes do mesmo;
5. No menu Permissões que irá aparecer na tela de detalhes, clique no botão "Adicionar permissões" que aparece no canto direito;
6. Na tela que irá aparecer, selecione a opção "Anexar políticas diretamente";
7. Pesquise pela permissão "AmazonEC2ContainerRegistryPowerUser" e adicione ela;
8. Após isso, de volta a tela de detalhes do usuário, clique na aba "Credenciais de Segurança", e no bloco "Chaves de acesso", clique em "Criar chave de acesso";
9. Na tela que irá se abrir, selecione a opção "Command Line Interface (CLI)" e clique em próximo;
10. No valor da etiqueta, coloque o valor "github actions" ou qualquer um que prefira para identificar posteriormente;
11. Copie os valores dos campos "Chave de acesso" e "Chave de acesso secreta";
12. Na plataforma do Github, acesse o menu "Settings" do projeto, na tela que se abrir, clique no menu Security->Secrets and variables->Actions;
13. Adicione uma "repository secret" chamada AWS_ACCESS_KEY_ID com o valor copiado de "Chave de acesso", e crie outra "repository secret" chamada AWS_SECRET_ACCESS_KEY com o valor copiado de "Chave de acesso secreta";
14. Após isso qualquer commit neste repositório que for para a branch "main", irá subir uma imagem desta api no ECR da AWS;

Tech Challenge 2:

Passos para homologação dos professores da Fiap

Foi utilizado o Ubuntu como sistema operacional no passo a passo abaixo, além disso, o computador estava com o docker instalado:

1. Crie uma conta e um projeto na plataforma do Google Cloud Platform (GCP), como exemplo neste passo a passo vamos supor que o nome do projeto criado é "fiap-pos-tech-arquitetura";

2. Ative o Container Registry no GCP;

3. Instale a CLI do GCloud através das instruções do link a abaixo:

https://cloud.google.com/sdk/docs/install?hl=pt-br

4. Definar o projeto no GCP em que vai atuar:

# gcloud config set project PROJECT_ID
gcloud config set project fiap-pos-tech-arquitetura

5. Faça a autenticação e configure o docker:

sudo usermod -a -G docker ${USER}

gcloud auth login

gcloud auth configure-docker

Obs: Caso você execute o docker com o sudo, é necessário executar os comandos acima com o sudo também.

6. Execute os seguintes comandos abaixo na raiz do projeto para subir uma imagem da api no Container Registry do GCP, considere que no exemplo o nome da imagem será "fiap-tech-challenge-api":

docker build -t fiap-tech-challenge-api .

docker tag fiap-tech-challenge-api gcr.io/fiap-pos-tech-arquitetura/fiap-tech-challenge-api:latest

docker push gcr.io/fiap-pos-tech-arquitetura/fiap-tech-challenge-api:latest

7. Após isso, no GCP ative o Kubernetes Engine API, este passo poderá levar alguns minutos;

8. Após isso vá até a tela de Clusters no menu "Kubernetes Engine->Clusters" e clique em "CREATE", caso a tela de criação de cluster autopilot seja aberta, clique no botão superior direiro com o label "switch to standard cluster", é necessário que seja criado um cluster standard pois o servidor de métricas usado pelo HPA não funcionará em um cluster autopilot. Neste passo a passo, um cluster com as configurações padrões já serão suficiente. Após o procedimento de criação do cluster ser finalizado por você, o GCP poderá levar alguns minutos para finalizar;

9. Após o GCP terminar de criar o cluster, clique sobre o nome do mesmo, e na tela que se abrir clique no botão no topo da página chamado "CONNECT", um modal irá se abrir, para facilitar a conexão com o cluster e não termos problemas na instalação de algumas bibliotecas na máquina local, clique em "RUN IN CLOUD SHELL";

10. Será aberto no rodapé uma janela que se assemelha a um terminal, após o comando de conexão com o cluster aparecer automaticamente, apenas clique em "ENTER", uma janela de confirmação com o título "Authorize Cloud Shell" irá aparecer, apenas confirme clicando em "AUTHORIZE";

11. Voltando ao projeto, altere o nome da imagem no arquivo infra/api-go/api-deployment.yaml para o nome da imagem que você subiu no Container Registry

12. Crie um arquivo .zip da pasta chamada "infra" deste projeto, o nome do arquivo deverá ficar como "infra.zip";

13. De volta ao terminal do Cloud Shell do GCP, clique no ícone de três pontos no canto superior direito do mesmo e depois na opção "UPLOAD", faça o upload do arquivo infra.zip que acabou de criar;

14. Ainda no Cloud Shell, execute a seguinte sequência de comandos abaixo:

unzip infra.zip

cd infra/

kubectl apply -f secrets.yaml

cd metrics-server/

# Metrics server downloaded from https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml
kubectl apply -f components.yaml

cd ../mysql/

kubectl apply -f mysql-pv.yaml

kubectl apply -f mysql-svc.yaml

kubectl apply -f mysql-deployment.yaml

cd ../api-go/

kubectl apply -f api-hpa.yaml

kubectl apply -f api-svc.yaml

kubectl apply -f api-deployment.yaml

14. O servidor de métricas pode levar de 5 minutos ou até mais para começar a coletar as métricas corretamente, para verificar se o mesmo já está funcionando execute o comando abaixo:

kubectl get hpa --watch

Caso a coluna "TARGETS" esteja com um valor de "/80%", então o mesmo ainda não está funcionando, quando começar a aparecer algum número antes do /80%, por exemplo assim "0%/80%", então o mesmo começou a funcionar;

15. De volta a interface do GCP, vá até o menu "Kubernetes Engine->Gateways, Services & Ingress" e copie o valor da coluna "Endpoints" da linha com o nome "api-svc", o valor copiado será algo semelhante a "http://34.41.255.86:3000";

A verficação de um endpoint com este valor seria assim por exemplo: http://34.41.255.86:3000/liveness

16. Após isso, abra o Insomnia e importe as collections que estão no arquivo:

/docs/insomnia_collection

17. Altere o valor da varíavel de ambiente base_url com o valor copiado da coluna "Endpoints", isso é possível abrindo as collections importadas e clicando na roldana ao lado de "Base Environment";

Tech Challenge 1:

Passos para homologação dos professores da Fiap

1. Faça o git clone do projeto:

git clone https://github.com/rhuandantas/fiap-tech-challenge-api.git

2. Cadastre a pasta /docker no File Sharing de seu Docker local.

3. Execute o seguinte comando na raiz do projeto:

docker-compose up --build

4. Importe as collections do Insomnia que estão no link abaixo:

https://github.com/rhuandantas/fiap-tech-challenge-api/blob/main/docs/insomnia_collection

Obs: Somente os status abaixo são válidos para executar os endpoints: atualiza status e lista por status:

1. "recebido"
2. "em_preparacao"
3. "pronto"
4. "finalizado"

---

this go application needs go version 1.20 or later

---

export env variables

export DB_HOST=
export DB_PORT=
export DB_NAME=
export DB_PASS=
export DB_USER=

to run application locally

go mod download
go run .

to run via docker

docker compose up

to access swagger doc

http://localhost:3000/docs/index.html

Development

Requirements

install libs

go install github.com/google/wire/cmd/wire@latest
go install github.com/swaggo/swag/cmd/swag@latest
go get -u github.com/swaggo/swag
go get -u github.com/google/wire/cmd/wire

to update swagger files

swag init

to update dependency injection file

delete wire_gen.go
go generate ./...