Esta wiki contém as diretrizes gerais, boas práticas e ferramentas que governam
o desenvolvimento de software no Datasus, em consonância com as
diretrizes arquiteturais do Ministério da Saúde. As
recomendações descritas aqui devem ser seguidas em todos os projetos e sistemas
no âmbito do Datasus e suas parceiras de desenvolvimento.
As orientações apresentadas neste ambiente não são exaustivas: casos omissos
serão analisados pela COATIC para que sejam adicionados oportunamente.
A iniciação de novos projetos de desenvolvimento ou de internalização será
comunicada pela Coordenação-Geral de Relacionamento, Governança e Projetos
(CGRGP/DATASUS).
A COATIC procederá à avaliação e definição arquitetural em conjunto com as
equipes de desenvolvimento, mediante apresentação prévia do diagrama de
arquitetura e, se possível, do modelo de dados em alto nível, elaborada com base
nos documentos de diretrizes arquiteturais.
As equipes de desenvolvimento deverão atualizar informações sobre a arquitetura
(design, DNS etc.) em ambiente a ser informado pela COATIC.
As áreas demandantes (fábrica de software, área de negócios etc.) deverão abrir
chamado no sistema de demandas de infraestrutura, disponível em
https://demandasdatasus.saude.gov.br:
A COATIC proverá a infraestrutura necessária ao desenvolvimento, assim composta:
O fluxo de trabalho das equipes de desenvolvimento seguirá o modelo
DevSecOps.
A cada entrega de release, a pipeline executará de forma automática a
verificação da qualidade e segurança do código, bem como garantir o ofuscamento
do código para entrada em produção.
A COATIC comunicará as equipes de desenvolvimento sobre eventuais ajustes das
pipelines, que deverão executar as adequações necessárias.
A infraestrutura de desenvolvimento será composta dos seguintes itens:
O banco de dados da aplicação deverá estar no rol homologado pela Coordenação de
Gestão de Banco de Dados (COBD/CGIE/DATASUS) e respeitar a Metodologia de
Administração de Dados (MAD), disponível em
https://datasus.saude.gov.br/metodologia-de-administracao-de-dados-mad/.
A comunicação entre camadas de back-end e front-end deverá seguir o padrão
REST API.
As integrações entre soluções e a obtenção de dados corporativos deverão ser
feitas por meio de chamadas REST a web services.
A concepção de novas soluções deverá ser agnóstica com relação à
infraestrutura de produção, ou seja, não pode estar vinculada a produtos
específicos de provedores nem a fornecedores de soluções externas ao Datasus.
Não é permitido o acoplamento desnecessário a recursos proprietários
(vendor lock-in) de provedores de nuvem, tais como serviços exclusivos de
plataforma, APIs fechadas ou funcionalidades que impeçam a portabilidade da
solução para outros ambientes. Quando um recurso específico de provedor fizer
parte de uma plataforma aprovada para o projeto, a dependência deverá ser
isolada e sua estratégia de portabilidade ou substituição deverá ser
documentada.
As soluções deverão priorizar tecnologias abertas, interoperáveis e portáveis
entre diferentes infraestruturas. Além disso, deverão, preferencialmente,
seguir a arquitetura de microsserviços.
O processamento de requisições com duração superior a 10 segundos deverá
fazer uso de fila de processamento, de forma assíncrona.
A autenticação deverá utilizar o provedor de identidade corporativo
Keycloak, integrado ao Gov.br e às identidades
internas conforme o contexto da solução.
Informações adicionais sobre a integração com o login único Gov.br estão
disponíveis no
roteiro técnico de integração.
A autorização permanecerá sob responsabilidade da solução e deverá observar
os atributos fornecidos pelo token e os mecanismos corporativos aplicáveis,
incluindo o SCPA quando previsto para o projeto.
Nos sistemas em que o Autorizador do Datasus ou o SCPA já façam parte da
arquitetura aprovada, sua continuidade ou transição deverá ser definida com
a COATIC no contexto do projeto.
O código-fonte deverá ser construído com base nas melhores práticas de
nomeação adotadas pela linguagem da solução, sugerindo-se as definições
apresentadas em
https://google.github.io/styleguide/.
A verificação dos padrões de codificação será realizada ao longo da
esteira de desenvolvimento.
Não serão aceitos diferentes padrões na mesma solução, por exemplo: nomeação
de variáveis ou objetos em diferentes idiomas, nem uso simultâneo de estilos
distintos de codificação, tais como:
camelCase);snake_case);kebab-case).A aceitação definitiva das entregas estará condicionada ao uso das tecnologias
abaixo, na versão e no contexto indicados em cada página.
A homologação de uma linguagem, biblioteca, plataforma ou serviço é limitada ao
escopo publicado em sua diretriz específica. A presença de uma tecnologia nesta
Wiki não representa autorização para utilizá-la em outras finalidades.
Tecnologias não listadas, ou utilizadas fora do escopo homologado, deverão ser
submetidas previamente à análise da COATIC. Bibliotecas adicionais seguirão os
critérios de avaliação e autorização definidos na página da respectiva
tecnologia.