[Azure DevOps Pipelines] c#(.NET Framework) を ビルドする

1. 環境準備

以上で Pipelines を操作する前の事前準備を完了です。

2. Pipeline を作成

Pipeline を作成していきます。

Step 1

画面左側の Pipeline ボタンをクリックすると下図のような画面を表示するので、［Create Pipeline］ボタンをクリックします。

Step 2

Pipeline の対象となるソースコードの所在を選択します。本ページでは "Azure Repos Git" を選択します。

Step 3

対象リポジトリを選択します。ここでは Counter を選択します。

Step 4

Pipeline を構成するプラットフォームを選択します。ここでは「.NET Desktop」を選択します。

Step 5

"azure-pipelines.yml" ファイルを生成してリポジトリへコミットされました。

内容を確認して必要に応じて修正します。まずは内容を確認してみましょう。

生成された yml ファイルのコードは以下のとおりです。

(1)NuGet パッケージの復元して、(2)ビルドして、(3)ユニットテストする、というような流れです。

["azure-pipelines.yml"]

# .NET Desktop 
# Build and run tests for .NET Desktop or Windows classic desktop solutions. 
# Add steps that publish symbols, save build artifacts, and more: 
# https://docs.microsoft.com/azure/devops/pipelines/apps/windows/dot-net

trigger: 
- main

pool:
  vmImage: 'windows-latest'

variables:
  solution: '**/*.sln'
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

steps: 
- task: NuGetToolInstaller@1

- task: NuGetCommand@2
  inputs:
    restoreSolution: '$(solution)'

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: VSTest@2
  inputs:
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

一部について説明します。

Step 6

いよいよ［Save and run］してみます。下図［Save and run］ボタンをクリックします。

下図画面を表示するので、もう一度［Save and run］ボタンをクリックします。

Pipeline を実行開始しました。

Pipeline を正常に完了ました。完了後の画面を以下に示します。

「✔ Job」のあたりをクリックすることで Job 詳細を確認することができます。

どうやら Pipeline は全て正常に処理できたようです。

以上から確認できたとりあえずの課題を以下に列挙します。

課題：

1. ビルド生成物（artifacts）を登録できていない。
   「0 artifacts」 という表示がありますが、ちゃんと設定できるとここからビルド生成物などを取得できるようになります。
2. Unitテストを実施できていない。
   Warnings がありますね。どうやら、VSTest の対象を見つけることができなかった、という内容のようです。
   少なくともデフォルト状態では "**\bin\**\*test.dll, **\bin\**\*tests.dll" というファイル名を満足する必要があるようです。

次章からこれら課題を順に解決していきます。

3. ビルド生成物（artifacts）を登録する

ビルド生成物（artifacts）を登録するように yml ファイルを修正します。

使用するコマンドは下記の２つです。

• CopyFiles@2
• PublishBuildArtifacts@1

CopyFiles@2 で登録したいファイルを一か所に集めて、PublishBuildArtifacts@1 でアーティファクト登録する、というような手順です。

他：

• 前回コードからの差分箇所に色付けしています。
• *.pdb ファイルを除外しています。
  意図的に２つの記載方法を試しています。

["azure-pipelines.yml"]

# .NET Desktop
# Build and run tests for .NET Desktop or Windows classic desktop solutions.
# Add steps that publish symbols, save build artifacts, and more:
# https://docs.microsoft.com/azure/devops/pipelines/apps/windows/dot-net

trigger:
- main

pool:
  vmImage: 'windows-latest'

variables:
  solution: '**/*.sln'
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

steps:
- task: NuGetToolInstaller@1

- task: NuGetCommand@2
  inputs:
    restoreSolution: '$(solution)'

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: VSTest@2
  inputs:
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: CopyFiles@2
  inputs:
    contents: CounterWPF\bin\$(buildConfiguration)\**\!(*.pdb)
    targetFolder: $(Build.ArtifactStagingDirectory)

