monanadmin / monan

Repositório organizacional das atividades dos macro-grupos do MONAN - Model for Ocean-laNd-Atmosphere PredictioN
14 stars 10 forks source link

[GCC] GRC: Ferramenta Understand - 2 #470

Closed joaomas closed 2 months ago

joaomas commented 3 months ago

:people_holding_hands: User Story

COMO Saulo, QUEREMOS Testar e investigar o funcionamento da ferramenta Understand PARA Adiantar o conhecimento de seu funcionamento em futura aquisição.

:clipboard: Critérios de aceite de conclusão da Issue

:pencil: Detalhamento adicional da atividade

-.

:comet: Impactos

-.

:link: Dependências

469

:hammer_and_wrench: Solução

Understanding é uma ferramenta de análise estática focada na compreensão do código-fonte, métricas, e testes de padrões. Ele foi projetado para ajudar a manter e compreender grandes quantidades de código-fonte legado ou recém-criado. Ele fornece uma plataforma cruzada, multilíngue, IDE orientado para manutenção (ambiente de desenvolvimento interativo)." https://documentation.scitools.com/pdf/understand.pdf

Analise Qualitativa

1. [] Investigar a ferramenta e gerar um relatório com as impressões. [Sprint 59]

2. Detalhes de bug indentification Não possui.

3. Detalhes de checagem de regras Codecheck Os scripts CodeCheck são scripts especiais em Python ou Perl que permitem criar verificações personalizadas para verificar os padrões de codificação da sua equipe. Eles podem ser usados para verificar a nomenclatura diretrizes, requisitos de métricas, melhores práticas publicadas ou quaisquer outras regras ou convenções que são importantes para sua equipe" https://support.scitools.com/support/solutions/articles/70000583282-codecheck-overview

Automatização via linha de comando: https://support.scitools.com/support/solutions/articles/70000583271-running-codecheck-from-the-command-line

4. Detalhes de test coverage Não possui.

5. Como pode ser usado (quais regras) na DTN01 O Understand tem algumas verificações e permite o uso de scripts para "outras regras ou convenções que são importantes para sua equipe", emitindo relatórios dessas verificações. Permite inserção de regras via API Especificamente sobre as regras da DTN01 até o momento ela não atende.

6. Testar um caso "real" de uso ou se encontrado na documentação não há necessidade do teste "real". Não foi necessário rodar um caso real, as respostas foram obtidas por documentação. De todo modo temos a issue #471 para uma primeira experimentação da ferramenta.

7. Verificar existência de APIs O Understand disponibiliza APIs para linguagens Python e Perl. A API para python poderia ser usada para elaboração dos scripts de customização de regras como as definidas pelo documento DTN01. https://github.com/stinb/plugins

8. Verificar dependências de biblioteca e SO's SOs: . Windows x64 (Windows 10.1809 and later), . Linux 64bit (CentOS and RHEL 8.4, Ubuntu 20.04, and later) . Mac OS (Big Sur 11 and later) Intel and Apple Silicon are both supported Ref. https://support.scitools.com/support/solutions/articles/70000583176-system-requirements-supported-oses

Fortran: . Understand suporta FORTRAN 77, Fortran 90, Fortran 95, Fortran 2003, e Fortran 2008.

:rotating_light: Problemas encontrados

-.

:white_check_mark: Conclusão

:spiral_calendar: Trabalhos Futuros

-.