1
=== modified file 'snappy/common_test.go'
2
--- snappy/common_test.go	2016-02-02 17:51:45 +0000
3
+++ snappy/common_test.go	2016-04-21 06:04:15 +0000
4
@@ -85,6 +85,14 @@
5
85
	return snaps, f.err
85
	return snaps, f.err
6
86
}
86
}
7
87
87
8
88
func (f *fakeSnapdClient) AddSnap(name string) (string, error) {
9
89
	return "", nil
10
90
}
11
91
12
92
func (f *fakeSnapdClient) RemoveSnap(name string) (string, error) {
13
93
	return "", nil
14
94
}
15
95
16
88
var _ snapdClient = (*fakeSnapdClient)(nil)
96
var _ snapdClient = (*fakeSnapdClient)(nil)
17
89
97
18
90
type fakeSnapdClientServicesNoExternalUI struct {
98
type fakeSnapdClientServicesNoExternalUI struct {
19
91
99
20
=== modified file 'snappy/converge.go'
21
--- snappy/converge.go	2016-02-02 17:51:45 +0000
22
+++ snappy/converge.go	2016-04-21 06:04:15 +0000
23
@@ -26,25 +26,22 @@
24
26
26
25
27
	"github.com/ubuntu-core/snappy/client"
27
	"github.com/ubuntu-core/snappy/client"
26
28
	"github.com/ubuntu-core/snappy/snap"
28
	"github.com/ubuntu-core/snappy/snap"
27
29
	"github.com/ubuntu-core/snappy/snappy"
28
30
	"launchpad.net/webdm/webprogress"
29
31
)
29
)
30
32
30
31
33
type snapPkg struct {
31
type snapPkg struct {
46
34
	ID            string             `json:"id"`
32
	ID            string    `json:"id"`
47
35
	Name          string             `json:"name"`
33
	Name          string    `json:"name"`
48
36
	Origin        string             `json:"origin"`
34
	Origin        string    `json:"origin"`
49
37
	Version       string             `json:"version"`
35
	Version       string    `json:"version"`
50
38
	Description   string             `json:"description"`
36
	Description   string    `json:"description"`
51
39
	Icon          string             `json:"icon"`
37
	Icon          string    `json:"icon"`
52
40
	Status        webprogress.Status `json:"status"`
38
	Status        string    `json:"status"`
53
41
	Message       string             `json:"message,omitempty"`
39
	Message       string    `json:"message,omitempty"`
54
42
	IsError       bool               `json:"-"`
40
	Progress      float64   `json:"progress,omitempty"`
55
43
	Progress      float64            `json:"progress,omitempty"`
41
	InstalledSize int64     `json:"installed_size,omitempty"`
56
44
	InstalledSize int64              `json:"installed_size,omitempty"`
42
	DownloadSize  int64     `json:"download_size,omitempty"`
57
45
	DownloadSize  int64              `json:"download_size,omitempty"`
43
	Type          snap.Type `json:"type,omitempty"`
58
46
	Type          snap.Type          `json:"type,omitempty"`
44
	UIPort        uint64    `json:"ui_port,omitempty"`
45
47
	UIPort        uint64             `json:"ui_port,omitempty"`
59
48
}
45
}
60
49
46
61
50
type response struct {
47
type response struct {
62
@@ -77,40 +74,28 @@
63
77
	return snapPkgs, nil
74
	return snapPkgs, nil
64
78
}
75
}
65
79
76
66
80
func (h *Handler) doRemovePackage(progress *webprogress.WebProgress, ID string) {
67
81
	pkgName := strings.Split(ID, ".")[0]
68
82
69
83
	err := snappy.Remove(pkgName, 0, progress)
70
84
	progress.ErrorChan <- err
71
85
	close(progress.ErrorChan)
72
86
}
73
87
74
88
func (h *Handler) removePackage(ID string) error {
77
func (h *Handler) removePackage(ID string) error {
76
89
	progress, err := h.statusTracker.Add(ID, webprogress.OperationRemove)
78
	snap, err := h.snapdClient.Snap(ID)
77
90
	if err != nil {
79
	if err != nil {
78
91
		return err
80
		return err
79
92
	}
81
	}
80
93
82
90
94
	go h.doRemovePackage(progress, ID)
83
	h.statusTracker.TrackUninstall(snap)
91
95
84
92
96
	return nil
85
	_, err = h.snapdClient.RemoveSnap(ID)
93
97
}
86
	return err
85
98
86
99
func (h *Handler) doInstallPackage(progress *webprogress.WebProgress, ID string) {
87
100
	_, err := snappy.Install(ID, 0, progress)
88
101
	progress.ErrorChan <- err
89
102
	close(progress.ErrorChan)
94
103
}
87
}
95
104
88
96
105
func (h *Handler) installPackage(ID string) error {
89
func (h *Handler) installPackage(ID string) error {
98
106
	progress, err := h.statusTracker.Add(ID, webprogress.OperationInstall)
90
	snap, err := h.snapdClient.Snap(ID)
99
107
	if err != nil {
91
	if err != nil {
100
108
		return err
92
		return err
101
109
	}
93
	}
102
110
94
104
111
	go h.doInstallPackage(progress, ID)
95
	h.statusTracker.TrackInstall(snap)
105
112
96
107
113
	return nil
97
	_, err = h.snapdClient.AddSnap(ID)
108
98
	return err
109
114
}
99
}
110
115
100
111
116
func hasPortInformation(snapQ *client.Snap) bool {
101
func hasPortInformation(snapQ *client.Snap) bool {
112
@@ -126,6 +111,7 @@
113
126
		Version:     snapQ.Version,
111
		Version:     snapQ.Version,
114
127
		Description: snapQ.Description,
112
		Description: snapQ.Description,
115
128
		Type:        snap.Type(snapQ.Type),
113
		Type:        snap.Type(snapQ.Type),
116
114
		Status:      h.statusTracker.Status(snapQ),
117
129
	}
115
	}
