Skip to content

Commit b20f0f4

Browse files
pettershao-ragilenetworkspettershao-ragilenetworks
authored
Gcov for swss daemon (sonic-net#1737)
* [gcov] swss support gcov * Introduce gcov-related automation script to test coverage rate for swss module Signed-off-by: pettershao-ragilenetworks <[email protected]>
1 parent 01c243a commit b20f0f4

File tree

25 files changed

+1203
-7
lines changed

25 files changed

+1203
-7
lines changed

‎.azure-pipelines/build-template.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ parameters:
4040
type: boolean
4141
default: false
4242

43+
- name: archive_gcov
44+
type: boolean
45+
default: false
46+
4347
jobs:
4448
- job:
4549
displayName: ${{ parameters.arch }}
@@ -126,6 +130,9 @@ jobs:
126130
set -x
127131
tar czf pytest.tgz tests
128132
cp -r pytest.tgz $(Build.ArtifactStagingDirectory)/
133+
if [ '${{ parameters.archive_gcov }}' == True ]; then
134+
export ENABLE_GCOV=y
135+
fi
129136
./autogen.sh
130137
dpkg-buildpackage -us -uc -b -j$(nproc) && cp ../*.deb .
131138
displayName: "Compile sonic swss"

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,7 @@ RUN dpkg -i /debs/syncd-vs_1.0.0_amd64.deb
2424

2525
RUN dpkg --purge swss
2626
RUN dpkg -i /debs/swss_1.0.0_amd64.deb
27+
28+
RUN apt-get update
29+
30+
RUN apt-get -y install lcov

‎.azure-pipelines/gcov.yml

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
parameters:
2+
- name: arch
3+
type: string
4+
values:
5+
- amd64
6+
default: amd64
7+
8+
- name: pool
9+
type: string
10+
values:
11+
- sonicbld
12+
- default
13+
default: default
14+
15+
- name: timeout
16+
type: number
17+
default: 180
18+
19+
- name: sonic_slave
20+
type: string
21+
22+
- name: sairedis_artifact_name
23+
type: string
24+
25+
- name: swss_common_artifact_name
26+
type: string
27+
28+
- name: swss_artifact_name
29+
type: string
30+
31+
- name: artifact_name
32+
type: string
33+
34+
- name: archive_gcov
35+
type: boolean
36+
default: false
37+
38+
jobs:
39+
- job:
40+
displayName: ${{ parameters.arch }}
41+
timeoutInMinutes: ${{ parameters.timeout }}
42+
43+
pool:
44+
${{ if ne(parameters.pool, 'default') }}:
45+
name: ${{ parameters.pool }}
46+
${{ if eq(parameters.pool, 'default') }}:
47+
vmImage: 'ubuntu-20.04'
48+
49+
container:
50+
image: sonicdev-microsoft.azurecr.io:443/${{ parameters.sonic_slave }}:latest
51+
52+
53+
steps:
54+
- script: |
55+
sudo apt-get install -y lcov
56+
displayName: "Install dependencies"
57+
condition: eq('${{ parameters.archive_gcov }}', true)
58+
- task: DownloadPipelineArtifact@2
59+
inputs:
60+
artifact: ${{ parameters.artifact_name }}
61+
displayName: "Download gcov artifact"
62+
condition: eq('${{ parameters.archive_gcov }}', true)
63+
- script: |
64+
set -x
65+
ls -lh
66+
sudo tar -zxvf sonic-gcov.tar.gz
67+
sudo cp -rf sonic-gcov $(Build.ArtifactStagingDirectory)
68+
sudo rm sonic-gcov.tar.gz
69+
ls -lh
70+
workingDirectory: $(Pipeline.Workspace)
71+
displayName: "store sonic-gcov"
72+
condition: eq('${{ parameters.archive_gcov }}', true)
73+
- checkout: self
74+
submodules: true
75+
condition: eq('${{ parameters.archive_gcov }}', true)
76+
- script: |
77+
set -x
78+
wget https://packages.microsoft.com/config/debian/10/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
79+
sudo dpkg -i packages-microsoft-prod.deb
80+
sudo apt-get update
81+
sudo apt-get install -y dotnet-sdk-5.0
82+
pushd ./s/
83+
sudo tar -zcvf swss.tar.gz ./*
84+
ls -lh ./*
85+
cp ./gcovpreload/lcov_cobertura.py $(Build.ArtifactStagingDirectory)/
86+
cp ./tests/gcov_support.sh $(Build.ArtifactStagingDirectory)/sonic-gcov
87+
sudo cp -rf swss.tar.gz $(Build.ArtifactStagingDirectory)/sonic-gcov
88+
popd
89+
sudo cp -rf $(Build.ArtifactStagingDirectory)/sonic-gcov ./
90+
pushd sonic-gcov
91+
ls -lh ./*
92+
sudo chmod +x ./gcov_support.sh
93+
sudo ./gcov_support.sh generate
94+
sudo ./gcov_support.sh merge_container_info $(Build.ArtifactStagingDirectory)
95+
sudo cp -rf gcov_output $(Build.ArtifactStagingDirectory)
96+
ls -lh $(Build.ArtifactStagingDirectory)
97+
popd
98+
workingDirectory: $(Pipeline.Workspace)
99+
displayName: "generate gcov reports"
100+
condition: eq('${{ parameters.archive_gcov }}', true)
101+
102+
- publish: $(Build.ArtifactStagingDirectory)/gcov_output
103+
artifact: gcov_info
104+
displayName: "Archive gcov info"
105+
condition: eq('${{ parameters.archive_gcov }}', true)
106+
107+
- task: PublishCodeCoverageResults@1
108+
inputs:
109+
codeCoverageTool: Cobertura
110+
summaryFileLocation: '$(Build.ArtifactStagingDirectory)/gcov_output/AllMergeReport/coverage.xml'
111+
reportDirectory: '$(Build.ArtifactStagingDirectory)/gcov_output/AllMergeReport/'
112+
displayName: 'Publish c c++ test coverage'
113+
condition: eq('${{ parameters.archive_gcov }}', true)
114+

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

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ parameters:
66
- name: log_artifact_name
77
type: string
88

9+
- name: gcov_artifact_name
10+
type: string
11+
12+
- name: sonic_slave
13+
type: string
14+
15+
- name: archive_gcov
16+
type: boolean
17+
default: false
18+
919
jobs:
1020
- job:
1121
displayName: vstest
@@ -53,7 +63,12 @@ jobs:
5363
sudo /sbin/ip link add Vrf1 type vrf table 1001 || { echo 'vrf command failed' ; exit 1; }
5464
sudo /sbin/ip link del Vrf1 type vrf table 1001
5565
pushd tests
56-
sudo py.test -v --force-flaky --junitxml=tr.xml --imgname=docker-sonic-vs:$(Build.DefinitionName).$(Build.BuildNumber)
66+
67+
if [ '${{ parameters.archive_gcov }}' == True ]; then
68+
sudo py.test -v --force-flaky --junitxml=tr.xml --keeptb --imgname=docker-sonic-vs:$(Build.DefinitionName).$(Build.BuildNumber)
69+
else
70+
sudo py.test -v --force-flaky --junitxml=tr.xml --imgname=docker-sonic-vs:$(Build.DefinitionName).$(Build.BuildNumber)
71+
fi
5772
displayName: "Run vs tests"
5873
5974
- task: PublishTestResults@2
@@ -64,9 +79,21 @@ jobs:
6479

6580
- script: |
6681
cp -r tests/log $(Build.ArtifactStagingDirectory)/
82+
83+
if [ '${{ parameters.archive_gcov }}' == True ]; then
84+
sudo apt-get install -y lcov
85+
./tests/gcov_support.sh set_environment $(Build.ArtifactStagingDirectory)
86+
docker stop $(docker ps -q -a)
87+
docker rm $(docker ps -q -a)
88+
fi
6789
displayName: "Collect logs"
6890
condition: always()
6991
92+
- publish: $(Build.ArtifactStagingDirectory)/gcov_tmp
93+
artifact: ${{ parameters.gcov_artifact_name }}
94+
displayName: "Publish gcov output"
95+
condition: eq('${{ parameters.archive_gcov }}', true)
96+
7097
- publish: $(Build.ArtifactStagingDirectory)/
7198
artifact: ${{ parameters.log_artifact_name }}@$(System.JobAttempt)
7299
displayName: "Publish logs"

‎Makefile.am

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
SUBDIRS = fpmsyncd neighsyncd fdbsyncd portsyncd mclagsyncd natsyncd orchagent swssconfig cfgmgr tests gearsyncd
1+
if GCOV_ENABLED
2+
SUBDIRS = gcovpreload fpmsyncd neighsyncd portsyncd mclagsyncd natsyncd fdbsyncd orchagent swssconfig cfgmgr tests gearsyncd
3+
else
4+
SUBDIRS = fpmsyncd neighsyncd portsyncd mclagsyncd natsyncd fdbsyncd orchagent swssconfig cfgmgr tests gearsyncd
5+
endif
6+
27

38
if HAVE_LIBTEAM
49
SUBDIRS += teamsyncd tlm_teamd

‎azure-pipelines.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ stages:
2222
sairedis_artifact_name: sonic-sairedis
2323
artifact_name: sonic-swss
2424
archive_pytests: true
25+
archive_gcov: true
2526

2627
- stage: BuildArm
2728
dependsOn: Build
@@ -38,6 +39,7 @@ stages:
3839
swss_common_artifact_name: sonic-swss-common.armhf
3940
sairedis_artifact_name: sonic-sairedis.armhf
4041
artifact_name: sonic-swss.armhf
42+
archive_gcov: false
4143

4244
- template: .azure-pipelines/build-template.yml
4345
parameters:
@@ -50,6 +52,7 @@ stages:
5052
buildimage_pipeline: 140
5153
sairedis_artifact_name: sonic-sairedis.arm64
5254
artifact_name: sonic-swss.arm64
55+
archive_gcov: false
5356

5457
- stage: BuildDocker
5558
dependsOn: Build
@@ -69,3 +72,20 @@ stages:
6972
- template: .azure-pipelines/test-docker-sonic-vs-template.yml
7073
parameters:
7174
log_artifact_name: log
75+
gcov_artifact_name: sonic-gcov
76+
sonic_slave: sonic-slave-buster
77+
archive_gcov: true
78+
79+
- stage: Gcov
80+
dependsOn: Test
81+
condition: always()
82+
jobs:
83+
- template: .azure-pipelines/gcov.yml
84+
parameters:
85+
arch: amd64
86+
sonic_slave: sonic-slave-buster
87+
swss_common_artifact_name: sonic-swss-common
88+
sairedis_artifact_name: sonic-sairedis
89+
swss_artifact_name: sonic-swss
90+
artifact_name: sonic-gcov
91+
archive_gcov: true

‎cfgmgr/Makefile.am

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,20 @@ macsecmgrd_SOURCES = macsecmgrd.cpp macsecmgr.cpp $(top_srcdir)/orchagent/orch.c
8787
macsecmgrd_CFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_SAI)
8888
macsecmgrd_CPPFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_SAI)
8989
macsecmgrd_LDADD = $(COMMON_LIBS) $(SAIMETA_LIBS)
90+
91+
if GCOV_ENABLED
92+
vlanmgrd_LDADD += -lgcovpreload
93+
teammgrd_LDADD += -lgcovpreload
94+
portmgrd_LDADD += -lgcovpreload
95+
intfmgrd_LDADD+= -lgcovpreload
96+
buffermgrd_LDADD += -lgcovpreload
97+
vrfmgrd_LDADD += -lgcovpreload
98+
nbrmgrd_LDADD += -lgcovpreload
99+
vxlanmgrd_LDADD += -lgcovpreload
100+
sflowmgrd_LDADD += -lgcovpreload
101+
natmgrd_LDADD += -lgcovpreload
102+
coppmgrd_LDADD += -lgcovpreload
103+
tunnelmgrd_LDADD += -lgcovpreload
104+
macsecmgrd_LDADD += -lgcovpreload
105+
endif
106+

‎configure.ac

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,25 @@ CFLAGS_COMMON+=" -Wno-switch-default"
102102
CFLAGS_COMMON+=" -Wno-long-long"
103103
CFLAGS_COMMON+=" -Wno-redundant-decls"
104104

105+
# Code testing coverage with gcov
106+
AC_MSG_CHECKING(whether to build with gcov testing)
107+
AC_ARG_ENABLE(gcov, AS_HELP_STRING([--enable-gcov], [Whether to enable gcov testing]),, enable_gcov=no)
108+
109+
if test "x$enable_gcov" = "xyes"; then
110+
if test "$GCC" = "no"; then
111+
AC_MSG_ERROR(not compiling with gcc, which is required for gcov testing)
112+
fi
113+
114+
CFLAGS_COMMON+=" -fprofile-arcs -ftest-coverage"
115+
AC_SUBST(CFLAGS_COMMON)
116+
117+
LDFLAGS+=" -fprofile-arcs -lgcov"
118+
AC_SUBST(LDFLAGS)
119+
fi
120+
121+
AM_CONDITIONAL(GCOV_ENABLED, test x$enable_gcov = xyes)
122+
AC_MSG_RESULT($enable_gcov)
123+
105124
AC_SUBST(CFLAGS_COMMON)
106125

107126
AC_CONFIG_FILES([

‎debian/rules

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,18 @@ include /usr/share/dpkg/default.mk
2727
# dh_auto_configure -- \
2828
# -DCMAKE_LIBRARY_PATH=$(DEB_HOST_MULTIARCH)
2929

30+
ifeq ($(ENABLE_GCOV), y)
31+
override_dh_auto_configure:
32+
dh_auto_configure -- --enable-gcov
33+
endif
34+
3035
override_dh_auto_install:
3136
dh_auto_install --destdir=debian/swss
37+
ifeq ($(ENABLE_GCOV), y)
38+
mkdir -p debian/swss/tmp/gcov
39+
sh ./tests/gcov_support.sh collect swss
40+
endif
3241

3342
override_dh_strip:
3443
dh_strip --dbg-package=swss-dbg
44+

‎fdbsyncd/Makefile.am

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,6 @@ fdbsyncd_CFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(COV_CFLAGS)
1414
fdbsyncd_CPPFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(COV_CFLAGS)
1515
fdbsyncd_LDADD = -lnl-3 -lnl-route-3 -lswsscommon $(COV_LDFLAGS)
1616

17+
if GCOV_ENABLED
18+
fdbsyncd_LDADD += -lgcovpreload
19+
endif

‎fpmsyncd/Makefile.am

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ fpmsyncd_SOURCES = fpmsyncd.cpp fpmlink.cpp routesync.cpp $(top_srcdir)/warmrest
1313
fpmsyncd_CFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON)
1414
fpmsyncd_CPPFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON)
1515
fpmsyncd_LDADD = -lnl-3 -lnl-route-3 -lswsscommon
16+
17+
if GCOV_ENABLED
18+
fpmsyncd_LDADD += -lgcovpreload
19+
endif

0 commit comments

Comments
 (0)