Factored out the code to copy an image and modify it for test

common.sh

 # 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.
 
 # Common constants for build scripts
 # This must evaluate properly for both /bin/bash and /bin/sh
 
 # All scripts should die on error unless commands are specifically excepted
 # by prefixing with '!' or surrounded by 'set +e' / 'set -e'.
 # TODO: Re-enable this once shflags is less prone to dying.
 #set -e
 
 # The number of jobs to pass to tools that can run in parallel (such as make
 # and dpkg-buildpackage
 NUM_JOBS=`grep -c "^processor" /proc/cpuinfo`
 
+# True if we have the 'pv' utility - also set up COMMON_PV_CAT for convenience
+COMMON_PV_OK=1
+COMMON_PV_CAT=pv
+pv -V >/dev/null 2>&1 || COMMON_PV_OK=0
+if [ $COMMON_PV_OK -eq 0 ]; then
+  COMMON_PV_CAT=cat
+fi
+
 # Store location of the calling script.
 TOP_SCRIPT_DIR="${TOP_SCRIPT_DIR:-$(dirname $0)}"
 
 # Find root of source tree
 if [ "x$GCLIENT_ROOT" != "x" ]
 then
   # GCLIENT_ROOT already set, so we're done
   true
 elif [ "x$COMMON_SH" != "x" ]
 then
@@ skipping 72 matching lines @@
 # Default location for chroot
 DEFAULT_CHROOT_DIR=${CHROMEOS_CHROOT_DIR:-"$GCLIENT_ROOT/chroot"}
 
 # All output files from build should go under $DEFAULT_BUILD_ROOT, so that
 # they don't pollute the source directory.
 DEFAULT_BUILD_ROOT=${CHROMEOS_BUILD_ROOT:-"$SRC_ROOT/build"}
 
 # Set up a global ALL_BOARDS value
 if [ -d $SRC_ROOT/overlays ]; then
   ALL_BOARDS=$(cd $SRC_ROOT/overlays;ls -1d overlay-* 2>&-|sed 's,overlay-,,g')
-fi 
+fi
 # Strip CR
 ALL_BOARDS=$(echo $ALL_BOARDS)
 # Set a default BOARD
 #DEFAULT_BOARD=x86-generic # or...
 DEFAULT_BOARD=$(echo $ALL_BOARDS | awk '{print $NF}')
 
 # Enable --fast by default on non-official builds
 DEFAULT_FAST="${FLAGS_TRUE}"
 if [ "${CHROMEOS_OFFICIAL:-0}" = "1" ]; then
   DEFAULT_FAST="${FLAGS_FALSE}"
 fi
 
 # Detect whether we're inside a chroot or not
 if [ -e /etc/debian_chroot ]
 then
   INSIDE_CHROOT=1
 else
   INSIDE_CHROOT=0
 fi
 
+
+# Standard filenames
+CHROMEOS_IMAGE_NAME="chromiumos_image.bin"
+CHROMEOS_TEST_IMAGE_NAME="chromiumos_test_image.bin"

[Nick Sanders, 2010/12/02 00:01:48]

Can you modify the output name based on test/factory/factory_install

[sjg, 2010/12/02 00:28:52]

I haven't added constants for these also at this stage. Nor have I used my
constants in all the other scripts.

+
+
 # Directory locations inside the dev chroot
 CHROOT_TRUNK_DIR="/home/$USER/trunk"
 
 # Install make for portage ebuilds.  Used by build_image and gmergefs.
 # TODO: Is /usr/local/autotest-chrome still used by anyone?
 DEFAULT_INSTALL_MASK="/usr/include /usr/man /usr/share/man /usr/share/doc \
   /usr/share/gtk-doc /usr/share/gtk-2.0 /usr/lib/gtk-2.0/include \
   /usr/share/info /usr/share/aclocal /usr/lib/gcc /usr/lib/pkgconfig \
   /usr/share/pkgconfig /usr/share/gettext /usr/share/readline /etc/runlevels \
   /usr/share/openrc /lib/rc *.a *.la /etc/init.d /usr/lib/debug
@@ skipping 379 matching lines @@
 chroot_hacks_from_outside() {
   # Give args better names.
   local chroot_dir="${1}"
 
   # Add root as a sudoer if not already done.
   if ! sudo grep -q '^root ALL=(ALL) ALL$' "${chroot_dir}/etc/sudoers" ; then
     info "Upgrading old chroot (pre 2010-10-19) - adding root to sudoers"
     sudo bash -c "echo root ALL=\(ALL\) ALL >> \"${chroot_dir}/etc/sudoers\""
   fi
 }
+
+# This function converts a chromiumos image into a test image, either
+# in place or by copying to a new test image filename first. It honors
+# the following flags (see mod_image_for_test.sh)
+#
+#   --factory
+#   --factory_install
+#   --force_copy
+#
+# On entry, pass the directory containing the image, and the image filename
+# On exit, it echoes the pathname of the resulting test image
+#
+# Usage:
+#   SRC_IMAGE=$(prepare_test_image "directory" "imagefile")
+prepare_test_image() {
+  # If we're asked to modify the image for test, then let's make a copy and
+  # modify that instead.
+  # Check for manufacturing image.
+  local args
+
+  if [ ${FLAGS_factory} -eq ${FLAGS_TRUE} ]; then
+    args="--factory"
+  fi
+
+  # Check for install shim.
+  if [ ${FLAGS_factory_install} -eq ${FLAGS_TRUE} ]; then
+    args="--factory_install"
+  fi
+
+  # Check for forcing copy of image
+  if [ ${FLAGS_force_copy} -eq ${FLAGS_TRUE} ]; then
+    args="${args} --force_copy"
+  fi
+
+  # Modify the image for test, creating a new test image
+  "${SCRIPTS_DIR}/mod_image_for_test.sh" --board=${FLAGS_board} \
+    --image="$1/$2" --noinplace ${args} >/dev/stderr

[Nick Sanders, 2010/12/02 00:07:51]

Can you get this output on stdout? It doesn't seem like a good idea to change
the nonerror message output stream to stderr. This will make is difficult and
annoying to grep, redirect to a file, or silence.

[sjg, 2010/12/02 00:28:52]

Chris suggested making this a function which takes arguments and returns a
result on stdout. See the first patch set for how it was originally done.

I don't know of a way of doing this without creating a lot of mess. I do want
the output to appear as it goes, but I agree it is changing behavior to put it
on stderr.

Which option is best?

+
+  # From now on we use the just-created test image
+  echo "$1/${CHROMEOS_TEST_IMAGE_NAME}"
+}