Merge lp:~mvo/snappy/snappy-snapfs-install-via-unpack into lp:~snappy-dev/snappy/snappy-moved-to-github

[Michael Vogt]

Add install support (via unpack) to new style snaps

This branch adds support for install of new style snaps via unpack.

[John Lenton (chipaca)]

lgtm, beyond conflicts and nits below

[lp:~mvo/snappy/snappy-snapfs-install-via-unpack]

750. By Michael Vogt on 2015-10-08

merged lp:snappy and resolved conflicts

751. By Michael Vogt on 2015-10-08

address execllent review comments

[Michael Vogt (mvo)]

Thanks, your review is invaluable!

[Michael Vogt (mvo)]

I addressed the comments.

[John Lenton (chipaca)]

review: Approve

=== modified file 'pkg/clickdeb/deb.go'
--- pkg/clickdeb/deb.go	2015-09-16 11:02:59 +0000
+++ pkg/clickdeb/deb.go	2015-10-08 17:42:26 +0000
@@ -155,6 +155,11 @@
 	return d.file.Close()
 }
 
+// Verify checks that the clickdeb is signed
+func (d *ClickDeb) Verify(allowUnauthenticated bool) error {
+	return Verify(d.Name(), allowUnauthenticated)
+}
+
 // ControlMember returns the content of the given control member file
 // (e.g. the content of the "manifest" file in the control.tar.gz ar member)
 func (d *ClickDeb) ControlMember(controlMember string) (content []byte, err error) {

=== modified file 'pkg/snapfs/pkg.go'
--- pkg/snapfs/pkg.go	2015-10-08 07:44:05 +0000
+++ pkg/snapfs/pkg.go	2015-10-08 17:42:26 +0000
@@ -45,6 +45,32 @@
 	return &Snap{path: path}
 }
 
