Merge lp:~sergiusens/snappy/lockDownRemove into lp:~snappy-dev/snappy/snappy-moved-to-github

[Sergio Schvezov]

Moving oem related tasks to an oem.go unit and adding support for Uninstall prevention of builtins.

This will need a remerge of mvo's changes, but wanted to get the general idea.

[John Lenton (chipaca)]

review: Approve

[Snappy Tarmac (snappydevtarmac)]

The attempt to merge lp:~sergiusens/snappy/lockDownRemove into lp:snappy failed. Below is the output from the failed tests.

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/juju/loggo failed; trying to fetch newer version
github.com/jessevdk/go-flags now at 15347ef417a300349807983f15af9e65cd2e1b3a
update github.com/mvo5/goconfigparser failed; trying to fetch newer version
github.com/juju/loggo now at 4c7cbce140ca070eeb59a28f4bf9507e511711f9
update gopkg.in/yaml.v2 failed; trying to fetch newer version
github.com/mvo5/goconfigparser now at 26426272dda20cc76aa1fa44286dc743d2972fe8
update launchpad.net/gocheck failed; trying to fetch newer version
gopkg.in/yaml.v2 now at 49c95bdc21843256fb6c4e0d370a05f24a0bf213
launchpad.net/gocheck now at <email address hidden>
Building
Running tests from /tmp/tmp.lNdVwxZXOl/src/launchpad.net/snappy
=== RUN Test
OK: 8 passed
--- PASS: Test (0.21 seconds)
PASS
coverage: 80.0% of statements
ok launchpad.net/snappy/clickdeb 0.212s coverage: 80.0% of statements
=== RUN Test
OK: 6 passed
--- PASS: Test (0.01 seconds)
PASS
coverage: 13.0% of statements
ok launchpad.net/snappy/cmd/snappy 0.017s coverage: 13.0% of statements
=== RUN Test
OK: 24 passed
--- PASS: Test (0.04 seconds)
PASS
coverage: 100.0% of statements
ok launchpad.net/snappy/coreconfig 0.044s coverage: 100.0% of statements
=== RUN Test
OK: 30 passed
--- PASS: Test (1.44 seconds)
PASS
coverage: 82.4% of statements
ok launchpad.net/snappy/helpers 1.442s coverage: 82.4% of statements
=== RUN Test
OK: 7 passed
--- PASS: Test (0.03 seconds)
PASS
coverage: 92.5% of statements
ok launchpad.net/snappy/logger 0.035s coverage: 92.5% of statements
=== RUN Test
OK: 36 passed
--- PASS: Test (0.10 seconds)
PASS
coverage: 81.7% of statements
ok launchpad.net/snappy/partition 0.105s coverage: 81.7% of statements
=== RUN Test
OK: 12 passed
--- PASS: Test (0.07 seconds)
PASS
coverage: 87.8% of statements
ok launchpad.net/snappy/policy 0.077s coverage: 87.8% of statements
=== RUN Test
OK: 3 passed
--- PASS: Test (0.00 seconds)
PASS
coverage: 84.8% of statements
ok launchpad.net/snappy/priv 0.004s coverage: 84.8% of statements
=== RUN Test
OK: 3 passed
--- PASS: Test (0.01 seconds)
PASS
coverage: 45.2% of statements
ok launchpad.net/snappy/progress 0.011s coverage: 45.2% of statements
=== RUN Test
OK: 6 passed
--- PASS: Test (0.00 seconds)
PASS
coverage: 100.0% of statements
ok launchpad.net/snappy/release 0.006s coverage: 100.0% of statements
=== RUN Test
2015-04-20 23:41:47 ERROR snappy logger.go:199 hello-app.potato failed to install: a package by that name is already installed
201...

[John Lenton (chipaca)]

review: Approve

[lp:~sergiusens/snappy/lockDownRemove]

398. By Sergio Schvezov on 2015-04-21

Moving oem related tasks to an oem.go unit and adding support for Uninstall prevention of builtins. by sergiusens approved by chipaca