118
130
116
119
131
	if hasPortInformation(snapQ) {
117
	if hasPortInformation(snapQ) {
120
@@ -150,25 +136,6 @@
121
150
		snap.DownloadSize = snapQ.DownloadSize
136
		snap.DownloadSize = snapQ.DownloadSize
122
151
	}
137
	}
123
152
138
124
153
	if stat, ok := h.statusTracker.Get(snap.ID); ok {
125
154
		snap.Status = stat.Status
126
155
		if stat.Done() {
127
156
			defer h.statusTracker.Remove(snap.ID)
128
157
129
158
			if stat.Error != nil {
130
159
				snap.Message = stat.Error.Error()
131
160
				snap.IsError = true
132
161
			}
133
162
134
163
		} else {
135
164
			snap.Progress = stat.Progress()
136
165
		}
137
166
	} else if isInstalled {
138
167
		snap.Status = webprogress.StatusInstalled
139
168
	} else {
140
169
		snap.Status = webprogress.StatusUninstalled
141
170
	}
142
171
143
172
	return snap
139
	return snap
144
173
}
140
}
145
174
141
146
175
142
147
=== modified file 'snappy/converge_test.go'
148
--- snappy/converge_test.go	2016-02-02 17:51:45 +0000
149
+++ snappy/converge_test.go	2016-04-21 06:04:15 +0000
150
@@ -24,7 +24,7 @@
151
24
	"github.com/ubuntu-core/snappy/client"
24
	"github.com/ubuntu-core/snappy/client"
152
25
	"github.com/ubuntu-core/snappy/snap"
25
	"github.com/ubuntu-core/snappy/snap"
153
26
	. "gopkg.in/check.v1"
26
	. "gopkg.in/check.v1"
155
27
	"launchpad.net/webdm/webprogress"
27
	"launchpad.net/webdm/statustracker"
156
28
)
28
)
157
29
29
158
30
type PackagePayloadSuite struct {
30
type PackagePayloadSuite struct {
159
@@ -36,7 +36,7 @@
160
36
36
161
37
func (s *PackagePayloadSuite) SetUpTest(c *C) {
37
func (s *PackagePayloadSuite) SetUpTest(c *C) {
162
38
	os.Setenv("SNAP_APP_DATA_PATH", c.MkDir())
38
	os.Setenv("SNAP_APP_DATA_PATH", c.MkDir())
164
39
	s.h.statusTracker = webprogress.New()
39
	s.h.statusTracker = statustracker.New()
165
40
	s.c = &fakeSnapdClient{}
40
	s.c = &fakeSnapdClient{}
166
41
	s.h.setClient(s.c)
41
	s.h.setClient(s.c)
167
42
}
42
}
168
@@ -75,7 +75,7 @@
169
75
75
170
76
func (s *PayloadSuite) SetUpTest(c *C) {
76
func (s *PayloadSuite) SetUpTest(c *C) {
171
77
	os.Setenv("SNAP_APP_DATA_PATH", c.MkDir())
77
	os.Setenv("SNAP_APP_DATA_PATH", c.MkDir())
173
78
	s.h.statusTracker = webprogress.New()
78
	s.h.statusTracker = statustracker.New()
174
79
	s.h.setClient(&fakeSnapdClient{})
79
	s.h.setClient(&fakeSnapdClient{})
175
80
}
80
}
176
81
81
177
@@ -86,7 +86,7 @@
178
86
86
179
87
	c.Check(q.Name, Equals, fakeSnap.Name)
87
	c.Check(q.Name, Equals, fakeSnap.Name)
180
88
	c.Check(q.Version, Equals, fakeSnap.Version)
88
	c.Check(q.Version, Equals, fakeSnap.Version)
182
89
	c.Check(q.Status, Equals, webprogress.StatusInstalled)
89
	c.Check(q.Status, Equals, statustracker.StatusInstalled)
183
90
	c.Check(q.Type, Equals, snap.Type(fakeSnap.Type))
90
	c.Check(q.Type, Equals, snap.Type(fakeSnap.Type))
184
91
	c.Check(q.UIPort, Equals, uint64(0))
91
	c.Check(q.UIPort, Equals, uint64(0))
185
92
	c.Check(q.Icon, Equals, "/icons/chatroom.ogra_icon.png")
92
	c.Check(q.Icon, Equals, "/icons/chatroom.ogra_icon.png")
186
@@ -101,7 +101,7 @@
187
101
101
188
102
	c.Assert(q.Name, Equals, fakeSnap.Name)
102
	c.Assert(q.Name, Equals, fakeSnap.Name)
189
103
	c.Assert(q.Version, Equals, fakeSnap.Version)
103
	c.Assert(q.Version, Equals, fakeSnap.Version)
191
104
	c.Assert(q.Status, Equals, webprogress.StatusInstalled)
104
	c.Assert(q.Status, Equals, statustracker.StatusInstalled)
192
105
	c.Assert(q.Type, Equals, snap.Type(fakeSnap.Type))
105
	c.Assert(q.Type, Equals, snap.Type(fakeSnap.Type))
193
106
	c.Assert(q.UIPort, Equals, uint64(0))
106
	c.Assert(q.UIPort, Equals, uint64(0))
194
107
}
107
}
195
@@ -114,7 +114,7 @@
196
114
114
197
115
	c.Assert(q.Name, Equals, fakeSnap.Name)
