ItsMyConsole.Tools.AzureDevOps 0.7.1

ItsMyConsole.Tools.AzureDevOps

Outil Azure DevOps (Création/Modification WorkItem) pour le Framework ItsMyConsole

Sommaire

• Pourquoi faire ?
• Getting Started
• Comment se servir de l'outil ?
• Ajout d'une configuration serveur Azure DevOps
• Création d'un WorkItem
• Modification d'un WorkItem
• Récupération des informations d'un WorkItem
• Suppression d'un WorkItem
• Ajout d'une relation entre WorkItems
• Récupération de l'itération courante d'un projet
• Récupération du nom de la configuration Azure DevOps

Pourquoi faire ?

Vous allez pouvoir étendre le Framework pour application Console .Net ItsMyConsole avec un outil de manipulation des WorkItems d'Azure DevOps.

L'outil ItsMyConsole.Tools.AzureDevOps met à disposition :

• La création de WorkItem
• La modification de WorkItem
• La récupération des informations d'un WorkItem
• La suppression d'un WorkItem
• L'ajout de relations entre les WorkItems
• L'itération courante pour un projet

Getting Started

1. Créer un projet "Application Console .Net" avec le nom "MyExampleConsole"
2. Ajouter ItsMyConsole au projet depuis le gestionnaire de package NuGet
3. Ajouter ItsMyConsole.Tools.AzureDevOps au projet depuis le gestionnaire de package NuGet
4. Aller sur le site web de votre serveur Azure DevOps
5. Cliquer sur l'icône de votre profil, puis "Sécurité"
6. Créer un nouveau jeton d'accès personnel, exemple de procédure ici, et faite une sauvegarde de la valeur
7. Dans le projet, modifier la méthode "Main" dans le fichier "Program.cs" par le code suivant :

using ItsMyConsole;
using ItsMyConsole.Tools.AzureDevOps;
using System;
using System.Threading.Tasks;

namespace MyExampleConsole
{
    class Program
    {
        static async Task Main() 
        {
            ConsoleCommandLineInterpreter ccli = new ConsoleCommandLineInterpreter();

            // Console configuration
            ccli.Configure(options => {
                options.Prompt = ">> ";
                options.LineBreakBetweenCommands = true;
                options.HeaderText = "##################\n#  Azure DevOps  #\n##################\n";
                options.TrimCommand = true;
            });

            // Azure DevOps configuration
            ccli.AddAzureDevOpsServer(new AzureDevOpsServer {
                Name = "TEST",
                Url = "https://<SERVEUR>",
                PersonalAccessToken = "<TOKEN>"
            });

            // Display the title of the workitem
            // Example : wi 1234
            ccli.AddCommand("^wi [0-9]*$", async tools => {
                int workItemId = Convert.ToInt32(tools.CommandArgs[1]);
                WorkItem workItem = await tools.AzureDevOps("TEST").GetWorkItemAsync(workItemId);
                Console.WriteLine($"WI {workItemId} - {workItem.Title}");
            });

            await ccli.RunAsync();
        }
    }
}

Voici le résultat attendu lors de l'utilisation de la Console :

Dans cet exemple de code on a configuré avec Configure, le prompt d’attente des commandes options.Prompt, la présence d'un saut de ligne entre les saisies options.LineBreakBetweenCommands et l’en-tête affichée au lancement options.HeaderText.

On ajoute la configuration du serveur Azure DevOps avec AddAzureDevOpsServer et on lui renseigne un nom Name qui permet de différentier si on configure plusieurs serveurs, l'url d'Azure DevOps Url et le jeton d'accès personnel PersonalAccessToken.

