Merge lp:~chipaca/snappy/removed-pkg into lp:~snappy-dev/snappy/snappy-moved-to-github

[John Lenton]

Introducing removed parts. Also, renamed ManifestPath -> RemoteManifestPath for clarity.

[Michael Vogt (mvo)]

This looks great, thanks! One inline comment that to maybe improves readability. But that can be a separate branch of course.

review: Approve

[lp:~chipaca/snappy/removed-pkg]

743. By John Lenton on 2015-10-07

Merged remote-snap into removed-pkg.

744. By John Lenton on 2015-10-07

clarified ManifestPath (-> RemoteManifestPath, + a comment)

=== added directory 'pkg/removed'
=== added file 'pkg/removed/removed.go'
--- pkg/removed/removed.go	1970-01-01 00:00:00 +0000
+++ pkg/removed/removed.go	2015-10-07 16:07:50 +0000
@@ -0,0 +1,158 @@
+// -*- 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 removed implements Removed packages, that are packages that
+// have been installed, removed, but not purged: there is no
+// application, but there might be data.
+package removed
+
+import (
+	"errors"
+	"io/ioutil"
+	"time"
+
+	"gopkg.in/yaml.v2"
+
+	"launchpad.net/snappy/pkg"
+	"launchpad.net/snappy/pkg/remote"
+	"launchpad.net/snappy/progress"
+	"launchpad.net/snappy/snappy"
+)
+
+// ErrRemoved is returned when you ask to operate on a removed package.
+var ErrRemoved = errors.New("package is removed")
+
+// Removed represents a removed package.
+type Removed struct {
+	name    string
+	origin  string
+	version string
+	pkgType pkg.Type
+	remote  *remote.Snap
+}
+
+// New removed package.
+func New(name, origin, version string, pkgType pkg.Type) snappy.Part {
+	part := &Removed{
+		name:    name,
+		origin:  origin,
+		version: version,
+		pkgType: pkgType,
+	}
+
+	// try to load the remote manifest, that would've been kept
+	// around when installing from the store.
+	content, _ := ioutil.ReadFile(snappy.RemoteManifestPath(part))
+	yaml.Unmarshal(content, &(part.remote))
+
+	return part
+}
+
+// Name from the snappy.Part interface
+func (r *Removed) Name() string { return r.name }
+
+// Version from the snappy.Part interface
+func (r *Removed) Version() string { return r.version }
+
+// Description from the snappy.Part interface
+func (r *Removed) Description() string {
+	if r.remote != nil {
+		return r.remote.Description
+	}
+
+	return ""
+}
+
+// Origin from the snappy.Part interface
+func (r *Removed) Origin() string {
+	if r.remote != nil {
+		return r.remote.Origin
+	}
+	if r.origin == "" {
+		return snappy.SideloadedOrigin
+	}
+	return r.origin
+}
+
+// Vendor from the snappy.Part interface
+func (r *Removed) Vendor() string {
+	if r.remote != nil {
+		return r.remote.Publisher
+	}
+
+	return ""
+}
+
+// Hash from the snappy.Part interface
+func (r *Removed) Hash() string { return "" }
+
+// IsActive from the snappy.Part interface
+func (r *Removed) IsActive() bool { return false }
+
+// IsInstalled from the snappy.Part interface
+func (r *Removed) IsInstalled() bool { return false }
+
+// NeedsReboot from the snappy.Part interface
+func (r *Removed) NeedsReboot() bool { return false }
+
+// Date from the snappy.Part interface
+func (r *Removed) Date() time.Time { return time.Time{} } // XXX: keep track of when the package was removed
+// Channel from the snappy.Part interface
+func (r *Removed) Channel() string { return "" }
+
+// Icon from the snappy.Part interface
+func (r *Removed) Icon() string {
+	if r.remote != nil {
+		return r.remote.IconURL
+	}
+
+	return ""
+}
+
+// Type from the snappy.Part interface
+func (r *Removed) Type() pkg.Type { return r.pkgType }
+
+// InstalledSize from the snappy.Part interface
+func (r *Removed) InstalledSize() int64 { return -1 }
+
+// DownloadSize from the snappy.Part interface
+func (r *Removed) DownloadSize() int64 {
+	if r.remote != nil {
+		return r.remote.DownloadSize
+	}
+
+	return -1
+}
+
+// Install from the snappy.Part interface
+func (r *Removed) Install(pb progress.Meter, flags snappy.InstallFlags) (name string, err error) {
+	return "", ErrRemoved
+}
+
+// Uninstall from the snappy.Part interface
+func (r *Removed) Uninstall(pb progress.Meter) error { return ErrRemoved }
+
+// Config from the snappy.Part interface
+func (r *Removed) Config(configuration []byte) (newConfig string, err error) { return "", ErrRemoved }
+
+// SetActive from the snappy.Part interface
+func (r *Removed) SetActive(bool, progress.Meter) error { return ErrRemoved }
+
+// Frameworks from the snappy.Part interface
+func (r *Removed) Frameworks() ([]string, error) { return nil, ErrRemoved }

