Archive build to pass USE flags to subcommands.

archive_build.sh

 #!/bin/bash
 
 # Copyright (c) 2010 The Chromium OS Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 # Script to archive build results.  Used by the buildbots.
 
 # --- BEGIN COMMON.SH BOILERPLATE ---
 # Load common CrOS utilities.  Inside the chroot this file is installed in
@@ skipping 17 matching lines @@
 # --- END COMMON.SH BOILERPLATE ---
 
 # Script must be run outside the chroot
 assert_outside_chroot
 
 IMAGES_DIR="${DEFAULT_BUILD_ROOT}/images"
 # Default to the most recent image
 DEFAULT_TO="${GCLIENT_ROOT}/archive"
 DEFAULT_FROM="${IMAGES_DIR}/$DEFAULT_BOARD/$(ls -t1 \
               $IMAGES_DIR/$DEFAULT_BOARD 2>&-| head -1)"
+# The set of environment assignment we need to pass to enter_chroots for this
+# build.  e.g. USE flags alter some of the commands' effect.
+CHROOT_ENV=""
 
 # Flags
 DEFINE_boolean archive_debug $FLAGS_TRUE \
     "Archive debug information for build"
 DEFINE_string board "$DEFAULT_BOARD" \
     "The board to build packages for."
 DEFINE_string build_number "" \
     "The build-bot build number (when called by buildbot only)." "b"
 DEFINE_string chroot "$DEFAULT_CHROOT_DIR" \
     "The chroot of the build to archive."
@@ skipping 16 matching lines @@
     "Optional Whether to append build # and chrome os hash to GS uploads"
 DEFINE_integer keep_max 0 "Maximum builds to keep in archive (0=all)"
 DEFINE_boolean official_build $FLAGS_FALSE \
     "Set CHROMEOS_OFFICIAL=1 for release builds."
 DEFINE_string test_tarball "" "Optional path to test tarball to archive"
 DEFINE_boolean test_mod $FLAGS_TRUE "Modify image for testing purposes"
 DEFINE_boolean prebuilt_upload $FLAGS_FALSE "Upload prebuilt binary packages."
 DEFINE_boolean remove_dev $FLAGS_TRUE "Remove the de image during archive."
 DEFINE_string to "$DEFAULT_TO" "Directory of build archive"
 DEFINE_string zipname "image.zip" "Name of zip file to create."
+DEFINE_string useflags "" \
+    "Space separated flags specifying types of pieces to assemble of modify."

[davidjames, 2011/04/25 20:58:19]

Lots of other scripts accept USE flags, and they do so via environment variable
instead of command-line options. Why is this script an exception?

Understood that environment variables are maybe a pain. But Emerge uses
environment variables for its interface, and sosa@ recently converted gmerge
from using command-line options to environment variables. So I'm thinking we
should try to stick to one way of doing this for consistency...

[davidjames, 2011/04/28 19:02:14]

Could you clarify this comment? "Space separated flags specifying types of
pieces to assemble of modify." Better would just to say "USE flags to pass in to
emerge."

[Peter Mayo, 2011/04/29 20:09:55]

I'm OK with dropping space separated, and referencing commands we call more
explicitly, but I don't like specifying one we don't actually call.  We call
mod_image_for_recovery, mod_image_for_test and build_image. They are the ones
that do the wrong things without the variable set.  They are called through
enter_chroot, so either them or enter_chroot makes sense to references, IMHO.

 
 # Parse command line
 FLAGS "$@" || exit 1
 eval set -- "${FLAGS_ARGV}"
 
 # Set if default from path is used
 DEFAULT_USED=
 
 # Reset "default" FLAGS_from based on passed-in board if not set on cmd-line
 if [ "$FLAGS_from" = "$DEFAULT_FROM" ]; then
   # Keep the directory name of the current image set (*.bin).
   IMG_DIR="$(readlink ${IMAGES_DIR}/${FLAGS_board}/latest)"
   FLAGS_from="${IMAGES_DIR}/${FLAGS_board}/${IMG_DIR}"
   DEFAULT_USED=1
 fi
 
 # Die on any errors.
 set -e
 
+if [ -n "${FLAGS_useflags}" ]; then
+  CHROOT_ENV="${CHROOT_ENV} USE='${FLAGS_useflags}'"
+fi
+
 if [ -z "$DEFAULT_USED" ]; then
   if [ $FLAGS_test_mod -eq $FLAGS_TRUE ] || \
      [ $FLAGS_factory_install_mod -eq $FLAGS_TRUE ] || \
      [ $FLAGS_factory_test_mod -eq $FLAGS_TRUE ]
   then
     echo "test_mod requires that the default from path be used."
     echo "If non default behavior is desired, run mod_image_for_test manually"
     echo "re-run archive build without test_mod"
     exit 1
   fi
