[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="$(grep '^MAJOR=' apt-inst/makefile |cut -d '=' -f 2)"

librarysymbolsfromfile() {
	local MISSING="$(grep '^+#MISSING' "$1")"
	local SYMVER="$2"
	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}@${SYMVER}\" $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

	# update the last-modification field of manpages based on git changes
	grep --files-with-matches '<date>' doc/*.xml | while read file; do \
		LASTMOD="$(date -d "@$(git log --format='%at' --max-count=1 --invert-grep --fixed-strings --grep 'review
typo
Git-Dch: Ignore' "$file")" '+%Y-%m-%dT00:00:00Z')"
		sed -i -e "s#^\([ ]\+\)<date>.*</date>\$#\1<date>$LASTMOD</date>#" "$file"
	done

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