[gcov-vs]support vs coverate rate

.azure-pipelines/build-template.yml

@@ -31,6 +31,9 @@ parameters:
 - name: syslog_artifact_name
   type: string
 
+- name: gcov_unittest_artifact_name
+  type: string
+
 - name: run_unit_test
   type: boolean
   default: false
@@ -154,9 +157,11 @@ jobs:
       set -ex
       rm ../*.deb || true
       ./autogen.sh
-      extraflags='--enable-code-coverage'
+      extraflags='--enable-code-coverage --enable-gcov'
       if [ '${{ parameters.asan }}' == True ]; then
          extraflags='--enable-asan'
+      else
+         export ENABLE_GCOV=y
       fi
       DEB_BUILD_OPTIONS=nocheck fakeroot debian/rules DEB_CONFIGURE_EXTRA_FLAGS=$extraflags CFLAGS="" CXXFLAGS="" binary-syncd-vs
       mv ../*.deb .
@@ -181,27 +186,18 @@ jobs:
         # Add SYS_TIME capability for settimeofday ok in syncd test
         sudo setcap "cap_sys_time=eip" syncd/.libs/tests
         make check
-        gcovr --version
         find SAI/meta -name "*.gc*" | xargs rm -vf
-        gcovr -r ./ -e ".*/SAI/.*" -e ".+/json.hpp" -e "swss/.+" -e ".*/.libs/.*" -e ".*/debian/.*" --exclude-unreachable-branches --exclude-throw-branches -x --xml-pretty -o coverage.xml
+        sudo apt-get install -y lcov
+        sudo mkdir -p $(Build.ArtifactStagingDirectory)/gcov_unittest_tmp
+        ./gcov_support.sh get_info $(Build.ArtifactStagingDirectory)/gcov_unittest_tmp
       displayName: "Run sonic sairedis unit tests"
   - publish: $(System.DefaultWorkingDirectory)/
     artifact: ${{ parameters.artifact_name }}
     displayName: "Archive sonic sairedis debian packages"
-  - ${{ if eq(parameters.archive_gcov, true) }}:
-      - script: |
-          set -ex
-          # Install .NET CORE
-          curl -sSL https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
-          sudo apt-add-repository https://packages.microsoft.com/debian/10/prod
-          sudo apt-get update
-          sudo apt-get install -y dotnet-sdk-5.0
-        displayName: "Install .NET CORE"
-      - task: PublishCodeCoverageResults@1
-        inputs:
-            codeCoverageTool: Cobertura
-            summaryFileLocation: '$(System.DefaultWorkingDirectory)/coverage.xml'
-        displayName: 'Publish test coverage'
+  - publish: $(Build.ArtifactStagingDirectory)/gcov_unittest_tmp
+    artifact: ${{ parameters.gcov_unittest_artifact_name }}
+    displayName: "Publish gcov unittest output"
+    condition: eq('${{ parameters.archive_gcov }}', true)
   - script: |
       pwd
       sudo chmod a+r /var/log/syslog*

.azure-pipelines/docker-sonic-vs/Dockerfile

@@ -19,3 +19,7 @@ RUN dpkg -i /debs/syncd-vs_1.0.0_amd64.deb
 RUN if [ "$need_dbg" = "y" ] ; then dpkg -i /debs/syncd-vs-dbg_1.0.0_amd64.deb ; fi
 
 RUN dpkg -i /debs/swss_1.0.0_amd64.deb
+
+RUN apt-get update
+
+RUN apt-get -y install lcov

.azure-pipelines/gcov.yml

