Merge pull request #83 from farsightsec/reed-1.6.1

mtbl 1.6.1 release with configure/make code coverage

Author: mcrawforddt

.gitignore

@@ -1,5 +1,7 @@
 *~
 .*swp
+*.gcda
+*.gcno
 *.la
 *.lo
 *.log
@@ -16,6 +18,9 @@
 /configure
 /libtool
 /stamp-h1
+all.coverage
+coverage-html
 Makefile
 Makefile.in
+report.coverage
 TAGS

ChangeLog

@@ -1,3 +1,16 @@
+mtbl (1.6.1)
+
+  * Add ./configure --with-coverage option to build with code coverage
+  and make targets: clean-coverage to remove the coverage data and results
+  and report-coverage to generate report (after running the code such as
+  with "make check").
+
+mtbl (1.6.0)
+
+  * Return mtbl_iter_init() to public API
+  * Further optimizations to mtbl_iter_seek() for mtbl_reader and mtbl_merger
+  * Streamline mtbl varint decoding
+
 mtbl (1.5.1)
 
   * Skip unnecessary seeks when seeking forward on a merger iterator.

Makefile.am

@@ -17,6 +17,41 @@ AM_CFLAGS = \
 	$(libzstd_CFLAGS)
 AM_LDFLAGS =
 
+#
+##
+### code coverage
+##
+#
+
+USE_LCOV=@USE_LCOV@
+LCOV=@LCOV@
+GENHTML=@GENHTML@
+
+clean-coverage:
+	@if [ $(USE_LCOV) = yes ] ; then \
+		$(LCOV) --directory . --zerocounters ; \
+		echo "Removing coverage info files and generated $(abs_top_builddir)/coverage-html/ directory" ; \
+		rm -rf all.coverage report.coverage ; \
+		rm -rf $(abs_top_builddir)/coverage-html/ ; \
+	else \
+		echo "Code coverage not enabled at configuration time." ; \
+		echo "Use: ./configure --with-coverage" ; \
+fi
+
+report-coverage:
+	@if [ $(USE_LCOV) = yes ] ; then \
+		$(LCOV) --capture --directory . --output-file all.coverage ; \
+		$(LCOV) --remove all.coverage \
+			$(abs_top_srcdir)/t/\* \
+			/usr/include/\* \
+			--output report.coverage ; \
+		$(GENHTML) --legend -o $(abs_top_builddir)/coverage-html report.coverage ; \
+		echo "Generated Code Coverage report in HTML at $(abs_top_builddir)/coverage-html" ; \
+	else \
+		echo "Code coverage not enabled at configuration time." ; \
+		echo "Use: ./configure --with-coverage" ; \
+fi
+
 #
 ##
 ### library

configure.ac

@@ -1,6 +1,6 @@
 AC_PREREQ(2.64)
 AC_INIT([mtbl],
-        [1.6.0],
+        [1.6.1],
         [https://github.com/farsightsec/mtbl/issues],
         [mtbl],
         [https://github.com/farsightsec/mtbl])
@@ -84,6 +84,35 @@ fi
 
 gl_LD_VERSION_SCRIPT
 
+AC_ARG_WITH(coverage,
+[ --with-coverage[=PROGRAM] enable gtest and coverage target using the specified lcov], lcov="$withval", lcov="no")
+
+USE_LCOV="no"
+if test "$lcov" != "no"; then
+	if test "$lcov" != "yes"; then
+		LCOV=$lcov
+	else
+		AC_PATH_PROG([LCOV], [lcov])
+	fi
+	if test -x "${LCOV}"; then
+		USE_LCOV="yes"
+	else
+		AC_MSG_ERROR([Cannot find lcov.])
+	fi
+	# is genhtml always in the same directory?
+	GENHTML=`echo "$LCOV" | ${SED} s/lcov$/genhtml/`
+	if test ! -x $GENHTML; then
+		AC_MSG_ERROR([genhtml not found, needed for lcov])
+	fi
+	CFLAGS="$CFLAGS --coverage"
+	LIBS=" $LIBS -lgcov"
+	AC_SUBST(CPPFLAGS)
+	AC_SUBST(LIBS)
+	AC_SUBST(LCOV)
+	AC_SUBST(GENHTML)
+fi
+AC_SUBST(USE_LCOV)
+
 AC_OUTPUT
 AC_MSG_RESULT([
     $PACKAGE $VERSION
@@ -102,4 +131,6 @@ AC_MSG_RESULT([
         bigendian:              ${ac_cv_c_bigendian}
 
         building manpage docs:  ${DOC_MAN_MSG}
+
+        code coverage enabled:  ${USE_LCOV}
 ])

debian/changelog

@@ -1,3 +1,12 @@
+mtbl (1.6.1-1) debian-fsi; urgency=medium
+
+  * Add ./configure --with-coverage option to build with code coverage
+    and make targets: clean-coverage to remove the coverage data and results
+    and report-coverage to generate report (after running the code such as
+    with "make check").
+
+ -- Farsight Security Inc <[email protected]>  Wed, 03 Apr 2024 15:40:01 +0000
+
 mtbl (1.6.0-2) debian-fsi; urgency=medium
 
   * Updated symbols

debian/control

@@ -4,7 +4,6 @@ Priority: optional
 Maintainer: Farsight Security, Inc. <[email protected]>
 Build-Depends:
  debhelper (>= 10~),
- dh-autoreconf (>= 5~),
  dpkg-dev (>= 1.16.0~),
  lcov,
  liblz4-dev (>= 0.0~r130),

mtbl.spec

@@ -1,5 +1,5 @@
 Name:           mtbl
-Version:        1.6.0
+Version:        1.6.1
 Release:        1%{?dist}
 Summary:	immutable sorted string table utilities