Merge lp:~mvo/snappy/snappy-improve-developer-mode-detection into lp:~snappy-dev/snappy/snappy-moved-to-github

[Michael Vogt]

Use install.yaml to detect if in developer mode.

This branch improves the developer mode detection by using the new
ubuntu-device-flash mechanism. It does not care about backward
compatibility currently. If thats a issue I can add the old code
back but given that it was not really reliable this seems like the
better approach.

It also does a bit of cleanup in the tests.

[Sergio Schvezov (sergiusens)]

hey, looks good, just some comments and maybe merge trunk.

we also maybe should define those // no idea

[Michael Vogt (mvo)]

Thanks, addressed (most) points and replied inline in the previous comment.

[Michael Vogt (mvo)]

Is there anything else missing in this branch? It has some dependencies that are stalled right now :)

[Sergio Schvezov (sergiusens)]

> Is there anything else missing in this branch? It has some dependencies that
> are stalled right now :)

It is related to the conversation from yesterday about u-d-f only being in tools-proposed; I guess its fine in any case as this is rolling...

[Sergio Schvezov (sergiusens)]

review: Approve

[Snappy Tarmac (snappydevtarmac)]

The attempt to merge lp:~mvo/snappy/snappy-improve-developer-mode-detection into lp:snappy failed. Below is the output from the failed tests.

Checking docs
Checking formatting
Installing godeps
Install golint
Obtaining dependencies
update code.google.com/p/go.crypto failed; trying to fetch newer version
update github.com/blakesmith/ar failed; trying to fetch newer version
code.google.com/p/go.crypto now at 69e2a90ed92d03812364aeb947b7068dc42e561e
update github.com/cheggaaa/pb failed; trying to fetch newer version
github.com/blakesmith/ar now at c9a977dd0cc1392b023382c7bfa5a22af8d3b730
update github.com/jessevdk/go-flags failed; trying to fetch newer version
github.com/cheggaaa/pb now at e8c7cc515bfde3e267957a3b110080ceed51354e
update github.com/mvo5/goconfigparser failed; trying to fetch newer version
github.com/jessevdk/go-flags now at 15347ef417a300349807983f15af9e65cd2e1b3a
update gopkg.in/check.v1 failed; trying to fetch newer version
github.com/mvo5/goconfigparser now at 26426272dda20cc76aa1fa44286dc743d2972fe8
update gopkg.in/yaml.v2 failed; trying to fetch newer version
gopkg.in/check.v1 now at 64131543e7896d5bcc6bd5a76287eb75ea96c673
gopkg.in/yaml.v2 now at 49c95bdc21843256fb6c4e0d370a05f24a0bf213
Building
Running tests from /home/tarmac/tmp/tmp.BeKP6ui6Ol/src/launchpad.net/snappy
=== RUN Test
OK: 16 passed
--- PASS: Test (0.32 seconds)
PASS
coverage: 74.3% of statements
ok launchpad.net/snappy/clickdeb 0.327s coverage: 74.3% of statements
=== RUN Test
OK: 6 passed
--- PASS: Test (0.07 seconds)
PASS
coverage: 12.9% of statements
ok launchpad.net/snappy/cmd/snappy 0.083s coverage: 12.9% of statements
=== RUN Test
OK: 24 passed
--- PASS: Test (0.08 seconds)
PASS
coverage: 100.0% of statements
ok launchpad.net/snappy/coreconfig 0.088s coverage: 100.0% of statements
=== RUN Test
OK: 50 passed
--- PASS: Test (0.34 seconds)
PASS
coverage: 80.9% of statements
ok launchpad.net/snappy/helpers 0.347s coverage: 80.9% of statements
=== RUN Test
OK: 6 passed
--- PASS: Test (0.00 seconds)
PASS
coverage: 93.5% of statements
ok launchpad.net/snappy/logger 0.005s coverage: 93.5% of statements
=== RUN Test
OK: 4 passed
--- PASS: Test (0.00 seconds)
PASS
coverage: 100.0% of statements
ok launchpad.net/snappy/oauth 0.005s coverage: 100.0% of statements
=== RUN Test
OK: 38 passed
--- PASS: Test (0.19 seconds)
PASS
coverage: 81.1% of statements
ok launchpad.net/snappy/partition 0.191s coverage: 81.1% of statements
=== RUN Test
OK: 3 passed
--- PASS: Test (0.00 seconds)
PASS
coverage: 100.0% of statements
ok launchpad.net/snappy/pkg 0.004s coverage: 100.0% of statements
=== RUN Test
OK: 12 passed
--- PASS: Test (0.07 seconds)
PASS
coverage: 94.3% of statements
ok launchpad.net/snappy/policy 0.072s coverage: 94.3% of statements
=== RUN Test
OK: 5 passed
--- PASS: Test (0.20 seconds)
PASS
coverage: 91.1% of statements
ok launchpad.net/snappy/priv 0.210s coverage: 91.1% of statements
=== RUN Test
OK: 4 passed
--- PASS: Test (0.02 seconds)
PASS
coverage: 50.0% of statements
ok launchpad.net/snappy/progress 0.020s coverage: 50.0% of statements
=== RUN Test

