Intégration de Cake et TeamCity

Cake est un excellent outil pour créer un pipeline de livraison pour vos applications. Je l'aime parce qu'il me permet d'écrire ce pipeline en C #, que je connais bien. Une grande fonctionnalité de Cake, PSake et d'autres frameworks similaires est qu'ils créent un script qui peut être exécuté à la fois sur la machine du développeur local et sur les serveurs CI. Ici, je vais expliquer comment organiser l'interaction du script Cake avec TeamCity .

Prérequis

Je suppose que vous avez déjà des connaissances de base sur Cake et TeamCity. Sinon, vous pouvez commencer par lire les ressources suivantes:

Pour le gâteau:

• Site Internet
• Cours Pluralsight

Pour TeamCity:

• Documents et démos
• Documentation en ligne

Parlons maintenant de l'interaction de Cake et TeamCity.

Journalisation

Le pipeline Cake comprend généralement plusieurs tâches. Ce serait formidable d'avoir une section distincte pour chacune de ces tâches dans le journal TeamCity. Je voudrais obtenir une section pliable pour chaque tâche Cake dans le journal:

L'API Cake a les méthodes TeamCity.WriteStartBuildBlock et TeamCity.WriteEndBuildBlock . Bien qu'il soit possible de les utiliser dans chaque tâche, il peut être automatisé. Cake a des méthodes TaskSetup et TaskTeardown qui sont appelées avant et après chaque tâche. Ils peuvent ouvrir et fermer des blocs de journaux TeamCity:

TaskSetup(setupContext => { if(TeamCity.IsRunningOnTeamCity) { TeamCity.WriteStartBuildBlock(setupContext.Task.Name); } }); TaskTeardown(teardownContext => { if(TeamCity.IsRunningOnTeamCity) { TeamCity.WriteEndBuildBlock(teardownContext.Task.Name); } }); 

Ici, la propriété TeamCity.IsRunningOnTeamCity est utilisée pour déterminer si le code de TeamCity est sauté ou non.

Maintenant, dans notre magazine, il y a des blocs pliables pour chaque tâche. Mais une amélioration supplémentaire peut être ajoutée.

En règle générale, les tâches dans Cake ont des noms courts: Build , Test , Clean . Ils sont donc plus faciles à exécuter à partir de la ligne de commande. Mais dans TeamCity, je préfère avoir des descriptions de tâches Cake plus détaillées. Et c'est possible de le faire. Pour donner une description à la tâche, utilisez la méthode Description :

 Task("Clean") .Description("Create and clean folders with results") .Does(() => { ... }); 

Maintenant, ces descriptions peuvent être utilisées pour former des blocs dans le journal:

 TaskSetup(setupContext => { if(TeamCity.IsRunningOnTeamCity) { TeamCity.WriteStartBuildBlock(setupContext.Task.Description ?? setupContext.Task.Name); } }); TaskTeardown(teardownContext => { if(TeamCity.IsRunningOnTeamCity) { TeamCity.WriteEndProgress(teardownContext.Task.Description ?? teardownContext.Task.Name); } }); 

Cela améliore sa lisibilité.

Progrès réalisés

Si le script Cake prend du temps, il est utile de savoir quelle tâche est en cours d'exécution.

Cela peut être réalisé à l'aide des méthodes TeamCity.WriteStartProgress et TeamCity.WriteEndProgress . Leurs appels peuvent être insérés dans les mêmes TaskSetup et TaskTeardown :

 TaskSetup(setupContext => { if(TeamCity.IsRunningOnTeamCity) { TeamCity.WriteStartBuildBlock(setupContext.Task.Description ?? setupContext.Task.Name); TeamCity.WriteStartProgress(setupContext.Task.Description ?? setupContext.Task.Name); } }); TaskTeardown(teardownContext => { if(TeamCity.IsRunningOnTeamCity) { TeamCity.WriteEndProgress(teardownContext.Task.Description ?? teardownContext.Task.Name); TeamCity.WriteEndBuildBlock(teardownContext.Task.Description ?? teardownContext.Task.Name); } }); 

