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

image_to_usb.sh

 #!/bin/bash
 
-# Copyright (c) 2009 The Chromium OS Authors. All rights reserved.
+# 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 convert the output of build_image.sh to a usb image.
 
 # Load common constants.  This should be the first executable line.
 # The path to common.sh should be relative to your script's location.
 . "$(dirname "$0")/common.sh"
 
 # Load functions and constants for chromeos-install
 . "$(dirname "$0")/chromeos-common.sh"
 
 get_default_board
 
 # Flags
 DEFINE_string board "${DEFAULT_BOARD}" "Board for which the image was built"
 DEFINE_string from "" \
-  "Directory containing chromiumos_image.bin"
+  "Directory containing ${CHROMEOS_IMAGE_NAME}"
 DEFINE_string to "/dev/sdX" "${DEFAULT_TO_HELP}"
 DEFINE_boolean yes ${FLAGS_FALSE} "Answer yes to all prompts" "y"
 DEFINE_boolean force_copy ${FLAGS_FALSE} "Always rebuild test image"
 DEFINE_boolean force_non_usb ${FLAGS_FALSE} \
   "Write out image even if target (--to) doesn't look like a USB disk"
 DEFINE_boolean factory_install ${FLAGS_FALSE} \
   "Whether to generate a factory install shim."
 DEFINE_boolean factory ${FLAGS_FALSE} \
   "Whether to generate a factory runin image. Implies aututest and test"
 DEFINE_boolean copy_kernel ${FLAGS_FALSE} \
   "Copy the kernel to the fourth partition."
 DEFINE_boolean test_image "${FLAGS_FALSE}" \
-  "Copies normal image to chromiumos_test_image.bin, modifies it for test."
-DEFINE_string image_name "chromiumos_image.bin" \
+  "Copies normal image to ${CHROMEOS_TEST_IMAGE_NAME}, modifies it for test."
+DEFINE_string image_name "${CHROMEOS_IMAGE_NAME}" \
   "Base name of the image" i
 DEFINE_string build_root "/build" \
   "The root location for board sysroots."
 DEFINE_boolean install ${FLAGS_FALSE} "Install to the usb device."
 DEFINE_string arch "" "Architecture of the image."
 
 # Parse command line
 FLAGS "$@" || exit 1
 eval set -- "${FLAGS_ARGV}"
 
@@ skipping 28 matching lines @@
 
 # No board set during install
 if [ -z "${FLAGS_board}" ] && [ ${FLAGS_install} -eq ${FLAGS_TRUE} ]; then
   setup_board_warning
   exit 1
 fi
 
 # We have a board name but no image set.  Use image at default location
 if [ -z "${FLAGS_from}" ]; then
   IMAGES_DIR="${DEFAULT_BUILD_ROOT}/images/${FLAGS_board}"
+
+  # Get latest image directory
   FLAGS_from="${IMAGES_DIR}/$(ls -t ${IMAGES_DIR} 2>&-| head -1)"
 fi
 
 if [ ! -d "${FLAGS_from}" ] ; then
   echo "Cannot find image directory ${FLAGS_from}"
   exit 1
 fi
 
 if [ "${FLAGS_to}" == "/dev/sdX" ]; then
   echo "You must specify a file or device to write to using --to."
