Merge lp:~salgado/linaro-image-tools/port-create_boot_cmd into lp:linaro-image-tools/11.11

[Guilherme Salgado]

Port the meat of create_boot_cmd to python and call that from l-m-c.

For now I'm just porting things to python and adding automated tests. Once everything is in python and we have good test coverage we can refactor to avoid duplication and generally improve things.

My plan is to have a separate .py script for every function of l-m-c and then call those scripts from l-m-c. The actual code should be split into as many python functions/classes are necessary, and the python script might need some boilerplate code to handle sys.argv and call its main function. Does that sound sane?

As for the tests, I'm probably keeping them all in a single file for now, but I'd like to know what's the best way to extend the existing test-suite so that a simple 'testr run' runs all tests. Do we need to combine hwpack's and media_create's test_suite's into a single one and use that in .testr.conf?

[James Westby (james-w)]

Hi,

As discussed on the phone, these branches look good to me.

I don't know how to have two test suites run by subunit.run, so we may
need a top level tests.py or something to combine them.

Thanks,

James

[lp:~salgado/linaro-image-tools/port-create_boot_cmd]

169. By Guilherme Salgado on 2010-11-22

Add instructions for running the tests and create a new top-level test_suite, used to run the whole test suite with subunit

[Martin Ohlsson (martin-ohlson)]

Hi Guilherme,

The code looks good to me.

/Martin

review: Approve

[Guilherme Salgado (salgado)]

Thanks for the review, Martin. I'd appreciate if you could review r169 (http://bazaar.launchpad.net/~salgado/linaro-image-tools/port-create_boot_cmd/revision/169) as well, as it was added after your review. That revision adds a top-level test_suite object and instructions for running the test suite.

[Martin Ohlsson (martin-ohlson)]

Sorry,

I will do that right away.

I'm actually waiting for that branch to be merged so I can use your test
suite and the PYTHONPATH setting in linaro-media-create :)

/Martin

On 23 November 2010 14:31, Guilherme Salgado <email address hidden> wrote:

> Thanks for the review, Martin. I'd appreciate if you could review r169 (
> http://bazaar.launchpad.net/~salgado/linaro-image-tools/port-create_boot_cmd/revision/169<http://bazaar.launchpad.net/%7Esalgado/linaro-image-tools/port-create_boot_cmd/revision/169>)
> as well, as it was added after your review. That revision adds a top-level
> test_suite object and instructions for running the test suite.
> --
>
> https://code.launchpad.net/~salgado/linaro-image-tools/port-create_boot_cmd/+merge/41208<https://code.launchpad.net/%7Esalgado/linaro-image-tools/port-create_boot_cmd/+merge/41208>
> You are reviewing the proposed merge of
> lp:~salgado/linaro-image-tools/port-create_boot_cmd into
> lp:linaro-image-tools.
>

[Martin Ohlsson (martin-ohlson)]

Hi Guilherme,

I've reviewed the new revision and it looks good!

/Martin

review: Approve

=== modified file '.testr.conf'
--- .testr.conf	2010-08-27 19:36:11 +0000
+++ .testr.conf	2010-11-22 13:47:16 +0000
@@ -1,3 +1,3 @@
 [DEFAULT]
 test_command=python -m subunit.run $IDLIST
-test_id_list_default=hwpack.tests.test_suite
+test_id_list_default=tests.test_suite
 
=== added file 'README'
--- README	1970-01-01 00:00:00 +0000
+++ README	2010-11-22 13:47:16 +0000
@@ -0,0 +1,21 @@
+This project contains a collection of tools to help creating Linaro bootable
+images to be used in development boards.
+
+= Running tests =
+
+Before running any tests you need to install the following packages:
+
+  - python-testrepository
+  - python-subunit
+
+And run the following command:
+
+  $ testr init
+
+After that you can run the whole test suite with:
+
+  $ testr run
+
+If you want to learn more about testrepository:
+
+  $ testr quickstart
 
=== modified file 'linaro-media-create'
--- linaro-media-create	2010-11-22 13:47:16 +0000
+++ linaro-media-create	2010-11-22 13:47:16 +0000
@@ -27,7 +27,8 @@
 BINARY_TARBALL='binary-tar.tar.gz'
 BOOT_LABEL=boot
 RFS_LABEL=rootfs
-IS_LIVE=
+IS_LIVE=0
+IS_LOWMEM=0
 FAT_SIZE=32
 IMAGE_SIZE=2G
 MMC_PART_OFFSET=0
