Merge lp:~mvo/snappy/15.04-snappy-bootsuccess-env2 into lp:~snappy-dev/snappy/15.04-deprecated

[Michael Vogt]

Backports of the uboot.env changes from trunk.

This branch backports the uboot.env changes from trunk to 15.04

[lp:~mvo/snappy/15.04-snappy-bootsuccess-env2]

462. By Michael Vogt on 2015-07-22

merge remaining revisions

[John Lenton (chipaca)]

review: Approve

=== modified file 'debian/control'
--- debian/control	2015-04-21 22:02:02 +0000
+++ debian/control	2015-07-22 12:17:55 +0000
@@ -15,6 +15,7 @@
                golang-goconfigparser-dev,
                golang-juju-loggo-dev,
                golang-pb-dev,
+               golang-uboot-go-dev,
                golang-yaml.v2-dev
 Standards-Version: 3.9.6
 Homepage: https://launchpad.net/snappy

=== modified file 'dependencies.tsv'
--- dependencies.tsv	2015-03-19 09:33:48 +0000
+++ dependencies.tsv	2015-07-22 12:17:55 +0000
@@ -4,5 +4,6 @@
 github.com/jessevdk/go-flags	git	15347ef417a300349807983f15af9e65cd2e1b3a	2015-01-25T08:53:51Z
 github.com/juju/loggo	git	4c7cbce140ca070eeb59a28f4bf9507e511711f9	2015-02-26T05:51:10Z
 github.com/mvo5/goconfigparser	git	26426272dda20cc76aa1fa44286dc743d2972fe8	2015-02-12T09:37:50Z
+github.com/mvo5/uboot-go	git	361f6ebcbb54f389d15dc9faefa000e996ba3e37	2015-07-22T06:53:46Z
 gopkg.in/yaml.v2	git	49c95bdc21843256fb6c4e0d370a05f24a0bf213	2015-02-24T22:57:58Z
 launchpad.net/gocheck	bzr	[e-mail]-20140225173054-xu9zlkf9kxhvow02	87

=== modified file 'partition/bootloader.go'
--- partition/bootloader.go	2015-04-14 20:37:54 +0000
+++ partition/bootloader.go	2015-07-22 12:17:55 +0000
@@ -27,6 +27,8 @@
 	// that the boot of the new rootfs was successful).
 	bootloaderBootmodeVar = "snappy_mode"
 
+	bootloaderTrialBootVar = "snappy_trial_boot"
+
 	// Initial and final values
 	bootloaderBootmodeTry     = "try"
 	bootloaderBootmodeSuccess = "regular"

=== modified file 'partition/bootloader_grub.go'
--- partition/bootloader_grub.go	2015-04-30 11:28:39 +0000
+++ partition/bootloader_grub.go	2015-07-22 12:17:55 +0000
@@ -30,17 +30,15 @@
 	bootloaderGrubConfigFileReal = "/boot/grub/grub.cfg"
 	bootloaderGrubEnvFileReal    = "/boot/grub/grubenv"
 