Résultats des tests

Si vous exécutez des tests dans la tâche Cake, TeamCity est en mesure de vous montrer leurs résultats.

Cela peut être fait à l'aide de la méthode TeamCity.ImportData . Il prend deux paramètres: une description de chaîne du type de données et le chemin d'accès au fichier contenant ces données. Par exemple, si vous utilisez MSTest, voici comment informer TeamCity des résultats des tests:

 Task("Run-Tests") .Description("Run tests") .IsDependentOn("Clean") .IsDependentOn("Build") .Does(() => { var testDllsPattern = string.Format("./**/bin/{0}/*.*Tests.dll", configuration); var testDlls = GetFiles(testDllsPattern); var testResultsFile = System.IO.Path.Combine(temporaryFolder, "testResults.trx"); MSTest(testDlls, new MSTestSettings() { ResultsFile = testResultsFile }); if(TeamCity.IsRunningOnTeamCity) { TeamCity.ImportData("mstest", testResultsFile); } }); 

TeamCity prend en charge plusieurs types de tests. En plus de mstest, vous pouvez utiliser nunit , vstest et quelques autres .

Test du code d'analyse de couverture

TeamCity est capable de montrer le résultat de l'analyse de la couverture du code par des tests.

TeamCity prend actuellement en charge l'intégration avec DotCover . Permettez-moi de vous montrer comment utiliser DotCover dans un script Cake. Tout d'abord, DotCover doit être installé:

 #tool "nuget:?package=JetBrains.dotCover.CommandLineTools" 

Après cela, il peut être utilisé dans des tâches:

 Task("Analyse-Test-Coverage") .Description("Analyse code coverage by tests") .IsDependentOn("Clean") .IsDependentOn("Build") .Does(() => { var coverageResultFile = System.IO.Path.Combine(temporaryFolder, "coverageResult.dcvr"); var testDllsPattern = string.Format("./**/bin/{0}/*.*Tests.dll", configuration); var testDlls = GetFiles(testDllsPattern); var testResultsFile = System.IO.Path.Combine(temporaryFolder, "testResults.trx"); DotCoverCover(tool => { tool.MSTest(testDlls, new MSTestSettings() { ResultsFile = testResultsFile }); }, new FilePath(coverageResultFile), new DotCoverCoverSettings() .WithFilter("+:Application") .WithFilter("-:Application.*Tests") ); if(TeamCity.IsRunningOnTeamCity) { TeamCity.ImportData("mstest", testResultsFile); TeamCity.ImportDotCoverCoverage(coverageResultFile); } }); 

Comme vous pouvez le voir, des tests sont également exécutés ici. Par conséquent, nous pouvons immédiatement informer TeamCity des résultats des tests et des résultats de l'analyse de leur couverture de code. La méthode TeamCity.ImportDotCoverCoverage fait exactement cela.

Édition d'artefacts

Dans TeamCity, vous pouvez publier certains artefacts créés pendant le fonctionnement du script Cake. Les packages NuGet sont un bon candidat pour ce rôle:

Pour ce faire, placez tous les artefacts que vous souhaitez publier dans un dossier. Vous pouvez ensuite publier à l'aide de la méthode TeamCity.PublishArtifacts :

 Task("Publish-Artifacts-On-TeamCity") .Description("Publish artifacts on TeamCity") .IsDependentOn("Create-NuGet-Package") .WithCriteria(TeamCity.IsRunningOnTeamCity) .Does(() => { TeamCity.PublishArtifacts(artifactsFolder); }); 

Conclusion

Espérons que ces exemples de code simples vous feront économiser du temps et des efforts si vous souhaitez que votre script Cake s'exécute sur TeamCity. La version complète du script et l'application qu'il traite se trouvent sur GitHub . Bonne chance