- task: CopyFiles@2
  inputs:
    contents: |
      CounterForm\bin\$(buildConfiguration)\*.*
      !**\*.pdb
    targetFolder: $(Build.ArtifactStagingDirectory)

- task: PublishBuildArtifacts@1
  inputs:
    pathToPublish: $(Build.ArtifactStagingDirectory)
    artifactName: 'MyBuildOutputs'
    publishLocation: 'Container'

Pipeline 実行完了後の画面です。「1 published」に変わりました。

「1 published」あたりの画面をクリックすると下図 Artifacts 画面を表示します。

[･･･] ボタンウォリックすることであなたが希望する Artifacts をダウンロードなどすることができます。

4. ビルド生成物（artifacts）を zip 圧縮して登録する

前章では Artifacts として各ファイルを保存する例を紹介しました。しかしながら実際の運用ではアプリケーションは多くのファイルから構成されており、個別ファイルよりも必要となるファイル一式を zip などで圧縮したものを Artifacts として登録する方が都合が良い場合が多いと考えます。

本章では、事前に zip 圧縮したビルド生成物（artifacts）を登録するように yml ファイルを修正します。

使用するコマンドは下記の２つです。

• ArchiveFiles@2
• PublishBuildArtifacts@1

ArchiveFiles@2 でフォルダをまとめて zip 圧縮して、PublishBuildArtifacts@1 でアーティファクト登録する、というような手順です。

他：

• 下記例では、変数 $(Build.BuildId) を使って zip ファイル名に Pipelines のビルドIDを追加しています。

["azure-pipelines.yml"]

# .NET Desktop
# Build and run tests for .NET Desktop or Windows classic desktop solutions.
# Add steps that publish symbols, save build artifacts, and more:
# https://docs.microsoft.com/azure/devops/pipelines/apps/windows/dot-net

trigger:
- main

pool:
  vmImage: 'windows-latest'

variables:
  solution: '**/*.sln'
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

steps:
- task: NuGetToolInstaller@1

- task: NuGetCommand@2
  inputs:
    restoreSolution: '$(solution)'

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: VSTest@2
  inputs:
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterWPF\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterForm\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

Pipelines 実行完了後の Artifacts 画面の様子は以下の通りです。

5. Unit テストを実行する

Unitテストを実行できるようにします。

現在の Warnings メッセージを見るとテスト用 dll のファイル名を変更するだけでもある程度動作しそうですが、任意のファイル名でテストできる方が今後の応用のためにも良いでしょう。そんな方向で進めてみます。

具体的には、VSTest@2 の inputs にて testAssemblyVer2 という要素でテストアセンブリを具合的に指定することで解決できました。
詳細は下記例を参照ください。

["azure-pipelines.yml"]

# .NET Desktop
# Build and run tests for .NET Desktop or Windows classic desktop solutions.
# Add steps that publish symbols, save build artifacts, and more:
# https://docs.microsoft.com/azure/devops/pipelines/apps/windows/dot-net

trigger:
- main

pool:
  vmImage: 'windows-latest'

variables:
  solution: '**/*.sln'
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

steps:
- task: NuGetToolInstaller@1

- task: NuGetCommand@2
  inputs:
    restoreSolution: '$(solution)'

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: VSTest@2
  inputs:
    testAssemblyVer2: |
      **\$(BuildConfiguration)\testCounter1.dll
      **\$(BuildConfiguration)\testCounter2.dll
      **\$(BuildConfiguration)\testCounter3.dll
      !**\obj\**
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterWPF\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterForm\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

以下、Pipelines 実行後の画面です。

Warnings が消えました。

16個のテストを実行して全てをパスしたことがわかります。

VSTest@2 で NUnit, MSTestV1, MSTestV2 を全部実行してくれたことがうれしい感じでした。

"Code Coverage" は空でした。

次章ではこの "Code Coverage" を有効化してみたいと思います。

6. カバレッジ計測

コード カバレッジは、ソースがどれくらいテストされているかを確認するのに役立つ指標および手法やツールのことを意味します。

