]> git.saurik.com Git - apt.git/blobdiff - prepare-release
add a 'coverage' command to generate reports
[apt.git] / prepare-release
index a9cc49cfda4e93be7c3a0cf674d58988aff5bc0a..e61266eef82f190a35cfaaf52286f0ef4ede74b9 100755 (executable)
@@ -1,14 +1,29 @@
 #!/bin/sh
-
 set -e
 
+cd "$(readlink -f $(dirname $0))"
+
+if [ -n "${GBP_BUILD_DIR}" ]; then
+   cd "$GBP_BUILD_DIR"
+fi
+
 VERSION=$(dpkg-parsechangelog | sed -n -e '/^Version:/s/^Version: //p')
 DISTRIBUTION=$(dpkg-parsechangelog | sed -n -e '/^Distribution:/s/^Distribution: //p')
 
-LIBAPTPKGVERSION="$(awk -v ORS='.' '/^\#define APT_PKG_M/ {print $3}' apt-pkg/init.h | sed 's/\.$//')"
+LIBAPTPKGVERSION="$(awk -v ORS='.' '/^\#define APT_PKG_M/ {print $3}' apt-pkg/contrib/macros.h | sed 's/\.$//')"
 LIBAPTINSTVERSION="$(egrep '^MAJOR=' apt-inst/makefile |cut -d '=' -f 2)"
 
