[apt.git] / prepare-release

#!/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/contrib/macros.h | sed 's/\.$//')"
LIBAPTINSTVERSION="$(egrep '^MAJOR=' apt-inst/makefile |cut -d '=' -f 2)"

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() {
		local LIBRARY="$1"
		local VERSION="$2"
		if [ ! -e "debian/${LIBRARY}${VERSION}.symbols" ]; then
		   echo >&2 "Library ${LIBRARY} in version ${VERSION} has no symbols file! (maybe forgot to rename?)"
		   exit 1
		fi
		if [ "$(head -n1 "debian/${LIBRARY}${VERSION}.symbols")" != "${LIBRARY}.so.${VERSION} ${LIBRARY}${VERSION} #MINVER#" ]; then
		   echo >&2 "Library ${LIBRARY}${VERSION} has incorrect version in symbol header! (»$(head -n1 "debian/${LIBRARY}${VERSION}.symbols")«)"
		   exit 2
		fi
	}

	libraryversioncheck 'libapt-pkg' "$LIBAPTPKGVERSION"
	libraryversioncheck 'libapt-inst' "$LIBAPTINSTVERSION"


	if [ "$DISTRIBUTION" = 'sid' ]; then
		echo >&2 '»sid« is not a valid distribution. Replace it with »unstable« for you'
		sed -i -e 's/) sid; urgency=/) unstable; urgency=/' debian/changelog
		DISTRIBUTION='unstable'
	elif [ "$DISTRIBUTION" = 'UNRELEASED' ]; then
		echo >&2 'WARNING: Remember to change to a valid distribution for release'
		VERSION="$VERSION~$(date +%Y%m%d)"
	fi

	sed -i -e "s/^PACKAGE_VERSION=\".*\"$/PACKAGE_VERSION=\"${VERSION}\"/" configure.ac
	sed -i -e "s/^<!ENTITY apt-product-version \".*\">$/<!ENTITY apt-product-version \"${VERSION}\">/" doc/apt-verbatim.ent

	if [ "$(date +%Y-%m-%d)" != "$(grep --max-count=1 '^"POT-Creation-Date: .*\n"$' po/apt-all.pot | cut -d' ' -f 2)" -o \
	     "$(date +%Y-%m-%d)" != "$(grep --max-count=1 '^"POT-Creation-Date: .*\n"$' doc/po/apt-doc.pot | cut -d' ' -f 2)" ]; then
		echo >&2 'POT files are not up-to-date. Execute »make update-po« for you…'
		make update-po
	fi
elif [ "$1" = 'post-build' ]; then
	if [ "$DISTRIBUTION" != "UNRELEASED" ]; then
		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

	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 || 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 || true
	./test/integration/run-tests -q || true
	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

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.

\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
Commit	Line	Data
3a496cd2	1	#!/bin/sh
fb83d0cc SL	2	set -e
fb83d0cc SL	3
a5414e56	4	cd "$(readlink -f $(dirname $0))"
01c790a7 DK	5
	6	if [ -n "${GBP_BUILD_DIR}" ]; then
	7	cd "$GBP_BUILD_DIR"
	8	fi
	9
3a496cd2 DK	10	VERSION=$(dpkg-parsechangelog \| sed -n -e '/^Version:/s/^Version: //p')
	11	DISTRIBUTION=$(dpkg-parsechangelog \| sed -n -e '/^Distribution:/s/^Distribution: //p')
	12
54298f49	13	LIBAPTPKGVERSION="$(awk -v ORS='.' '/^\#define APT_PKG_M/ {print $3}' apt-pkg/contrib/macros.h \| sed 's/\.$//')"
5ca28ebd DK	14	LIBAPTINSTVERSION="$(egrep '^MAJOR=' apt-inst/makefile \|cut -d '=' -f 2)"
5ca28ebd DK	15
4c90bc28 DK	16	librarysymbolsfromfile() {
	17	local MISSING="$(grep '^+#MISSING' "$1")"
	18	echo '=== Missing optional symbols:'
	19	echo -n "$MISSING" \| grep '\|optional=' \|\| true
	20	echo '=== Missing required symbols:'
	21	echo -n "$MISSING" \| grep -v '\|optional=' \|\| true
	22	echo '=== New symbols:'
	23	grep '^+ ' "$1" \| cut -d' ' -f 2 \| cut -d'@' -f 1 \| c++filt \| while read line; do
	24	echo " (c++)\"${line}@Base\" $VERSION"
	25	done \| sort -u
	26	}
	27
3a496cd2	28	if [ "$1" = 'pre-export' ]; then
154fd04e	29	libraryversioncheck() {
58921d7d DK	30	local LIBRARY="$1"
58921d7d DK	31	local VERSION="$2"
154fd04e DK	32	if [ ! -e "debian/${LIBRARY}${VERSION}.symbols" ]; then
	33	echo >&2 "Library ${LIBRARY} in version ${VERSION} has no symbols file! (maybe forgot to rename?)"
	34	exit 1
	35	fi
	36	if [ "$(head -n1 "debian/${LIBRARY}${VERSION}.symbols")" != "${LIBRARY}.so.${VERSION} ${LIBRARY}${VERSION} #MINVER#" ]; then
	37	echo >&2 "Library ${LIBRARY}${VERSION} has incorrect version in symbol header! (»$(head -n1 "debian/${LIBRARY}${VERSION}.symbols")«)"
	38	exit 2
	39	fi
	40	}
	41
