Revisão de código - DataWorks: Central de Documentação do Alibaba Cloud

Pré-requisitos

O DataWorks Professional Edition ou uma edição superior deve estar ativado. Para comparar os recursos entre as diferentes edições do DataWorks, consulte Edições do DataWorks. Para ativar o DataWorks, consulte Faturamento.
Você deve ter a função Workspace Administrator. Para mais informações, consulte Usuários, funções e permissões.
Crie um nó para desenvolvimento de dados. Para mais informações, consulte Desenvolvimento de dados no DataStudio (legado).

Informações de fundo

Quando várias tarefas são executadas simultaneamente no DataWorks, as tarefas de alta prioridade recebem precedência na alocação de recursos. Recomendamos impor a revisão de código para tarefas de alta prioridade. Isso evita que códigos não conformes causem falhas, desperdicem recursos e bloqueiem outras tarefas. Ao adicionar essas tarefas ao escopo de revisão obrigatória, os revisores podem verificar a qualidade do código e impedir a implantação de erros no ambiente de produção.

A tabela a seguir descreve como a ativação da revisão obrigatória de código afeta o processo de envio e implantação de nós.

Status da revisão obrigatória de código

Descrição

Impacto nas operações

Desativada

Ao enviar um nó, você pode opcionalmente especificar revisores para notificá-los sobre a alteração.

Nota

Esse método permite notificar qualquer membro do workspace sobre alterações no nó, independentemente da função exercida.

Essa configuração não afeta o processo de envio e implantação do nó. O envio e a implantação ocorrem normalmente.

Ativada

Ao enviar um nó, selecione um revisor qualificado para revisar o código e garantir sua qualidade.

Nota

O envio de uma exclusão de nó não aciona uma revisão de código.

Essa ação bloqueia o processo de envio e implantação do nó até a conclusão da revisão.

Se a revisão for aprovada, o processo de envio e implantação do nó será retomado.
Se a revisão for reprovada, não será possível enviar ou implantar o nó. Corrija os problemas no código e reenvie para revisão até obter aprovação.

Limitações

O recurso de revisão de código está disponível apenas no DataWorks Professional Edition ou em edições superiores.
Somente usuários com a função Workspace Administrator podem ativar ou desativar a revisão de código para um workspace.
A revisão de código não é suportada para certos tipos de nós, como nós compostos (por exemplo, nós for-each e loop) e arquivos de resource que não sejam Python.

Fluxo de trabalho

A tabela abaixo detalha o fluxo de trabalho para utilização da revisão obrigatória de código.

Etapa	Função	Descrição
Ativar a revisão obrigatória de código e definir as configurações	Workspace Administrator	O Workspace Administrator ativa a revisão obrigatória e configura os revisores e o escopo conforme as necessidades do negócio. O recurso só entra em vigor após a ativação. Nota A ativação da revisão obrigatória bloqueia o processo de envio e implantação dos nós afetados.
Iniciar uma revisão de código	Developer	Um Developer inicia a revisão ao enviar um nó. Após a seleção do revisor, o sistema gera um ticket de revisão de código. Nota Em workspaces no modo padrão, Developers podem iniciar revisões em lote na página Deploy. Para mais informações, consulte Implantar nós.
Visualizar e aprovar tickets de revisão de código	Remetente do nó Revisor de código	Tanto o remetente quanto os revisores podem visualizar e gerenciar as revisões iniciadas e pendentes na página Code Review.

Ativar e configurar a revisão obrigatória de código

Faça login no console do DataWorks. Na região desejada, clique em Data Development and O&M > Data Development no painel de navegação à esquerda. Selecione um workspace na lista suspensa e clique em Go to Data Development.
Acesse a página Security Settings and Others.
1. Na página DataStudio, clique no ícone no canto inferior esquerdo para acessar a página Configure.
2. Clique na aba Security Settings and Others na página Configure para ir à página Security Settings and Others.

Ative e configure a revisão obrigatória de código.

Na seção Code Review, ative a opção Force to review code e configure os revisores e o escopo de baseline.

