diff --git a/ChangeLog b/ChangeLog index 21ff3bdc1c21d65768dc74d2d4830d3ceb6f1d21..dfc62ee2550fa8dcef0dce8dfdbb8f3287781d08 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +Tue Feb 13 19:46:35 EST 2007 Daniel Berrange + + * autobuild.sh: Run coverage tests during automated build + * autogen.sh: Point aclocal at m4 directory explicitly + * configure.in: Added command line arg to enable coverage + * Makefile.am: Added scripts directory + * src/Makefile.am: Build with coverage testing if requested + and add target for extracting coverage data + * scripts/*: Helper tools for coverage testing + * tests/Makefile.am: Make tests link to object files instad + of the static library to ensure single output dest for + coverage data when running tests + Tue Feb 13 19:29:35 EST 2007 Daniel Berrange * src/qemu_internal.h, src/qemu_internal.c, src/Makefile.am, diff --git a/Makefile.am b/Makefile.am index ddf52ca9f9ab62c6ee1a9ae69cbd5542fe786886..630762356c9d9ff486c473a2ad6abb4ba370bbb5 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ ## Process this file with automake to produce Makefile.in -SUBDIRS = src qemud proxy include docs @PYTHON_SUBDIR@ tests po +SUBDIRS = src qemud proxy include docs @PYTHON_SUBDIR@ tests po scripts ACLOCAL_AMFLAGS = -I m4 @@ -21,4 +21,23 @@ check-local: all tests tests: @(cd docs/examples ; $(MAKE) MAKEFLAGS+=--silent tests) @(if [ "@PYTHON_SUBDIR@" != "" ] ; then cd python ; \ - $(MAKE) MAKEFLAGS+=--silent tests ; fi) + $(MAKE) MAKEFLAGS+=--silent tests ; fi) + +cov: cov-recursive cov-am + +clean-cov: + rm -rf $(top_builddir)/coverage + cd src && $(MAKE) $(AM_MAKEFLAGS) clean-cov + +cov-recursive: + cd src && $(MAKE) $(AM_MAKEFLAGS) cov + +cov-am: + rm -rf $(top_builddir)/coverage + mkdir $(top_builddir)/coverage + perl $(srcdir)/scripts/coverage-report.pl src/*.cov > $(top_builddir)/coverage/index.xml + xsltproc $(srcdir)/scripts/coverage-report.xsl \ + $(top_builddir)/coverage/index.xml \ + > $(top_builddir)/coverage/index.html + for i in $(top_builddir)/src/*.gcov ; do o=`echo $$i | sed -e 's,$(top_builddir)/src,coverage,'` ; \ + perl $(srcdir)/scripts/coverage-report-entry.pl $$i > $$o.html ; done diff --git a/autobuild.sh b/autobuild.sh index 2c23e62dcab8bc19ecfe5c151f4128ed2f5f8ef9..1ec2aa1c9887fbca9853053b80939fa43c9921b2 100755 --- a/autobuild.sh +++ b/autobuild.sh @@ -1,25 +1,26 @@ #!/bin/sh set -e +set -v # Make things clean. test -n "$1" && RESULTS="$1" || RESULTS="results.log" test -f Makefile && make -k distclean || : -rm -rf MANIFEST blib +rm -rf coverage #rm -rf build #mkdir build #cd build -./autogen.sh --prefix=$AUTOBUILD_INSTALL_ROOT +./autogen.sh --prefix=$AUTOBUILD_INSTALL_ROOT --enable-test-coverage make make install -make check 1>$RESULTS 2>&1 -#make cov +make check 2>&1 | tee $RESULTS +make cov rm -f *.tar.gz make dist diff --git a/autogen.sh b/autogen.sh index 798eff713702c5a9c40883d4656ab20b7c7d1279..7eb745d0dd7d791b7fce82298308569db1a785af 100755 --- a/autogen.sh +++ b/autogen.sh @@ -57,7 +57,7 @@ fi autopoint --force #rm -rf m4 libtoolize --copy --force -aclocal $ACLOCAL_FLAGS +aclocal -I m4 automake --add-missing autoconf diff --git a/configure.in b/configure.in index c1bade40aabe343e9135485e91c39b21bb0a2a30..2cb1e98d9887a0fede8d0c1f54de4d36a71ae7fd 100644 --- a/configure.in +++ b/configure.in @@ -268,6 +268,23 @@ AC_MSG_RESULT($RUNNING_XEND) AM_CONDITIONAL(ENABLE_XEN_TESTS, [test "$RUNNING_XEN" != "no" -a "$RUNNING_XEND" != "no"]) +AC_ARG_ENABLE(test-coverage, +[ --enable-test-coverage turn on code coverage instrumentation], +[case "${enableval}" in + yes|no) ;; + *) AC_MSG_ERROR([bad value ${enableval} for test-coverage option]) ;; + esac], + [enableval=no]) + +if test "${enableval}" = yes; then + gl_COMPILER_FLAGS(-fprofile-arcs) + gl_COMPILER_FLAGS(-ftest-coverage) + AC_SUBST([COVERAGE_CFLAGS], [$COMPILER_FLAGS]) + AC_SUBST([COVERAGE_LDFLAGS], [$COMPILER_FLAGS]) + COMPILER_FLAGS= +fi + + AM_GNU_GETTEXT_VERSION([0.14.1]) AM_GNU_GETTEXT([external]) if test -d po @@ -285,7 +302,7 @@ AC_OUTPUT(Makefile src/Makefile include/Makefile docs/Makefile \ docs/examples/Makefile docs/devhelp/Makefile \ docs/examples/python/Makefile \ libvirt.pc libvirt.spec \ - po/Makefile.in \ + po/Makefile.in scripts/Makefile \ include/libvirt/Makefile include/libvirt/libvirt.h \ python/Makefile python/tests/Makefile \ qemud/Makefile \ diff --git a/scripts/.cvsignore b/scripts/.cvsignore new file mode 100644 index 0000000000000000000000000000000000000000..282522db0342d8750454b3dc162493b5fc709cc8 --- /dev/null +++ b/scripts/.cvsignore @@ -0,0 +1,2 @@ +Makefile +Makefile.in diff --git a/scripts/Makefile.am b/scripts/Makefile.am new file mode 100644 index 0000000000000000000000000000000000000000..7078fe8302b23e1d5cda67ddab4d9fbe6aadd167 --- /dev/null +++ b/scripts/Makefile.am @@ -0,0 +1,4 @@ + +EXTRA_DIST = coverage-report.pl \ + coverage-report-entry.pl \ + coverage-report.xsl diff --git a/scripts/README b/scripts/README new file mode 100644 index 0000000000000000000000000000000000000000..fdbf9574e3227be8de75d96608dbe46f4480178f --- /dev/null +++ b/scripts/README @@ -0,0 +1,3 @@ +This directory provides a collection of tools used in the +build / test process. They are not installed / used after +deployment. diff --git a/scripts/coverage-report-entry.pl b/scripts/coverage-report-entry.pl new file mode 100644 index 0000000000000000000000000000000000000000..c3f02558f71901c569811bcb4f476aeef2e76397 --- /dev/null +++ b/scripts/coverage-report-entry.pl @@ -0,0 +1,77 @@ +#!/usr/bin/perl +# +# Copyright (C) 2006-2007 Daniel P. Berrange +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# Author: Daniel P. Berrange +# +# coverage-report-entry.pl: convert gcov annotated source into HTML +# +# This script takes a gcov annotated source code files on STDIN +# converts it to HTML, coloured according to coverage, and sends +# it to STDOUT + +print < + +Coverage report for $ARGV[0] + + + +

Coverage report for $ARGV[0]

+ +
+EOF
+
+
+while (<>) {
+    s/&/&/g;
+    s//>/g;
+
+    if (/^\s*function (\S+) called (\d+) returned \d+% blocks executed \d+%/) {
+	my $class = $2 > 0 ? "perfect" : "terrible";
+	$_ = "$_";
+    } elsif (/^\s*branch\s+\d+\s+taken\s+(\d+)%\s+.*$/) {
+	my $class = $1 > 0 ? "perfect" : "terrible";
+	$_ = "$_";
+    } elsif (/^\s*branch\s+\d+\s+never executed.*$/) {
+	my $class = "terrible";
+	$_ = "$_";
+    } elsif (/^\s*call\s+\d+\s+never executed.*$/) {
+	my $class = "terrible";
+	$_ = "$_";
+    } elsif (/^\s*call\s+\d+\s+returned\s+(\d+)%.*$/) {
+	my $class = $1 > 0 ? "perfect" : "terrible";
+	$_ = "$_";
+    }
+
+
+    print;
+}
+
+print <
+
+
+EOF
diff --git a/scripts/coverage-report.pl b/scripts/coverage-report.pl
new file mode 100644
index 0000000000000000000000000000000000000000..e67ecf9e74fee9a10d875a7a50b6548b936df3b8
--- /dev/null
+++ b/scripts/coverage-report.pl
@@ -0,0 +1,137 @@
+#!/usr/bin/perl
+#
+# Copyright (C) 2006-2007 Daniel P. Berrange
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
+#
+# Author: Daniel P. Berrange 
+#
+# coverage-report.pl: generate XML coverage summary report
+#
+# This script takes a listof gcov .cov files as args, and generates
+# an XML document summarizing the coverage per function and per
+# source file.
+
+use warnings;
+use strict;
+
+my %coverage = ( functions => {}, files => {} );
+
+my %filemap;
+
+my $type;
+my $name;
+
+my @functions;
+
+while (<>) {
+    if (/^Function '(.*)'\s*$/) {
+	$type = "function";
+	$name = $1;
+	$coverage{$type}->{$name} = {};
+	push @functions, $name;
+    } elsif (/^File '(.*?)'\s*$/) {
+	$type = "file";
+	$name = $1;
+	$coverage{$type}->{$name} = {};
+
+	foreach my $func (@functions) {
+	    $coverage{"function"}->{$func}->{file} = $name;
+	}
+	@functions = ();
+    } elsif (/^Lines executed:(.*)%\s*of\s*(\d+)\s*$/) {
+	$coverage{$type}->{$name}->{lines} = $2;
+	$coverage{$type}->{$name}->{linesCoverage} = $1;
+    } elsif (/^Branches executed:(.*)%\s*of\s*(\d+)\s*$/) {
+	$coverage{$type}->{$name}->{branches} = $2;
+	$coverage{$type}->{$name}->{branchesCoverage} = $1;
+    } elsif (/^Taken at least once:(.*)%\s*of\s*(\d+)\s*$/) {
+	$coverage{$type}->{$name}->{conds} = $2;
+	$coverage{$type}->{$name}->{condsCoverage} = $1;
+    } elsif (/^Calls executed:(.*)%\s*of\s*(\d+)\s*$/) {
+	$coverage{$type}->{$name}->{calls} = $2;
+	$coverage{$type}->{$name}->{callsCoverage} = $1;
+    } elsif (/^No branches$/) {
+	$coverage{$type}->{$name}->{branches} = 0;
+	$coverage{$type}->{$name}->{branchesCoverage} = "100.00";
+	$coverage{$type}->{$name}->{conds} = 0;
+	$coverage{$type}->{$name}->{condsCoverage} = "100.00";
+    } elsif (/^No calls$/) {
+	$coverage{$type}->{$name}->{calls} = 0;
+	$coverage{$type}->{$name}->{callsCoverage} = "100.00";
+    } elsif (/^\s*(.*):creating '(.*)'\s*$/) {
+	$filemap{$1} = $2;
+    } elsif (/^\s*$/) {
+	# nada
+    } else {
+	warn "unexpected input [$_]\n";
+    }
+}
+
+my %summary;
+foreach my $type ("function", "file") {
+    $summary{$type} = {};
+    foreach my $m ("lines", "branches", "conds", "calls") {
+	my $totalGot = 0;
+	my $totalMiss = 0;
+	my $count = 0;
+	foreach my $func (keys %{$coverage{function}}) {
+	    $count++;
+	    my $got = $coverage{function}->{$func}->{$m};
+	    $totalGot += $got;
+	    my $miss = $got * $coverage{function}->{$func}->{$m ."Coverage"} / 100;
+	    $totalMiss += $miss;
+	}
+	$summary{$type}->{$m} = sprintf("%d", $totalGot);
+	if ($totalGot == 0) {
+	    $summary{$type}->{$m . "Coverage"} = "100.00";
+	} else {
+	    $summary{$type}->{$m . "Coverage"} = sprintf("%.2f", $totalMiss / $totalGot * 100);
+	}
+    }
+}
+
+
+
+print "\n";
+
+foreach my $type ("function", "file") {
+    printf "<%ss>\n", $type;
+    foreach my $name (sort { $a cmp $b } keys %{$coverage{$type}}) {
+	my $rec = $coverage{$type}->{$name};
+	printf "  \n", $name, ($type eq "file" ? $filemap{$name} : $filemap{$rec->{file}});
+	printf "    \n", $rec->{lines}, $rec->{linesCoverage};
+	if (exists $rec->{branches}) {
+	    printf "    \n", $rec->{branches}, $rec->{branchesCoverage};
+	}
+	if (exists $rec->{conds}) {
+	    printf "    \n", $rec->{conds}, $rec->{condsCoverage};
+	}
+	if (exists $rec->{calls}) {
+	    printf "    \n", $rec->{calls}, $rec->{callsCoverage};
+	}
+	print  "  \n";
+    }
+
+    printf "  \n";
+    printf "    \n", $summary{$type}->{lines}, $summary{$type}->{linesCoverage};
+    printf "    \n", $summary{$type}->{branches}, $summary{$type}->{branchesCoverage};
+    printf "    \n", $summary{$type}->{conds}, $summary{$type}->{condsCoverage};
+    printf "    \n", $summary{$type}->{calls}, $summary{$type}->{callsCoverage};
+    printf  "  \n";
+    printf "\n", $type;
+}
+
+print "\n";
diff --git a/scripts/coverage-report.xsl b/scripts/coverage-report.xsl
new file mode 100644
index 0000000000000000000000000000000000000000..67750357144b715db9ddeaa0faba990e5bb03642
--- /dev/null
+++ b/scripts/coverage-report.xsl
@@ -0,0 +1,217 @@
+
+
+
+  
+
+  
+    
+      
+        Coverage report
+        
+      
+      
+        
Coverage report

+        
+      
+    
+  
+
+  
+    
Function coverage

+    
+      
+    
+  
+  
+
+  
+    
File coverage

+    
+      
+    
+  
+
+  
+    
+    
+      
+        
+          
+          
+          
+          
+          
+        
+      
+      
+        
+          
+            
+            
+              
+                
+                  odd
+                
+                
+                  even
+                
+              
+            
+          
+        
+      
+      
+        
+          
+            
+            
+              
+                
+                  odd
+                
+                
+                  even
+                
+              
+            
+          
+        
+      
+    
NameLinesBranchesConditionsCalls

+  
+  
+  
+    
+    
+    
+      
+        
+          
+        
+        
+          
+        
+        
+          Summary
+        
+      
+
+      
+        
+      
+      
+        
+      
+
+      
+        
+      
+      
+        
+      
+
+      
+        
+      
+      
+        
+      
+
+      
+        
+      
+      
+        
+      
+
+    
+  
+  
+  
+    
+  
+
+  
+    
+  
+
+  
+    
+  
+
+  
+    
+  
+
+  
+    
+  
+
+  
+    
+      
+        
+          perfect
+        
+        
+          excellant
+        
+        
+          good
+        
+        
+          poor
+        
+        
+          bad
+        
+        
+          terrible
+        
+      
+    
+    
+    % of 
+  
+
+
diff --git a/src/Makefile.am b/src/Makefile.am
index df210f753a1c738a792d08efc5b8625a9a4eb5e0..69546b63fc220d93e2de2cd8ec0c32ead8c628bb 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -13,8 +13,9 @@ EXTRA_DIST = libvirt_sym.version
 lib_LTLIBRARIES = libvirt.la
 libvirt_la_LIBADD = @LIBXML_LIBS@
 libvirt_la_LDFLAGS = -Wl,--version-script=$(srcdir)/libvirt_sym.version \
-                    -version-info @LIBVIRT_VERSION_INFO@
-
+                    -version-info @LIBVIRT_VERSION_INFO@ \
+                    $(COVERAGE_CFLAGS:-f%=-Wc,-f%)
+libvirt_la_CFLAGS = $(COVERAGE_CFLAGS)
 libvirt_la_SOURCES =						\
 		libvirt.c internal.h				\
 		hash.c hash.h					\
@@ -34,12 +35,25 @@ libvirt_la_SOURCES =						\
 bin_PROGRAMS = virsh
 
 virsh_SOURCES = virsh.c console.c console.h
-virsh_LDFLAGS =
+virsh_LDFLAGS = $(COVERAGE_LDFLAGS)
 virsh_DEPENDENCIES = $(DEPS)
 virsh_LDADD = $(LDADDS) $(VIRSH_LIBS)
+virsh_CFLAGS = $(COVERAGE_CFLAGS)
 
 #
 # target to ease building test programs
 #
 tst: tst.c
 	$(CC) $(CFLAGS) -I../include -o tst tst.c .libs/libvirt.a -lxml2 -lxenstore -lpthread
+
+COVERAGE_FILES = $(libvirt_la_SOURCES:%.c=libvirt_la-%.cov)
+
+cov: clean-cov $(COVERAGE_FILES)
+
+clean-cov:
+	rm -f *.cov *.gcov
+
+%.cov: .libs/%.o
+	gcov -b -f -o .libs $< > $@
+
+CLEANFILES = *.cov *.gcov .libs/*.gcda .libs/*.gcno *.gcno *.gcda
diff --git a/tests/Makefile.am b/tests/Makefile.am
index e48e3fe94362e81d496317a26a59579b2582302f..93e9a8f39e2a74e96c622a5efabce00872e00728 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -2,7 +2,13 @@
 
 SUBDIRS = virshdata confdata sexpr2xmldata xml2sexprdata xmconfigdata
 
-LIBVIRT = $(top_builddir)/src/.libs/libvirt.a
+# Wierd libtool related juju...
+#
+# We explicitly want wildcard here instead of just linking
+# to the libvirt.a file. This ensures that when coverage
+# tests are run, all the output data ends up in the correct
+# location. ie, src/ instead of src/.libs.
+LIBVIRT = $(wildcard $(top_builddir)/src/.libs/*.o)
 
 INCLUDES = \
 	-I$(top_builddir)/include \
@@ -11,11 +17,14 @@ INCLUDES = \
 	-I$(top_srcdir)/src \
 	@LIBXML_CFLAGS@ \
         -D_XOPEN_SOURCE=600 -D_POSIX_C_SOURCE=199506L \
-        -DGETTEXT_PACKAGE=\"$(PACKAGE)\"
+        -DGETTEXT_PACKAGE=\"$(PACKAGE)\" \
+         $(COVERAGE_CFLAGS)
+
 LDADDS = \
 	@STATIC_BINARIES@ \
 	@LIBXML_LIBS@ \
-	$(LIBVIRT)
+	$(LIBVIRT) \
+        $(COVERAGE_LDFLAGS)
 
 EXTRA_DIST = xmlrpcserver.py test_conf.sh