Cake.Common.Build.AzurePipelines vs Cake.AzureDevOps

[soroshsabz]

ITNOA

I found two way (native and extension) in cake exist for communication with Azure DevOps, I want to know which one is better (official support and better maintenance)

In another way I try to use Cake.Common.Build.AzurePipelines to publish test, but I failed as you can see in below

Publish test result.....................................
testResultsFiles publish...
artifacts/Commons.TestsResult.xml
artifacts/Commons.TestsResult.xml
artifacts/Domain.TestsResult.xml
artifacts/Data.TestsResult.xml
artifacts/AppService.TestsResult.xml
artifacts/Service.TestsResult.xml
artifacts/Web.TestsResult.xml
##[warning]Failed to publish test results: Could not find file 'C:\agent\_work\1\s\Resa\build\artifacts\AppService.TestsResult.xml'.
Finished executing task: Test
Completed in 00:03:21.1649140

========================================
JustTest
========================================
Executing task: JustTest
Finished executing task: JustTest
Completed in 00:00:00.0000590

Task                          Duration            
--------------------------------------------------
Clean                         Skipped             
Restore                       00:01:20.4699223    
Build                         00:01:50.8878283    
Test                          00:03:21.1649460    
JustTest                      00:00:00.0000699    
--------------------------------------------------
Total:                        00:06:32.5227665    
Async Command Start: Publish test results
Async Command End: Publish test results
Finishing: BatchScript

and my cake publish code like below

https://stackoverflow.com/q/66184826/1539100

  if (testProjects.Any() && AzurePipelines.IsRunningOnAzurePipelines)
    {
        Information("Publish test result.....................................");
        if (testResultsFiles.Any())
        {
            AzurePipelines.Commands.PublishTestResults(
                new AzurePipelinesPublishTestResultsData
                {
                    TestResultsFiles = testResultsFiles.ToArray(),
                    TestRunner = AzurePipelinesTestRunnerType.NUnit
                }
            );
        }
        if (vsTestResultsFiles.Any())
        {
            AzurePipelines.Commands.PublishTestResults(
                new AzurePipelinesPublishTestResultsData
                {
                    TestResultsFiles = vsTestResultsFiles.ToArray(),
                    TestRunner = AzurePipelinesTestRunnerType.VSTest
                }
            );
        }
    }

[pascalberger]

In your concrete example the issue seems to be that the test results file is missing. Where differences between Cake.Common.Build.AzurePipelines and Cake.AzureDevOpsare irrelevant.

Regarding the differences: They both serve a different purpose / have different implications and are supplementary to each other. There is no general better here, but it depends on your concrete situation and requirements.

Cake.Common.Build.AzurePipelines

Cake.Common.Build.AzurePipelines provides an API to access values provided by Azure Pipelines through environment variables and allows to pass values to the Azure Pipelines build through service messages (e.g. Logging commands.

Cake.AzureDevOps

Cake.AzureDevOps addin provides additional Cake aliases which use Azure DevOps REST API underneath. You can see it as a convenience layer instead of making direct HTTP requests.

Comparison

Cake.Common.Build.AzurePipelines is part of Cake.Common which is shipped with Cake and part of every Cake runner, while Cake.AzureDevOps is shipped as an Addin.

Cake.AzureDevOps can cover more scenarios than what is possible through service messages in Cake.Common.Build.AzurePipelines.

Cake.Common.Build.AzurePipelines is maintained by core Cake team, while Cake.AzureDevOps is community maintained. Cake.AzureDevOps is part of the Cake Contributions organization, which helps to ensure continued maintenance if current maintainers are no longer able to maintain it.