@@ -0,0 +1,127 @@
+parameters:
+
+- name: arch
+  type: string
+  values:
+  - amd64
+  default: amd64
+
+- name: pool
+  type: string
+  values:
+  - sonicbld
+  - default
+  default: default
+
+- name: timeout
+  type: number
+  default: 180
+
+- name: sonic_slave
+  type: string
+
+- name: sairedis_artifact_name
+  type: string
+
+- name: gcov_unittest_artifact_name
+  type: string
+
+- name: swss_common_artifact_name
+  type: string
+
+- name: swss_artifact_name
+  type: string
+
+- name: artifact_name
+  type: string
+
+- name: archive_gcov
+  type: boolean
+  default: false
+
+jobs:
+- job:
+  displayName: ${{ parameters.arch }}
+  timeoutInMinutes: ${{ parameters.timeout }}
+
+  pool:
+    ${{ if ne(parameters.pool, 'default') }}:
+      name: ${{ parameters.pool }}
+    ${{ if eq(parameters.pool, 'default') }}:
+      vmImage: 'ubuntu-20.04'
+
+  container:
+    image: sonicdev-microsoft.azurecr.io:443/${{ parameters.sonic_slave }}:latest
+
+
+  steps:
+  - script: |
+      sudo apt-get install -y lcov
+    displayName: "Install dependencies"
+    condition: eq('${{ parameters.archive_gcov }}', true)
+  - task: DownloadPipelineArtifact@2
+    inputs:
+      artifact: ${{ parameters.sairedis_artifact_name }}
+    displayName: "Download sonic sairedis deb packages"
+  - task: DownloadPipelineArtifact@2
+    inputs:
+      artifact: ${{ parameters.artifact_name }}
+    displayName: "Download gcov artifact"
+    condition: eq('${{ parameters.archive_gcov }}', true)
+  - task: DownloadPipelineArtifact@2
+    inputs:
+      artifact: ${{ parameters.gcov_unittest_artifact_name }}
+    displayName: "Download gcov unittest artifact"
+    condition: eq('${{ parameters.archive_gcov }}', true)
+  - script: |
+      set -x
+      ls -lh
+      sudo tar -zxvf sonic-gcov.tar.gz
+      sudo cp unittest_total.info sonic-gcov/
+      sudo cp -rf sonic-gcov $(Build.ArtifactStagingDirectory)
+      sudo rm sonic-gcov.tar.gz
+      ls -lh
+    workingDirectory: $(Pipeline.Workspace)
+    displayName: "store sonic-gcov"
+    condition: eq('${{ parameters.archive_gcov }}', true)
+  - checkout: self
+    submodules: true
+    condition: eq('${{ parameters.archive_gcov }}', true)
+  - script: |
+      set -x
+      wget https://packages.microsoft.com/config/debian/10/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
+      sudo dpkg -i packages-microsoft-prod.deb
+      sudo apt-get update
+      sudo apt-get install -y dotnet-sdk-5.0
+      pushd ./s/
+      sudo tar -zcvf syncd.tar.gz ./*
+      ls -lh ./*
+      sudo cp ./lcov_cobertura.py $(Build.ArtifactStagingDirectory)/
+      sudo cp ./gcov_support.sh $(Build.ArtifactStagingDirectory)/sonic-gcov
+      sudo cp -rf syncd.tar.gz $(Build.ArtifactStagingDirectory)/sonic-gcov
+      popd
+      sudo cp -rf $(Build.ArtifactStagingDirectory)/sonic-gcov ./
+      pushd sonic-gcov
+      ls -lh ./*
+      sudo chmod +x ./gcov_support.sh
+      sudo ./gcov_support.sh generate
+      sudo ./gcov_support.sh merge_container_info $(Build.ArtifactStagingDirectory)
+      sudo find gcov_output -name "SAI" | xargs sudo rm -rf
+      sudo cp -rf gcov_output $(Build.ArtifactStagingDirectory)
+      ls -lh $(Build.ArtifactStagingDirectory)
+      popd
+    workingDirectory: $(Pipeline.Workspace)
+    displayName: "generate gcov reports"
+    condition: eq('${{ parameters.archive_gcov }}', true)
+  - publish: $(Build.ArtifactStagingDirectory)/gcov_output
+    artifact: gcov_info
+    displayName: "Archive gcov info"
+    condition: eq('${{ parameters.archive_gcov }}', true)
+
+  - task: PublishCodeCoverageResults@1
+    inputs:
+      codeCoverageTool: Cobertura
+      summaryFileLocation: '$(Build.ArtifactStagingDirectory)/gcov_output/AllMergeReport/coverage.xml'
+      reportDirectory: '$(Build.ArtifactStagingDirectory)/gcov_output/AllMergeReport/'
+    displayName: 'Publish c c++ test coverage'
+    condition: eq('${{ parameters.archive_gcov }}', true)

.azure-pipelines/test-docker-sonic-vs-template.yml

@@ -6,6 +6,16 @@ parameters:
 - name: log_artifact_name
   type: string
 
+- name: gcov_artifact_name
+  type: string
+
+- name: sonic_slave
+  type: string
+
+- name: archive_gcov
+  type: boolean
+  default: false
+
 - name: docker_sonic_vs_name
   type: string
   default: docker-sonic-vs
@@ -84,13 +94,21 @@ jobs:
         test_set+=("${test}")
         if [ ${#test_set[@]} -ge 20 ]; then
           test_name=$(echo "${test_set[0]}" | cut -d "." -f 1)
+          if [ '${{ parameters.archive_gcov }}' == True ]; then
+          echo "${test_set[*]}" | xargs sudo py.test -v --force-flaky --junitxml="${test_name}_tr.xml" $params --keeptb --imgname=docker-sonic-vs:$(Build.DefinitionName).$(Build.BuildNumber).asan-${{ parameters.asan }}
+        else
           echo "${test_set[*]}" | xargs sudo py.test -v --force-flaky --junitxml="${test_name}_tr.xml" $params --imgname=docker-sonic-vs:$(Build.DefinitionName).$(Build.BuildNumber).asan-${{ parameters.asan }}
+        fi
           test_set=()
         fi
       done
       if [ ${#test_set[@]} -gt 0 ]; then
         test_name=$(echo "${test_set[0]}" | cut -d "." -f 1)
-        echo "${test_set[*]}" | xargs sudo py.test -v --force-flaky --junitxml="${test_name}_tr.xml" $params --imgname=docker-sonic-vs:$(Build.DefinitionName).$(Build.BuildNumber).asan-${{ parameters.asan }}
+        if [ '${{ parameters.archive_gcov }}' == True ]; then
+          echo "${test_set[*]}" | xargs sudo py.test -v --force-flaky --junitxml="${test_name}_tr.xml" --keeptb $params --imgname=docker-sonic-vs:$(Build.DefinitionName).$(Build.BuildNumber).asan-${{ parameters.asan }}
+        else
+          echo "${test_set[*]}" | xargs sudo py.test -v --force-flaky --junitxml="${test_name}_tr.xml" $params --imgname=docker-sonic-vs:$(Build.DefinitionName).$(Build.BuildNumber).asan-${{ parameters.asan }}
+        fi
       fi
       rm -rf $(Build.ArtifactStagingDirectory)/download
     displayName: "Run vs tests"
@@ -104,12 +122,23 @@ jobs:
 
   - script: |
       cp -r sonic-swss/tests/log $(Build.ArtifactStagingDirectory)/
+      if [ '${{ parameters.archive_gcov }}' == True ]; then
+        sudo apt-get install -y lcov
+        ./sonic-sairedis/gcov_support.sh set_environment $(Build.ArtifactStagingDirectory)
+        docker stop $(docker ps -q -a)
+        docker rm $(docker ps -q -a)
+      fi
       if [ '${{ parameters.asan }}' == True ]; then
         cp -vr sonic-swss/tests/log/*/log/asan $(Build.ArtifactStagingDirectory)/
       fi
     displayName: "Collect logs"
     condition: always()
 
