Configurar CI utilizando sonarcloud

[sergiosacj]

Descrição

Configurar CI utilizando sonarcloud.

Como solucionar

Opções mais simples de configurar:

• Github Actions;
• Gitlab CI.

Critérios de aceitação

• CI configurada para executar para todo push;
• Repositório bloquear merge de PRs com CI falhando.

[sergiosacj]

No momento será usada a mesma issue tanto para o frontend quando para o backend, já que a pessoa que for configurar o sonarclound será responsável por fazer isso em todos os repositórios.

[sergiosacj]

Formalização do Requisito:

a) a chamada a api do sonar deve ser orquestrada em um pipeline, para cada repositório de código-fonte (microsserviço)

b) deve haver a automação que execute o suite de testes automatizados e “informe” o relatório da execução ao sonarclooud. Faz-se necessário que haja, em cada repositório, o arquivo sonar-project.properties, devidamente configurado. OBS: Atenção a exclusão dos diretórios que não contem arquivos de código-fonte, como por exemplo, diretório com arquivos de testes.

c) no repositório de documentação, criar uma pasta/diretório com o seguinte nome: analytics-raw-data . Esta pasta deverá conter os TODOS arquivos gerados com as métricas fornecidas pelo sonar, para cada versão do produto (releases major e minor; PR fechado).

d) criar uma função no respectivo pipeline para disponibilizar o arquivo coletado com as métricas das versões de produto, no diretorio .

e) a cada versão de produto gerada nos repositórios, vocês precisarão disponibilizar, via assets, no GitHub, o arquivo .JSON extraído do serviço do SonarCloud.io, na organização da disciplina.

f) o nome do arquivo arquivo .json a ser gerado deve seguir o seguinte formato: fga-eps-mds-YYYY_SEMESTRE_UNB-NOME_PROJETO-NOME_REPOSITORIO-DATA_HORA_RELEASE-VERSAO_RELEASE onde:

1. DATA_HORA_RELEASE deve ter o formato MM-DD-YYYY-HH-MM-SS

2. VERSAO_RELEASE = vX.Y.Z sendo: X é a versão principal (ou major); Y é a versão secundária (ou minor); Z é a versão de correção rápida (ou patch); e, X, Y e Z pertencem ao conjunto dos números inteiros positivos
   Exemplo:

fga-eps-mds-2021-2-CartografiaSocial-front-05-07-2022-04-51-38-v3.0.1.json

g) O sonarcloud faz a integração automática com seus repositórios na organização da disciplina, sem necessitar de um trigger externo.
Para adicionar os repositórios na organização do sonacloud das disciplinas você precisa ter a permissão de owner no github. Portanto, aqueles responsáveis pela administração dos diferentes ambientes. @team-env-admin Assim:

g.1) crie sua conta na organização do sonacloud com o mesmo usuário do github
https://sonarcloud.io/organizations/fga-eps-mds-1/projects?sort=name

g.2) adicione cada repositório de código-fonte(microsserviços) na organização das disciplinas

Exemplo da configuração do arquivo sonar-project.properties
https://github.com/fga-eps-mds/MeasureSoftGram-CLI/blob/develop/sonar-project.properties

Atenção à propriedade sonar.sources.exclusions. É importante para a validade dos dados coletados que somente arquivos de código-fonte sejam processados.

Exemplo de um pipeline orquestrado para geração do arquivo de coleta (data point):
https://github.com/fga-eps-mds/MeasureSoftGram-CLI/blob/develop/.github/workflows/metrics.yml

Exemplo de um dataset coletado ao longo do desenvolvimento em um semestre:
https://github.com/fga-eps-mds/2022-2-MeasureSoftGram-Doc/tree/main/analytics-raw-data

Documentação do sonar sobre a configuração para coleta das métricas de teste:

1. Cobertura
   https://docs.sonarcloud.io/enriching/test-coverage/test-coverage-parameters/

2. Execução dos testes automatizados
   https://docs.sonarcloud.io/enriching/test-coverage/test-execution-parameters/