本章では、前章で空だった "Code Coverage" タブで確認結果を表示できるようになるようにします。

Step 1

早速 VSTest@2 実施時にカバレッジ計測を追加してみましょう。VSTest@2 に「codeCoverageEnabled: true」の１行を追加するだけです。

["azure-pipelines.yml"]

  # .NET Desktop
# Build and run tests for .NET Desktop or Windows classic desktop solutions.
# Add steps that publish symbols, save build artifacts, and more:
# https://docs.microsoft.com/azure/devops/pipelines/apps/windows/dot-net

trigger:
- main

pool:
  vmImage: 'windows-latest'

variables:
  solution: '**/*.sln'
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

steps:
- task: NuGetToolInstaller@1

- task: NuGetCommand@2
  inputs:
    restoreSolution: '$(solution)'

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: VSTest@2
  inputs:
    testAssemblyVer2: |
      **\$(BuildConfiguration)\testCounter1.dll
      **\$(BuildConfiguration)\testCounter2.dll
      **\$(BuildConfiguration)\testCounter3.dll
      !**\obj\**
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'
    codeCoverageEnabled: true

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterWPF\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterForm\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

Pipelines 実行後の「Code Coverage」画面です。

評価対象である CounterDll.dll および関係するアセンブリのコードカバレッジ結果を確認することができるようになりました。

Step 2

Step 1 の結果には不要なモジュール「nunit3.testadapter.dll 」のカバレッジ結果も含まれていました。関係はしているので含まれることは正常な動作と思いますが、これを削除したいと思いました。

これを実現する方法を説明したページがありました。

• unit testing - Excluding files from code coverage analysis in Azure devops pipeline - Stack Overflow

この内容に従って以下の修正を行います。

".runsetting" というファイルを新規に作成し、CodeCoverage の対象から除外したいファイルを <Exclude>～</Exclude> の部分に記載します。ファイル名は別の名称でも問題ありません。

[".runsetting"]

<?xml version="1.0" encoding="utf-8" ?>
<RunSettings>
  <DataCollectionRunSettings>
    <DataCollectors>
      <DataCollector friendlyName="Code Coverage">
        <Configuration>
          <CodeCoverage>
            <ModulePaths>
              <Exclude>
                <ModulePath>nunit3.testadapter.dll</ModulePath>
                <!-- Add more ModulePath nodes here. -->
              </Exclude>
            </ModulePaths>
          </CodeCoverage>
        </Configuration>
      </DataCollector>
    </DataCollectors>
  </DataCollectionRunSettings>
</RunSettings>

そして、VSTest@2 に「runSettingsFile: '.\.runsettings'」の１行を追加するだけです。

["azure-pipelines.yml"]

# .NET Desktop
# Build and run tests for .NET Desktop or Windows classic desktop solutions.
# Add steps that publish symbols, save build artifacts, and more:
# https://docs.microsoft.com/azure/devops/pipelines/apps/windows/dot-net

trigger:
- main

pool:
  vmImage: 'windows-latest'

variables:
  solution: '**/*.sln'
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

steps:
- task: NuGetToolInstaller@1

- task: NuGetCommand@2
  inputs:
    restoreSolution: '$(solution)'

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: VSTest@2
  inputs:
    testAssemblyVer2: |
      **\$(BuildConfiguration)\testCounter1.dll
      **\$(BuildConfiguration)\testCounter2.dll
      **\$(BuildConfiguration)\testCounter3.dll
      !**\obj\**
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'
    codeCoverageEnabled: true
    runSettingsFile: '.\.runsettings'

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterWPF\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterForm\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

以上の修正により、不要なモジュールの結果を除外することができました。

Step 3

以上の手順により、一応カバレッジを計測して結果を見ることができました。しかし、出力結果は HTML や XML ではなく .coverage 拡張子なので、"Code Coverage" 画面上でソースコードと対比してのカバレッジ確認をすることはできませんでした。結果をダウンロードすることもできますが、カバレッジ計測に対応している "Visual Studio Enterprise" 以外ではどちらにせよ内容を見られない、ということのようです。