-	bootloaderGrubEnvCmdReal       = "/usr/bin/grub-editenv"
-	bootloaderGrubUpdateCmdReal    = "/usr/sbin/update-grub"
-	bootloaderGrubTrialBootVarReal = "snappy_trial_boot"
+	bootloaderGrubEnvCmdReal    = "/usr/bin/grub-editenv"
+	bootloaderGrubUpdateCmdReal = "/usr/sbin/update-grub"
 )
 
 // var to make it testable
 var (
-	bootloaderGrubDir          = bootloaderGrubDirReal
-	bootloaderGrubConfigFile   = bootloaderGrubConfigFileReal
-	bootloaderGrubTrialBootVar = bootloaderGrubTrialBootVarReal
-	bootloaderGrubEnvFile      = bootloaderGrubEnvFileReal
+	bootloaderGrubDir        = bootloaderGrubDirReal
+	bootloaderGrubConfigFile = bootloaderGrubConfigFileReal
+	bootloaderGrubEnvFile    = bootloaderGrubEnvFileReal
 
 	bootloaderGrubEnvCmd    = bootloaderGrubEnvCmdReal
 	bootloaderGrubUpdateCmd = bootloaderGrubUpdateCmdReal
@@ -136,7 +134,7 @@
 func (g *grub) MarkCurrentBootSuccessful() (err error) {
 	// Clear the variable set by grub on boot to denote a good
 	// boot.
-	if err := g.unsetBootVar(bootloaderGrubTrialBootVar); err != nil {
+	if err := g.unsetBootVar(bootloaderTrialBootVar); err != nil {
 		return err
 	}
 

=== modified file 'partition/bootloader_uboot.go'
--- partition/bootloader_uboot.go	2015-06-03 12:12:13 +0000
+++ partition/bootloader_uboot.go	2015-07-22 12:17:55 +0000
@@ -28,6 +28,7 @@
 	"launchpad.net/snappy/helpers"
 
 	"github.com/mvo5/goconfigparser"
+	"github.com/mvo5/uboot-go/uenv"
 )
 
 const (
@@ -40,9 +41,11 @@
 	// this partition is "good".
 	bootloaderUbootStampFileReal = "/boot/uboot/snappy-stamp.txt"
 
-	// the main uEnv.txt u-boot config file sources this snappy
-	// boot-specific config file.
+	// DEPRECATED:
 	bootloaderUbootEnvFileReal = "/boot/uboot/snappy-system.txt"
+
+	// the real uboot env
+	bootloaderUbootFwEnvFileReal = "/boot/uboot/uboot.env"
 )
 
 // var to make it testable
@@ -51,6 +54,7 @@
 	bootloaderUbootConfigFile = bootloaderUbootConfigFileReal
 	bootloaderUbootStampFile  = bootloaderUbootStampFileReal
 	bootloaderUbootEnvFile    = bootloaderUbootEnvFileReal
+	bootloaderUbootFwEnvFile  = bootloaderUbootFwEnvFileReal
 	atomicFileUpdate          = atomicFileUpdateImpl
 )
 
@@ -199,23 +203,6 @@
 	return file.Sync()
 }
 
-func (u *uboot) MarkCurrentBootSuccessful() (err error) {
-	changes := []configFileChange{
-		configFileChange{Name: bootloaderBootmodeVar,
-			Value: bootloaderBootmodeSuccess,
-		},
-		configFileChange{Name: bootloaderRootfsVar,
-			Value: string(u.currentRootfs),
-		},
-	}
-
-	if err := modifyNameValueFile(bootloaderUbootEnvFile, changes); err != nil {
-		return err
-	}
-
-	return os.RemoveAll(bootloaderUbootStampFile)
-}
-
 func (u *uboot) SyncBootFiles() (err error) {
 	srcDir := u.currentBootPath
 	destDir := u.otherBootPath
@@ -317,6 +304,91 @@
 	return err
 }
 
+func (u *uboot) unsetBootVar(name string) error {
+	hasBootVar, err := u.hasBootVar(name)
+	if err != nil {
+		return err
+	}
+
+	// already unset, nothing to do
+	if !hasBootVar {
+		return nil
+	}
+
+	return u.setBootVar(name, "")
+}
+
+func (u *uboot) setBootVar(name, value string) error {
+	env, err := uenv.Open(bootloaderUbootFwEnvFile)
+	if err != nil {
+		return err
+	}
+
+	// already set, nothing to do
+	if env.Get(name) == value {
+		return nil
+	}
+
+	env.Set(name, value)
+	return env.Save()
+}
+
+func (u *uboot) hasBootVar(name string) (bool, error) {
+	v, err := u.getBootVar(name)
+	return v != "", err
+}
+
+func (u *uboot) getBootVar(name string) (string, error) {
+	env, err := uenv.Open(bootloaderUbootFwEnvFile)
+	if err != nil {
+		return "", err
+	}
+
+	return env.Get(name), nil
+}
+
+// FIXME: this is super similar to grub now, refactor to extract the
+//        common code
+func (u *uboot) markCurrentBootSuccessfulFwEnv(currentRootfs string) error {
+	// Clear the variable set on boot to denote a good boot.
+	if err := u.unsetBootVar(bootloaderTrialBootVar); err != nil {
+		return err
+	}
+
+	if err := u.setBootVar(bootloaderRootfsVar, currentRootfs); err != nil {
+		return err
+	}
+
+	return u.setBootVar(bootloaderBootmodeVar, bootloaderBootmodeSuccess)
+}
+
+func (u *uboot) markCurrentBootSuccessfulLegacy(currentRootfs string) error {
+	changes := []configFileChange{
+		configFileChange{Name: bootloaderBootmodeVar,
+			Value: bootloaderBootmodeSuccess,
+		},
+		configFileChange{Name: bootloaderRootfsVar,
+			Value: string(u.currentRootfs),
+		},
+	}
+
+	if err := modifyNameValueFile(bootloaderUbootEnvFile, changes); err != nil {
+		return err
+	}
+
+	return os.RemoveAll(bootloaderUbootStampFile)
+}
+
+func (u *uboot) MarkCurrentBootSuccessful() error {
+	// modern system
+	if helpers.FileExists(bootloaderUbootFwEnvFile) {
+		return u.markCurrentBootSuccessfulFwEnv(u.currentRootfs)
+	}
+
+	// legacy
+	return u.markCurrentBootSuccessfulLegacy(u.currentRootfs)
+}
+
 // Write lines to file atomically. File does not have to preexist.
 // FIXME: put into utils package
 func atomicFileUpdateImpl(file string, lines []string) (err error) {

=== modified file 'partition/bootloader_uboot_test.go'
--- partition/bootloader_uboot_test.go	2015-06-02 20:23:20 +0000
+++ partition/bootloader_uboot_test.go	2015-07-22 12:17:55 +0000
@@ -22,9 +22,12 @@
 	"os"
 	"path/filepath"
 	"strings"
+	"time"
 
 	. "launchpad.net/gocheck"
 	"launchpad.net/snappy/helpers"
+
+	"github.com/mvo5/uboot-go/uenv"
 )
 
 // TODO move to uboot specific test suite.