115
	c.Assert(q.Name, Equals, fakeSnap.Name)
198
116
	c.Assert(q.Version, Equals, fakeSnap.Version)
116
	c.Assert(q.Version, Equals, fakeSnap.Version)
200
117
	c.Assert(q.Status, Equals, webprogress.StatusInstalled)
117
	c.Assert(q.Status, Equals, statustracker.StatusInstalled)
201
118
	c.Assert(q.Type, Equals, snap.Type(fakeSnap.Type))
118
	c.Assert(q.Type, Equals, snap.Type(fakeSnap.Type))
202
119
	c.Assert(q.UIPort, Equals, uint64(1024))
119
	c.Assert(q.UIPort, Equals, uint64(1024))
203
120
}
120
}
204
@@ -129,18 +129,18 @@
205
129
129
206
130
	c.Assert(q.Name, Equals, fakeSnap.Name)
130
	c.Assert(q.Name, Equals, fakeSnap.Name)
207
131
	c.Assert(q.Version, Equals, fakeSnap.Version)
131
	c.Assert(q.Version, Equals, fakeSnap.Version)
209
132
	c.Assert(q.Status, Equals, webprogress.StatusInstalled)
132
	c.Assert(q.Status, Equals, statustracker.StatusInstalled)
210
133
	c.Assert(q.Type, Equals, snap.Type(fakeSnap.Type))
133
	c.Assert(q.Type, Equals, snap.Type(fakeSnap.Type))
211
134
	c.Assert(q.UIPort, Equals, uint64(0))
134
	c.Assert(q.UIPort, Equals, uint64(0))
212
135
}
135
}
213
136
136
214
137
func (s *PayloadSuite) TestPayloadSnapInstalling(c *C) {
137
func (s *PayloadSuite) TestPayloadSnapInstalling(c *C) {
215
138
	fakeSnap := newDefaultSnap()
138
	fakeSnap := newDefaultSnap()
218
139
	fakeSnapID := fakeSnap.Name + "." + fakeSnap.Origin
139
	fakeSnap.Status = client.StatusNotInstalled
219
140
	s.h.statusTracker.Add(fakeSnapID, webprogress.OperationInstall)
140
	s.h.statusTracker.TrackInstall(fakeSnap)
220
141
141
221
142
	payload := s.h.snapToPayload(fakeSnap)
142
	payload := s.h.snapToPayload(fakeSnap)
223
143
	c.Assert(payload.Status, Equals, webprogress.StatusInstalling)
143
	c.Assert(payload.Status, Equals, statustracker.StatusInstalling)
224
144
}
144
}
225
145
145
226
146
type AllPackagesSuite struct {
146
type AllPackagesSuite struct {
227
@@ -152,7 +152,7 @@
228
152
152
229
153
func (s *AllPackagesSuite) SetUpTest(c *C) {
153
func (s *AllPackagesSuite) SetUpTest(c *C) {
230
154
	os.Setenv("SNAP_APP_DATA_PATH", c.MkDir())
154
	os.Setenv("SNAP_APP_DATA_PATH", c.MkDir())
232
155
	s.h.statusTracker = webprogress.New()
155
	s.h.statusTracker = statustracker.New()
233
156
	s.c = &fakeSnapdClient{}
156
	s.c = &fakeSnapdClient{}
234
157
	s.h.setClient(s.c)
157
	s.h.setClient(s.c)
235
158
}
158
}
236
159
159
237
=== modified file 'snappy/handlers.go'
238
--- snappy/handlers.go	2016-02-23 16:00:47 +0000
239
+++ snappy/handlers.go	2016-04-21 06:04:15 +0000
240
@@ -26,21 +26,21 @@
241
26
26
242
27
	"github.com/ubuntu-core/snappy/client"
27
	"github.com/ubuntu-core/snappy/client"
243
28
	"github.com/ubuntu-core/snappy/snappy"
28
	"github.com/ubuntu-core/snappy/snappy"
245
29
	"launchpad.net/webdm/webprogress"
29
	"launchpad.net/webdm/statustracker"
246
30
30
247
31
	"github.com/gorilla/mux"
31
	"github.com/gorilla/mux"
248
32
)
32
)
249
33
33
250
34
// Handler implements snappy's packages api.
34
// Handler implements snappy's packages api.
251
35
type Handler struct {
35
type Handler struct {
253
36
	statusTracker *webprogress.StatusTracker
36
	statusTracker *statustracker.StatusTracker
254
37
	snapdClient   snapdClient
37
	snapdClient   snapdClient
255
38
}
38
}
256
39
39
257
40
// NewHandler creates an instance that implements snappy's packages api.
40
// NewHandler creates an instance that implements snappy's packages api.
258
41
func NewHandler() *Handler {
41
func NewHandler() *Handler {
259
42
	return &Handler{
42
	return &Handler{
261
43
		statusTracker: webprogress.New(),
43
		statusTracker: statustracker.New(),
262
44
		snapdClient:   client.New(nil),
44
		snapdClient:   client.New(nil),
263
45
	}
45
	}
264
46
}
46
}
265
@@ -92,10 +92,6 @@
266
92
		return