ここまで頑張ってみましたが、ソースコードと対比してカバレッジを確認できないのは残念でした。

これを実現する方法について説明している記事がありました。

• yaml - Azure Pipelines - Where is the CodeCoverage generated by VSTest@2? - Stack Overflow

この内容に従って yml ファイルを以下のように修正します。

["azure-pipelines.yml"]

# .NET Desktop
# Build and run tests for .NET Desktop or Windows classic desktop solutions.
# Add steps that publish symbols, save build artifacts, and more:
# https://docs.microsoft.com/azure/devops/pipelines/apps/windows/dot-net

trigger:
- main

pool:
  vmImage: 'windows-latest'
  # vmImage: 'windows-2022'

variables:
  solution: '**/*.sln'
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

steps:
- task: NuGetToolInstaller@1

- task: NuGetCommand@2
  inputs:
    restoreSolution: '$(solution)'

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: VSTest@2
  inputs:
    testAssemblyVer2: |
      **\$(BuildConfiguration)\testCounter1.dll
      **\$(BuildConfiguration)\testCounter2.dll
      **\$(BuildConfiguration)\testCounter3.dll
      !**\obj\**
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'
    searchFolder: '$(System.DefaultWorkingDirectory)'
    resultsFolder: '$(build.ArtifactStagingDirectory)/Test/Results'
    otherConsoleOptions: '/collect:"Code Coverage;Format=Cobertura"'  # <<<< this is the important bit
    codeCoverageEnabled: true
    runSettingsFile: '.\.runsettings'

# vv Then add publish coverage manually vv
- task: PublishCodeCoverageResults@1
  inputs:
    codeCoverageTool: 'Cobertura'
    summaryFileLocation: '$(build.ArtifactStagingDirectory)/Test/Results/**/*.xml'

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterWPF\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterForm\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

上記修正を行った後に実行した Pipelines 結果から "Code Coverage" の部分を以下に表示します。

無事にカバレッジ結果の詳細を閲覧できるようになりました。

"Branch coverage" も計測できており十分活用できそうです。とても良い感じになりました。

7. OpenCover でカバレッジ計測

OpenCover は、.NET 2 以上（Windows OSのみ - MONOを除く）に対応したコードカバレッジツールです。32ビットと64ビットのプロセスをサポートし、ブランチとシーケンスポイントの両方をカバーします。

本章では OpenCover を使ってカバレッジ計測を行う方法について記載します。

ローカルPCで OpenCover によるカバレッジ計測をできるようになってから、次に Azure の Pipelines で OpenCover できるようにする、という順序で進めてみます。

rem Microsoft Visual Studio 2022 環境設定
call "C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\Tools\VsDevCmd.bat"

rem OpenCoverの実行
.\packages\OpenCover.4.7.1221\tools\OpenCover.Console.exe -register:Path64 -target:"vstest.console.exe" -targetargs:"./testCounter*/bin/debug/testCounter*.dll" -targetdir:"." -filter:"+[CounterDll]*" -output:OpenCoverReport.xml

rem OpenCover の出力レポートを整形出力
.\packages\ReportGenerator.5.2.0\tools\net47\ReportGenerator.exe -reports:".\OpenCoverReport.xml" -reporttypes:html -targetdir:".\CoverageReport"

rem レポートを表示
.\CoverageReport\index.html

pause

・・・

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

# - task: VSTest@2
#   inputs:
#     testAssemblyVer2: |
#       **\$(BuildConfiguration)\testCounter1.dll
#       **\$(BuildConfiguration)\testCounter2.dll
#       **\$(BuildConfiguration)\testCounter3.dll
#       !**\obj\**
#     platform: '$(buildPlatform)'
#     configuration: '$(buildConfiguration)'
#     codeCoverageEnabled: true
#     runSettingsFile: '.\.runsettings'

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterWPF\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'