@@ -328,3 +331,56 @@
 	c.Check(strings.Contains(string(bytes), "snappy_mode=regular"), Equals, true)
 	c.Check(strings.Contains(string(bytes), "snappy_ab=a"), Equals, true)
 }
+
+func (s *PartitionTestSuite) TestUbootMarkCurrentBootSuccessfulFwEnv(c *C) {
+	s.makeFakeUbootEnv(c)
+
+	env, err := uenv.Create(bootloaderUbootFwEnvFile, 4096)
+	c.Assert(err, IsNil)
+	env.Set("snappy_ab", "a")
+	env.Set("snappy_mode", "try")
+	env.Set("snappy_trial_boot", "1")
+	err = env.Save()
+	c.Assert(err, IsNil)
+
+	partition := New()
+	u := newUboot(partition)
+	c.Assert(u, NotNil)
+
+	err = u.MarkCurrentBootSuccessful()
+	c.Assert(err, IsNil)
+
+	env, err = uenv.Open(bootloaderUbootFwEnvFile)
+	c.Assert(err, IsNil)
+	c.Assert(env.String(), Equals, "snappy_ab=a\nsnappy_mode=regular\n")
+}
+
+func (s *PartitionTestSuite) TestUbootSetEnvNoUselessWrites(c *C) {
+	s.makeFakeUbootEnv(c)
+
+	env, err := uenv.Create(bootloaderUbootFwEnvFile, 4096)
+	c.Assert(err, IsNil)
+	env.Set("snappy_ab", "a")
+	env.Set("snappy_mode", "regular")
+	err = env.Save()
+	c.Assert(err, IsNil)
+
+	st, err := os.Stat(bootloaderUbootFwEnvFile)
+	c.Assert(err, IsNil)
+	time.Sleep(100 * time.Millisecond)
+
+	partition := New()
+	u := newUboot(partition)
+	c.Assert(u, NotNil)
+
+	err = u.(*uboot).setBootVar(bootloaderRootfsVar, "a")
+	c.Assert(err, IsNil)
+
+	env, err = uenv.Open(bootloaderUbootFwEnvFile)
+	c.Assert(err, IsNil)
+	c.Assert(env.String(), Equals, "snappy_ab=a\nsnappy_mode=regular\n")
+
+	st2, err := os.Stat(bootloaderUbootFwEnvFile)
+	c.Assert(err, IsNil)
+	c.Assert(st.ModTime(), Equals, st2.ModTime())
+}

=== modified file 'partition/partition_test.go'
--- partition/partition_test.go	2015-03-30 14:42:31 +0000
+++ partition/partition_test.go	2015-07-22 12:17:55 +0000
@@ -60,6 +60,7 @@
 	bootloaderUbootDir = filepath.Join(s.tempdir, "boot", "uboot")
 	bootloaderUbootConfigFile = filepath.Join(bootloaderUbootDir, "uEnv.txt")
 	bootloaderUbootEnvFile = filepath.Join(bootloaderUbootDir, "uEnv.txt")
+	bootloaderUbootFwEnvFile = filepath.Join(bootloaderUbootDir, "uboot.env")
 	bootloaderUbootStampFile = filepath.Join(bootloaderUbootDir, "snappy-stamp.txt")
 
 	c.Assert(mounts, DeepEquals, mountEntryArray(nil))