Relatório de Qualidade - fga-eps-mds/2017.1-Cadernos-API GitHub Wiki

Histórico de Revisão

Data	Versão	Modificação	Autor
18/04/2017	1.0.0	Resultados do acompanhamento da qualidade	Fábio Teixeira

---

Sumário

1. Introdução
2. Resultados
   1. 2ª Iteração
      1. Code Climate
   2. 3ª Iteração
      1. Code Climate
      2. Tavis
      3. Coveralls
      4. Pull Requests
      5. Heroku
3. Conclusão

1. Introdução

Este documento visa registrar o acompanhamento que é realizado sob os aspectos de qualidade do projeto, conforme definido no Plano de Gerenciamento de Qualidade.

2. Resultados

2ª Iteração

Ao final da 2ª iteração, foi iniciado o desenvolvimento da API em Ruby on Rails, nessa iteração apenas configurações da API e ambientes Travis, Heroku e Coveralls foram executadas:

Code Climate:

GPA:

3ª Iteração

Seguindo o nosso cronograma, na 3ª iteração deveriam ser implementado os casos de uso: Manter usuários, Manter atividades, Visualizar cadernos. Seguem os resultados obtidos pelas ferramentas indicadas no Plano de Gerenciamento de Qualidade para essa iteração:

Code Climate:

GPA:

Cada ponto na imagem apresenta um arquivo, são mostrados os arquivos com impacto relevante. Quanto mais acima e mais a direita, pior, consequentemente modificando a cor numa escala de verde a vermelho. O arquivo amarelo indicado no gráfico é o "db/schema.rb" onde, por ser sempre gerado automaticamente pelo rails será colocado nos ignores do code climate.

Tavis:

Log de Pull Requests direcionados a branch homolog, estes só foram aceitos após passarem pelos testes no Travis e a devida análise de pelo menos um membros de GPP observando os parâmetros definidos no documento Plano de gerenciamento de configuração de software no tópico 3.4. Política de aprovação de código.

Coveralls

Pull Requests

Pull requests devidamente avaliados pelos membros de GPP como descrito no tópico 3.4. Política de aprovação de código do Plano de gerenciamento de configuração de software.

• PR Manter usuários

• PR Manter atividades

• PR Visualizar cadernos

Heroku

Deploy automático no Heroku feito pelas builds do Travis sobre a branch homolog.

3. Conclusão

Com base nos dados obtidos pelas ferramentas de qualidade definidas e nas iterações 2ª e 3ª, podemos concluir que serão necessárias algumas mudanças na configuração do code climate, visto que este está abaixando a nossa nota GPA com arquivos de deveriam ser ignorados(como pode ser observado no quadro Churn vs Quality).

Um fator importante a se notar e ao mesmo tempo preocupante a longo prazo, é a falsa sensação de segurança gerada pela alta cobertura de código demostrada pelo Coveralls, já que não foram testados os uploads de arquivos, algo que é considerado de extrema importância para o aplicativo, mas que mesmo assim não deixou que a cobertura caísse ao ponto de demonstrar essa falha no desenvolvimento dos testes da API. Sendo assim, podemos entrar em consenso que pontos chave da API e do aplicativo deverão ser observados com mais cautelosidade já que não podemos confiar cegamente nos números gerados pelas ferramentas.