----------------------------------------------------------------------
FAIL: provis...

[lp:~mvo/snappy/snappy-improve-developer-mode-detection]

506. By Michael Vogt on 2015-06-22

merged lp:snappy

507. By Michael Vogt on 2015-06-22

fix test in tarmac

[Michael Vogt (mvo)]

review: Approve

=== modified file 'provisioning/provisioning.go'
--- provisioning/provisioning.go	2015-06-09 18:07:51 +0000
+++ provisioning/provisioning.go	2015-06-22 13:55:37 +0000
@@ -29,18 +29,24 @@
 	"gopkg.in/yaml.v2"
 )
 
-var (
+const (
 	// InstallYamlFile is the name of the file created by
 	// ubuntu-device-flash(1), created at system installation time,
 	// that contains metadata on the installation.
 	//
 	// XXX: Public for ubuntu-device-flash(1)
 	InstallYamlFile = "install.yaml"
-
-	// ErrNoInstallYaml is emitted when InstallYamlFile does not exist.
-	ErrNoInstallYaml = fmt.Errorf("no %s", InstallYamlFile)
 )
 
+// ErrNoInstallYaml is emitted when InstallYamlFile does not exist.
+type ErrNoInstallYaml struct {
+	origErr error
+}
+
+func (e *ErrNoInstallYaml) Error() string {
+	return fmt.Sprintf("failed to read provisioning data: %s", e.origErr)
+}
+
 // InstallMeta encapsulates the metadata for a system install.
 type InstallMeta struct {
 	Timestamp         time.Time
@@ -79,7 +85,7 @@
 func parseInstallYaml(path string) (*InstallYaml, error) {
 	data, err := ioutil.ReadFile(path)
 	if err != nil {
-		return nil, ErrNoInstallYaml
+		return nil, &ErrNoInstallYaml{origErr: err}
 	}
 
 	return parseInstallYamlData(data)
@@ -124,3 +130,21 @@
 
 	return false
 }
+
+// InDeveloperMode returns true if the image was build with --developer-mode
+func InDeveloperMode(bootloaderDir string) bool {
+	file := filepath.Join(bootloaderDir, InstallYamlFile)
+
+	if !helpers.FileExists(file) {
+		// no idea
+		return false
+	}
+
+	InstallYaml, err := parseInstallYaml(file)
+	if err != nil {
+		// no idea
+		return false
+	}
+
+	return InstallYaml.InstallOptions.DeveloperMode
+}

=== modified file 'provisioning/provisioning_test.go'
--- provisioning/provisioning_test.go	2015-06-10 12:52:22 +0000
+++ provisioning/provisioning_test.go	2015-06-22 13:55:37 +0000
@@ -30,8 +30,8 @@
 func Test(t *testing.T) { TestingT(t) }
 
 type ProvisioningTestSuite struct {
-	tempdir         string
-	installYamlFile string
+	mockBootDir  string
+	mockYamlFile string
 }
 
 var _ = Suite(&ProvisioningTestSuite{})
@@ -78,74 +78,70 @@
 var garbageData = `Fooled you!?`
 
 func (ts *ProvisioningTestSuite) SetUpTest(c *C) {
-	ts.tempdir = c.MkDir()
-
-	ts.installYamlFile = filepath.Join(ts.tempdir, "install.yaml")
-
-	InstallYamlFile = ts.installYamlFile
-	os.Remove(InstallYamlFile)
+	ts.mockBootDir = c.MkDir()
+	ts.mockYamlFile = filepath.Join(ts.mockBootDir, "install.yaml")
 }
 
 func (ts *ProvisioningTestSuite) TestSideLoadedSystemNoInstallYaml(c *C) {
-	c.Assert(IsSideLoaded(""), Equals, false)
+	c.Assert(IsSideLoaded(ts.mockBootDir), Equals, false)
 }
 
 func (ts *ProvisioningTestSuite) TestSideLoadedSystem(c *C) {
-	c.Assert(IsSideLoaded(""), Equals, false)
+	c.Assert(IsSideLoaded(ts.mockBootDir), Equals, false)
 
-	err := ioutil.WriteFile(InstallYamlFile, []byte(yamlData), 0750)
+	err := ioutil.WriteFile(ts.mockYamlFile, []byte(yamlData), 0750)
 	c.Assert(err, IsNil)
 
-	c.Assert(IsSideLoaded(""), Equals, true)
+	c.Assert(IsSideLoaded(ts.mockBootDir), Equals, true)
 
-	os.Remove(InstallYamlFile)
-	c.Assert(IsSideLoaded(""), Equals, false)
+	os.Remove(ts.mockYamlFile)
+	c.Assert(IsSideLoaded(ts.mockBootDir), Equals, false)
 }
 
 func (ts *ProvisioningTestSuite) TestSideLoadedSystemNoDevicePart(c *C) {
 
-	c.Assert(IsSideLoaded(""), Equals, false)
+	c.Assert(IsSideLoaded(ts.mockBootDir), Equals, false)
 
-	err := ioutil.WriteFile(InstallYamlFile, []byte(yamlDataNoDevicePart), 0750)
+	err := ioutil.WriteFile(ts.mockYamlFile, []byte(yamlDataNoDevicePart), 0750)
 	c.Assert(err, IsNil)
 
-	c.Assert(IsSideLoaded(""), Equals, false)
+	c.Assert(IsSideLoaded(ts.mockBootDir), Equals, false)
 
-	os.Remove(InstallYamlFile)
-	c.Assert(IsSideLoaded(""), Equals, false)
+	os.Remove(ts.mockYamlFile)
+	c.Assert(IsSideLoaded(ts.mockBootDir), Equals, false)
 }
 
 func (ts *ProvisioningTestSuite) TestSideLoadedSystemGarbageInstallYaml(c *C) {
-	c.Assert(IsSideLoaded(""), Equals, false)
+	c.Assert(IsSideLoaded(ts.mockBootDir), Equals, false)
 
-	err := ioutil.WriteFile(InstallYamlFile, []byte(garbageData), 0750)
+	err := ioutil.WriteFile(ts.mockYamlFile, []byte(garbageData), 0750)
 	c.Assert(err, IsNil)
 
 	// we assume sideloaded if the file isn't parseable
-	c.Assert(IsSideLoaded(""), Equals, true)
+	c.Assert(IsSideLoaded(ts.mockBootDir), Equals, true)
 
-	os.Remove(InstallYamlFile)
-	c.Assert(IsSideLoaded(""), Equals, false)
+	os.Remove(ts.mockYamlFile)
+	c.Assert(IsSideLoaded(ts.mockBootDir), Equals, false)
 }
 
 func (ts *ProvisioningTestSuite) TestParseInstallYaml(c *C) {
 
-	_, err := parseInstallYaml(InstallYamlFile)
-	c.Check(err, Equals, ErrNoInstallYaml)
-
-	err = ioutil.WriteFile(InstallYamlFile, []byte(yamlData), 0750)
-	c.Check(err, IsNil)
-	_, err = parseInstallYaml(InstallYamlFile)
-	c.Check(err, IsNil)
-
-	err = ioutil.WriteFile(InstallYamlFile, []byte(yamlDataNoDevicePart), 0750)
-	c.Check(err, IsNil)
-	_, err = parseInstallYaml(InstallYamlFile)
-	c.Check(err, IsNil)
-
-	err = ioutil.WriteFile(InstallYamlFile, []byte(garbageData), 0750)
-	c.Check(err, IsNil)
-	_, err = parseInstallYaml(InstallYamlFile)
+	_, err := parseInstallYaml(ts.mockYamlFile)
+	c.Check(err, ErrorMatches, `failed to read provisioning data: open .*/install.yaml: no such file or directory`)
+
+	err = ioutil.WriteFile(ts.mockYamlFile, []byte(yamlData), 0750)
+	c.Check(err, IsNil)
+	_, err = parseInstallYaml(ts.mockYamlFile)
+	c.Check(err, IsNil)
+
+	err = ioutil.WriteFile(ts.mockYamlFile, []byte(yamlDataNoDevicePart), 0750)
+	c.Check(err, IsNil)
+	_, err = parseInstallYaml(ts.mockYamlFile)
+	c.Check(err, IsNil)
+
+	err = ioutil.WriteFile(ts.mockYamlFile, []byte(garbageData), 0750)
+	c.Check(err, IsNil)
+	_, err = parseInstallYaml(ts.mockYamlFile)
 	c.Check(err, Not(Equals), nil)
 }
 
@@ -163,3 +159,25 @@
 	_, err = parseInstallYamlData([]byte(garbageData))
 	c.Check(err, Not(Equals), nil)
 }
+
+func (ts *ProvisioningTestSuite) TestInDeveloperModeEmpty(c *C) {
+	c.Assert(InDeveloperMode(""), Equals, false)
+}
+
+func (ts *ProvisioningTestSuite) TestInDeveloperModeWithDevModeOn(c *C) {
+	err := ioutil.WriteFile(ts.mockYamlFile, []byte(`
+options:
+ developer-mode: true
+`), 0644)
+	c.Assert(err, IsNil)
+	c.Assert(InDeveloperMode(ts.mockBootDir), Equals, true)
+}
+
+func (ts *ProvisioningTestSuite) TestInDeveloperModeWithDevModeOff(c *C) {
+	err := ioutil.WriteFile(ts.mockYamlFile, []byte(`
+options:
+ developer-mode: false
+`), 0644)
+	c.Assert(err, IsNil)
+	c.Assert(InDeveloperMode(ts.mockBootDir), Equals, false)
+}

=== modified file 'snappy/install.go'
--- snappy/install.go	2015-06-10 13:38:10 +0000
+++ snappy/install.go	2015-06-22 13:55:37 +0000
@@ -21,13 +21,12 @@
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"sort"
-	"strings"
 
 	"launchpad.net/snappy/logger"
 	"launchpad.net/snappy/progress"
+	"launchpad.net/snappy/provisioning"
 )
 
 // InstallFlags can be used to pass additional flags to the install of a