92
		return
267
93
	}
93
	}
268
94
94
269
95
	if payload.IsError {
270
96
		w.WriteHeader(http.StatusInternalServerError)
271
97
	}
272
98
273
99
	if err := enc.Encode(payload); err != nil {
95
	if err := enc.Encode(payload); err != nil {
274
100
		w.WriteHeader(http.StatusInternalServerError)
96
		w.WriteHeader(http.StatusInternalServerError)
275
101
		// give up on json
97
		// give up on json
276
@@ -155,9 +151,6 @@
277
155
	case snappy.ErrAlreadyInstalled:
151
	case snappy.ErrAlreadyInstalled:
278
156
		status = http.StatusOK
152
		status = http.StatusOK
279
157
		msg = "Installed"
153
		msg = "Installed"
280
158
	case webprogress.ErrPackageInstallInProgress:
281
159
		status = http.StatusBadRequest
282
160
		msg = "Operation in progress"
283
161
	case snappy.ErrPackageNotFound:
154
	case snappy.ErrPackageNotFound:
284
162
		status = http.StatusNotFound
155
		status = http.StatusNotFound
285
163
		msg = "Package not found"
156
		msg = "Package not found"
286
164
157
287
=== modified file 'snappy/handlers_test.go'
288
--- snappy/handlers_test.go	2016-02-02 17:50:38 +0000
289
+++ snappy/handlers_test.go	2016-04-21 06:04:15 +0000
290
@@ -23,7 +23,6 @@
291
23
	"os"
23
	"os"
292
24
24
293
25
	"github.com/ubuntu-core/snappy/client"
25
	"github.com/ubuntu-core/snappy/client"
294
26
	"launchpad.net/webdm/webprogress"
295
27
26
296
28
	. "gopkg.in/check.v1"
27
	. "gopkg.in/check.v1"
297
29
)
28
)
298
@@ -37,7 +36,6 @@
299
37
36
300
38
func (s *HandlersSuite) SetUpTest(c *C) {
37
func (s *HandlersSuite) SetUpTest(c *C) {
301
39
	os.Setenv("SNAP_APP_DATA_PATH", c.MkDir())
38
	os.Setenv("SNAP_APP_DATA_PATH", c.MkDir())
302
40
	s.h.statusTracker = webprogress.New()
303
41
	s.c = &fakeSnapdClient{}
39
	s.c = &fakeSnapdClient{}
304
42
	s.h.setClient(s.c)
40
	s.h.setClient(s.c)
305
43
}
41
}
306
44
42
307
=== modified file 'snappy/snapd_client.go'
308
--- snappy/snapd_client.go	2016-02-02 17:50:37 +0000
309
+++ snappy/snapd_client.go	2016-04-21 06:04:15 +0000
310
@@ -26,4 +26,6 @@
311
26
	Services(pkg string) (map[string]*client.Service, error)
26
	Services(pkg string) (map[string]*client.Service, error)
312
27
	Snap(name string) (*client.Snap, error)
27
	Snap(name string) (*client.Snap, error)
313
28
	FilterSnaps(filter client.SnapFilter) (map[string]*client.Snap, error)
28
	FilterSnaps(filter client.SnapFilter) (map[string]*client.Snap, error)
314
29
	AddSnap(name string) (string, error)
315
30
	RemoveSnap(name string) (string, error)
