From 65dc53124a09979e22ee565a467134117e262819 Mon Sep 17 00:00:00 2001
From: Michael Kubacki <michael.kubacki@microsoft.com>
Date: Fri, 21 Oct 2022 12:28:47 -0400
Subject: [PATCH] PrGate.yml: Add support for publishing code coverage results

Introduces a new parameter called "extra_build_args" that can be used
to specify additional flags to pass to build commands.

This is used to pass flags needed to generate code coverage results
in this change.

The coverage.xml and coverage.html files added to the log copy step
will not have an impact if code coverage is not enabled.

For now, the code coverage publication step depends on the platform
setting "CODE_COVERAGE=TRUE" in the "extra_build_args" parameter.

This can be refactored/generalized as needeed in the future.

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 Steps/PrGate.yml | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/Steps/PrGate.yml b/Steps/PrGate.yml
index 41a77c66..125b5e46 100644
--- a/Steps/PrGate.yml
+++ b/Steps/PrGate.yml
@@ -42,6 +42,10 @@ parameters:
   displayName: Perform Stuart PR Evaluation
   type: boolean
   default: true
+- name: extra_build_args
+  displayName: Extra Build Command Arguments
+  type: string
+  default: ''
 - name: tool_chain_tag
   displayName: Tool Chain (e.g. VS2022)
   type: string
@@ -110,7 +114,7 @@ steps:
     displayName: Build and Test ${{ parameters.build_pkgs }} ${{ parameters.build_archs}}
     inputs:
       filename: stuart_build
-      arguments: -c ${{ parameters.build_file }} -p $(pkgs_to_build) -t ${{ parameters.build_targets}} -a ${{ parameters.build_archs}} TOOL_CHAIN_TAG=${{ parameters.tool_chain_tag}}
+      arguments: -c ${{ parameters.build_file }} -p $(pkgs_to_build) -t ${{ parameters.build_targets}} -a ${{ parameters.build_archs}} TOOL_CHAIN_TAG=${{ parameters.tool_chain_tag}} ${{ parameters.extra_build_args}}
     condition: and(gt(variables.pkg_count, 0), succeeded())
 
 - ${{ if eq(parameters.do_ci_build, true) }}:
@@ -118,7 +122,7 @@ steps:
     displayName: CI Build and Test ${{ parameters.build_pkgs }} ${{ parameters.build_archs}}
     inputs:
       filename: stuart_ci_build
-      arguments: -c ${{ parameters.build_file }} -p $(pkgs_to_build) -t ${{ parameters.build_targets}} -a ${{ parameters.build_archs}} TOOL_CHAIN_TAG=${{ parameters.tool_chain_tag}}
+      arguments: -c ${{ parameters.build_file }} -p $(pkgs_to_build) -t ${{ parameters.build_targets}} -a ${{ parameters.build_archs}} TOOL_CHAIN_TAG=${{ parameters.tool_chain_tag}} ${{ parameters.extra_build_args}}
     condition: and(gt(variables.pkg_count, 0), succeeded())
 
 # Publish Test Results to Azure Pipelines/TFS
@@ -163,6 +167,8 @@ steps:
       TestSuites.xml
       **/BUILD_TOOLS_REPORT.html
       **/OVERRIDELOG.TXT
+      coverage.xml
+      coverage.html
     flattenFolders: true
   condition: succeededOrFailed()
 
@@ -174,3 +180,11 @@ steps:
     pathtoPublish: '$(Build.ArtifactStagingDirectory)'
     artifactName: 'Build Logs $(System.JobName)'
   condition: succeededOrFailed()
+
+- task: PublishCodeCoverageResults@1
+  displayName: Publish Code Coverage Results
+  inputs:
+    codeCoverageTool: 'Cobertura'
+    summaryFileLocation: 'Build/coverage.xml'
+    pathToSources: '$(Build.SourcesDirectory)'
+  condition: and(succeededOrFailed(), and(gt(variables.pkg_count, 0), contains('${{ parameters.extra_build_args }}', 'CODE_COVERAGE=TRUE')))