@@ -45,28 +44,6 @@
 	AllowOEM
 )
 
-// check if the image is in developer mode
-// FIXME: this is a bit crude right now, but it seems like there is not more
-//        meta-data to check right now
-// TODO: add feature to ubuntu-device-flash to write better info file when
-//       the image is in developer mode
-func inDeveloperMode() bool {
-	f, err := os.Open(cloudMetaDataFile)
-	if err != nil {
-		return false
-	}
-	defer f.Close()
-	data, err := ioutil.ReadAll(f)
-	if err != nil {
-		return false
-	}
-	needle := "public-keys:\n"
-	if strings.Contains(string(data), needle) {
-		return true
-	}
-	return false
-}
-
 // Update the installed snappy packages, it returns the updated Parts
 // if updates where available and an error and nil if any of the updates
 // fail to apply.
@@ -115,7 +92,12 @@
 	if fi, err := os.Stat(name); err == nil && fi.Mode().IsRegular() {
 		// we allow unauthenticated package when in developer
 		// mode
-		if inDeveloperMode() {
+		//
+		// FIXME: this is terrible, we really need a single
+		//        bootloader dir like /boot or /boot/loader
+		//        instead of having to query the partition code
+		p := newPartition()
+		if provisioning.InDeveloperMode(p.BootloaderDir()) {
 			flags |= AllowUnauthenticated
 		}
 

=== modified file 'snappy/install_test.go'
--- snappy/install_test.go	2015-06-10 15:13:07 +0000
+++ snappy/install_test.go	2015-06-22 13:55:37 +0000
@@ -42,21 +42,6 @@
 	return w.Name()
 }
 
-func (s *SnapTestSuite) TestNotInDeveloperMode(c *C) {
-	cloudMetaDataFile = makeCloudInitMetaData(c, `instance-id: nocloud-static`)
-	defer os.Remove(cloudMetaDataFile)
-	c.Assert(inDeveloperMode(), Equals, false)
-}
-
-func (s *SnapTestSuite) TestInDeveloperMode(c *C) {
-	cloudMetaDataFile = makeCloudInitMetaData(c, `instance-id: nocloud-static
-public-keys:
-  - ssh-rsa AAAAB3NzAndSoOn
-`)
-	defer os.Remove(cloudMetaDataFile)
-	c.Assert(inDeveloperMode(), Equals, true)
-}
-
 func (s *SnapTestSuite) TestInstallInstall(c *C) {
 	snapFile := makeTestSnapPackage(c, "")
 	name, err := Install(snapFile, AllowUnauthenticated|DoInstallGC, &progress.NullProgress{})