316
29
}
31
}
317
30
32
318
=== added directory 'statustracker'
319
=== added file 'statustracker/statustracker.go'
320
--- statustracker/statustracker.go	1970-01-01 00:00:00 +0000
321
+++ statustracker/statustracker.go	2016-04-21 06:04:15 +0000
322
@@ -0,0 +1,134 @@
323
1
/*
324
2
 * Copyright (C) 2016 Canonical Ltd
325
3
 *
326
4
 * This program is free software: you can redistribute it and/or modify
327
5
 * it under the terms of the GNU General Public License version 3 as
328
6
 * published by the Free Software Foundation.
329
7
 *
330
8
 * This program is distributed in the hope that it will be useful,
331
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
332
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
333
11
 * GNU General Public License for more details.
334
12
 *
335
13
 * You should have received a copy of the GNU General Public License
336
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
337
15
 *
338
16
 */
339
17
340
18
// Package statustracker enables the tracking of snap installation and removal.
341
19
//
342
20
// Once a snap has been marked as "installing" it will remain in that
343
21
// state until it's status as provided by snapd indicates that it is installed
344
22
// on the system. Similarly for removing snaps. Status lifecycle is thus:
345
23
//
346
24
// "uninstalled" -> "installing" -> "installed" -> "uninstalling" and repeat
347
25
package statustracker
348
26
349
27
import (
350
28
	"sync"
351
29
	"time"
352
30
353
31
	"github.com/ubuntu-core/snappy/client"
354
32
)
355
33
356
34
const (
357
35
	// StatusInstalled indicates the package is in an installed state.
358
36
	StatusInstalled = "installed"
359
37
	// StatusUninstalled indicates the package is in an uninstalled state.
360
38
	StatusUninstalled = "uninstalled"
361
39
	// StatusInstalling indicates the package is in an installing state.
362
40
	StatusInstalling = "installing"
363
41
	// StatusUninstalling indicates the package is in an uninstalling state.
364
42
	StatusUninstalling = "uninstalling"
365
43
)
366
44
367
45
var trackerDuration = 1 * time.Minute
368
46
369
47
// StatusTracker tracks statuses
370
48
type StatusTracker struct {
371
49
	sync.Mutex
372
50
	statuses map[string]string
373
51
}
374
52
375
53
// New returns a new status tracker
376
54
func New() *StatusTracker {
377
55
	return &StatusTracker{
378
56
		statuses: make(map[string]string),
379
57
	}
380
58
}
381
59
382
60
// Status returns the status of the given snap
383
61
func (s *StatusTracker) Status(snap *client.Snap) string {
384
62
	s.Lock()
385
63
	defer s.Unlock()
386
64
387
65
	status, ok := s.statuses[snapID(snap)]
388
66
	if !ok {
389
67
		return translateStatus(snap)
390
68
	}
391
69
392
70
	if hasCompleted(status, snap) {
393
71
		delete(s.statuses, snapID(snap))
394
72
		return translateStatus(snap)
395
73
	}
396
74
397
75
	return status
398
76
}
399
77
400
78
// TrackInstall tracks the installation of the given snap
401
79
func (s *StatusTracker) TrackInstall(snap *client.Snap) {
402
80
	if isInstalled(snap) {
403
81
		return
404
82
	}
405
83
406
84
	s.trackOperation(snapID(snap), StatusInstalling)
407
85
}
408
86
409
87
func (s *StatusTracker) trackOperation(id, operation string) {
410
88
	s.Lock()
411
89
	defer s.Unlock()
412
90
413
91
	s.statuses[id] = operation
414
92
415
93
	go func() {
416
94
		<-time.After(trackerDuration)
417
95
		s.Lock()
418
96
		delete(s.statuses, id)
419
97
		s.Unlock()
420
98
	}()
421
99
}
422
100
423
101
// TrackUninstall tracks the removal of the given snap
424
102
func (s *StatusTracker) TrackUninstall(snap *client.Snap) {
425
103
	if !isInstalled(snap) {
426
104
		return
427
105
	}
428
106
429
107
	s.trackOperation(snapID(snap), StatusUninstalling)
430
108
}
431
109
432
110
func snapID(s *client.Snap) string {
433
111
	return s.Name + "." + s.Origin
434
112
}
435
113
436
114
func isInstalled(s *client.Snap) bool {
437
115
	return s.Status == client.StatusInstalled || s.Status == client.StatusActive
438
116
}
439
117
440
118
// translate a status from the snappy world into one webdm understands
441
119
func translateStatus(s *client.Snap) string {
442
120
	if isInstalled(s) {
443
121
		return StatusInstalled
444
122
	}
445
123
446
124
	return StatusUninstalled
447
125
}
448
126
449
127
// has the tracked process denoted by status completed?
450
128
func hasCompleted(status string, snap *client.Snap) bool {
451
129
	if status == StatusInstalling {
452
130
		return isInstalled(snap)
453
131
	}
454
132
455
133
	return !isInstalled(snap)
456
134
}
457
0
135
458
=== added file 'statustracker/statustracker_test.go'
459
--- statustracker/statustracker_test.go	1970-01-01 00:00:00 +0000
460
+++ statustracker/statustracker_test.go	2016-04-21 06:04:15 +0000
461
@@ -0,0 +1,121 @@
462
1
/*
463
2
 * Copyright (C) 2016 Canonical Ltd
464
3
 *
465
4
 * This program is free software: you can redistribute it and/or modify
466
5
 * it under the terms of the GNU General Public License version 3 as
467
6
 * published by the Free Software Foundation.
468
7
 *
469
8
 * This program is distributed in the hope that it will be useful,
470
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
471
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
472
11
 * GNU General Public License for more details.
473
12
 *
474
13
 * You should have received a copy of the GNU General Public License
475
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
476
15
 *
477
16
 */