@@ skipping 30 matching lines @@
     disk_manufacturer=$(get_disk_info ${FLAGS_to##*/} manufacturer)
     disk_product=$(get_disk_info ${FLAGS_to##*/} product)
   elif [ ${FLAGS_force_non_usb} -ne ${FLAGS_TRUE} ]; then
     # Safeguard against writing to a real non-USB disk
     echo "Error: Device ${FLAGS_to} does not appear to be a USB disk!"
     echo "       To override this safeguard, use the --force_non_usb flag"
     exit 1
   fi
 fi
 
-# Use this image as the source image to copy
-SRC_IMAGE="${FLAGS_from}/${FLAGS_image_name}"
-
 STATEFUL_DIR="${FLAGS_from}/stateful_partition"
 mkdir -p "${STATEFUL_DIR}"
 
 function do_cleanup {
   echo "Cleaning loopback devices: ${STATEFUL_LOOP_DEV}"
   if [ "${STATEFUL_LOOP_DEV}" != "" ]; then
     sudo umount "${STATEFUL_DIR}"
     sudo losetup -d "${STATEFUL_LOOP_DEV}"
     rmdir "${STATEFUL_DIR}"
     echo "Cleaned"
   fi
 }
 
+if [ ${FLAGS_test_image} -eq ${FLAGS_TRUE} ] ; then
+  # Make a test image as requested, this will modify SRC_IMAGE
+  SRC_IMAGE=$(prepare_test_image "${FLAGS_from}" "${FLAGS_image_name}")
 
-# If we're asked to modify the image for test, then let's make a copy and
-# modify that instead.
-if [ ${FLAGS_test_image} -eq ${FLAGS_TRUE} ] ; then
-  if [ ! -f "${FLAGS_from}/chromiumos_test_image.bin" ] || \
-     [ ${FLAGS_force_copy} -eq ${FLAGS_TRUE} ] ; then
-    # Copy it.
-    echo "Creating test image from original..."
-    cp -f "${SRC_IMAGE}" "${FLAGS_from}/chromiumos_test_image.bin"
-
-    # Check for manufacturing image.
-    if [ ${FLAGS_factory} -eq ${FLAGS_TRUE} ] ; then
-      EXTRA_ARGS="--factory"
-    fi
-
-    # Check for instqall shim.
-    if [ ${FLAGS_factory_install} -eq ${FLAGS_TRUE} ] ; then
-      EXTRA_ARGS="--factory_install"
-    fi
-
-    # Modify it.  Pass --yes so that mod_image_for_test.sh won't ask us if we
-    # really want to modify the image; the user gave their assent already with
-    # --test-image and the original image is going to be preserved.
-    "${SCRIPTS_DIR}/mod_image_for_test.sh" --image \
-      "${FLAGS_from}/chromiumos_test_image.bin" --board=${FLAGS_board} \
-      ${EXTRA_ARGS} --yes
-    echo "Done with mod_image_for_test."
-  else
-    echo "Using cached test image."
-  fi
-  SRC_IMAGE="${FLAGS_from}/chromiumos_test_image.bin"
-  echo "Source test image is: ${SRC_IMAGE}"
+  # No need to check with the user, as we are preserving the base image
+  FLAGS_yes="${FLAGS_TRUE}"
+else
+  # Use the standard image
+  SRC_IMAGE="${FLAGS_from}/${FLAGS_image_name}"
 fi
 
-
 # Let's do it.
 if [ -b "${FLAGS_to}" ]
 then
   # Output to a block device (i.e., a real USB key), so need sudo dd
   if [ ${FLAGS_install} -ne ${FLAGS_TRUE} ]; then
     echo "Copying USB image ${SRC_IMAGE} to device ${FLAGS_to}..."
   else
     echo "Installing USB image ${SRC_IMAGE} to device ${FLAGS_to}..."
   fi
 
@@ skipping 33 matching lines @@
       echo "The device you have specified is already mounted at some point "
       echo "that is not visible from inside the chroot.  Please unmount the "
       echo "device manually from outside the chroot and try again."
       echo
       exit 1
     fi
   done
   sleep 3
 
   if [ ${FLAGS_install} -ne ${FLAGS_TRUE} ]; then
-    echo "Copying ${SRC_IMAGE} to ${FLAGS_to}..."
-    if type pv >/dev/null 2>&1; then
-      # pv displays file size in k=1024 while dd uses k=1000.
-      # To prevent confusion, we suppress the summary report from dd.
-      sudo pv -ptreb -B 4m "${SRC_IMAGE}" |
-        sudo dd of="${FLAGS_to}" bs=4M oflag=sync status=noxfer
-    else
-      sudo dd if="${SRC_IMAGE}" of="${FLAGS_to}" bs=4M oflag=sync
-    fi
+    echo "Copying with dd ${SRC_IMAGE} to ${FLAGS_to}..."
+    sudo ${COMMON_PV_CAT} "${SRC_IMAGE}" |
+      sudo dd of="${FLAGS_to}" bs=4M oflag=sync status=noxfer
     sync
   else
     if [ ${INSIDE_CHROOT} -ne 1 ]; then
       echo "Installation must be done from inside the chroot."
       exit 1
     fi
 
     echo "Installing ${SRC_IMAGE} to ${FLAGS_to}..."
     "${FLAGS_build_root}/${FLAGS_board}/usr/sbin/chromeos-install" \
       --yes \
       --skip_src_removable \
       --skip_dst_removable \
       --arch="${FLAGS_arch}" \
       --payload_image="${SRC_IMAGE}" \
       --dst="${FLAGS_to}"
   fi
   echo "Done."
 else
   # Output to a file, so just make a copy.
   echo "Copying ${SRC_IMAGE} to ${FLAGS_to}..."
-  cp -f "${SRC_IMAGE}" "${FLAGS_to}"
+  ${COMMON_PV_CAT} "${SRC_IMAGE}" >"${FLAGS_to}"
 
   echo "Done.  To copy to a USB drive, do something like:"
   echo "   sudo dd if=${FLAGS_to} of=/dev/sdX bs=4M oflag=sync"
   echo "where /dev/sdX is the entire drive."
 fi