aries-common: use releasetools extensions

releasetools extensions is an AOSP-supported method of extending
releasetools which is better than duplicating the way we have now.

Change-Id: I7d81b2713226f89e93df983c3e365415ae6e9f8f

6 files changed, 75 insertions, 432 deletions

diff --git a/BoardConfigCommon.mk b/BoardConfigCommon.mk
index fa61dfc..faf7f60 100644
--- a/BoardConfigCommon.mk
+++ b/BoardConfigCommon.mk
@@ -43,8 +43,7 @@ BOARD_UMS_LUNFILE := /sys/class/android_usb/android0/f_mass_storage/lun/file
 TARGET_KERNEL_SOURCE := kernel/samsung/aries
 
 # Releasetools
-TARGET_RELEASETOOL_OTA_FROM_TARGET_SCRIPT := ./device/samsung/aries-common/releasetools/aries_ota_from_target_files
-TARGET_RELEASETOOL_IMG_FROM_TARGET_SCRIPT := ./device/samsung/aries-common/releasetools/aries_img_from_target_files
+TARGET_RELEASETOOLS_EXTENSIONS := device/samsung/aries-common
 
 # Camera
 USE_CAMERA_STUB := false
diff --git a/releasetools.py b/releasetools.py
new file mode 100644
index 0000000..76721e0
--- /dev/null
+++ b/releasetools.py
@@ -0,0 +1,74 @@
+# Copyright (C) 2012 The Android Open Source Project
+# Copyright (C) 2012 The CyanogenMod Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Custom OTA commands for aries"""
+
+import common
+import os
+import shutil
+
+LOCAL_DIR = os.path.dirname(os.path.abspath(__file__))
+TARGET_DIR = os.getenv('OUT')
+UTILITIES_DIR = os.path.join(TARGET_DIR, 'utilities')
+
+def FullOTA_Assertions(info):
+  info.output_zip.write(os.path.join(TARGET_DIR, "modem.bin"), "modem.bin")
+  info.output_zip.write(os.path.join(TARGET_DIR, "updater.sh"), "updater.sh")
+  info.output_zip.write(os.path.join(UTILITIES_DIR, "make_ext4fs"), "make_ext4fs")
+  info.output_zip.write(os.path.join(UTILITIES_DIR, "busybox"), "busybox")
+  info.output_zip.write(os.path.join(UTILITIES_DIR, "flash_image"), "flash_image")
+  info.output_zip.write(os.path.join(UTILITIES_DIR, "erase_image"), "erase_image")
+  info.output_zip.write(os.path.join(UTILITIES_DIR, "bml_over_mtd"), "bml_over_mtd")
+  info.output_zip.write(os.path.join(LOCAL_DIR, "bml_over_mtd.sh"), "bml_over_mtd.sh")
+
+  info.script.AppendExtra(
+        ('package_extract_file("modem.bin", "/tmp/modem.bin");\n'
+         'set_perm(0, 0, 0777, "/tmp/modem.bin");'))
+  info.script.AppendExtra(
+        ('package_extract_file("updater.sh", "/tmp/updater.sh");\n'
+         'set_perm(0, 0, 0777, "/tmp/updater.sh");'))
+  info.script.AppendExtra(
+       ('package_extract_file("make_ext4fs", "/tmp/make_ext4fs");\n'
+        'set_perm(0, 0, 0777, "/tmp/make_ext4fs");'))
+  info.script.AppendExtra(
+        ('package_extract_file("busybox", "/tmp/busybox");\n'
+         'set_perm(0, 0, 0777, "/tmp/busybox");'))
+  info.script.AppendExtra(
+        ('package_extract_file("flash_image", "/tmp/flash_image");\n'
+         'set_perm(0, 0, 0777, "/tmp/flash_image");'))
+  info.script.AppendExtra(
+        ('package_extract_file("erase_image", "/tmp/erase_image");\n'
+         'set_perm(0, 0, 0777, "/tmp/erase_image");'))
+  info.script.AppendExtra(
+        ('package_extract_file("bml_over_mtd", "/tmp/bml_over_mtd");\n'
+         'set_perm(0, 0, 0777, "/tmp/bml_over_mtd");'))
+  info.script.AppendExtra(
+        ('package_extract_file("bml_over_mtd.sh", "/tmp/bml_over_mtd.sh");\n'
+         'set_perm(0, 0, 0777, "/tmp/bml_over_mtd.sh");'))
+
+  info.script.AppendExtra('package_extract_file("boot.img", "/tmp/boot.img");')
+  info.script.AppendExtra('assert(run_program("/tmp/updater.sh") == 0);')
+
+  # Make common releasetools copy boot.img verbatim
+  kernel_path = os.path.join(info.input_tmp, "BOOT", "kernel")
+  prebuilt_dir = os.path.join(info.input_tmp, "BOOTABLE_IMAGES")
+  prebuilt_path = os.path.join(prebuilt_dir, "boot.img")
+  os.mkdir(prebuilt_dir)
+  shutil.copyfile(kernel_path, prebuilt_path)
+
+
+def FullOTA_InstallEnd(info):
+  # Remove writing boot.img from script (we do it in updater.sh)
+  info.script.script = [cmd for cmd in info.script.script if not "write_raw_image" in cmd]
diff --git a/releasetools/aries_common.py b/releasetools/aries_common.py
deleted file mode 100644
index 93f1b8e..0000000
--- a/releasetools/aries_common.py
+++ /dev/null
@@ -1,31 +0,0 @@
-#
-# Copyright (C) 2008 The Android Open Source Project
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import os, sys
-
-LOCAL_DIR = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
-RELEASETOOLS_DIR = os.path.abspath(os.path.join(LOCAL_DIR, '../../../build/tools/releasetools'))
-
-# Add releasetools directory to python path
-sys.path.append(RELEASETOOLS_DIR)
-
-from common import *
-
-def load_module_from_file(module_name, filename):
-    import imp
-    f = open(filename, 'r')
-    module = imp.load_module(module_name, f, filename, ('', 'U', 1))
-    f.close()
-    return module
diff --git a/releasetools/aries_edify_generator.py b/releasetools/aries_edify_generator.py
deleted file mode 100644
index 4685b77..0000000
--- a/releasetools/aries_edify_generator.py
+++ /dev/null
@@ -1,74 +0,0 @@
-#
-# Copyright (C) 2008 The Android Open Source Project
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import os, sys
-
-LOCAL_DIR = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
-RELEASETOOLS_DIR = os.path.abspath(os.path.join(LOCAL_DIR, '../../../build/tools/releasetools'))
-VENDOR_SAMSUNG_DIR = os.path.abspath(os.path.join(LOCAL_DIR, '../../../vendor/samsung'))
-
-import edify_generator
-
-class EdifyGenerator(edify_generator.EdifyGenerator):
-    def AssertDevice(self, device):
-      edify_generator.EdifyGenerator.AssertDevice(self, device)
-      self.script.append('show_progress(0.15, 5);');
-      self.script.append(
-            ('package_extract_file("modem.bin", "/tmp/modem.bin");\n'
-             'set_perm(0, 0, 0777, "/tmp/modem.bin");'))
-      self.script.append(
-            ('package_extract_file("updater.sh", "/tmp/updater.sh");\n'
-             'set_perm(0, 0, 0777, "/tmp/updater.sh");'))
-      self.script.append(
-           ('package_extract_file("make_ext4fs", "/tmp/make_ext4fs");\n'
-            'set_perm(0, 0, 0777, "/tmp/make_ext4fs");'))
-      self.script.append(
-            ('package_extract_file("busybox", "/tmp/busybox");\n'
-             'set_perm(0, 0, 0777, "/tmp/busybox");'))
-      self.script.append(
-            ('package_extract_file("flash_image", "/tmp/flash_image");\n'
-             'set_perm(0, 0, 0777, "/tmp/flash_image");'))
-      self.script.append(
-            ('package_extract_file("erase_image", "/tmp/erase_image");\n'
-             'set_perm(0, 0, 0777, "/tmp/erase_image");'))
-      self.script.append(
-            ('package_extract_file("bml_over_mtd", "/tmp/bml_over_mtd");\n'
-             'set_perm(0, 0, 0777, "/tmp/bml_over_mtd");'))
-      self.script.append(
-            ('package_extract_file("bml_over_mtd.sh", "/tmp/bml_over_mtd.sh");\n'
-             'set_perm(0, 0, 0777, "/tmp/bml_over_mtd.sh");'))
-
-      self.script.append('package_extract_file("boot.img", "/tmp/boot.img");')
-      self.script.append('assert(run_program("/tmp/updater.sh") == 0);')
-
-    def RunBackup(self, command):
-      edify_generator.EdifyGenerator.RunBackup(self, command)
-
-    def RunConfig(self, command):
-      edify_generator.EdifyGenerator.RunConfig(self, command)
-
-    def WriteBMLoverMTD(self, partition, partition_start_block, reservoirpartition, reservoir_start_block, image):
-      """Write the given package file into the given partition."""
-
-      args = {'partition': partition, 'partition_start_block': partition_start_block, 'reservoirpartition': reservoirpartition, 'reservoir_start_block': reservoir_start_block, 'image': image}
-
-      self.script.append(
-            ('assert(run_program("/tmp/erase_image", "%(partition)s"));') % args)
-
-      self.script.append(
-            ('assert(package_extract_file("%(image)s", "/tmp/%(partition)s.img"),\n'
-             '       run_program("/tmp/bml_over_mtd.sh", "%(partition)s", "%(partition_start_block)s", "%(reservoirpartition)s", "%(reservoir_start_block)s", "/tmp/%(partition)s.img"),\n'
-             '       delete("/tmp/%(partition)s.img"));') % args)
-
diff --git a/releasetools/aries_img_from_target_files b/releasetools/aries_img_from_target_files
deleted file mode 100755
index f2c3c49..0000000
--- a/releasetools/aries_img_from_target_files
+++ /dev/null
@@ -1,187 +0,0 @@
-#!/usr/bin/env python
-#
-# Copyright (C) 2008 The Android Open Source Project
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""
-Given a target-files zipfile, produces an image zipfile suitable for
-use with 'fastboot update'.
-
-Usage:  img_from_target_files [flags] input_target_files output_image_zip
-
-  -b  (--board_config)  <file>
-      Deprecated.
-
-"""
-
-import sys
-
-if sys.hexversion < 0x02040000:
-  print >> sys.stderr, "Python 2.4 or newer is required."
-  sys.exit(1)
-
-import errno
-import os
-import re
-import shutil
-import subprocess
-import tempfile
-import zipfile
-
-# missing in Python 2.4 and before
-if not hasattr(os, "SEEK_SET"):
-  os.SEEK_SET = 0
-
-import aries_common as common
-
-OPTIONS = common.OPTIONS
-
-def AddUserdata(output_zip):
-  """Create an empty userdata image and store it in output_zip."""
-
-  print "creating userdata.img..."
-
-  # The name of the directory it is making an image out of matters to
-  # mkyaffs2image.  So we create a temp dir, and within it we create an
-  # empty dir named "data", and build the image from that.
-  temp_dir = tempfile.mkdtemp()
-  user_dir = os.path.join(temp_dir, "data")
-  os.mkdir(user_dir)
-  img = tempfile.NamedTemporaryFile()
-
-  build_command = []
-  if OPTIONS.info_dict["fstab"]["/data"].fs_type.startswith("ext"):
-    build_command = ["mkuserimg.sh",
-                     user_dir, img.name,
-                     OPTIONS.info_dict["fstab"]["/data"].fs_type, "data"]
-    if "userdata_size" in OPTIONS.info_dict:
-      build_command.append(str(OPTIONS.info_dict["userdata_size"]))
-  else:
-    build_command = ["mkyaffs2image", "-f"]
-    extra = OPTIONS.info_dict.get("mkyaffs2_extra_flags", None)
-    if extra:
-      build_command.extend(extra.split())
-    build_command.append(user_dir)
-    build_command.append(img.name)
-
-  p = common.Run(build_command)
-  p.communicate()
-  assert p.returncode == 0, "build userdata.img image failed"
-
-  common.CheckSize(img.name, "userdata.img", OPTIONS.info_dict)
-  output_zip.write(img.name, "userdata.img")
-  img.close()
-  os.rmdir(user_dir)
-  os.rmdir(temp_dir)
-
-
-def AddSystem(output_zip):
-  """Turn the contents of SYSTEM into a system image and store it in
-  output_zip."""
-
-  print "creating system.img..."
-
-  img = tempfile.NamedTemporaryFile()
-
-  # The name of the directory it is making an image out of matters to
-  # mkyaffs2image.  It wants "system" but we have a directory named
-  # "SYSTEM", so create a symlink.
-  try:
-    os.symlink(os.path.join(OPTIONS.input_tmp, "SYSTEM"),
-               os.path.join(OPTIONS.input_tmp, "system"))
-  except OSError, e:
-      # bogus error on my mac version?
-      #   File "./build/tools/releasetools/img_from_target_files", line 86, in AddSystem
-      #     os.path.join(OPTIONS.input_tmp, "system"))
-      # OSError: [Errno 17] File exists
-    if (e.errno == errno.EEXIST):
-      pass
-
-  build_command = []
-  if OPTIONS.info_dict["fstab"]["/system"].fs_type.startswith("ext"):
-    build_command = ["mkuserimg.sh",
-                     os.path.join(OPTIONS.input_tmp, "system"), img.name,
-                     OPTIONS.info_dict["fstab"]["/system"].fs_type, "system"]
-    if "system_size" in OPTIONS.info_dict:
-      build_command.append(str(OPTIONS.info_dict["system_size"]))
-  else:
-    build_command = ["mkyaffs2image", "-f"]
-    extra = OPTIONS.info_dict.get("mkyaffs2_extra_flags", None)
-    if extra:
-      build_command.extend(extra.split())
-    build_command.append(os.path.join(OPTIONS.input_tmp, "system"))
-    build_command.append(img.name)
-
-  p = common.Run(build_command)
-  p.communicate()
-  assert p.returncode == 0, "build system.img image failed"
-
-  img.seek(os.SEEK_SET, 0)
-  data = img.read()
-  img.close()
-
-  common.CheckSize(data, "system.img", OPTIONS.info_dict)
-  common.ZipWriteStr(output_zip, "system.img", data)
-
-
-def CopyInfo(output_zip):
-  """Copy the android-info.txt file from the input to the output."""
-  output_zip.write(os.path.join(OPTIONS.input_tmp, "OTA", "android-info.txt"),
-                   "android-info.txt")
-
-
-def main(argv):
-
-  def option_handler(o, a):
-    if o in ("-b", "--board_config"):
-      pass       # deprecated
-    else:
-      return False
-    return True
-
-  args = common.ParseOptions(argv, __doc__,
-                             extra_opts="b:",
-                             extra_long_opts=["board_config="],
-                             extra_option_handler=option_handler)
-
-  if len(args) != 2:
-    common.Usage(__doc__)
-    sys.exit(1)
-
-  OPTIONS.input_tmp, input_zip = common.UnzipTemp(args[0])
-  OPTIONS.info_dict = common.LoadInfoDict(input_zip)
-
-  output_zip = zipfile.ZipFile(args[1], "w", compression=zipfile.ZIP_DEFLATED)
-
-  common.AddBoot(output_zip, OPTIONS.info_dict)
-  common.AddRecovery(output_zip, OPTIONS.info_dict)
-  AddSystem(output_zip)
-  AddUserdata(output_zip)
-  CopyInfo(output_zip)
-
-  print "cleaning up..."
-  output_zip.close()
-  shutil.rmtree(OPTIONS.input_tmp)
-
-  print "done."
-
-
-if __name__ == '__main__':
-  try:
-    main(sys.argv[1:])
-  except common.ExternalError, e:
-    print
-    print "   ERROR: %s" % (e,)
-    print
-    sys.exit(1)
diff --git a/releasetools/aries_ota_from_target_files b/releasetools/aries_ota_from_target_files
deleted file mode 100755
index e607fd4..0000000
--- a/releasetools/aries_ota_from_target_files
+++ /dev/null
@@ -1,138 +0,0 @@
-#!/usr/bin/env python
-#
-# Copyright (C) 2008 The Android Open Source Project
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import sys
-import os
-import aries_common as common
-
-LOCAL_DIR = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
-RELEASETOOLS_DIR = os.path.abspath(os.path.join(LOCAL_DIR, '../../../build/tools/releasetools'))
-TARGET_DIR = os.getenv('OUT')
-UTILITIES_DIR = os.path.join(TARGET_DIR, 'utilities')
-
-# Add releasetools directory to python path
-sys.path.append(RELEASETOOLS_DIR)
-
-# Import the existing file so we just have to rewrite the modules we need.
-# This is a nasty hack as the filename doesn't end in .py, but it works
-filename = os.path.join(RELEASETOOLS_DIR, "ota_from_target_files")
-ota_from_target_files = common.load_module_from_file('ota_from_target_files', filename)
-
-from ota_from_target_files import *
-import aries_edify_generator as edify_generator
-
-__doc__ = ota_from_target_files.__doc__
-
-def CopyBootFiles(input_zip, output_zip):
-    output_zip.write(os.path.join(TARGET_DIR, "boot.img"),"boot.img")
-
-def CopyBMLoverMTD(output_zip):
-  """Copy the bml_over_mtd utility and script to the output."""
-  output_zip.write(os.path.join(TARGET_DIR, "modem.bin"),"modem.bin")
-  output_zip.write(os.path.join(UTILITIES_DIR, "make_ext4fs"),"make_ext4fs")
-  output_zip.write(os.path.join(UTILITIES_DIR, "busybox"),"busybox")
-  output_zip.write(os.path.join(UTILITIES_DIR, "flash_image"),"flash_image")
-  output_zip.write(os.path.join(UTILITIES_DIR, "erase_image"),"erase_image")
-  output_zip.write(os.path.join(UTILITIES_DIR, "bml_over_mtd"),"bml_over_mtd")
-  output_zip.write(os.path.join(LOCAL_DIR, "bml_over_mtd.sh"),"bml_over_mtd.sh")
-  output_zip.write(os.path.join(TARGET_DIR, "updater.sh"),"updater.sh")
-
-def WriteFullOTAPackage(input_zip, output_zip):
-  # TODO: how to determine this?  We don't know what version it will
-  # be installed on top of.  For now, we expect the API just won't
-  # change very often.
-  script = edify_generator.EdifyGenerator(3, OPTIONS.info_dict)
-
-  metadata = {"post-build": GetBuildProp("ro.build.fingerprint", OPTIONS.info_dict),
-              "pre-device": GetBuildProp("ro.product.device", OPTIONS.info_dict),
-              "post-timestamp": GetBuildProp("ro.build.date.utc", OPTIONS.info_dict),
-              }
-
-  device_specific = common.DeviceSpecificParams(
-      input_zip=input_zip,
-      input_version=OPTIONS.info_dict["recovery_api_version"],
-      output_zip=output_zip,
-      script=script,
-      input_tmp=OPTIONS.input_tmp,
-      metadata=metadata,
-      info_dict=OPTIONS.info_dict)
-
-#  if not OPTIONS.omit_prereq:
-#    ts = GetBuildProp("ro.build.date.utc", input_zip)
-#    script.AssertOlderBuild(ts)
-
-  # script.ShowProgress(0.15, 5) in device-specific assert as I could not get it to show up before it in here
-
-  AppendAssertions(script, input_zip)
-  device_specific.FullOTA_Assertions()
-  device_specific.FullOTA_InstallBegin()
-
-  if OPTIONS.backuptool:
-    script.Mount("/system")
-    script.RunBackup("backup")
-    script.Unmount("/system")
-
-  if OPTIONS.wipe_user_data:
-    script.FormatPartition("/data")
-
-  if "selinux_fc" in OPTIONS.info_dict:
-    WritePolicyConfig(OPTIONS.info_dict["selinux_fc"], output_zip)
-
-  script.FormatPartition("/system")
-  script.Mount("/system")
-  script.ShowProgress(0.7, 30);
-  script.UnpackPackageDir("recovery", "/system")
-  script.UnpackPackageDir("system", "/system")
-
-  symlinks = CopySystemFiles(input_zip, output_zip)
-  script.MakeSymlinks(symlinks)
-
-  Item.GetMetadata(input_zip)
-  script.ShowProgress(0.15, 5)
-  Item.Get("system").SetPermissions(script)
-
-  if OPTIONS.backuptool:
-    script.ShowProgress(0.2, 10)
-    script.RunBackup("restore")
-
-  CopyBootFiles(input_zip, output_zip)
-  CopyBMLoverMTD(output_zip)
-
-  device_specific.FullOTA_InstallEnd()
-
-  if OPTIONS.extra_script is not None:
-    script.AppendExtra(OPTIONS.extra_script)
-
-  script.UnmountAll()
-  script.AddToZip(input_zip, output_zip)
-  WriteMetadata(metadata, output_zip)
-ota_from_target_files.WriteFullOTAPackage = WriteFullOTAPackage
-
-
-def WriteIncrementalOTAPackage(target_zip, source_zip, output_zip):
-    print "Incremental OTA Packages are not support on the Samsung Galaxy S at this time"
-    sys.exit(1)
-ota_from_target_files.WriteIncrementalOTAPackage = WriteIncrementalOTAPackage
-
-
-if __name__ == '__main__':
-  try:
-    main(sys.argv[1:])
-  except common.ExternalError, e:
-    print
-    print "   ERROR: %s" % (e,)
-    print
-    sys.exit(1)