Merge lp:~jamesodhunt/ubuntu/raring/sbuild/dep8-procenv into lp:ubuntu/raring/sbuild

[James Hunt]

Added a DEP-8 test to exercise sbuild by performing the following:

- creates an sbuild chroot for the current release
- builds the 'procenv' package (*)
- installs the resulting .deb
- runs the command provided by the .deb

(*) - procenv was chosen to allow both the sbuild and AutoPkgTest environments to be seen by looking at the logfile for this test.

[James Hunt (jamesodhunt)]

This is analogous to lp:~jamesodhunt/ubuntu/raring/pbuilder/dep8-procenv.

[Jean-Baptiste Lallement (jibel)]

Thanks for your work!

The test passes on first run, but next run will fail because schroot and sbuild configuration files created during the test are not removed at the end while the target chroot has been destroyed.

The 2 files remaining after the tests are:
- /etc/sbuild/chroot/raring-amd64-sbuild which is a broken symlink to the chroot directory
- /etc/schroot/chroot.d/raring-amd64-sbuild-XXXXXX

Note that it can potentially harm the host system if autopkgtest is run with the virt-null driver.

review: Needs Fixing

[lp:~jamesodhunt/ubuntu/raring/sbuild/dep8-procenv]

54. By James Hunt on 2013-04-19

* debian/tests/build_procenv:
  - Since schroot chroots cannot be named, avoid interfering with
    existing chroots for the current release and architecture.
  - Check schroot chroot is known.
  - Display schroot chroot info.
  - Cleanup by ending a schroot session for the chroot (if there is one)
    and removing the sbuild chroot symlink and schroot config file.

[James Hunt (jamesodhunt)]

Hi Jibel - thanks for testing. I've now updated the test to:

- bail (successfully) if it detects existing chroots that would interfere with the test.
- cleanup after itself.

[lp:~jamesodhunt/ubuntu/raring/sbuild/dep8-procenv]

55. By James Hunt on 2013-04-22

* debian/tests/build_procenv: Use the Debian archive as appropriate.

[James Hunt (jamesodhunt)]

Latest version forwarded to Debian: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=705926

[lp:~jamesodhunt/ubuntu/raring/sbuild/dep8-procenv]

56. By James Hunt on 2013-04-23

* debian/tests/build_procenv:
  - Use /etc/os-release rather than lsb_release for maximum portability.
  - Explicit archive url handling for debian.
  - Create chroot for latest stable debian release but latest ubuntu
    release.
  - Abort if archive cannot be determined for distribution.
  - More checks and comments.
  - Ensure package source is downloaded for correct release.
* debian/tests/control:
  - add Depends for distro-info.
  - Add 'breaks-testbed' restriction as the test manipulates files in
    /etc.

57. By James Hunt on 2013-04-23

* debian/tests/build_procenv:
  - Revert to using lsb-release: os-release is available by default, but
    does not provide release name in a portable format.
  - Only install the built .deb if the release built for matches the
    running release.
  - Perform checks on .deb since we might not be able to install it.
* debian/tests/control:
  - Removed breaks-testbed as this stops the test even running on
    Ubuntu.
  - Added lsb-release dependency.

[Martin Pitt (pitti)]

Verified on current saucy with "run-adt-test -sS lp:~jamesodhunt/ubuntu/raring/sbuild/dep8-procenv". Thanks!

I merged this into the saucy branch, so closing manually.

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2013-01-17 08:59:27 +0000
+++ debian/changelog	2013-04-23 21:33:26 +0000
@@ -1,3 +1,9 @@
+sbuild (0.63.2-1.1ubuntu2) UNRELEASED; urgency=low
+
+  * Added DEP-8 autopkgtest to build procenv.
+
+ -- James Hunt <[e-mail]>  Tue, 23 Apr 2013 22:30:35 +0100
+
 sbuild (0.63.2-1.1ubuntu1) raring; urgency=low
 
   * Merge from Debian unstable. Remaining changes:
 
=== modified file 'debian/control'
--- debian/control	2012-06-23 22:27:58 +0000
+++ debian/control	2013-04-23 21:33:26 +0000
@@ -8,6 +8,7 @@
 Standards-Version: 3.9.1
 Vcs-Browser: http://git.debian.org/?p=buildd-tools/sbuild.git
 Vcs-Git: git://git.debian.org/git/buildd-tools/sbuild
+XS-Testsuite: autopkgtest
 
 Package: libsbuild-perl
 Architecture: all
 