Puis avec AddCommand, on a ajouté un pattern d’interprétation des lignes de commande ^wi [0-9]*$ (commence par "wi" et suivi d'un nombre).

Lors de l'exécution de la Console, si on saisit une commande qui commence par "wi" avec un nombre à la suite, il lancera l'implémentation de l'action associée. Dans cet exemple, il récupère l'identifiant du WorkItem en utilisant tools.CommandArgs depuis les outils disponibles (tableau des arguments de la ligne de commande) pour lui permet de récupérer les informations du WorkItem associé avec tools.AzureDevOps("TEST").GetWorkItemAsync (ici "TEST" c'est le nom donné à la configuration du serveur). Avec les informations récupérées, il affiche son titre dans la Console.

Maintenant que l'on a configuré la Console et l'implémentation de l'action associée au pattern ^wi [0-9]*$, l'utilisation de RunAsync lance la mise en attente d'une saisie de commande par l'utilisateur.

Comment se servir de l'outil ?

Tout d'abord, vous devez ajouter une configuration serveur Azure DevOps avec AddAzureDevOpsServeret définir un nom Name. Vous pouvez ensuite accéder à l'outil Azure DevOps lorsque vous ajoutez une interprétation de commande avec AddCommand.
Le nom défini lors de la configuration permet de cibler le serveur lors de l'utilisation de l'outil.

ConsoleCommandLineInterpreter ccli = new ConsoleCommandLineInterpreter();

// Azure DevOps configuration
ccli.AddAzureDevOpsServer(new AzureDevOpsServer {/*  */});

// Add command
ccli.AddCommand("<PATTERN>", async tools => 
{
    WorkItem example = await tools.AzureDevOps("<NAME>").GetWorkItemAsync(1234);
});

Vous devez ajouter using ItsMyConsole.Tools.AzureDevOps; pour avoir accès a l'outil Azure DevOps depuis tools de AddCommand.

Ajout d'une configuration serveur Azure DevOps

Vous pouvez ajouter une configuration d'un serveur Azure DevOps en utilisant AddAzureDevOpsServer.

ConsoleCommandLineInterpreter ccli = new ConsoleCommandLineInterpreter();

// Azure DevOps configuration
ccli.AddAzureDevOpsServer(new AzureDevOpsServer {
    Name = "TEST",
    Url = "https://<SERVEUR>",
    PersonalAccessToken = "<TOKEN>"
});

Si vous avez plusieurs serveurs Azure DevOps, le nom Name permet de cibler celui que vous voulez lors de la manipulation des WorkItems.

Création d'un WorkItem

Vous pouvez créer des WorkItems en utilisant CreateWorkItemAsync.

ccli.AddCommand("<PATTERN>", async tools => 
{
    WorkItem newWorkItem = await tools.AzureDevOps("<NAME>")
                                      .CreateWorkItemAsync(new WorkItemCreateFields {
                                          // Insert yours fields here
                                      });
});

Vous pouvez modifier les champs suivants :

Vous avez en retour un objet de type WorkItem.

Modification d'un WorkItem

Vous pouvez modifier un WorkItem en utilisant UpdateWorkItemAsync.

Vous avez aussi la possibilité de modifier un WorkItem en lui passant directement l'objet WorkItem. De cette façon, il permettra d'effectuer la mise à jour seulement si le Workitem n'a pas été modifié depuis la lecture de l'objet passé en paramètre. Par exemple, on récupére les informations du Workitem, on vérifie que les données soient correctes et puis on le modifie avec de nouvelles valeurs. Si entre la lecture et la modification, le WorkItem a été changé, alors notre mise à jour échouera. Si vous ne voulez aucune vérification de contrôle, vous devez passer l'identifiant du WorkItem au lieu de l'objet.

ccli.AddCommand("<PATTERN>", async tools => 
{
    await tools.AzureDevOps("<NAME>").UpdateWorkItemAsync(1234, new WorkItemUpdateFields 
    {
        // Insert yours fields here
    });
});

Vous pouvez modifier les champs suivants :

Vous avez en retour un objet de type WorkItem.

Récupération des informations d'un WorkItem

Vous pouvez récupérer les informations d'un WorkItem en utilisant GetWorkItemAsync.

ccli.AddCommand("<PATTERN>", async tools => 
{
    WorkItem workItem = await tools.AzureDevOps("<NAME>").GetWorkItemAsync(1234);
});

Vous avez en retour un objet de type WorkItem.

Suppression d'un WorkItem

Vous pouvez supprimer un WorkItem en utilisant DeleteWorkItemAsync.

ccli.AddCommand("<PATTERN>", async tools => 
{
    await tools.AzureDevOps("<NAME>").DeleteWorkItemAsync(1234);
});

Ajout d'une relation entre WorkItems

Vous pouvez ajouter des relations entre WorkItems en utilisant AddWorkItemRelationAsync pour une seule relation et AddWorkItemRelationsAsync pour en ajouter plusieurs.

ccli.AddCommand("<PATTERN>", async tools => 
{
    WorkItem workItemToAdd = await tools.AzureDevOps("<NAME>").GetWorkItemAsync(5678);
    await tools.AzureDevOps("<NAME>").AddWorkItemRelationAsync(1234, workItemToAdd, LinkType.Child);
});

Vous avez en retour un objet de type WorkItem.

Récupération de l'itération courante d'un projet

Vous pouvez récupérer l'itération courante d'un projet en utilisant GetCurrentIterationAsync.

ccli.AddCommand("<PATTERN>", async tools => 
{
    Iteration iteration = await tools.AzureDevOps("<NAME>").GetCurrentIterationAsync("<PROJECT>");
});

Vous avez en retour un objet de type Iteration.

Récupération du nom de la configuration Azure DevOps

Vous pouvez récupérer le nom de la configuration Azure DevOps en utilisant GetAzureDevOpsServerName.

ccli.AddCommand("<PATTERN>", async tools => 
{
    string serverName = tools.AzureDevOps("<NAME>").GetAzureDevOpsServerName();
});