5ca28ebd DK	42	libraryversioncheck 'libapt-pkg' "$LIBAPTPKGVERSION"
5ca28ebd DK	43	libraryversioncheck 'libapt-inst' "$LIBAPTINSTVERSION"
154fd04e DK	44
154fd04e DK	45
3a496cd2 DK	46	if [ "$DISTRIBUTION" = 'sid' ]; then
	47	echo >&2 '»sid« is not a valid distribution. Replace it with »unstable« for you'
	48	sed -i -e 's/) sid; urgency=/) unstable; urgency=/' debian/changelog
	49	DISTRIBUTION='unstable'
	50	elif [ "$DISTRIBUTION" = 'UNRELEASED' ]; then
	51	echo >&2 'WARNING: Remember to change to a valid distribution for release'
	52	VERSION="$VERSION~$(date +%Y%m%d)"
	53	fi
	54
fe1f8511 DK	55	sed -i -e "s/^PACKAGE_VERSION=\".*\"$/PACKAGE_VERSION=\"${VERSION}\"/" configure.ac
	56	sed -i -e "s/^<!ENTITY apt-product-version \".*\">$/<!ENTITY apt-product-version \"${VERSION}\">/" doc/apt-verbatim.ent
	57
3a496cd2 DK	58	if [ "$(date +%Y-%m-%d)" != "$(grep --max-count=1 '^"POT-Creation-Date: .*\n"$' po/apt-all.pot \| cut -d' ' -f 2)" -o \
	59	"$(date +%Y-%m-%d)" != "$(grep --max-count=1 '^"POT-Creation-Date: .*\n"$' doc/po/apt-doc.pot \| cut -d' ' -f 2)" ]; then
	60	echo >&2 'POT files are not up-to-date. Execute »make update-po« for you…'
	61	make update-po
	62	fi
3a496cd2 DK	63	elif [ "$1" = 'post-build' ]; then
3a496cd2 DK	64	if [ "$DISTRIBUTION" != "UNRELEASED" ]; then
3fadd319	65	echo >&2 "REMEMBER: Tag this release with »git tag ${VERSION}« if you are satisfied"
3a496cd2 DK	66	else
	67	echo >&2 'REMEMBER: Change to a valid distribution before release'
	68	fi
0c268997	69
d382a0e4 DK	70	dpkg-checkbuilddeps -d 'libxml2-utils'
d382a0e4 DK	71
5abbf5bb DK	72	HEADERBLUEPRINT="$(mktemp)"
	73	sed -n '1,/^$/p' doc/apt.8.xml > "$HEADERBLUEPRINT"
	74	find doc -mindepth 1 -maxdepth 1 -type f -name '*.xml' \| while read FILE; do
	75	if ! sed -n '1,/^$/p' "$FILE" \| cmp "$HEADERBLUEPRINT" - >/dev/null 2>&1; then
	76	echo >&2 "WARNING: Manpage $FILE has not the usual header! (see diff below)"
	77	sed -n '1,/^$/p' "$FILE" \| diff -u "$HEADERBLUEPRINT" - \|\| true
	78	fi
	79	done
	80	sed -n '1,/^$/p' doc/guide.dbk > "$HEADERBLUEPRINT"
	81	find doc -mindepth 1 -maxdepth 1 -type f -name '*.dbk' \| while read FILE; do
	82	if ! sed -n '1,/^$/p' "$FILE" \| cmp "$HEADERBLUEPRINT" - >/dev/null 2>&1; then
	83	echo >&2 "WARNING: Documentation $FILE has not the usual header (see diff below)!"
	84	sed -n '1,/^$/p' "$FILE" \| diff -u "$HEADERBLUEPRINT" - \|\| true
	85	fi
	86	done
	87	rm "$HEADERBLUEPRINT"
	88
0c268997 DK	89	# check the manpages with each vendor for vendor-specific errors…
	90	find vendor -mindepth 1 -maxdepth 1 -type d \| cut -d'/' -f 2 \| while read DISTRO; do
	91	ln -sf ../vendor/${DISTRO}/apt-vendor.ent doc
	92	if ! xmllint --nonet --valid --noout $(find doc/ -maxdepth 1 -name '*.xml'); then
	93	echo >&2 "WARNING: original docbook manpages have errors with vendor ${DISTRO}!"
	94	fi
	95	done
01c790a7 DK	96	# lets assume we will always have a german manpage translation
	97	if [ -e 'doc/de/' ]; then
	98	# … but check the translations only with one vendor for translation-specific errors
	99	if ! xmllint --nonet --valid --noout $(find doc/ -mindepth 2 -maxdepth 2 -name '*.xml'); then
	100	echo >&2 "WARNING: translated docbook manpages have errors!"
	101	fi
	102	else
	103	echo >&2 "ERROR: translated manpages need to be build before they can be checked!"