・・・

・・・

- task: CmdLine@2
  displayName: "VSTest & OpenCover"
  inputs:
    script: >
      packages\OpenCover.4.7.1221\tools\OpenCover.Console.exe
      -target:"C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\IDE\CommonExtensions\Microsoft\TestWindow\vstest.console.exe"
      -targetargs:".\testCounter*\bin\$(BuildConfiguration)\testCounter*.dll /logger:trx;LogFileName=TestResult.xml"
      -targetdir:"."
      -register:Path64
      -filter:"+[CounterDll]*"
      -output:"OpenCoverReport.xml"
      -returntargetcode

・・・

・・・

- task: PublishTestResults@2
  displayName: "Publish Test Result"
  condition: always()
  inputs:
    testResultsFormat: 'VSTest'
    testResultsFiles: '**\TestResult.xml'

・・・

・・・

- task: reportgenerator@5
  condition: always()
  inputs:
    reports: '**\OpenCoverReport.xml'
    targetdir: 'CoverageReport'

    reporttypes: HtmlInline_AzurePipelines;Cobertura

・・・

・・・

- task: PublishCodeCoverageResults@1
  condition: always()
  inputs:
    codeCoverageTool: 'Cobertura'
    summaryFileLocation: 'CoverageReport\Cobertura.xml'
    reportDirectory: 'CoverageReport'
  env:
    DISABLE_COVERAGE_AUTOGENERATE: 'true'

・・・

# .NET Desktop
# Build and run tests for .NET Desktop or Windows classic desktop solutions.
# Add steps that publish symbols, save build artifacts, and more:
# https://docs.microsoft.com/azure/devops/pipelines/apps/windows/dot-net

trigger:
- main

pool:
  vmImage: 'windows-latest'

variables:
  solution: '**/*.sln'
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

steps:
- task: NuGetToolInstaller@1

- task: NuGetCommand@2
  inputs:
    restoreSolution: '$(solution)'

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

# - task: VSTest@2
#   inputs:
#     testAssemblyVer2: |
#       **\$(BuildConfiguration)\testCounter1.dll
#       **\$(BuildConfiguration)\testCounter2.dll
#       **\$(BuildConfiguration)\testCounter3.dll
#       !**\obj\**
#     platform: '$(buildPlatform)'
#     configuration: '$(buildConfiguration)'
#     codeCoverageEnabled: true
#     runSettingsFile: '.\.runsettings'

- task: CmdLine@2
  displayName: "VSTest & OpenCover"
  inputs:
    script: >
      packages\OpenCover.4.7.1221\tools\OpenCover.Console.exe
      -target:"C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\IDE\CommonExtensions\Microsoft\TestWindow\vstest.console.exe"
      -targetargs:".\testCounter*\bin\$(BuildConfiguration)\testCounter*.dll /logger:trx;LogFileName=TestResult.xml"
      -targetdir:"."
      -register:Path64
      -filter:"+[CounterDll]*"
      -output:"OpenCoverReport.xml"
      -returntargetcode

- task: PublishTestResults@2
  displayName: "Publish Test Result"
  condition: always()
  inputs:
    testResultsFormat: 'VSTest'
    testResultsFiles: '**\TestResult.xml'

- task: reportgenerator@5
  condition: always()
  inputs:
    reports: '**\OpenCoverReport.xml'
    targetdir: 'CoverageReport'
    reporttypes: HtmlInline_AzurePipelines_Dark;Cobertura

- task: PublishCodeCoverageResults@1
  condition: always()
  inputs:
    codeCoverageTool: 'Cobertura'
    summaryFileLocation: 'CoverageReport\Cobertura.xml'
    reportDirectory: 'CoverageReport'
  env:
    DISABLE_COVERAGE_AUTOGENERATE: 'true'

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterWPF\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterWPF_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