+// Close is not doing anything for snapfs - COMPAT
+func (s *Snap) Close() error {
+	return nil
+}
+
+// ControlMember extracts from meta/ - COMPAT
+func (s *Snap) ControlMember(controlMember string) ([]byte, error) {
+	return s.ReadFile(filepath.Join("DEBIAN", controlMember))
+}
+
+// MetaMember extracts from meta/ - COMPAT
+func (s *Snap) MetaMember(metaMember string) ([]byte, error) {
+	return s.ReadFile(filepath.Join("meta", metaMember))
+}
+
+// ExtractHashes does notthing for snapfs snaps - COMAPT
+func (s *Snap) ExtractHashes(dir string) error {
+	return nil
+}
+
+// UnpackWithDropPrivs unpacks the meta and puts stuff in place - COMAPT
+func (s *Snap) UnpackWithDropPrivs(instDir, rootdir string) error {
+	// FIXME: actually drop privs
+	return s.Unpack("*", instDir)
+}
+
 // UnpackMeta unpacks just the meta/* directory of the given snap
 func (s *Snap) UnpackMeta(dst string) error {
 	if err := s.Unpack("meta/*", dst); err != nil {

=== modified file 'snappy/common_test.go'
--- snappy/common_test.go	2015-10-08 06:25:35 +0000
+++ snappy/common_test.go	2015-10-08 17:42:26 +0000
@@ -39,6 +39,9 @@
 	helloAppComposedName = "hello-app.testspacethename"
 )
 
+// here to make it easy to switch in tests to "BuildSnapfsSnap"
+var snapBuilderFunc = BuildLegacySnap
+
 // makeInstalledMockSnap creates a installed mock snap without any
 // content other than the meta data
 func makeInstalledMockSnap(tempdir, packageYamlContent string) (yamlFile string, err error) {
@@ -142,7 +145,7 @@
 	// build it
 	err := helpers.ChDir(tmpdir, func() error {
 		var err error
-		snapFile, err = BuildLegacySnap(tmpdir, "")
+		snapFile, err = snapBuilderFunc(tmpdir, "")
 		c.Assert(err, IsNil)
 		return err
 	})

=== added file 'snappy/pkgformat.go'
--- snappy/pkgformat.go	1970-01-01 00:00:00 +0000
+++ snappy/pkgformat.go	2015-10-08 17:42:26 +0000
@@ -0,0 +1,64 @@
+// -*- Mode: Go; indent-tabs-mode: t -*-
+
+/*
+ * 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/>.
+ *
+ */
+
+package snappy
+
+import (
+	"bytes"
+	"fmt"
+	"os"
+	"strings"
+
+	"launchpad.net/snappy/pkg/clickdeb"
+	"launchpad.net/snappy/pkg/snapfs"
+)
+
+// PackageFile is the interface to interact with the low-level snap files
+type PackageFile interface {
+	Verify(allowUnauthenticated bool) error
+	Close() error
+	UnpackWithDropPrivs(targetDir, rootDir string) error
+	ControlMember(name string) ([]byte, error)
+	MetaMember(name string) ([]byte, error)
+	ExtractHashes(targetDir string) error
+}
+
+// OpenPackageFile opens a given snap file with the right backend
+func OpenPackageFile(path string) (PackageFile, error) {
+	f, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+	defer f.Close()
+
+	// look, libmagic!
+	header := make([]byte, 20)
+	if _, err := f.Read(header); err != nil {
+		return nil, err
+	}
+	// note that we only support little endian squashfs for now
+	if bytes.HasPrefix(header, []byte{'h', 's', 'q', 's'}) {
+		return snapfs.New(path), nil
+	}
+	if strings.HasPrefix(string(header), "!<arch>\ndebian") {
+		return clickdeb.Open(path)
+	}
+
+	return nil, fmt.Errorf("unknown header %v", header)
+}

=== modified file 'snappy/snapp.go'
--- snappy/snapp.go	2015-10-08 12:20:09 +0000
+++ snappy/snapp.go	2015-10-08 17:42:26 +0000
@@ -43,7 +43,6 @@
 	"launchpad.net/snappy/logger"
 	"launchpad.net/snappy/oauth"
 	"launchpad.net/snappy/pkg"
-	"launchpad.net/snappy/pkg/clickdeb"
 	"launchpad.net/snappy/pkg/remote"
 	"launchpad.net/snappy/policy"
 	"launchpad.net/snappy/progress"
@@ -182,7 +181,7 @@
 	isActive    bool
 	isInstalled bool
 	description string
-	deb         *clickdeb.ClickDeb
+	deb         PackageFile
 	basedir     string
 }
 
@@ -433,7 +432,7 @@
 // package, as deduced from the license agreement (which might involve asking
 // the user), or an error that explains the reason why installation should not
 // proceed.
-func (m *packageYaml) checkLicenseAgreement(ag agreer, d *clickdeb.ClickDeb, currentActiveDir string) error {
+func (m *packageYaml) checkLicenseAgreement(ag agreer, d PackageFile, currentActiveDir string) error {
 	if !m.ExplicitLicenseAgreement {
 		return nil
 	}
@@ -541,18 +540,18 @@
 }
 
 // NewSnapPartFromSnapFile loads a snap from the given (clickdeb) snap file.
-// Caller should call Close on the clickdeb.
+// Caller should call Close on the pkg.
 // TODO: expose that Close.
 func NewSnapPartFromSnapFile(snapFile string, origin string, unauthOk bool) (*SnapPart, error) {
-	if err := clickdeb.Verify(snapFile, unauthOk); err != nil {
-		return nil, err
-	}
-
-	d, err := clickdeb.Open(snapFile)
+	d, err := OpenPackageFile(snapFile)
 	if err != nil {
 		return nil, err
 	}
 
+	if err := d.Verify(unauthOk); err != nil {
+		return nil, err
+	}
+
 	yamlData, err := d.MetaMember("package.yaml")
 	if err != nil {
 		return nil, err

=== added file 'snappy/snapp_snapfs_test.go'
--- snappy/snapp_snapfs_test.go	1970-01-01 00:00:00 +0000
+++ snappy/snapp_snapfs_test.go	2015-10-08 17:42:26 +0000
@@ -0,0 +1,84 @@
+// -*- Mode: Go; indent-tabs-mode: t -*-
+
+/*
+ * 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/>.
+ *
+ */
+
+package snappy
+
+import (
+	"path/filepath"
+
+	"launchpad.net/snappy/dirs"
+	"launchpad.net/snappy/helpers"
+	"launchpad.net/snappy/pkg/snapfs"
+
+	. "gopkg.in/check.v1"
+)
+
+type SnapfsTestSuite struct {
+}
+
+func (s *SnapfsTestSuite) SetUpTest(c *C) {
+	// mocks
+	aaClickHookCmd = "/bin/true"
+	dirs.SetRootDir(c.MkDir())
+
+	// ensure we use the right builder func (snapfs)
+	snapBuilderFunc = BuildSnapfsSnap
+}
+
+func (s *SnapfsTestSuite) TearDownTest(c *C) {
+	snapBuilderFunc = BuildLegacySnap
+}
+
+var _ = Suite(&SnapfsTestSuite{})
+
+const packageHello = `name: hello-app
+version: 1.10
+vendor: Somebody
+icon: meta/hello.svg
+`
+
+func (s *SnapfsTestSuite) TestMakeSnapMakesSnapfs(c *C) {
+	snapPkg := makeTestSnapPackage(c, packageHello)
+	part, err := NewSnapPartFromSnapFile(snapPkg, "origin", true)
+	c.Assert(err, IsNil)
+
+	// ensure the right backend got picked up
+	c.Assert(part.deb, FitsTypeOf, &snapfs.Snap{})
+}
+
+func (s *SnapfsTestSuite) TestInstallViaSnapfsWorks(c *C) {
+	snapPkg := makeTestSnapPackage(c, packageHello)
+	part, err := NewSnapPartFromSnapFile(snapPkg, "origin", true)
+	c.Assert(err, IsNil)
+
+	_, err = part.Install(&MockProgressMeter{}, 0)
+	c.Assert(err, IsNil)
+
+	// after install its just on disk for now, note that this will
+	// change once the mounting gets added
+	base := filepath.Join(dirs.SnapAppsDir, "hello-app.origin", "1.10")
+	for _, needle := range []string{
+		"bin/foo",
+		"meta/package.yaml",
+		".click/info/hello-app.origin.manifest",
+	} {
+		println(needle)
+		c.Assert(helpers.FileExists(filepath.Join(base, needle)), Equals, true)
+	}
+}