=== added file 'pkg/removed/removed_test.go'
--- pkg/removed/removed_test.go	1970-01-01 00:00:00 +0000
+++ pkg/removed/removed_test.go	2015-10-07 16:07:50 +0000
@@ -0,0 +1,137 @@
+// -*- 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 removed
+
+import (
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"gopkg.in/check.v1"
+
+	"launchpad.net/snappy/dirs"
+	"launchpad.net/snappy/pkg"
+	"launchpad.net/snappy/progress"
+	"launchpad.net/snappy/snappy"
+)
+
+type removedSuite struct{}
+
+func Test(t *testing.T) { check.TestingT(t) }
+
+var _ = check.Suite(&removedSuite{})
+
+func (s *removedSuite) SetUpTest(c *check.C) {
+	dirs.SetRootDir(c.MkDir())
+	c.Check(os.MkdirAll(filepath.Join(dirs.SnapDataDir, "foo.bar", "1"), 0755), check.IsNil)
+}
+
+func (s *removedSuite) MkStoreYaml(c *check.C, pkgType pkg.Type) {
+	// creating the part to get its manifest path is cheating, a little
+	part := &Removed{
+		name:    "foo",
+		origin:  "bar",
+		version: "1",
+		pkgType: pkgType,
+	}
+
+	content := `
+name: foo
+origin: bar
+version: 1
+type: app
+description: |-
+  bla bla bla
+publisher: example.com
+iconurl: http://i.stack.imgur.com/i8q1U.jpg
+downloadsize: 5554242
+`
+	p := snappy.RemoteManifestPath(part)
+	c.Assert(os.MkdirAll(filepath.Dir(p), 0755), check.IsNil)
+	c.Assert(ioutil.WriteFile(p, []byte(content), 0644), check.IsNil)
+
+}
+
+func (s *removedSuite) TestNoStore(c *check.C) {
+	part := New("foo", "bar", "1", pkg.TypeApp)
+
+	c.Check(part.Name(), check.Equals, "foo")
+	c.Check(part.Origin(), check.Equals, "bar")
+	c.Check(part.Version(), check.Equals, "1")
+	c.Check(part.Description(), check.Equals, "")
+	c.Check(part.Vendor(), check.Equals, "")
+	c.Check(part.Hash(), check.Equals, "")
+	c.Check(part.Icon(), check.Equals, "")
+	c.Check(part.DownloadSize(), check.Equals, int64(-1))
+
+	c.Check(part.InstalledSize(), check.Equals, int64(-1))
+	c.Check(part.IsActive(), check.Equals, false)
+	c.Check(part.IsInstalled(), check.Equals, false)
+	c.Check(part.NeedsReboot(), check.Equals, false)
+
+	prog := &progress.NullProgress{}
+	c.Check(part.Uninstall(prog), check.Equals, ErrRemoved)
+	c.Check(part.SetActive(true, prog), check.Equals, ErrRemoved)
+	_, err := part.Install(prog, 0)
+	c.Check(err, check.Equals, ErrRemoved)
+	_, err = part.Config(nil)
+	c.Check(err, check.Equals, ErrRemoved)
+	_, err = part.Frameworks()
+	c.Check(err, check.Equals, ErrRemoved)
+}
+
+func (s *removedSuite) TestNoOrigin(c *check.C) {
+	part := New("foo", "", "1", pkg.TypeFramework)
+	c.Check(part.Origin(), check.Equals, snappy.SideloadedOrigin)
+
+	s.MkStoreYaml(c, pkg.TypeFramework)
+	part = New("foo", "", "1", pkg.TypeFramework)
+	c.Check(part.Origin(), check.Equals, "bar")
+}
+
+func (s *removedSuite) TestWithStore(c *check.C) {
+	s.MkStoreYaml(c, pkg.TypeApp)
+	part := New("foo", "bar", "1", pkg.TypeApp)
+
+	c.Check(part.Name(), check.Equals, "foo")
+	c.Check(part.Origin(), check.Equals, "bar")
+	c.Check(part.Version(), check.Equals, "1")
+	c.Check(part.Description(), check.Equals, "bla bla bla")
+	c.Check(part.Vendor(), check.Equals, "example.com")
+	c.Check(part.Hash(), check.Equals, "")
+	c.Check(part.Icon(), check.Equals, "http://i.stack.imgur.com/i8q1U.jpg")
+	c.Check(part.DownloadSize(), check.Equals, int64(5554242))
+
+	c.Check(part.InstalledSize(), check.Equals, int64(-1))
+	c.Check(part.IsActive(), check.Equals, false)
+	c.Check(part.IsInstalled(), check.Equals, false)
+	c.Check(part.NeedsReboot(), check.Equals, false)
+
+	prog := &progress.NullProgress{}
+	c.Check(part.Uninstall(prog), check.Equals, ErrRemoved)
+	c.Check(part.SetActive(true, prog), check.Equals, ErrRemoved)
+	_, err := part.Install(prog, 0)
+	c.Check(err, check.Equals, ErrRemoved)
+	_, err = part.Config(nil)
+	c.Check(err, check.Equals, ErrRemoved)
+	_, err = part.Frameworks()
+	c.Check(err, check.Equals, ErrRemoved)
+}