478
17
479
18
package statustracker
480
19
481
20
import (
482
21
	"testing"
483
22
	"time"
484
23
485
24
	"github.com/ubuntu-core/snappy/client"
486
25
487
26
	. "gopkg.in/check.v1"
488
27
)
489
28
490
29
func Test(t *testing.T) { TestingT(t) }
491
30
492
31
type StatusTrackerSuite struct {
493
32
	t *StatusTracker
494
33
}
495
34
496
35
var _ = Suite(&StatusTrackerSuite{})
497
36
498
37
func (s *StatusTrackerSuite) SetUpTest(c *C) {
499
38
	s.t = New()
500
39
}
501
40
502
41
func (s *StatusTrackerSuite) TestTranslateStatus(c *C) {
503
42
	tests := []struct {
504
43
		snapStatus string
505
44
		status     string
506
45
	}{
507
46
		{client.StatusInstalled, StatusInstalled},
508
47
		{client.StatusActive, StatusInstalled},
509
48
		{client.StatusNotInstalled, StatusUninstalled},
510
49
		{client.StatusRemoved, StatusUninstalled},
511
50
	}
512
51
513
52
	for _, tt := range tests {
514
53
		snap := &client.Snap{Status: tt.snapStatus}
515
54
		c.Assert(translateStatus(snap), Equals, tt.status)
516
55
	}
517
56
}
518
57
519
58
func (s *StatusTrackerSuite) TestHasCompleted(c *C) {
520
59
	tests := []struct {
521
60
		status     string
522
61
		snapStatus string
523
62
		completed  bool
524
63
	}{
525
64
		{StatusInstalling, client.StatusInstalled, true},
526
65
		{StatusInstalling, client.StatusRemoved, false},
527
66
		{StatusUninstalling, client.StatusRemoved, true},
528
67
		{StatusUninstalling, client.StatusActive, false},
529
68
	}
530
69
531
70
	for _, tt := range tests {
532
71
		snap := &client.Snap{Status: tt.snapStatus}
533
72
		c.Assert(hasCompleted(tt.status, snap), Equals, tt.completed)
534
73
	}
535
74
}
536
75
537
76
func (s *StatusTrackerSuite) TestUntrackedSnap(c *C) {
538
77
	snap := &client.Snap{Status: client.StatusInstalled}
539
78
	c.Assert(s.t.Status(snap), Equals, StatusInstalled)
540
79
}
541
80
542
81
func (s *StatusTrackerSuite) TestTrackInstallAlreadyInstalled(c *C) {
543
82
	snap := &client.Snap{Status: client.StatusInstalled}
544
83
	s.t.TrackInstall(snap)
545
84
	c.Assert(s.t.Status(snap), Equals, StatusInstalled)
546
85
}
547
86
548
87
func (s *StatusTrackerSuite) TestTrackInstall(c *C) {
549
88
	snap := &client.Snap{Status: client.StatusNotInstalled}
550
89
	s.t.TrackInstall(snap)
551
90
	c.Assert(s.t.Status(snap), Equals, StatusInstalling)
552
91
	// installation completes
553
92
	snap.Status = client.StatusActive
554
93
	c.Assert(s.t.Status(snap), Equals, StatusInstalled)
555
94
}
556
95
557
96
func (s *StatusTrackerSuite) TestTrackInstallExpiry(c *C) {
558
97
	trackerDuration = 200 * time.Millisecond
559
98
560
99
	snap := &client.Snap{Status: client.StatusNotInstalled}
561
100
	s.t.TrackInstall(snap)
562
101
	c.Assert(s.t.Status(snap), Equals, StatusInstalling)
563
102
564
103
	// don't track indefinitely if operation fails
565
104
	time.Sleep(trackerDuration * 2)
566
105
	c.Assert(s.t.Status(snap), Equals, StatusUninstalled)
567
106
}
568
107
569
108
func (s *StatusTrackerSuite) TestTrackUninstallNotInstalled(c *C) {
570
109
	snap := &client.Snap{Status: client.StatusNotInstalled}
571
110
	s.t.TrackUninstall(snap)
572
111
	c.Assert(s.t.Status(snap), Equals, StatusUninstalled)
573
112
}
574
113
575
114
func (s *StatusTrackerSuite) TestTrackUninstall(c *C) {
576
115
	snap := &client.Snap{Status: client.StatusInstalled}
577
116
	s.t.TrackUninstall(snap)
578
117
	c.Assert(s.t.Status(snap), Equals, StatusUninstalling)
579
118
	// uninstallation completes
580
119
	snap.Status = client.StatusRemoved
581
120
	c.Assert(s.t.Status(snap), Equals, StatusUninstalled)
582
121
}
583
0
122
584
=== removed file 'webprogress/meter.go'
585
--- webprogress/meter.go	2015-12-11 15:07:16 +0000
586
+++ webprogress/meter.go	1970-01-01 00:00:00 +0000
587
@@ -1,159 +0,0 @@
588
1
/*
589
2
 * Copyright (C) 2014-2015 Canonical Ltd
590
3
 *
591
4
 * This program is free software: you can redistribute it and/or modify
592
5
 * it under the terms of the GNU General Public License version 3 as
593
6
 * published by the Free Software Foundation.
594
7
 *
595
8
 * This program is distributed in the hope that it will be useful,
596
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
597
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
598
11
 * GNU General Public License for more details.
599
12
 *
600
13
 * You should have received a copy of the GNU General Public License
601
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
602
15
 *
603
16
 */