Parâmetro	Descrição
Force to review code	Impõe a revisão de código para nós dentro do escopo especificado no workspace atual. Open: O código dos nós neste workspace exige revisão obrigatória antes da implantação. Especifique revisores; a implantação só ocorre após a aprovação. Essa ação bloqueia o processo de envio e implantação do nó. Nota As opções Code reviewers e Baseline scopes for code review só podem ser configuradas após ativar Force to review code. Close: A implantação do código dos nós neste workspace ocorre sem revisão. Ainda é possível selecionar revisores opcionalmente ao enviar um nó, mas isso serve apenas como notificação e não bloqueia o processo de implantação.
Code reviewers	Define a política para seleção de revisores quando um nó é enviado. Any Developer Role: Após o início da revisão, qualquer usuário com a função Developer no workspace pode aprovar a alteração. O usuário que envia o nó seleciona o revisor específico. Specify development role users: Após o início da revisão, apenas os usuários especificados com a função Developer podem aprovar a alteração. O DataWorks seleciona automaticamente os revisores configurados aqui como padrão ao enviar um nó. Nota Apenas usuários com a função Developer no workspace atual podem ser selecionados como revisores. Se múltiplos revisores forem configurados, a lógica de aprovação dependerá da política escolhida.
Baseline scopes for code review	Define quais nós exigem revisão de código no momento do envio. Selecione os nós que requerem revisão obrigatória com base na prioridade da baseline. A lógica é a seguinte: Se o escopo de revisão for definido para tarefas fora da baseline, as novas tarefas criadas no workspace exigirão aprovação. Se o escopo for definido para tarefas de um nível específico de baseline, os nós nessa baseline exigirão aprovação no envio. Um número maior de baseline indica maior prioridade. Tarefas em baseline têm prioridade superior às tarefas fora da baseline. Para mais detalhes sobre como as baselines controlam a prioridade das tarefas, consulte Visão geral do Smart Baseline.

Iniciar uma revisão de código

Ao enviar um nó, um Developer pode especificar um ou mais revisores. O processo varia conforme o modo do workspace, conforme mostrado na tabela a seguir.

Nota

Se uma nova revisão for iniciada para um nó que já possui uma revisão em andamento, o DataWorks invalidará automaticamente a revisão anterior.
O envio de uma exclusão de nó não aciona uma revisão de código.

Modo do workspace	Processo de revisão	Pontos de entrada para revisão de código
Standard mode	Se a revisão obrigatória estiver ativada, o processo de envio e implantação fica bloqueado até a aprovação. Após a aprovação, o nó é enviado e você pode prosseguir para a página Deploy para implantá-lo.	Iniciar revisão para um único nó Inicie a revisão diretamente na caixa de diálogo de envio. Após enviar o nó, clique no ícone Code Review na barra de ferramentas da página de edição do nó. Iniciar revisão em lote para múltiplos nós Inicie a revisão na caixa de diálogo de envio ao enviar um workflow. Acesse Deploy > Create Deploy Task para iniciar uma revisão em lote para vários nós. Nota Para saber como acessar a página Create Deploy Task, consulte Implantar nós.
Simple mode	Se a revisão obrigatória estiver ativada, selecione Only Initiate Code Review ao enviar um nó. Após a aprovação, envie o nó novamente para implantar o código no ambiente de produção.	Iniciar revisão para um único nó Inicie a revisão diretamente na caixa de diálogo de envio. Iniciar revisão em lote para múltiplos nós Inicie a revisão na caixa de diálogo de envio ao enviar um workflow.

Visualizar e aprovar tickets de revisão de código

Acesse a página Code Review.
Existem duas formas de acessar a página Code Review:
- No canto superior esquerdo da página DataStudio, clique no ícone e escolha All Products > Data Development and O&M > Code Review.
- Na página de edição do nó desejado, clique no ícone Code Review na barra de ferramentas.

Visualize e processe o ticket de revisão de código.

Na página Code Review, visualize a lista de revisões iniciadas por você ou atribuídas a você e processe-as conforme necessário.

Área	Descrição
1 (Abas)	Nesta área, realize as seguintes ações: Revisores podem visualizar e processar suas tarefas atribuídas na aba Review by Me. Remetentes podem visualizar as tarefas de revisão que iniciaram na aba Submitted by Me.
2	Utilize esta área para filtrar tickets de revisão por critérios como status, nome do ticket, tipo, remetente e horário de envio.
3	Esta área exibe informações básicas sobre o ticket, como versão e status, além de permitir abrir os detalhes para processar a revisão. As principais ações incluem: Comparação de versões: Compare as diferenças de código entre versões do nó para entender rapidamente as alterações. Ações do revisor no ticket: Write a comment: Adicione um comentário à versão do nó. Passed: Esta ação aciona o verificador de revisão de código. Após a aprovação na verificação, o remetente pode implantar a tarefa na página Deploy. Nota Para mais informações sobre como implantar uma tarefa, consulte Implantar nós. Not through: O resultado depende se a revisão obrigatória está ativada. Se estiver ativada, bloqueia o envio e a implantação. Se estiver desativada, ainda é possível enviar e implantar o nó. Abandoned: Abandona o processo de revisão atual. Após o abandono, é possível enviar e implantar a versão do nó. Reopen: Caso seja necessário revisar novamente um processo descartado, utilize a opção Reopen.