@@ -60,7 +61,14 @@
 
 }
 
-PATH="$(dirname "$(readlink -f "$0")"):$PATH"
+# Make sure other scripts are called from the correct place when running this
+# off of a l-m-c working tree.
+script_dir=$(dirname "$(readlink -f "$0")")
+PATH="${script_dir}:$PATH"
+
+# Also make sure the necessary python modules are available when running this
+# off of a l-m-c working tree.
+export PYTHONPATH="$script_dir"
 
 ensure_command() {
   # ensure_command foo foo-package
@@ -392,18 +400,9 @@
 }
 
 create_boot_cmd() {
-  if [ "$IS_LIVE" ]; then
-    boot_snippet='boot=casper'
-    [ "$IS_LOWMEM" ] && lowmem_opt=only-ubiquity
-  else
-    boot_snippet='root=UUID='${RFS_UUID}
-  fi
-  
-  cat > ${TMP_DIR}/boot.cmd << BOOTCMD
-setenv bootcmd 'fatload mmc $mmc_option $KERNEL_ADDR uImage; fatload mmc $mmc_option $INITRD_ADDR uInitrd; bootm $KERNEL_ADDR $INITRD_ADDR'
-setenv bootargs '${serial_opts} ${splash_opts} ${lowmem_opt} ${boot_snippet} ${boot_args_options}'
-boot
-BOOTCMD
+  python -m media_create.boot_cmd $IS_LIVE $IS_LOWMEM "$mmc_option" \
+    "$RFS_UUID" "$KERNEL_ADDR" "$INITRD_ADDR" "$serial_opts" \
+    "$boot_args_options" "$splash_opts" > ${TMP_DIR}/boot.cmd
 }
 
 cleanup_sd() {
@@ -541,7 +540,7 @@
   echo "Installing Boot Loader"
   echo ""
  
-  if [ "$IS_LIVE" ]; then
+  if [ "$IS_LIVE" -eq 1 ]; then
     parts_dir=casper
   else
     parts_dir=boot
@@ -792,7 +791,7 @@
   for c in ${consoles}; do
     serial_opts="$serial_opts console=$c"
   done
-  if [ "$IS_LIVE" ]; then
+  if [ "$IS_LIVE" -eq 1 ]; then
     serial_opts="$serial_opts serialtty=ttyS2"
   fi
 fi
@@ -815,7 +814,7 @@
   case "$DEVIMAGE" in
     beagle|igep)
       serial_opts="$serial_opts console=tty0 console=ttyS2,115200n8"
-      if [ "$IS_LIVE" ]; then
+      if [ "$IS_LIVE" -eq 1 ]; then
         serial_opts="$serial_opts serialtty=ttyS2"
       fi
       KERNEL_ADDR="0x80000000"
@@ -824,7 +823,7 @@
       ;;
     panda)
       serial_opts="$serial_opts console=tty0 console=ttyO2,115200n8"
-      if [ "$IS_LIVE" ]; then
+      if [ "$IS_LIVE" -eq 1 ]; then
         serial_opts="$serial_opts serialtty=ttyO2"
       fi
       KERNEL_ADDR="0x80200000"
@@ -833,7 +832,7 @@
       ;;
     ux500)
       serial_opts="$serial_opts console=tty0 console=ttyAMA2,115200n8"
-      if [ "$IS_LIVE" ]; then
+      if [ "$IS_LIVE" -eq 1 ]; then
         serial_opts="$serial_opts serialtty=ttyAMA2"
       fi
       KERNEL_ADDR="0x00100000"
@@ -844,7 +843,7 @@
       ;;
     mx51evk)
       serial_opts="$serial_opts console=tty0 console=ttymxc0,115200n8"
-      if [ "$IS_LIVE" ]; then
+      if [ "$IS_LIVE" -eq 1 ]; then
         serial_opts="$serial_opts serialtty=ttymxc0"
       fi
       KERNEL_ADDR="0x90000000"
@@ -854,7 +853,7 @@
       ;;
     vexpress)
       serial_opts="$serial_opts console=tty0 console=ttyAMA0,38400n8"
-      if [ "$IS_LIVE" ]; then
+      if [ "$IS_LIVE" -eq 1 ]; then
         serial_opts="$serial_opts serialtty=ttyAMA0"
       fi
       KERNEL_ADDR="0x60008000"
@@ -869,7 +868,7 @@
       ;;
   esac
 else