-dpkg-checkbuilddeps -d 'libxml2-utils'
+librarysymbolsfromfile() {
+       local MISSING="$(grep '^+#MISSING' "$1")"
+       echo '=== Missing optional symbols:'
+       echo -n "$MISSING" | grep '|optional=' || true
+       echo '=== Missing required symbols:'
+       echo -n "$MISSING" | grep -v '|optional=' || true
+       echo '=== New symbols:'
+       grep '^+ ' "$1" | cut -d' ' -f 2 | cut -d'@' -f 1 | c++filt | while read line; do
+               echo " (c++)\"${line}@Base\" $VERSION"
+       done | sort -u
+}
 
 if [ "$1" = 'pre-export' ]; then
        libraryversioncheck() {
@@ -47,41 +62,124 @@ if [ "$1" = 'pre-export' ]; then
        sed -i -e "s/^<!ENTITY apt-product-version \".*\">$/<!ENTITY apt-product-version \"${VERSION}\">/" doc/apt-verbatim.ent
 elif [ "$1" = 'post-build' ]; then
        if [ "$DISTRIBUTION" != "UNRELEASED" ]; then
-               echo >&2 "REMEMBER: Tag this release with »bzr tag ${VERSION}« if you are satisfied"
+               echo >&2 "REMEMBER: Tag this release with »git tag ${VERSION}« if you are satisfied"
        else
                echo >&2 'REMEMBER: Change to a valid distribution before release'
        fi
-       if ! xmllint --nonet --valid --noout $(find doc/ -maxdepth 1 -name '*.xml'); then
-               echo >&2 'WARNING: original docbook manpages have errors!'
-       elif ! xmllint --nonet --valid --noout $(find doc/ -mindepth 2 -maxdepth 2 -name '*.xml'); then
-               echo >&2 'WARNING: translated docbook manpages have errors, but originals are okay!'
+
+       dpkg-checkbuilddeps -d 'libxml2-utils'
+
+       HEADERBLUEPRINT="$(mktemp)"
+       sed -n '1,/^$/p' doc/apt.8.xml > "$HEADERBLUEPRINT"
+       find doc -mindepth 1 -maxdepth 1 -type f -name '*.xml' | while read FILE; do
+               if ! sed -n '1,/^$/p' "$FILE" | cmp "$HEADERBLUEPRINT" - >/dev/null 2>&1; then
+                       echo >&2 "WARNING: Manpage $FILE has not the usual header! (see diff below)"
+                       sed -n '1,/^$/p' "$FILE" | diff -u "$HEADERBLUEPRINT" - || true
+               fi
+       done
+       sed -n '1,/^$/p' doc/guide.dbk > "$HEADERBLUEPRINT"
+       find doc -mindepth 1 -maxdepth 1 -type f -name '*.dbk' | while read FILE; do
+               if ! sed -n '1,/^$/p' "$FILE" | cmp "$HEADERBLUEPRINT" - >/dev/null 2>&1; then
+                       echo >&2 "WARNING: Documentation $FILE has not the usual header (see diff below)!"
+                       sed -n '1,/^$/p' "$FILE" | diff -u "$HEADERBLUEPRINT" - || true
+               fi
+       done
+       rm "$HEADERBLUEPRINT"
+
+       # check the manpages with each vendor for vendor-specific errors…
+       find vendor -mindepth 1 -maxdepth 1 -type d | cut -d'/' -f 2 | while read DISTRO; do
+               ln -sf ../vendor/${DISTRO}/apt-vendor.ent doc
+               if ! xmllint --nonet --valid --noout $(find doc/ -maxdepth 1 -name '*.xml'); then
+                       echo >&2 "WARNING: original docbook manpages have errors with vendor ${DISTRO}!"
+               fi
+       done
+       # lets assume we will always have a german manpage translation
+       if [ -e 'doc/de/' ]; then
+               # … but check the translations only with one vendor for translation-specific errors
+               if ! xmllint --nonet --valid --noout $(find doc/ -mindepth 2 -maxdepth 2 -name '*.xml'); then
+                       echo >&2 "WARNING: translated docbook manpages have errors!"
+               fi
+       else
+               echo >&2 "ERROR: translated manpages need to be build before they can be checked!"
        fi
+       rm -f doc/apt-vendor.ent
+
 elif [ "$1" = 'library' ]; then
        librarysymbols() {
                echo "Checking $1 in version $2"
                local tmpfile=$(mktemp)
-               dpkg-gensymbols -p${1}${2} -ebuild/bin/${1}.so.${2} -Idebian/${1}${2}.symbols -O/dev/null 2> /dev/null > $tmpfile
-               echo '=== Missing symbols:'
-               grep '^+#MISSING' $tmpfile
-               echo '=== New symbols:'
-               grep '^+ ' $tmpfile | cut -d' ' -f 2 | cut -d'@' -f 1 | c++filt | while read line; do
-                       echo " (c++)\"${line}@Base\" $VERSION"
-               done | sort -u
-               rm $tmpfile
+               dpkg-gensymbols -p${1}${2} -ebuild/bin/${1}.so.${2} -Idebian/${1}${2}.symbols -O/dev/null 2> /dev/null > $tmpfile || true
+               librarysymbolsfromfile "$tmpfile"
+               rm -f $tmpfile
        }
        librarysymbols 'libapt-pkg' "${LIBAPTPKGVERSION}"
        echo
        librarysymbols 'libapt-inst' "${LIBAPTINSTVERSION}"
+elif [ "$1" = 'buildlog' ]; then
+       while [ -n "$2" ]; do
+               librarysymbolsfromfile "$2"
+               shift
+       done
+elif [ "$1" = 'travis-ci' ]; then
+       apt-get install -q --no-install-recommends $(sed -n -e '/^Build-Depends: /,/^Build-Depends-Indep: / {p}' debian/control | sed -e 's#([^)]*)##g' -e 's#^Build-Depends\(-Indep\)\?: ##' | tr -d ',')
+       apt-get install -q --no-install-recommends $(sed -n 's#^Depends: .*@, \(.*\)$#\1#p' debian/tests/control | tr -d ',')
+elif [ "$1" = 'coverage' ]; then
+       DIR="${2:-./coverage}"
+       git clean -dfX # remove ignored build artefacts for a clean start
+       make CFLAGS+='--coverage' CXXFLAGS+='--coverage'
+       LCOVRC='--rc geninfo_checksum=1 --rc lcov_branch_coverage=1'
+       mkdir "$DIR"
+       lcov --no-external --directory . --capture --initial --output-file "${DIR}/apt.coverage.init" ${LCOVRC}
+       make test
+       ./test/integration/run-tests -q
+       lcov --no-external --directory . --capture --output-file "${DIR}/apt.coverage.run" ${LCOVRC}
+       lcov -a "${DIR}/apt.coverage.init" -a "${DIR}/apt.coverage.run"  -o "${DIR}/apt.coverage.total" ${LCOVRC}
+       cp "${DIR}/apt.coverage.total" "${DIR}/apt.coverage.fixed"
+       rewritefile() {
+               file="$1"
+               shift
+               name="$(basename "$file")"
+               while [ -n "$1" ]; do
+                       if [ -r "$1/$name" ]; then
+                               sed -i "s#$file#$1/$name#" "${DIR}/apt.coverage.fixed"
+                               break
+                       fi
+                       shift
+               done
+               if [ -z "$1" ]; then
+                       echo >&2 "Coverage data captured for unknown file $file"
+               fi
+       }
+       grep 'build/include/' "${DIR}/apt.coverage.fixed" | sed "s#^SF:$(pwd)/##" | while read file; do
+               rewritefile "$file" 'apt-pkg' 'apt-pkg/deb' 'apt-pkg/edsp' 'apt-pkg/contrib' \
+                  'apt-inst' 'apt-inst/deb' 'apt-inst/contrib' 'apt-private'
+       done
+       genhtml --output-directory "${DIR}" "${DIR}/apt.coverage.fixed" ${LCOVRC}
 else
        echo >&1 "Usage:\t$0 pre-export
 \t$0 post-build
-\t$0 library
 
-If you use »bzr builddeb« you can leave this script alone as it will
+If you use »git buildpackage« you can leave these alone as they will
 be run at the right places auto-magically. Otherwise you should use
 »pre-export« to update po and pot files as well as version numbering.
 »post-build« can be used to run some more or less useful checks later on.
 
-»library« isn't run automatically but can be useful for maintaining the
-(more or less experimental) symbols files we provide"
+\t$0 library
+\t$0 buildlog filename…
+
+»library« and »buildlog« aren't run automatically but can be useful for
+maintaining the (more or less experimental) symbols files we provide.
+»library« displays the diff between advertised symbols and the once provided
+by the libraries, while »buildlog« extracts this diff from the buildlogs.
+Both will format the diff properly.
+
+\t$0 travis-ci
+\t$0 coverage [output-dir]
+
+»travis-ci« is a shortcut to install all build- as well as test-dependencies
+used by .travis.yml.
+»coverage« does a clean build with the right flags for coverage reporting,
+runs all tests and generates a html report in the end.
+"
+
 fi