=== modified file 'snappy/parts.go'
--- snappy/parts.go	2015-10-07 16:07:49 +0000
+++ snappy/parts.go	2015-10-07 16:07:50 +0000
@@ -361,7 +361,7 @@
 	return filepath.Join(dirs.SnapIconsDir, fmt.Sprintf("%s_%s.png", QualifiedName(s), s.Version()))
 }
 
-// ManifestPath returns the would be path for the store manifest meta data
-func ManifestPath(s Part) string {
+// RemoteManifestPath returns the would be path for the store manifest meta data
+func RemoteManifestPath(s Part) string {
 	return filepath.Join(dirs.SnapMetaDir, fmt.Sprintf("%s_%s.manifest", QualifiedName(s), s.Version()))
 }

=== modified file 'snappy/snapp.go'
--- snappy/snapp.go	2015-10-07 16:07:49 +0000
+++ snappy/snapp.go	2015-10-07 16:07:50 +0000
@@ -634,7 +634,7 @@
 	}
 	part.hash = h.ArchiveSha512
 
-	remoteManifestPath := ManifestPath(part)
+	remoteManifestPath := RemoteManifestPath(part)
 	if helpers.FileExists(remoteManifestPath) {
 		content, err := ioutil.ReadFile(remoteManifestPath)
 		if err != nil {
@@ -1615,7 +1615,7 @@
 	}
 
 	// don't worry about previous contents
-	return ioutil.WriteFile(ManifestPath(s), content, 0644)
+	return ioutil.WriteFile(RemoteManifestPath(s), content, 0644)
 }
 
 // Install installs the snap