+  - publish: $(Build.ArtifactStagingDirectory)/gcov_tmp
+    artifact: ${{ parameters.gcov_artifact_name }}
+    displayName: "Publish gcov output"
+    condition: eq('${{ parameters.archive_gcov }}', true)
+
   - publish: $(Build.ArtifactStagingDirectory)/
     artifact: ${{ parameters.log_artifact_name }}@$(System.JobAttempt)
     displayName: "Publish logs"

Makefile.am

@@ -1,4 +1,4 @@
-SUBDIRS = meta lib vslib pyext
+SUBDIRS = gcovpreload meta lib vslib pyext
 
 if SYNCD
 SUBDIRS += syncd saiplayer saidump saidiscovery saisdkdump saiasiccmp tests unittest

azure-pipelines.yml

@@ -56,6 +56,7 @@ stages:
       swss_common_artifact_name: sonic-swss-common
       artifact_name: sonic-sairedis
       syslog_artifact_name: sonic-sairedis.syslog
+      gcov_unittest_artifact_name: gcov_unitest.info
       run_unit_test: true
       archive_gcov: true
       debian_version: ${{ parameters.debian_version }}
@@ -88,6 +89,7 @@ stages:
       swss_common_artifact_name: sonic-swss-common.armhf
       artifact_name: sonic-sairedis.armhf
       syslog_artifact_name: sonic-sairedis.syslog.armhf
+      gcov_unittest_artifact_name: gcov_unitest.info
       debian_version: ${{ parameters.debian_version }}
 
   - template: .azure-pipelines/build-template.yml