@@ skipping 34 matching lines @@
 FACTORY_ZIPFILE="${OUTDIR}/factory_${FLAGS_zipname}"
 echo "archive to dir: $OUTDIR"
 echo "archive to file: $ZIPFILE"
 
 rm -rf "$OUTDIR"
 mkdir -p "$OUTDIR"
 
 # Modify image for test if flag set.
 if [ $FLAGS_test_mod -eq $FLAGS_TRUE ]; then
   echo "Modifying image for test"
-  ./enter_chroot.sh -- ./mod_image_for_test.sh --board $FLAGS_board \
-      --noinplace --yes
+  ./enter_chroot.sh $CHROOT_ENV -- ./mod_image_for_test.sh \
+    --board $FLAGS_board --noinplace --yes
 
   pushd "${FLAGS_chroot}/build/${FLAGS_board}/usr/local"
   echo "Archiving autotest build artifacts"
   tar cjf "${FLAGS_from}/autotest.tar.bz2" --checkpoint=1000 autotest
   popd
 fi
 
 # Modify for recovery
 if [ $FLAGS_official_build -eq $FLAGS_TRUE ]; then
   BUILDVER="$(readlink ${IMAGES_DIR}/${FLAGS_board}/latest)"
   CHROOT_IMAGE_DIR=/home/$USER/trunk/src/build/images/$FLAGS_board/$BUILDVER
-  ./enter_chroot.sh -- ./mod_image_for_recovery.sh --board $FLAGS_board \
-    --image $CHROOT_IMAGE_DIR/chromiumos_base_image.bin
+  ./enter_chroot.sh $CHROOT_ENV -- ./mod_image_for_recovery.sh \
+    --board $FLAGS_board --image $CHROOT_IMAGE_DIR/chromiumos_base_image.bin
 fi
 
 # Remove the developer build if test image is also built.
 if [ $FLAGS_remove_dev -eq $FLAGS_TRUE ]; then
   rm -f "${FLAGS_from}/${CHROMEOS_IMAGE_NAME}"
 fi
 
 if [ $FLAGS_factory_test_mod -eq $FLAGS_TRUE ]; then
   echo "Generating image for factory test"
   # HACK: The build system can't currently handle more than one image size
   # at a time. Therefore it's necessary to do another round of build after
   # archiving the original build. This should be fixed in Chromite.
 
   # HACK: cbuild has a special case when running on chrome-bot that
   # zeroes out the current revision, which makes calling build_image directly
   # fail. You must explictly call replace and specify a unique name numerically
   # using build_attempt.
-  ./enter_chroot.sh -- ./build_image --board $FLAGS_board \
+  ./enter_chroot.sh $CHROOT_ENV -- ./build_image --board $FLAGS_board \
       --replace --noenable_rootfs_verification --build_attempt 4
 
-  ./enter_chroot.sh -- ./mod_image_for_test.sh --board $FLAGS_board \
-      --yes --noinplace --factory
+  ./enter_chroot.sh $CHROOT_ENV -- ./mod_image_for_test.sh \
+      --board $FLAGS_board --yes --noinplace --factory
 
   # Get the factory test dir: It is the newest build.
   # This is the output dir for the factory shim, the factory test and
   # release images will remain in IMG_DIR, defined previously.
   FACTORY_DIR="$(readlink ${IMAGES_DIR}/${FLAGS_board}/latest)"
 
   echo "Factory image dir: ${FACTORY_DIR}"
 fi
 
 # Build differently sized shims. Currently only factory install shim is
 # supported, TODO(tgao): Add developer shim.
 if [ $FLAGS_factory_install_mod -eq $FLAGS_TRUE ]; then
   echo "Building factory install shim."
   # HACK: The build system can't currently handle more than one image size
   # at a time. Therefore it's necessary to do another round of build after
   # archiving the original build. This should be fixed in Chromite.
 
   # HACK: cbuild has a special case when running on chrome-bot that
   # zeroes out the current revision, which makes calling build_image directly
   # fail. You must explictly call replace and specify a unique name numerically
   # using build_attempt.
-  ./enter_chroot.sh -- ./build_image --board $FLAGS_board --factory_install \
-      --replace --build_attempt 7
+  ./enter_chroot.sh $CHROOT_ENV -- ./build_image --board $FLAGS_board \
+    --factory_install --replace --build_attempt 7
 
   # Get the install shim dir: It is the newest build.
   # This is the output dir for the factory shim, the factory test and
   # release images will remain in IMG_DIR, defined previously.
   SHIM_DIR="$(readlink ${IMAGES_DIR}/${FLAGS_board}/latest)"
 
   echo "Factory install shim dir: ${SHIM_DIR}"
 fi
 
 # Zip the build
@@ skipping 134 matching lines @@
 # Purge old builds if necessary
 if [ $FLAGS_keep_max -gt 0 ]; then
   echo "Deleting old builds (all but the newest ${FLAGS_keep_max})..."
   cd "$FLAGS_to"
   # +2 because line numbers start at 1 and need to skip LATEST file
   rm -rf `ls -t1 | tail --lines=+$(($FLAGS_keep_max + 2))`
   cd -
 fi
 
 echo "Done."