- task: ArchiveFiles@2
  displayName: "Archive files"
  inputs:
    rootFolderOrFile: CounterForm\bin\$(buildConfiguration)
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)\CounterForm_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs - zip'
    publishLocation: Container

良い感じです！

8. ClickOnce

Pipelines で ClickOnce インストーラ作成を試してみました。私が期待する結果を得ることができましたので、こちらにメモを残します。

[環境]

Step 1

Visual Studio 上で「発行」から ClickOnce 設定を行って「ClickOnceProfile.pubxml」を設定します。

本ページは Pipelines の実現方法を記載することが目的なので、発行および ClickOnce についての説明を割愛します。

["ClickOnceProfile.pubxml" 例]

<?xml version="1.0" encoding="utf-8"?>
<!--
https://go.microsoft.com/fwlink/?LinkID=208121.
-->
<Project>
  <PropertyGroup>
    <ApplicationRevision>1</ApplicationRevision>
    <ApplicationVersion>1.0.0.*</ApplicationVersion>
    <BootstrapperEnabled>True</BootstrapperEnabled>
    <Configuration>Release</Configuration>
    <CreateWebPageOnPublish>False</CreateWebPageOnPublish>
    <GenerateManifests>true</GenerateManifests>
    <Install>True</Install>
    <InstallFrom>Unc</InstallFrom>
    <InstallUrl>\\10.75.46.168\share$\ホゲホゲアプリ\</InstallUrl>
    <IsRevisionIncremented>True</IsRevisionIncremented>
    <IsWebBootstrapper>False</IsWebBootstrapper>
    <MapFileExtensions>True</MapFileExtensions>
    <MinimumRequiredVersion>1.0.0.0</MinimumRequiredVersion>
    <OpenBrowserOnPublish>False</OpenBrowserOnPublish>
    <Platform>Any CPU</Platform>
    <PublishDir>bin\Release\net8.0-windows10.0.22621.0\app.publish\</PublishDir>
    <PublishUrl>\\10.75.46.168\share$\ホゲホゲアプリ\</PublishUrl>
    <PublishProtocol>ClickOnce</PublishProtocol>
    <PublishReadyToRun>False</PublishReadyToRun>
    <PublishSingleFile>False</PublishSingleFile>
    <SelfContained>False</SelfContained>
    <SignatureAlgorithm>(なし)</SignatureAlgorithm>
    <SignManifests>False</SignManifests>
    <SkipPublishVerification>false</SkipPublishVerification>
    <TargetFramework>net8.0-windows10.0.22621.0</TargetFramework>
    <UpdateEnabled>True</UpdateEnabled>
    <UpdateMode>Foreground</UpdateMode>
    <UpdateRequired>True</UpdateRequired>
    <WebPageFileName>Publish.html</WebPageFileName>
    <ProductName>ホゲホゲアプリ</ProductName>
    <DisallowUrlActivation>True</DisallowUrlActivation>
    <PublisherName>ホゲ</PublisherName>
  </PropertyGroup>
  <ItemGroup>
    <BootstrapperPackage Include="Microsoft.NetCore.DesktopRuntime.8.0.x64">
      <Install>true</Install>
      <ProductName>.NET デスクトップ ランタイム 8.0.1 (x64)</ProductName>
    </BootstrapperPackage>
  </ItemGroup>
</Project>

Step 2

"ClickOnceProfile.pubxml" および発行に必要なファイルをリポジトリへコミットします。

Step 3

"azure-pipelines.yml" へ "- task: VSBuild@1" を下図のように追加します。

• "msbuildArgs" で "ClickOnceProfile.pubxml" へのパスを正確に記載します。
• '-p:PublishDir="bin/Publish"' という感じで ClickOnce 出力先を指定します。

以上の内容だけだと発行先に不要なファイルを多数保存しています。DeleteFiles@1 で不要なファイルを削除します。下記ファイルおよびフォルダ以外は不要のはずです。

• setup.exe
• ****.application
• Application Files/

["azure-pipelines.yml"]