604
17
605
18
package webprogress
606
19
607
20
import "github.com/ubuntu-core/snappy/progress"
608
21
609
22
// Operation indicates the desired operation to perform
610
23
type Operation uint
611
24
612
25
const (
613
26
	// OperationInstall indicates that a package needs installing
614
27
	OperationInstall Operation = iota
615
28
	// OperationRemove indicates that a package needs uninstalling
616
29
	OperationRemove
617
30
)
618
31
619
32
// Status indicates the status a package is in.
620
33
type Status string
621
34
622
35
const (
623
36
	// StatusInstalled indicates the package is in an installed state.
624
37
	StatusInstalled Status = "installed"
625
38
	// StatusUninstalled indicates the package is in an uninstalled state.
626
39
	StatusUninstalled Status = "uninstalled"
627
40
	// StatusInstalling indicates the package is in an installing state.
628
41
	StatusInstalling Status = "installing"
629
42
	// StatusUninstalling indicates the package is in an uninstalling state.
630
43
	StatusUninstalling Status = "uninstalling"
631
44
)
632
45
633
46
// WebProgress show progress on the terminal
634
47
type WebProgress struct {
635
48
	progress.Meter
636
49
	total               float64
637
50
	current             float64
638
51
	Status              Status
639
52
	statusMessage       string
640
53
	notificationMessage string
641
54
	Error               error
642
55
	ErrorChan           chan error
643
56
	operation           Operation
644
57
}
645
58
646
59
// NewWebProgress returns a new WebProgress type
647
60
func NewWebProgress(op Operation) *WebProgress {
648
61
	var status Status
649
62
	switch op {
650
63
	case OperationInstall:
651
64
		status = StatusInstalling
652
65
	case OperationRemove:
653
66
		status = StatusUninstalling
654
67
	default:
655
68
		panic("Not a valid Operation")
656
69
	}
657
70
658
71
	t := &WebProgress{
659
72
		ErrorChan: make(chan error),
660
73
		Status:    status,
661
74
		operation: op,
662
75
	}
663
76
664
77
	go func() {
665
78
		err := <-t.ErrorChan
666
79
667
80
		if err != nil {
668
81
			t.Status = StatusUninstalled
669
82
			t.Error = err
670
83
		} else {
671
84
			var status Status
672
85
			switch op {
673
86
			case OperationInstall:
674
87
				status = StatusInstalled
675
88
			case OperationRemove:
676
89
				status = StatusUninstalled
677
90
			default:
678
91
				panic("Not a valid Operation")
679
92
			}
680
93
			t.Status = status
681
94
		}
682
95
	}()
683
96
684
97
	return t
685
98
}
686
99
687
100
// Start starts showing progress
688
101
func (t *WebProgress) Start(pkgName string, total float64) {
689
102
	t.total = total
690
103
}
691
104
692
105
// Set sets the progress to the current value
693
106
func (t *WebProgress) Set(current float64) {
694
107
	t.current = current
695
108
}
696
109
697
110
// SetTotal set the total steps needed
698
111
func (t *WebProgress) SetTotal(total float64) {
699
112
	t.total = total
700
113
}
701
114
702
115
// Finished stops displaying the progress
703
116
func (t *WebProgress) Finished() {
704
117
}
705
118
706
119
// Done returns a boolean value indicating that the progress report
707
120
// has finished with no concerns if it was succesfull or not.
708
121
func (t *WebProgress) Done() bool {
709
122
	return t.Status == StatusInstalled || t.Status == StatusUninstalled
710
123
}
711
124
712
125
// Write is there so that progress can implement a Writer and can be
713
126
// used to display progress of io operations
714
127
//
715
128
// This is not needed for web progress.
716
129
func (t *WebProgress) Write(p []byte) (n int, err error) {
717
130
	t.current += float64(len(p))
718
131
	return len(p), nil
719
132
}
720
133
721
134
// Spin advances a spinner, i.e. can be used to show progress for operations
722
135
// that have a unknown duration
723
136
func (t *WebProgress) Spin(msg string) {
724
137
	t.statusMessage = msg
725
138
}
726
139
727
140
// Agreed asks the user whether they agree to the given license text
728
141
func (t *WebProgress) Agreed(intro, license string) bool {
729
142
	// TODO needs implementation
730
143
	return true
731
144
}
732
145
733
146
// Notify the user of miscelaneous events
734
147
func (t *WebProgress) Notify(msg string) {
735
148
	// TODO needs implementation producer/consumer
736
149
	t.notificationMessage = msg
737
150
}
738
151
739
152
// Progress returns the current progress
740
153
func (t *WebProgress) Progress() float64 {
741
154
	if t.total == 0 {
742
155
		return 0
743
156
	}
744
157
745
158
	return t.current * 100 / t.total
746
159
}
747
160
0
748
=== removed file 'webprogress/progress.go'
749
--- webprogress/progress.go	2015-05-06 14:41:13 +0000
750
+++ webprogress/progress.go	1970-01-01 00:00:00 +0000
751
@@ -1,72 +0,0 @@
752
1
/*
753
2
 * Copyright (C) 2014-2015 Canonical Ltd
754
3
 *
755
4
 * This program is free software: you can redistribute it and/or modify
756
5
 * it under the terms of the GNU General Public License version 3 as
757
6
 * published by the Free Software Foundation.
758
7
 *
759
8
 * This program is distributed in the hope that it will be useful,
760
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
761
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
762
11
 * GNU General Public License for more details.
763
12
 *
764
13
 * You should have received a copy of the GNU General Public License
765
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
766
15
 *
767
16
 */