@@ -99,11 +101,12 @@ stages:
       swss_common_artifact_name: sonic-swss-common.arm64
       artifact_name: sonic-sairedis.arm64
       syslog_artifact_name: sonic-sairedis.syslog.arm64
+      gcov_unittest_artifact_name: gcov_unitest.info
       debian_version: ${{ parameters.debian_version }}
 
 - stage: BuildSwss
   dependsOn: Build
-  condition: succeeded('Build')
+  condition: always()
   jobs:
   - template: .azure-pipelines/build-swss-template.yml
     parameters:
@@ -116,7 +119,7 @@ stages:
 
 - stage: BuildDocker
   dependsOn: BuildSwss
-  condition: succeeded('BuildSwss')
+  condition: always()
   jobs:
   - template: .azure-pipelines/build-docker-sonic-vs-template.yml
     parameters:
@@ -146,6 +149,24 @@ stages:
   - template: .azure-pipelines/test-docker-sonic-vs-template.yml
     parameters:
       log_artifact_name: log
+      gcov_artifact_name: sonic-gcov
+      sonic_slave: sonic-slave-buster
+      archive_gcov: true
+
+- stage: Gcov
+  dependsOn: Test
+  condition: always()
+  jobs:
+  - template: .azure-pipelines/gcov.yml
+    parameters:
+      arch: amd64
+      sonic_slave: sonic-slave-buster
+      swss_common_artifact_name: sonic-swss-common
+      sairedis_artifact_name: sonic-sairedis
+      gcov_unittest_artifact_name: gcov_unitest.info
+      swss_artifact_name: sonic-swss
+      artifact_name: sonic-gcov
+      archive_gcov: true
 
 - stage: TestAsan
   dependsOn: BuildDockerAsan

configure.ac

@@ -159,6 +159,25 @@ CXXFLAGS_COMMON+=" -Wno-switch-default"
 CXXFLAGS_COMMON+=" -Wconversion"
 CXXFLAGS_COMMON+=" -Wno-psabi"
 
+# Code testing coverage with gcov
+AC_MSG_CHECKING(whether to build with gcov testing)
+AC_ARG_ENABLE(gcov, AS_HELP_STRING([--enable-gcov], [Whether to enable gcov testing]),, enable_gcov=no)
+
+if test "x$enable_gcov" = "xyes"; then
+    if test "$GCC" = "no"; then
+        AC_MSG_ERROR(not compiling with gcc, which is required for gcov testing)
+    fi
+
+    CXXFLAGS_COMMON+=" -fprofile-arcs -ftest-coverage"
+    AC_SUBST(CXXFLAGS_COMMON)
+
+    CXXFLAGS+=" -fprofile-arcs -lgcov"
+    AC_SUBST(CXXFLAGS)
+fi
+
+AM_CONDITIONAL(GCOV_ENABLED, test x$enable_gcov = xyes)
+AC_MSG_RESULT($enable_gcov)
+
 SAVED_FLAGS="$CXXFLAGS"
 CXXFLAGS="-Wcast-align=strict"
 AC_MSG_CHECKING([whether CXX supports -Wcast-align=strict])
@@ -210,6 +229,7 @@ CXXFLAGS="$SAVED_FLAGS"
 AC_CHECK_FUNCS(sai_bulk_object_clear_stats sai_bulk_object_get_stats)
 
 AC_OUTPUT(Makefile
+	  gcovpreload/Makefile
           meta/Makefile
           lib/Makefile
           vslib/Makefile

debian/rules

@@ -87,6 +87,7 @@ override_dh_auto_configure:
 	dh_auto_configure -- $(DEB_CONFIGURE_EXTRA_FLAGS) $(shell cat /tmp/syncd-build) ${SWSS_COMMON_CONFIG} $(configure_opts)
 
 override_dh_install:
+	sh ./gcov_support.sh collect syncd-vs
 	dh_install
 	# Note: escape $ with an extra $ symbol
 	if egrep -q '(^| )--enable-rpcserver=yes( |$$)' /tmp/syncd-build && [ -f debian/syncd-rpc/usr/bin/syncd_init_common.sh ] ; then

debian/syncd.install

@@ -1,7 +1,9 @@
+usr/lib/*/libgcovpreload*.so.* usr/lib
 usr/bin/saidump
 usr/bin/saiplayer
 usr/bin/saisdkdump
 usr/bin/saidiscovery
 usr/bin/saiasiccmp
 usr/bin/syncd*
 syncd/scripts/* usr/bin
+gcov tmp