Linux 机器上运行 Cake 任务时遇到的“Code-coverage”构建问题该如何解决？

2024-03-05 05:33:00

Linux 机器上运行 Cake 任务的“Code-coverage”构建问题

简介

在将 Cake 脚本从 Windows 迁移到 Linux 机器时，可能会遇到运行“Code-coverage”任务时的问题。此错误通常是因为 DotCover 找不到输出目录。

问题

在 Linux 机器上运行 Cake 任务“Code-coverage”时，遇到了以下错误：

Error: DotCover Cover : Failed to run dotCover tests (code coverage). Arguments: dotnet test /Users/shared/Artifactory/Project/CI-Artifactory/.BuildCache/035845af2bb3/jobs/job/workspace/artifacts/ProjectCode/bin/Debug/netcoreapp3.1/Project.UnitTests.dll --logger trx;LogFileName=xUnit.results.trx --configuration Release --no-build --filter System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute --code-coverage -o '/Users/shared/Artifactory/Project/CI-Artifactory/.BuildCache/035845af2bb3/jobs/job/workspace/artifacts/ProjectCode/bin/Debug/netcoreapp3.1/coverage.xml'
Working directory: /Users/shared/Artifactory/Project/CI-Artifactory/.BuildCache/035845af2bb3/jobs/job/workspace/artifacts/ProjectCode/bin/Debug/netcoreapp3.1

解决方法

解决此问题的方法是修改 DotCoverCover 设置中的输出目录。具体步骤如下：

在 DotCoverCoverSettings 中添加 WithOutputDirectory(codecoverageReportDir) 代码。
重新运行任务。

完整代码

以下是修改后的 Cake 任务代码：

Task("Code-Coverage")
    .ContinueOnError()
    .Does(() =>
    {
    try
    {
        if (!DirectoryExists(cireports))
        {
            CreateDirectory(cireports);
            CreateDirectory(xunitReportDir);
        } else {
            if(!DirectoryExists(xunitReportDir))
            {
                CreateDirectory(xunitReportDir);
            }
            else {
                DeleteDirectory(xunitReportDir, recursive:true);
                CreateDirectory(xunitReportDir);
            }
        }

        if (!DirectoryExists(codecoverageReportDir))
        {
            CreateDirectory(codecoverageReportDir); 
        } else { 
                DeleteDirectory(codecoverageReportDir, recursive:true);
                CreateDirectory(codecoverageReportDir); 
        }

        var projects = GetFiles(unitTestProjectDirPathPattern);
        var settings = new DotCoverCoverSettings()
                    .WithFilter(codeCoverageFilter)
                    .WithAttributeFilter("System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute")
                    .WithOutputDirectory(codecoverageReportDir);

        foreach(var project in projects)
        {
            DotCoverCover(
                x => x.DotNetCoreTest(
                     project.FullPath,
                     new DotNetCoreTestSettings() {
                          Configuration = configuration,
                          Logger = $"trx;LogFileName={unitTestingReport}",
                          NoBuild = true,
                           }
                ),
                dotCodeCoverageReport,
                settings
            );
        }
    }   
    catch(Exception ex) {        
        throw new Exception(String.Format("Please fix the project compilation failures"));  
    }
    });