768
17
769
18
package webprogress
770
19
771
20
import (
772
21
	"errors"
773
22
	"sync"
774
23
)
775
24
776
25
var (
777
26
	// ErrPackageInstallInProgress indicates that installation of the package is
778
27
	// already in progress.
779
28
	ErrPackageInstallInProgress = errors.New("package installion in progress")
780
29
)
781
30
782
31
// StatusTracker holds the state of all operations that require progress information.
783
32
type StatusTracker struct {
784
33
	status map[string]*WebProgress
785
34
	l      sync.Mutex
786
35
}
787
36
788
37
// New creates a new Status.
789
38
func New() *StatusTracker {
790
39
	return &StatusTracker{status: make(map[string]*WebProgress)}
791
40
}
792
41
793
42
// Add add pkg to the list of progresses to track, it is idempotent
794
43
func (i *StatusTracker) Add(pkg string, op Operation) (*WebProgress, error) {
795
44
	i.l.Lock()
796
45
	defer i.l.Unlock()
797
46
798
47
	if _, ok := i.status[pkg]; ok {
799
48
		return nil, ErrPackageInstallInProgress
800
49
	}
801
50
802
51
	i.status[pkg] = NewWebProgress(op)
803
52
804
53
	return i.status[pkg], nil
805
54
}
806
55
807
56
// Remove removes pkg to the list of progresses to track, it is a no op
808
57
// to remove multiple times.
809
58
func (i *StatusTracker) Remove(pkg string) {
810
59
	i.l.Lock()
811
60
	defer i.l.Unlock()
812
61
813
62
	delete(i.status, pkg)
814
63
}
815
64
816
65
// Get returns a *WebProgress corresponding to pkg or nil if not tracked.
817
66
func (i *StatusTracker) Get(pkg string) (*WebProgress, bool) {
818
67
	i.l.Lock()
819
68
	defer i.l.Unlock()
820
69
821
70
	w, ok := i.status[pkg]
822
71
	return w, ok
823
72
}
Status:	Merged
Approved by:	Federico Gimenez on 2016-04-22
Approved revision:	180
Merged at revision:	178
Proposed branch:	lp:~stevenwilkin/snapweb/add-remove-snaps-via-api
Merge into:	lp:~snappy-dev/snapweb/trunk
Diff against target:	823 lines (+302/-310) 10 files modified snappy/common_test.go (+8/-0) snappy/converge.go (+23/-56) snappy/converge_test.go (+11/-11) snappy/handlers.go (+3/-10) snappy/handlers_test.go (+0/-2) snappy/snapd_client.go (+2/-0) statustracker/statustracker.go (+134/-0) statustracker/statustracker_test.go (+121/-0) webprogress/meter.go (+0/-159) webprogress/progress.go (+0/-72)
To merge this branch:	bzr merge lp:~stevenwilkin/snapweb/add-remove-snaps-via-api
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Martin Albisetti (community)		2016-03-08	Approve on 2016-04-20
Review via email: mp+288437@code.launchpad.net