# .NET Desktop
# Build and run tests for .NET Desktop or Windows classic desktop solutions.
# Add steps that publish symbols, save build artifacts, and more:
# https://docs.microsoft.com/azure/devops/pipelines/apps/windows/dot-net

trigger:
- main
- develop
- release/**
- hotfix/**
- feature/**

pool:
  #vmImage: 'windows-latest'
  vmImage: 'windows-2022'

variables:
  solution: '**/*.sln'
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'
  zipFilename: 'HogeHogeApp'

steps:
- task: NuGetToolInstaller@1

- task: NuGetCommand@2
  inputs:
    restoreSolution: '$(solution)'

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: VSBuild@1
  displayName: 'Publish'
  inputs:
    solution: '$(solution)'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'
    msbuildArgs: '-t:publish -p:PublishProfile=Properties\PublishProfiles\ClickOnceProfile.pubxml -p:PublishDir="bin/Publish"'

- task: DeleteFiles@1
  displayName: 'Remove unneeded files'
  inputs:
    contents: |
      bin/Publish/HogeHogeApp.exe
      bin/Publish/Launcher.exe
      bin/Publish/*.dll
      bin/Publish/*.pdb
      bin/Publish/*.json

- task: ArchiveFiles@2
  inputs:
    rootFolderOrFile: bin\
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStrageDirectory)\$(zipFilename)_$(Build.BuildId).zip'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStrageDirectory)\$(zipFilename)_$(Build.BuildId).zip'
    artifactName: 'MyBuildOutputs'
    publishLocation: Container

Step 4

最後にあなたが希望する場所へデプロイします。

上記 "azure-pipelines.yml" 例では zip 圧縮してアーティファクトとして発行しています。

Step 5

デプロイした結果を取得して確認します。

下図は取得した zip ファイルを解凍した "bin/Publish/" フォルダ内の様子です。ClickOnce インストーラ一式が保存されていることを確認できます。

以上です。

ライセンス

本ページの情報は、特記無い限り下記 MIT ライセンスで提供されます。

参考

• Azure DevOps Services | Microsoft Azure
  https://azure.microsoft.com/ja-jp/products/devops/
• VSTest@2 - Visual Studio Test v2 タスク | Microsoft Learn
  https://learn.microsoft.com/ja-jp/azure/devops/pipelines/tasks/reference/vstest-v2?view=azure-pipelines
• Azure Pipelines で.Net FrameworkとNUnitのテスト実行とカバレッジ計測してみる - 気まま研究所ブログ (hatenablog.jp)
• Azure Pipelines で.NET Framework + xUnit のユニットテストの実行と集計方法について - やる気駆動型エンジニアの備忘録 (hatenablog.com)
• Azure DevOpsのBuild PipelineでWebAppsにデプロイ（Build編）|ネスケラボ (nextscape.net)
• Azure Pipelines のビルド結果画面にコードカバレッジの結果を表示する（.NET Core） - ツナ缶雑記 (hateblo.jp)
• 事前定義済み変数 - Azure Pipelines | Microsoft Learn
• unit testing - Excluding files from code coverage analysis in Azure devops pipeline - Stack Overflow
• WPFアプリケーションの公開作業をAzure Pipelinesを使って自動化する - テトシスの備忘録 (tetsis.com)
  https://www.tetsis.com/blog/wpf-publish-azure-pipelines/
• yaml - Azure Pipelines - Where is the CodeCoverage generated by VSTest@2? - Stack Overflow
  https://stackoverflow.com/questions/57177772/azure-pipelines-where-is-the-codecoverage-generated-by-vstest2
• 単体テストにコードカバレッジを使用する - .NET | Microsoft Learn
  https://learn.microsoft.com/ja-jp/dotnet/core/testing/unit-testing-code-coverage?tabs=windows
• Azure Pipelines の Pull Request 時の起動トリガ設定｜まくろぐ (maku.blog)
  https://maku.blog/p/i6549xd/

変更履歴