-
Notifications
You must be signed in to change notification settings - Fork 37
/
resources.go
372 lines (350 loc) · 12.1 KB
/
resources.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
// Copyright 2016 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package charmstore // import "gopkg.in/juju/charmstore.v5/internal/charmstore"
import (
"fmt"
"io"
"sort"
"time"
"gopkg.in/errgo.v1"
"gopkg.in/juju/charm.v6"
"gopkg.in/juju/charm.v6/resource"
"gopkg.in/juju/charmrepo.v3/csclient/params"
"gopkg.in/mgo.v2"
"gopkg.in/mgo.v2/bson"
"gopkg.in/juju/charmstore.v5/internal/mongodoc"
"gopkg.in/juju/charmstore.v5/internal/router"
)
// newResourceQuery returns a mongo query doc that will retrieve the
// given named resource and revision associated with the given charm URL.
// If revision is < 0, all revisions of the resource will be selected by
// the query.
func newResourceQuery(url *charm.URL, name string, revision int) bson.D {
query := make(bson.D, 2, 3)
query[0] = bson.DocElem{"baseurl", mongodoc.BaseURL(url)}
query[1] = bson.DocElem{"name", name}
if revision >= 0 {
query = append(query, bson.DocElem{"revision", revision})
}
return query
}
// sortResources sorts the provided resource docs, The resources are
// sorted first by URL then by name and finally by revision.
func sortResources(resources []*mongodoc.Resource) {
sort.Sort(resourcesByName(resources))
}
type resourcesByName []*mongodoc.Resource
func (sorted resourcesByName) Len() int { return len(sorted) }
func (sorted resourcesByName) Swap(i, j int) { sorted[i], sorted[j] = sorted[j], sorted[i] }
func (sorted resourcesByName) Less(i, j int) bool {
r0, r1 := sorted[i], sorted[j]
if *r0.BaseURL != *r1.BaseURL {
return r0.BaseURL.String() < r1.BaseURL.String()
}
if r0.Name != r1.Name {
return r0.Name < r1.Name
}
return r0.Revision < r1.Revision
}
// ListResources returns the set of resources for the entity with the
// given id. If the unpublished channel is specified then set is
// composed of the latest revision for each resource. Otherwise it holds
// the revisions declared when the charm/channel pair was published.
func (s *Store) ListResources(id *router.ResolvedURL, channel params.Channel) ([]*mongodoc.Resource, error) {
if channel == params.NoChannel {
return nil, errgo.Newf("no channel specified")
}
if id.URL.Series == "bundle" {
return nil, nil
}
entity, err := s.FindEntity(id, FieldSelector("charmmeta", "baseurl"))
if err != nil {
return nil, errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
if entity.CharmMeta == nil {
return nil, errgo.Newf("entity missing charm metadata")
}
baseEntity, err := s.FindBaseEntity(entity.URL, FieldSelector("channelresources"))
if err != nil {
return nil, errgo.Mask(err)
}
// get all of the resources associated with the charm first.
resources, revisions, err := s.charmResources(entity.BaseURL)
if err != nil {
return nil, errgo.Mask(err)
}
if channel != params.UnpublishedChannel {
revisions = mapRevisions(baseEntity.ChannelResources[channel])
}
var docs []*mongodoc.Resource
for name := range entity.CharmMeta.Resources {
revision, ok := revisions[name]
var doc *mongodoc.Resource
if !ok {
// Create a placeholder for the missing resource.
doc = &mongodoc.Resource{
BaseURL: baseEntity.URL,
Name: name,
Revision: -1,
}
} else if doc = resources[name][revision]; doc == nil {
return nil, errgo.Newf("published resource %q not found", fmt.Sprintf("%s/%d", name, revision))
}
docs = append(docs, doc)
}
sortResources(docs)
return docs, nil
}
// charmResources returns all of the currently stored resources for a charm.
func (s *Store) charmResources(baseURL *charm.URL) (map[string]map[int]*mongodoc.Resource, map[string]int, error) {
resources := make(map[string]map[int]*mongodoc.Resource)
latest := make(map[string]int)
iter := s.DB.Resources().Find(bson.D{{"baseurl", baseURL}}).Iter()
var r mongodoc.Resource
for iter.Next(&r) {
resource := r
if _, ok := resources[r.Name]; !ok {
resources[r.Name] = make(map[int]*mongodoc.Resource)
}
resources[r.Name][r.Revision] = &resource
if r.Revision >= latest[r.Name] {
latest[r.Name] = r.Revision
}
}
if err := iter.Close(); err != nil {
return nil, nil, errgo.Mask(err)
}
return resources, latest, nil
}
// mapRevisions converts a list of ResourceRevisions into a map of
// resource name and revision.
func mapRevisions(resourceRevisions []mongodoc.ResourceRevision) map[string]int {
revisions := make(map[string]int)
for _, rr := range resourceRevisions {
revisions[rr.Name] = rr.Revision
}
return revisions
}
// UploadResource add blob to the blob store and adds a new resource with
// the given name to the entity with the given id. If revision is -1, the revision of the new resource
// will be calculated to be one higher than any existing resources.
//
// TODO consider restricting uploads so that if the hash matches the
// latest revision then a new revision isn't created. This would match
// the behaviour for charms and bundles.
func (s *Store) UploadResource(id *router.ResolvedURL, name string, revision int, blob io.Reader, blobHash string, size int64) (*mongodoc.Resource, error) {
entity, err := s.FindEntity(id, FieldSelector("charmmeta", "baseurl"))
if err != nil {
return nil, errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
if !charmHasResource(entity.CharmMeta, name) {
return nil, errgo.Newf("charm does not have resource %q", name)
}
if _, err := s.putArchive(blob, size, blobHash); err != nil {
return nil, errgo.Mask(err)
}
res, err := s.addResource(&mongodoc.Resource{
BaseURL: entity.BaseURL,
Name: name,
Revision: revision,
BlobHash: blobHash,
Size: size,
UploadTime: time.Now().UTC(),
}, "")
if err != nil {
return nil, errgo.Mask(err)
}
return res, nil
}
// AddResourceWithUploadId is like UploadResource except that it associates
// the resource with an already-uploaded multipart upload.
func (s *Store) AddResourceWithUploadId(id *router.ResolvedURL, name string, revision int, uploadId string) (*mongodoc.Resource, error) {
entity, err := s.FindEntity(id, FieldSelector("charmmeta", "baseurl"))
if err != nil {
return nil, errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
if !charmHasResource(entity.CharmMeta, name) {
return nil, errgo.Newf("charm does not have resource %q", name)
}
info, err := s.BlobStore.UploadInfo(uploadId)
if err != nil {
return nil, errgo.Mask(err)
}
var size int64
for _, p := range info.Parts {
size += p.Size
}
idx, ok := info.Index()
if !ok {
return nil, errgo.Newf("upload not completed yet")
}
res, err := s.addResource(&mongodoc.Resource{
BaseURL: entity.BaseURL,
Name: name,
Revision: revision,
BlobHash: info.Hash,
BlobIndex: idx,
Size: size,
UploadTime: time.Now().UTC(),
}, uploadId)
if err != nil {
return nil, errgo.Mask(err, errgo.Is(params.ErrDuplicateUpload))
}
return res, nil
}
// AddDockerResource adds a docker resource to the Kubernetes charm with
// the given id. The image name should be non-empty only if the image is
// held outside the charm store's associated registry. The digest holds
// the hash of the image, in "sha256:abcdabcd" format.
//
// If revision is -1 the revision of the new resource will be calculated
// to be one higher than any existing resources.
func (s *Store) AddDockerResource(id *router.ResolvedURL, resourceName string, revision int, imageName, digest string) (*mongodoc.Resource, error) {
entity, err := s.FindEntity(id, FieldSelector("charmmeta", "baseurl"))
if err != nil {
return nil, errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
if !IsKubernetesCharm(entity.CharmMeta) {
return nil, errgo.Newf("entity is not a kubernetes charm")
}
if !charmHasDockerResource(entity.CharmMeta, resourceName) {
return nil, errgo.Newf("%q does not have image resource %q", id, resourceName)
}
res, err := s.addResource(&mongodoc.Resource{
BaseURL: entity.BaseURL,
Name: resourceName,
Revision: revision,
UploadTime: time.Now().UTC(),
DockerImageName: imageName,
DockerImageDigest: digest,
}, "")
if err != nil {
return nil, errgo.Mask(err)
}
return res, nil
}
// addResource adds r to the resources collection. If r does not specify
// a revision number will be one higher than any existing revisions. The
// inserted resource is returned on success.
func (s *Store) addResource(r *mongodoc.Resource, uploadId string) (*mongodoc.Resource, error) {
if r.Revision < 0 {
r1 := *r
rev, err := s.nextResourceRevision(r.BaseURL, r.Name)
if err != nil {
return nil, errgo.Mask(err)
}
r1.Revision = rev
r = &r1
}
if err := r.Validate(); err != nil {
return nil, errgo.Mask(err)
}
if uploadId != "" {
// See Store.isUploadOwnedBy for the consumer of this format.
err := s.BlobStore.SetOwner(uploadId, resourceUploadOwner(r), time.Now().Add(10*time.Minute))
if err != nil {
return nil, errgo.Notef(err, "cannot set owner of upload")
}
}
err := s.DB.Resources().Insert(r)
if uploadId != "" {
if removeErr := s.BlobStore.RemoveUpload(uploadId); removeErr != nil {
// We can't remove the upload document, but we've
// still succeeded in doing what the user asked,
// so just log the error.
logger.Errorf("cannot remove upload for %v: %v", r.BaseURL, removeErr)
}
}
if err == nil {
return r, nil
}
if mgo.IsDup(err) {
return nil, errgo.WithCausef(nil, params.ErrDuplicateUpload, "")
}
return nil, errgo.Notef(err, "cannot insert resource")
}
// nextRevisionNumber calculates the next revision number to use for a
// resource.
func (s *Store) nextResourceRevision(baseURL *charm.URL, name string) (int, error) {
var r mongodoc.Resource
if err := s.DB.Resources().Find(newResourceQuery(baseURL, name, -1)).Sort("-revision").One(&r); err != nil {
if err == mgo.ErrNotFound {
return 0, nil
}
return -1, err
}
return r.Revision + 1, nil
}
// ResolveResource finds the resource specified. If a matching resource
// cannot be found an error with the cause params.ErrNotFound will be
// returned.
// If revision is negative, the most recently published revision
// for the given channel will be returned.
func (s *Store) ResolveResource(url *router.ResolvedURL, name string, revision int, channel params.Channel) (*mongodoc.Resource, error) {
if channel == params.NoChannel {
channel = params.StableChannel
}
if revision < 0 && channel != params.UnpublishedChannel {
baseEntity, err := s.FindBaseEntity(&url.URL, FieldSelector("channelresources"))
if err != nil {
return nil, errgo.Mask(err)
}
var ok bool
revision, ok = mapRevisions(baseEntity.ChannelResources[channel])[name]
if !ok {
return nil, errgo.WithCausef(nil, params.ErrNotFound, "%s has no %q resource on %s channel", url, name, channel)
}
}
q := newResourceQuery(mongodoc.BaseURL(&url.URL), name, revision)
var r mongodoc.Resource
if err := s.DB.Resources().Find(q).Sort("-revision").One(&r); err != nil {
if err == mgo.ErrNotFound {
suffix := ""
if revision >= 0 {
suffix = fmt.Sprintf("/%d", revision)
}
return nil, errgo.WithCausef(nil, params.ErrNotFound, "%s has no %q resource", url, name+suffix)
}
return nil, errgo.Mask(err)
}
return &r, nil
}
func IsKubernetesCharm(meta *charm.Meta) bool {
return meta != nil && len(meta.Series) == 1 && meta.Series[0] == "kubernetes"
}
func charmHasResource(meta *charm.Meta, name string) bool {
if meta == nil {
return false
}
_, ok := meta.Resources[name]
return ok
}
func charmHasDockerResource(meta *charm.Meta, name string) bool {
if meta == nil {
return false
}
r, ok := meta.Resources[name]
return ok && r.Type == resource.TypeContainerImage
}
// OpenResourceBlob returns the blob associated with the given resource.
func (s *Store) OpenResourceBlob(res *mongodoc.Resource) (*Blob, error) {
r, size, err := s.BlobStore.Open(res.BlobHash, res.BlobIndex)
if err != nil {
return nil, errgo.Notef(err, "cannot open archive data for %s resource %q", res.BaseURL, fmt.Sprintf("%s/%d", res.Name, res.Revision))
}
return &Blob{
ReadSeekCloser: r,
Size: size,
Hash: res.BlobHash,
}, nil
}
// resourceUploadOwner returns the owner string for
// uploads that will be associated with the given
// resource.
func resourceUploadOwner(r *mongodoc.Resource) string {
return fmt.Sprintf("resource %s %s %d",
r.BaseURL.String(),
r.Name,
r.Revision,
)
}