-  if [ "$IS_LIVE" ]; then
+  if [ "$IS_LIVE" -eq 1 ]; then
     splash_opts="quiet splash"
   fi
 fi
 
=== added directory 'media_create'
=== added file 'media_create/__init__.py'
=== added file 'media_create/boot_cmd.py'
--- media_create/boot_cmd.py	1970-01-01 00:00:00 +0000
+++ media_create/boot_cmd.py	2010-11-22 13:47:16 +0000
@@ -0,0 +1,26 @@
+import sys
+
+
+def create_boot_cmd(is_live, is_lowmem, mmc_option, root_uuid, kernel_addr,
+                    initrd_addr, serial_opts, boot_args_options,
+                    splash_opts=""):
+    boot_snippet = 'root=UUID=%s' % root_uuid
+    lowmem_opt = ''
+    if is_live:
+        boot_snippet = 'boot=casper'
+        if is_lowmem:
+            lowmem_opt = 'only-ubiquity'
+
+    return ("setenv bootcmd 'fatload mmc %(mmc_option)s %(kernel_addr)s "
+                "uImage; fatload mmc %(mmc_option)s %(initrd_addr)s uInitrd; "
+                "bootm %(kernel_addr)s %(initrd_addr)s'\n"
+            "setenv bootargs '%(serial_opts)s %(splash_opts)s %(lowmem_opt)s "
+                "%(boot_snippet)s %(boot_args_options)s'\n"
+            "boot" % vars())
+
+
+if __name__ == '__main__':
+    is_live = int(sys.argv[1])
+    is_lowmem = int(sys.argv[2])
+    # Use sys.stdout.write() to avoid the trailing newline added by print.
+    sys.stdout.write(create_boot_cmd(is_live, is_lowmem, *sys.argv[3:]))
 
=== added directory 'media_create/tests'
=== added file 'media_create/tests/__init__.py'
--- media_create/tests/__init__.py	1970-01-01 00:00:00 +0000
+++ media_create/tests/__init__.py	2010-11-22 13:47:16 +0000
@@ -0,0 +1,8 @@
+import unittest
+
+def test_suite():
+    module_names = ['media_create.tests.test_media_create',
+                   ]
+    loader = unittest.TestLoader()
+    suite = loader.loadTestsFromNames(module_names)
+    return suite
 
=== added file 'media_create/tests/test_media_create.py'
--- media_create/tests/test_media_create.py	1970-01-01 00:00:00 +0000
+++ media_create/tests/test_media_create.py	2010-11-22 13:47:16 +0000
@@ -0,0 +1,32 @@
+import subprocess
+import sys
+
+from testtools import TestCase
+
+from media_create.boot_cmd import create_boot_cmd
+
+
+class TestCreateBootCMD(TestCase):
+
+    expected_boot_cmd = (
+        "setenv bootcmd 'fatload mmc mmc_option kernel_addr uImage; "
+        "fatload mmc mmc_option initrd_addr uInitrd; bootm kernel_addr "
+        "initrd_addr'\nsetenv bootargs 'serial_opts splash_opts  "
+        "root=UUID=root_uuid boot_args'\nboot")
+
+    def test_create_boot_cmd(self):
+        cmd = create_boot_cmd(
+            is_live=False, is_lowmem=False, mmc_option='mmc_option',
+            root_uuid='root_uuid', kernel_addr="kernel_addr",
+            initrd_addr="initrd_addr", serial_opts="serial_opts",
+            boot_args_options="boot_args", splash_opts="splash_opts")
+        self.assertEqual(self.expected_boot_cmd, cmd)
+
+    def test_create_boot_cmd_as_script(self):
+        args = "%s -m media_create.boot_cmd " % sys.executable
+        args += ("0 0 mmc_option root_uuid kernel_addr initrd_addr "
+                 "serial_opts boot_args splash_opts")
+        process = subprocess.Popen(
+            args, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        stdout, stderr = process.communicate()
+        self.assertEqual(self.expected_boot_cmd, stdout)
 
=== added directory 'tests'
=== added file 'tests/__init__.py'
--- tests/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/__init__.py	2010-11-22 13:47:16 +0000
@@ -0,0 +1,8 @@
+from hwpack.tests import test_suite as hwpack_suite
+from media_create.tests import test_suite as media_create_suite
+
+
+def test_suite():
+    suite = hwpack_suite()
+    suite.addTests(media_create_suite())
+    return suite