=== added directory 'debian/tests'
=== added file 'debian/tests/build_procenv'
--- debian/tests/build_procenv	1970-01-01 00:00:00 +0000
+++ debian/tests/build_procenv	2013-04-23 21:33:26 +0000
@@ -0,0 +1,170 @@
+#!/bin/sh -e
+#---------------------------------------------------------------------
+# DEP-8 test for sbuild.
+#
+# Creates a sbuild chroot, builds a package, installs the resulting
+# .deb, then runs the command provided by the .deb.
+#---------------------------------------------------------------------
+
+die()
+{
+    msg="$*"
+    echo "ERROR: $msg" >&2
+    exit 1
+}
+
+# The package we'll ask sbuild to build (we know its buildable since
+# it's already in the archive :-)
+#
+# The advantage of choosing this particular package being that it runs
+# *itself* at the end of its build, which has the nice side-effect of
+# exposing the full sbuild environment to those perusing the autopkgtest
+# logs.
+pkg=procenv
+
+distro=$(lsb_release --id|cut -d: -f2-|awk '{print $1}'|tr '[A-Z]' '[a-z]')
+[ -z "$distro" ] && die "cannot establish distribution"
+
+host_release=$(lsb_release --codename|cut -d: -f2-|awk '{print $1}')
+[ -z "$host_release" ] && die "cannot establish release running on host"
+
+if [ "$distro" = ubuntu ]
+then
+    # Build chroot for latest release.
+    release=$(distro-info --devel)
+
+    url=http://archive.ubuntu.com/ubuntu
+elif [ "$distro" = debian ]
+then
+    # Build chroot for latest stable release since
+    # sid may not be buildable on a particular day.
+    release=$(distro-info --stable)
+
+    url=http://archive.debian.org/debian
+else
+    die "need to know where archive is for distro '$distro'"
+fi
+
+arch=$(dpkg --print-architecture 2>/dev/null)
+[ -z "$arch" ] && die "cannot establish architecture"
+
+[ -z "$ADTTMP" ] && die "ADTTMP not set"
+dir="$ADTTMP/schroot-$release"
+
+# The expected name of the schroot that sbuild-createchroot will create
+chroot="${release}-${arch}-sbuild"
+
+# schroot does not allow a chroot name to be specified at creation time.
+# As such, we must take care to avoid stomping on a developers chroots.
+# If we find any that match the chroot we're about to try and make, exit
+# with a message.
+#
+# Note that we are very cautious in the grep check below; we purposely
+# don't match on the _type_ of schroot in case new schroot types are
+# added and this test is not updated to take account of the new types.
+
+schroots=$(schroot -l 2>/dev/null)
+
+if [ -n "$schroots" ] && echo "$schroots"|grep -q ":${release}-${arch}"
+then
+    echo "INFO:"
+    echo "INFO: Existing schroots detected for current release ($release)"
+    echo "INFO: and architecture ($arch)"
+    echo "INFO:"
+    echo "INFO: Not continuing."
+    echo "INFO:"
+
+    # exit successfully
+    exit 0
+fi
+
+# Use '--download-only' to avoid unpack which generates a
+# signature warning to stderr, causing this test to fail.
+# Take care to download the package version for the release we will
+# create the chroot for. 
+echo "INFO: Downloading source for package '$pkg' from release '$release'"
+apt-get source --download-only "$pkg/$release"
+
+dsc=$(ls ${pkg}*.dsc)
+
+echo "INFO: Creating sbuild chroot '$chroot' for release '$release' in directory '$dir' from url '$url'"
+sbuild-createchroot "$release" "$dir" "$url"
+
+echo "INFO: Checking chroot '$chroot' is known"
+schroot --list --all-chroots|grep "^chroot:${chroot}$"
+
+echo "INFO: Displaying information about chroot '$chroot'"
+schroot --info "${chroot}"
+
+# crucial
+echo "INFO: Creating sbuild key pair"
+sbuild-update --keygen 2>&1
+
+echo "INFO: Building package '$pkg' for release '$release' from '$dsc'"
+sbuild -A -d "$release" $dsc 2>&1
+
+pkg_and_version=$(echo "$dsc"|sed 's/\.dsc$//g')
+deb=${pkg_and_version}_${arch}.deb
+
+echo "INFO: Displaying sbuild log"
+cat ${pkg_and_version}_${arch}*.build
+
+# Do what we can to check if the .deb looks usable (since we may not
+# be able to install it to test it properly)
+echo "INFO: Listing information on '$deb'"
+dpkg --info "$deb"
+
+echo "INFO: Listing contents of '$deb'"
+dpkg --contents "$deb"
+
+extract="$ADTTMP/extract"
+echo "INFO: Extracting '$deb' to '$extract'"
+dpkg --extract "$deb" "$extract"
+
+if [ "$release" = "$host_release" ]
+then
+    echo "INFO: Installing package '$pkg' from '$deb'"
+    dpkg -i "$deb"
+
+    # run the command to prove the build worked but also to expose the
+    # auto-package-test environment used for this test.
+    cmd=$pkg
+    echo "INFO: Showing AutoPkgTest environment by running '$cmd' from package '$pkg'"
+    "$cmd"
+else
+    echo "INFO: Not installing package '$pkg' as host release ('$host_release')"
+    echo "INFO: differs to release package is built for ('$release')"
+fi
+
+# There is no sbuild/schroot command to actually delete the chroot, but
+# we do want to clean up fully. The best we can do is end the schroot
+# session, and remove the sym links. Removing the chroot itself is not
+# necessary since it is created below $ADTTMP so will be removed
+# automatically by the AutoPkgTest environment.
+
+echo "INFO: Establishing schroot sessions for chroot '$chroot'"
+session=$(schroot --list --all-sessions|grep "^session:${release}-${arch}-" || :)
+if [ -n "$session" ]
+then
+    count=$(echo "$session"|wc -l)
+    [ $count -eq 1 ] || die "expected 1 session, found $count"
+
+    echo "INFO: Ending schroot session '$session'"
+    schroot --end-session --chroot "$session"
+else
+    echo "INFO: No schroot session to end"
+fi
+
+echo "INFO: Cleaning up"
+
+echo "INFO: Removing sbuild chroot symbolic link for '$chroot'"
+link=$(ls /etc/sbuild/chroot/${chroot})
+# remove soon-to-be-broken symbolic link
+[ -h "$link" ] && rm "$link"
+
+# remove soon-to-be stale configuration file
+echo "INFO: Removing schroot configuration file for '$chroot'"
+config=$(ls /etc/schroot/chroot.d/${chroot}-*)
+[ -f "$config" ] && rm "$config"
+
+echo "INFO: SUCCESS"
 
=== added file 'debian/tests/control'
--- debian/tests/control	1970-01-01 00:00:00 +0000
+++ debian/tests/control	2013-04-23 21:33:26 +0000
@@ -0,0 +1,3 @@
+Tests: build_procenv
+Depends: @, distro-info, lsb-release
+Restrictions: needs-root