372c2a2d	104	fi
0c268997 DK	105	rm -f doc/apt-vendor.ent
0c268997 DK	106
5ca28ebd DK	107	elif [ "$1" = 'library' ]; then
	108	librarysymbols() {
	109	echo "Checking $1 in version $2"
58921d7d	110	local tmpfile=$(mktemp)
f1d87437	111	dpkg-gensymbols -p${1}${2} -ebuild/bin/${1}.so.${2} -Idebian/${1}${2}.symbols -O/dev/null 2> /dev/null > $tmpfile \|\| true
4c90bc28	112	librarysymbolsfromfile "$tmpfile"
f1d87437	113	rm -f $tmpfile
5ca28ebd DK	114	}
	115	librarysymbols 'libapt-pkg' "${LIBAPTPKGVERSION}"
	116	echo
	117	librarysymbols 'libapt-inst' "${LIBAPTINSTVERSION}"
4c90bc28 DK	118	elif [ "$1" = 'buildlog' ]; then
	119	while [ -n "$2" ]; do
	120	librarysymbolsfromfile "$2"
	121	shift
	122	done
d382a0e4 DK	123	elif [ "$1" = 'travis-ci' ]; then
d382a0e4 DK	124	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 ',')
0d33183f	125	apt-get install -q --no-install-recommends $(sed -n 's#^Depends: .@, \(.\)$#\1#p' debian/tests/control \| tr -d ',')
13fe505c DK	126	elif [ "$1" = 'coverage' ]; then
	127	DIR="${2:-./coverage}"
	128	git clean -dfX # remove ignored build artefacts for a clean start
	129	make CFLAGS+='--coverage' CXXFLAGS+='--coverage'
	130	LCOVRC='--rc geninfo_checksum=1 --rc lcov_branch_coverage=1'
	131	mkdir "$DIR"
	132	lcov --no-external --directory . --capture --initial --output-file "${DIR}/apt.coverage.init" ${LCOVRC}
ad7e0941 DK	133	make test \|\| true
ad7e0941 DK	134	./test/integration/run-tests -q \|\| true
13fe505c DK	135	lcov --no-external --directory . --capture --output-file "${DIR}/apt.coverage.run" ${LCOVRC}
	136	lcov -a "${DIR}/apt.coverage.init" -a "${DIR}/apt.coverage.run" -o "${DIR}/apt.coverage.total" ${LCOVRC}
	137	cp "${DIR}/apt.coverage.total" "${DIR}/apt.coverage.fixed"
	138	rewritefile() {
	139	file="$1"
	140	shift
	141	name="$(basename "$file")"
	142	while [ -n "$1" ]; do
	143	if [ -r "$1/$name" ]; then
	144	sed -i "s#$file#$1/$name#" "${DIR}/apt.coverage.fixed"
	145	break
	146	fi
	147	shift
	148	done
	149	if [ -z "$1" ]; then
	150	echo >&2 "Coverage data captured for unknown file $file"
	151	fi
	152	}
	153	grep 'build/include/' "${DIR}/apt.coverage.fixed" \| sed "s#^SF:$(pwd)/##" \| while read file; do
	154	rewritefile "$file" 'apt-pkg' 'apt-pkg/deb' 'apt-pkg/edsp' 'apt-pkg/contrib' \
	155	'apt-inst' 'apt-inst/deb' 'apt-inst/contrib' 'apt-private'
	156	done
	157	genhtml --output-directory "${DIR}" "${DIR}/apt.coverage.fixed" ${LCOVRC}
3a496cd2 DK	158	else
	159	echo >&1 "Usage:\t$0 pre-export
	160	\t$0 post-build
	161
13fe505c	162	If you use »git buildpackage« you can leave these alone as they will
3a496cd2 DK	163	be run at the right places auto-magically. Otherwise you should use
3a496cd2 DK	164	»pre-export« to update po and pot files as well as version numbering.
5ca28ebd DK	165	»post-build« can be used to run some more or less useful checks later on.
5ca28ebd DK	166
13fe505c DK	167	\t$0 library
	168	\t$0 buildlog filename…
	169
	170	»library« and »buildlog« aren't run automatically but can be useful for
	171	maintaining the (more or less experimental) symbols files we provide.
	172	»library« displays the diff between advertised symbols and the once provided
	173	by the libraries, while »buildlog« extracts this diff from the buildlogs.
	174	Both will format the diff properly.
	175
	176	\t$0 travis-ci
	177	\t$0 coverage [output-dir]
	178
	179	»travis-ci« is a shortcut to install all build- as well as test-dependencies
	180	used by .travis.yml.
	181	»coverage« does a clean build with the right flags for coverage reporting,
	182	runs all tests and generates a html report in the end.
	183	"
	184
3a496cd2	185	fi