=== added file 'snappy/oem.go'
--- snappy/oem.go	1970-01-01 00:00:00 +0000
+++ snappy/oem.go	2015-04-20 23:57:04 +0000
@@ -0,0 +1,197 @@
+/*
+ * Copyright (C) 2014-2015 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+// TODO this should be it's own package, but depends on splitting out
+// package.yaml's
+
+package snappy
+
+import (
+	"errors"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"strings"
+)
+
+// OEM represents the structure inside the package.yaml for the oem component
+// of an oem package type.
+type OEM struct {
+	Store    Store `yaml:"store,omitempty"`
+	Hardware struct {
+		Assign []HardwareAssign `yaml:"assign,omitempty"`
+	} `yaml:"hardware,omitempty"`
+	Software Software `yaml:"software,omitempty"`
+}
+
+// Store holds information relevant to the store provided by an OEM snap
+type Store struct {
+	ID string `yaml:"id,omitempty"`
+}
+
+// Software describes the installed software provided by an OEM snap
+type Software struct {
+	BuiltIn []string `yaml:"built-in,omitempty"`
+}
+
+// HardwareAssign describes the hardware a app can use
+type HardwareAssign struct {
+	PartID string `yaml:"part-id,omitempty"`
+	Rules  []struct {
+		Kernel         string   `yaml:"kernel,omitempty"`
+		Subsystem      string   `yaml:"subsystem,omitempty"`
+		WithSubsystems string   `yaml:"with-subsystems,omitempty"`
+		WithDriver     string   `yaml:"with-driver,omitempty"`
+		WithAttrs      []string `yaml:"with-attrs,omitempty"`
+		WithProps      []string `yaml:"with-props,omitempty"`
+	} `yaml:"rules,omitempty"`
+}
+
+func (hw *HardwareAssign) generateUdevRuleContent() (string, error) {
+	s := ""
+	for _, r := range hw.Rules {
+		if r.Kernel != "" {
+			s += fmt.Sprintf(`KERNEL=="%v", `, r.Kernel)
+		}
+		if r.Subsystem != "" {
+			s += fmt.Sprintf(`SUBSYSTEM=="%v", `, r.Subsystem)
+		}
+		if r.WithSubsystems != "" {
+			s += fmt.Sprintf(`SUBSYSTEMS=="%v", `, r.WithSubsystems)
+		}
+		if r.WithDriver != "" {
+			s += fmt.Sprintf(`DRIVER=="%v", `, r.WithDriver)
+		}
+		for _, a := range r.WithAttrs {
+			l := strings.Split(a, "=")
+			s += fmt.Sprintf(`ATTRS{%v}=="%v", `, l[0], l[1])
+		}
+		for _, a := range r.WithProps {
+			l := strings.SplitN(a, "=", 2)
+			s += fmt.Sprintf(`ENV{%v}=="%v", `, l[0], l[1])
+		}
+		s += fmt.Sprintf(`TAG:="snappy-assign", ENV{SNAPPY_APP}:="%s"`, hw.PartID)
+		s += "\n\n"
+	}
+
+	return s, nil
+}
+
+// getOem is a convenience function to not go into the details for the business
+// logic for an oem package in every other function
+var getOem = getOemImpl
+
+var getOemImpl = func() (*packageYaml, error) {
+	oems, _ := ActiveSnapsByType(SnapTypeOem)
+	if len(oems) == 1 {
+		return oems[0].(*SnapPart).m, nil
+	}
+
+	return nil, errors.New("no oem snap")
+}
+
+// StoreID returns the store id setup by the oem package or an empty string
+func StoreID() string {
+	oem, err := getOem()
+	if err != nil {
+		return ""
+	}
+
+	return oem.OEM.Store.ID
+}
+
+// IsBuiltInSoftware returns true if the package is part of the built-in software
+// defined by the oem.
+func IsBuiltInSoftware(name string) bool {
+	oem, err := getOem()
+	if err != nil {
+		return false
+	}
+
+	for _, builtin := range oem.OEM.Software.BuiltIn {
+		if builtin == name {
+			return true
+		}
+	}
+
+	return false
+}
+
+func cleanupOemHardwareUdevRules(m *packageYaml) error {
+	oldFiles, err := filepath.Glob(filepath.Join(snapUdevRulesDir, fmt.Sprintf("80-snappy_%s_*.rules", m.Name)))
+	if err != nil {
+		return err
+	}
+
+	for _, f := range oldFiles {
+		os.Remove(f)
+	}
+
+	return nil
+}
+
+func writeOemHardwareUdevRules(m *packageYaml) error {
+	// cleanup
+	if err := cleanupOemHardwareUdevRules(m); err != nil {
+		return err
+	}
+	// write new files
+	for _, h := range m.OEM.Hardware.Assign {
+		rulesContent, err := h.generateUdevRuleContent()
+		if err != nil {
+			return err
+		}
+		outfile := filepath.Join(snapUdevRulesDir, fmt.Sprintf("80-snappy_%s_%s.rules", m.Name, h.PartID))
+		if err := ioutil.WriteFile(outfile, []byte(rulesContent), 0644); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+// var to make testing easier
+var runUdevAdm = runUdevAdmImpl
+
+func runUdevAdmImpl(args ...string) error {
+	cmd := exec.Command(args[0], args[1:]...)
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	return cmd.Run()
+}
+
+func activateOemHardwareUdevRules(m *packageYaml) error {
+	if err := runUdevAdm("udevadm", "control", "--reload-rules"); err != nil {
+		return err
+	}
+
+	return runUdevAdm("udevadm", "trigger")
+}
+
+func installOemHardwareUdevRules(m *packageYaml) error {
+	if err := writeOemHardwareUdevRules(m); err != nil {
+		return err
+	}
+
+	if err := activateOemHardwareUdevRules(m); err != nil {
+		return err
+	}
+
+	return nil
+}
 
=== added file 'snappy/oem_test.go'
--- snappy/oem_test.go	1970-01-01 00:00:00 +0000
+++ snappy/oem_test.go	2015-04-20 23:57:04 +0000
@@ -0,0 +1,59 @@
+/*
+ * Copyright (C) 2014-2015 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+// TODO this should be it's own package, but depends on splitting out
+// package.yaml's
+
+package snappy
+
+import (
+	. "launchpad.net/gocheck"
+)
+
+type OemSuite struct {
+}
+
+var _ = Suite(&OemSuite{})
+
+var (
+	getOemOrig = getOem
+)
+
+func (s *OemSuite) SetUpTest(c *C) {
+	getOem = func() (*packageYaml, error) {
+		return &packageYaml{
+			OEM: OEM{
+				Software: Software{[]string{"makeuppackage", "anotherpackage"}},
+				Store:    Store{"ninjablocks"},
+			},
+		}, nil
+	}
+}
+
+func (s *OemSuite) TearDownTest(c *C) {
+	getOem = getOemImpl
+}
+
+func (s *OemSuite) TestIsBuildIn(c *C) {
+	c.Check(IsBuiltInSoftware("notapackage"), Equals, false)
+	c.Check(IsBuiltInSoftware("makeuppackage"), Equals, true)
+	c.Check(IsBuiltInSoftware("anotherpackage"), Equals, true)
+}
+
+func (s *OemSuite) TestStoreID(c *C) {
+	c.Assert(StoreID(), Equals, "ninjablocks")
+}
 
=== modified file 'snappy/snapp.go'
--- snappy/snapp.go	2015-04-20 16:51:29 +0000
+++ snappy/snapp.go	2015-04-20 23:57:04 +0000
@@ -173,6 +173,8 @@
 
 var commasplitter = regexp.MustCompile(`\s*,\s*`).Split
 
+// TODO split into payloads per package type composing the common
+// elements for all snaps.
 type packageYaml struct {
 	Name    string
 	Version string
@@ -192,14 +194,7 @@
 	Binaries []Binary  `yaml:"binaries,omitempty"`
 
 	// oem snap only
-	OEM struct {
-		Store struct {
-			ID string `yaml:"id,omitempty"`
-		} `yaml:"store,omitempty"`
-		Hardware struct {
-			Assign []HardwareAssign `yaml:"assign,omitempty"`
-		} `yaml:"hardware,omitempty"`
-	} `yaml:"oem,omitempty"`
+	OEM    OEM          `yaml:"oem,omitempty"`
 	Config SystemConfig `yaml:"config,omitempty"`
 
 	// this is a bit ugly, but right now integration is a one:one
@@ -210,19 +205,6 @@
 	LicenseVersion           string `yaml:"license-version,omitempty"`
 }
 
-// HardwareAssign describes the hardware a app can use
-type HardwareAssign struct {
-	PartID string `yaml:"part-id,omitempty"`
-	Rules  []struct {
-		Kernel         string   `yaml:"kernel,omitempty"`
-		Subsystem      string   `yaml:"subsystem,omitempty"`
-		WithSubsystems string   `yaml:"with-subsystems,omitempty"`
-		WithDriver     string   `yaml:"with-driver,omitempty"`
-		WithAttrs      []string `yaml:"with-attrs,omitempty"`
-		WithProps      []string `yaml:"with-props,omitempty"`
-	} `yaml:"rules,omitempty"`
-}
-
 type remoteSnap struct {
 	Alias           string             `json:"alias,omitempty"`
 	AnonDownloadURL string             `json:"anon_download_url,omitempty"`
@@ -248,99 +230,6 @@
 	} `json:"_embedded"`
 }
 
-func cleanupOemHardwareUdevRules(m *packageYaml) error {
-	oldFiles, err := filepath.Glob(filepath.Join(snapUdevRulesDir, fmt.Sprintf("80-snappy_%s_*.rules", m.Name)))
-	if err != nil {
-		return err
-	}
-
-	for _, f := range oldFiles {
-		os.Remove(f)
-	}
-
-	return nil
-}
-
-func writeOemHardwareUdevRules(m *packageYaml) error {
-	// cleanup
-	if err := cleanupOemHardwareUdevRules(m); err != nil {
-		return err
-	}
-	// write new files
-	for _, h := range m.OEM.Hardware.Assign {
-		rulesContent, err := h.generateUdevRuleContent()
-		if err != nil {
-			return err
-		}
-		outfile := filepath.Join(snapUdevRulesDir, fmt.Sprintf("80-snappy_%s_%s.rules", m.Name, h.PartID))
-		if err := ioutil.WriteFile(outfile, []byte(rulesContent), 0644); err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-// var to make testing easier
-var runUdevAdm = runUdevAdmImpl
-
-func runUdevAdmImpl(args ...string) error {
-	cmd := exec.Command(args[0], args[1:]...)
-	cmd.Stdout = os.Stdout
-	cmd.Stderr = os.Stderr
-	return cmd.Run()
-}
-
-func activateOemHardwareUdevRules(m *packageYaml) error {
-	if err := runUdevAdm("udevadm", "control", "--reload-rules"); err != nil {
-		return err
-	}
-
-	return runUdevAdm("udevadm", "trigger")
-}
-
-func installOemHardwareUdevRules(m *packageYaml) error {
-	if err := writeOemHardwareUdevRules(m); err != nil {
-		return err
-	}
-
-	if err := activateOemHardwareUdevRules(m); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func (hw *HardwareAssign) generateUdevRuleContent() (string, error) {
-	s := ""
-	for _, r := range hw.Rules {
-		if r.Kernel != "" {
-			s += fmt.Sprintf(`KERNEL=="%v", `, r.Kernel)
-		}
-		if r.Subsystem != "" {
-			s += fmt.Sprintf(`SUBSYSTEM=="%v", `, r.Subsystem)
-		}
-		if r.WithSubsystems != "" {
-			s += fmt.Sprintf(`SUBSYSTEMS=="%v", `, r.WithSubsystems)
-		}
-		if r.WithDriver != "" {
-			s += fmt.Sprintf(`DRIVER=="%v", `, r.WithDriver)
-		}
-		for _, a := range r.WithAttrs {
-			l := strings.Split(a, "=")
-			s += fmt.Sprintf(`ATTRS{%v}=="%v", `, l[0], l[1])
-		}
-		for _, a := range r.WithProps {
-			l := strings.SplitN(a, "=", 2)
-			s += fmt.Sprintf(`ENV{%v}=="%v", `, l[0], l[1])
-		}
-		s += fmt.Sprintf(`TAG:="snappy-assign", ENV{SNAPPY_APP}:="%s"`, hw.PartID)
-		s += "\n\n"
-	}
-
-	return s, nil
-}
-
 func parsePackageYamlFile(yamlPath string) (*packageYaml, error) {
 
 	yamlData, err := ioutil.ReadFile(yamlPath)
@@ -689,6 +578,10 @@
 		return ErrPackageNotRemovable
 	}
 
+	if IsBuiltInSoftware(s.Name()) && s.IsActive() {
+		return ErrPackageNotRemovable
+	}
+
 	deps, err := s.DependentNames()
 	if err != nil {
 		return err
@@ -1206,13 +1099,8 @@
 	req.Header.Set("X-Ubuntu-Architecture", string(Architecture()))
 	req.Header.Set("X-Ubuntu-Release", release.String())
 
-	// check if the oem part sets a custom store-id
-	oems, _ := ActiveSnapsByType(SnapTypeOem)
-	if len(oems) == 1 {
-		storeID := oems[0].(*SnapPart).m.OEM.Store.ID
-		if storeID != "" {
-			req.Header.Set("X-Ubuntu-Store", storeID)
-		}
+	if storeID := StoreID(); storeID != "" {
+		req.Header.Set("X-Ubuntu-Store", storeID)
 	}
 
 	// sso
 
=== modified file 'snappy/snapp_test.go'
--- snappy/snapp_test.go	2015-04-20 18:40:29 +0000
+++ snappy/snapp_test.go	2015-04-20 23:57:04 +0000
@@ -835,6 +835,37 @@
 	repo.Details("xkcd")
 }
 
+func (s *SnapTestSuite) TestUninstallBuiltIn(c *C) {
+	// install custom oem snap with store-id
+	oemYaml, err := makeInstalledMockSnap(s.tempdir, `name: oem-test
+version: 1.0
+vendor: mvo
+oem:
+  store:
+    id: my-store
+  software:
+    built-in:
+      - hello-app
+type: oem
+`)
+	c.Assert(err, IsNil)
+	makeSnapActive(oemYaml)
+
+	packageYaml, err := makeInstalledMockSnap(s.tempdir, "")
+	c.Assert(err, IsNil)
+	makeSnapActive(packageYaml)
+
+	p := &MockProgressMeter{}
+
+	snap := NewLocalSnapRepository(filepath.Join(s.tempdir, "apps"))
+	c.Assert(snap, NotNil)
+	installed, err := snap.Installed()
+	c.Assert(err, IsNil)
+	parts := FindSnapsByName("hello-app", installed)
+	c.Assert(parts, HasLen, 1)
+	c.Check(parts[0].Uninstall(p), Equals, ErrPackageNotRemovable)
+}
+
 var securityBinaryPackageYaml = []byte(`name: test-snap
 version: 1.2.8
 vendor: Jamie Strandboge <[e-mail]>
@@ -1209,10 +1240,10 @@
      - subsystem: tty
        with-subsystems: usb-serial
        with-driver: pl2303
-       with-attrs: 
+       with-attrs:
        - idVendor=0xf00f00
        - idProduct=0xb00
-       with-props: 
+       with-props:
        - BAUD=9600
        - META1=foo*
        - META2=foo?