DataWorks:Revue de code

Prérequis

• Vous disposez de DataWorks Professional Edition ou d'une édition supérieure. Pour comparer les fonctionnalités des différentes éditions de DataWorks, consultez Éditions de DataWorks. Pour activer DataWorks, reportez-vous à la section Facturation.

• Vous disposez du rôle Workspace Administrator. Pour plus d'informations, consultez la page Utilisateurs, rôles et autorisations.

• Vous avez créé un nœud pour le développement de données. Pour plus d'informations, consultez la section Développement de données dans DataStudio (ancienne version).

Contexte

Lorsque plusieurs tâches s'exécutent simultanément dans DataWorks, les tâches prioritaires bénéficient d'une priorité d'accès aux ressources. Il est recommandé d'imposer la revue de code pour les tâches prioritaires. Cela permet d'éviter que du code non conforme ne provoque des échecs susceptibles de gaspiller des ressources et de bloquer d'autres tâches. En ajoutant ces tâches à la portée de la revue de code obligatoire, les réviseurs peuvent vérifier la qualité du code et empêcher le déploiement d'erreurs dans l'environnement de production.

Limites

• La fonctionnalité de revue de code est disponible uniquement dans DataWorks Professional Edition ou une édition supérieure.

• Seuls les utilisateurs disposant du rôle Workspace Administrator peuvent activer ou désactiver la revue de code pour un espace de travail.

• La revue de code n'est pas prise en charge pour certains types de nœuds, tels que les nœuds composites (par exemple, les nœuds for-each et loop) et les fichiers de ressources non Python.

Flux de travail

Activer et configurer la revue de code obligatoire

1. Connectez-vous à la console DataWorks. Dans la région cible, cliquez sur Data Development and O&M > Data Development dans le volet de navigation de gauche. Sélectionnez un espace de travail dans la liste déroulante et cliquez sur Go to Data Development.

2. Accédez à la page Security Settings and Others.

   1. Sur la page DataStudio, cliquez sur l'icône en bas à gauche pour accéder à la page Configure.

   2. Cliquez sur l'onglet Security Settings and Others de la page Configure pour accéder à la page Security Settings and Others.

3. Activez et configurez la revue de code obligatoire.

   Dans la section Code Review, activez l'option Force to review code, puis configurez les réviseurs et la portée de la ligne de base.

   Paramètre	Description
   Force to review code	Impose la revue de code pour les nœuds situés dans la portée spécifiée de l'espace de travail actuel. Open : Le code des nœuds de cet espace de travail nécessite une revue de code obligatoire avant le déploiement. Vous devez spécifier des réviseurs et vous ne pouvez déployer le code qu'après approbation de la revue. Cette action bloque le processus de validation et de déploiement du nœud. Remarque Vous pouvez configurer les options Code reviewers et Baseline scopes for code review uniquement après avoir activé l'option Force to review code. Close : Vous pouvez déployer le code des nœuds de cet espace de travail sans revue de code. Vous pouvez toujours sélectionner facultativement des réviseurs lors de la validation d'un nœud, mais cela sert uniquement de notification et ne bloque pas le processus de déploiement.
   Code reviewers	Définit la politique de sélection des réviseurs lors de la validation d'un nœud. Any Developer Role : Après l'initiation d'une revue de code, tout utilisateur disposant du rôle Developer dans l'espace de travail peut approuver la modification. L'utilisateur qui valide le nœud sélectionne le réviseur spécifique. Specify development role users : Après l'initiation d'une revue de code, seuls les utilisateurs spécifiés disposant du rôle Developer peuvent approuver la modification. DataWorks sélectionne par défaut les réviseurs configurés ici lorsque vous validez un nœud. Remarque Vous pouvez sélectionner uniquement des utilisateurs disposant du rôle Developer dans l'espace de travail actuel comme réviseurs. Si vous configurez plusieurs réviseurs, la logique d'approbation dépend de la politique choisie.
   Baseline scopes for code review	Définit quels nœuds nécessitent une revue de code lors de la soumission. Vous pouvez sélectionner les nœuds nécessitant une revue de code obligatoire en fonction de leur priorité de ligne de base. La logique est la suivante : Si vous définissez la portée de la revue sur les tâches hors ligne de base, les tâches nouvellement créées dans l'espace de travail nécessitent une approbation. Si vous définissez la portée de la revue sur les tâches d'un niveau de ligne de base spécifique, les nœuds de cette ligne de base nécessitent une approbation lors de la soumission. Un numéro de ligne de base plus élevé indique une priorité plus élevée. Les tâches de ligne de base ont une priorité plus élevée que les tâches hors ligne de base. Pour plus d'informations sur la manière dont les lignes de base contrôlent la priorité des tâches, consultez la page Présentation de Smart Baseline.

Initier une revue de code

Consulter et approuver les tickets de revue de code

1. Accédez à la page Code Review.

   Vous pouvez accéder à la page Code Review de l'une des manières suivantes :

   • Dans le coin supérieur gauche de la page DataStudio, cliquez sur l'icône et choisissez All Products > Data Development and O&M > Code Review.

   • Sur la page d'édition du nœud cible, cliquez sur l'icône Code Review dans la barre d'outils.

2. Consultez et traitez le ticket de revue de code.

   Sur la page Code Review, vous pouvez consulter la liste des revues que vous avez initiées ou qui vous sont assignées, et les traiter selon vos besoins.

   Zone	Description
   1 (Onglets)	Dans cette zone, vous pouvez effectuer les actions suivantes : Les réviseurs peuvent consulter et traiter leurs tâches de revue assignées dans l'onglet Review by Me. Les soumetteurs peuvent consulter les tâches de revue qu'ils ont initiées dans l'onglet Submitted by Me.
   2	Dans cette zone, vous pouvez filtrer les tickets de revue de code selon des critères tels que le statut de la revue, le nom du ticket, le type, le soumetteur et l'heure de soumission.
   3	Dans cette zone, vous pouvez consulter les informations de base d'un ticket de revue de code, telles que sa version et son statut de revue, ou ouvrir ses détails pour traiter la revue. Les actions clés incluent : Comparaison des versions : Comparez les différences de code entre les versions de nœuds pour comprendre rapidement les modifications. Actions du réviseur sur un ticket : Write a comment : Ajoutez un commentaire à la version du nœud. Passed : Cette action déclenche le vérificateur de revue de code. Après réussite de la vérification, le soumetteur peut déployer la tâche depuis la page Deploy. Remarque Pour plus d'informations sur le déploiement d'une tâche, consultez la page Déployer des nœuds. Not through : Le résultat dépend de l'activation ou non de la revue de code obligatoire. Si elle est activée, cela bloque la validation et le déploiement. Si elle est désactivée, vous pouvez toujours valider et déployer le nœud. Abandoned : Abandonne le processus de revue actuel. Après l'abandon du processus, vous pouvez valider et déployer la version du nœud. Reopen : Si vous devez revoir un processus de revue abandonné, vous pouvez utiliser l'option Reopen.