-
Notifications
You must be signed in to change notification settings - Fork 18
/
method.go
374 lines (316 loc) · 9.08 KB
/
method.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
373
374
package ociartifact
import (
"fmt"
"io"
"strings"
"sync"
. "github.com/mandelsoft/goutils/finalizer"
"github.com/mandelsoft/goutils/errors"
"github.com/mandelsoft/goutils/general"
"github.com/opencontainers/go-digest"
"github.com/open-component-model/ocm/pkg/blobaccess"
"github.com/open-component-model/ocm/pkg/contexts/credentials"
ociidentity "github.com/open-component-model/ocm/pkg/contexts/credentials/builtin/oci/identity"
"github.com/open-component-model/ocm/pkg/contexts/oci"
"github.com/open-component-model/ocm/pkg/contexts/oci/artdesc"
"github.com/open-component-model/ocm/pkg/contexts/oci/grammar"
"github.com/open-component-model/ocm/pkg/contexts/oci/repositories/artifactset"
"github.com/open-component-model/ocm/pkg/contexts/oci/repositories/ocireg"
ocmcpi "github.com/open-component-model/ocm/pkg/contexts/ocm/cpi"
"github.com/open-component-model/ocm/pkg/contexts/ocm/cpi/accspeccpi"
"github.com/open-component-model/ocm/pkg/logging"
"github.com/open-component-model/ocm/pkg/runtime"
)
// Type is the access type of a oci registry.
const (
Type = "ociArtifact"
TypeV1 = Type + runtime.VersionSeparator + "v1"
)
const (
LegacyType = "ociRegistry"
LegacyTypeV1 = LegacyType + runtime.VersionSeparator + "v1"
)
func init() {
accspeccpi.RegisterAccessType(accspeccpi.NewAccessSpecType[*AccessSpec](Type, accspeccpi.WithDescription(usage)))
accspeccpi.RegisterAccessType(accspeccpi.NewAccessSpecType[*AccessSpec](TypeV1, accspeccpi.WithFormatSpec(formatV1), accspeccpi.WithConfigHandler(ConfigHandler())))
accspeccpi.RegisterAccessType(accspeccpi.NewAccessSpecType[*AccessSpec](LegacyType))
accspeccpi.RegisterAccessType(accspeccpi.NewAccessSpecType[*AccessSpec](LegacyTypeV1))
}
func Is(spec accspeccpi.AccessSpec) bool {
return spec != nil && (spec.GetKind() == Type || spec.GetKind() == LegacyType)
}
// AccessSpec describes the access for a oci registry.
type AccessSpec struct {
runtime.ObjectVersionedType `json:",inline"`
// ImageReference is the actual reference to the oci image repository and tag.
ImageReference string `json:"imageReference"`
}
var (
_ accspeccpi.AccessSpec = (*AccessSpec)(nil)
_ accspeccpi.HintProvider = (*AccessSpec)(nil)
_ blobaccess.DigestSource = (*AccessSpec)(nil)
)
// New creates a new oci registry access spec version v1.
func New(ref string) *AccessSpec {
return &AccessSpec{
ObjectVersionedType: runtime.NewVersionedTypedObject(Type),
ImageReference: ref,
}
}
func (a *AccessSpec) Describe(ctx accspeccpi.Context) string {
return fmt.Sprintf("OCI artifact %s", a.ImageReference)
}
func (_ *AccessSpec) IsLocal(accspeccpi.Context) bool {
return false
}
func (a *AccessSpec) Digest() digest.Digest {
ref, err := oci.ParseRef(a.ImageReference)
if err != nil || ref.Digest == nil {
return ""
}
return *ref.Digest
}
func (a *AccessSpec) GlobalAccessSpec(ctx accspeccpi.Context) accspeccpi.AccessSpec {
return a
}
func (a *AccessSpec) GetReferenceHint(cv accspeccpi.ComponentVersionAccess) string {
ref, err := oci.ParseRef(a.ImageReference)
if err != nil {
return ""
}
hint := ref.Repository
r := cv.Repository()
if r != nil {
prefix := ocmcpi.RepositoryPrefix(cv.Repository().GetSpecification())
if strings.HasPrefix(hint, prefix+grammar.RepositorySeparator) {
// try to keep hint identical, even across intermediate
// artifact globalizations
hint = hint[len(prefix)+1:]
}
}
if ref.Tag != nil {
hint += grammar.TagSeparator + *ref.Tag
}
return hint
}
func (a *AccessSpec) GetOCIReference(cv accspeccpi.ComponentVersionAccess) (string, error) {
return a.ImageReference, nil
}
func (_ *AccessSpec) GetType() string {
return Type
}
func (a *AccessSpec) AccessMethod(c accspeccpi.ComponentVersionAccess) (accspeccpi.AccessMethod, error) {
return NewMethod(c.GetContext(), a, a.ImageReference)
}
func (a *AccessSpec) GetInexpensiveContentVersionIdentity(cv accspeccpi.ComponentVersionAccess) string {
ref, err := oci.ParseRef(a.ImageReference)
if err != nil {
return ""
}
if ref.Digest != nil {
return ref.Digest.String()
}
// TODO: optimize for oci registries
return ""
}
////////////////////////////////////////////////////////////////////////////////
type AccessMethodImpl = *accessMethod
type accessMethod struct {
lock sync.Mutex
ctx accspeccpi.Context
spec accspeccpi.AccessSpec
reference string
finalizer Finalizer
err error
id credentials.ConsumerIdentity
ref *oci.RefSpec
mime string
digest digest.Digest
art oci.ArtifactAccess
repo oci.Repository
blob artifactset.ArtifactBlob
}
var (
_ accspeccpi.AccessMethodImpl = (*accessMethod)(nil)
_ blobaccess.DigestSource = (*accessMethod)(nil)
_ accspeccpi.DigestSource = (*accessMethod)(nil)
_ credentials.ConsumerIdentityProvider = (*accessMethod)(nil)
)
func NewMethod(ctx accspeccpi.ContextProvider, a accspeccpi.AccessSpec, ref string, repo ...oci.Repository) (accspeccpi.AccessMethod, error) {
m := &accessMethod{
spec: a,
reference: ref,
ctx: ctx.OCMContext(),
}
return accspeccpi.AccessMethodForImplementation(m, m.eval(general.Optional(repo...)))
}
func (_ *accessMethod) IsLocal() bool {
return false
}
func (m *accessMethod) GetOCIReference(cv accspeccpi.ComponentVersionAccess) (string, error) {
return m.reference, nil
}
func (m *accessMethod) GetKind() string {
return m.spec.GetKind()
}
func (m *accessMethod) AccessSpec() accspeccpi.AccessSpec {
return m.spec
}
func (m *accessMethod) Cache() {
m.lock.Lock()
ref := m.ref
m.lock.Unlock()
if ref == nil {
return
}
logger := Logger(WrapContextProvider(m.ctx))
logger.Info("cache artifact blob", "ref", m.reference)
_, m.err = m.getBlob()
m.finalizer.Finalize()
}
func (m *accessMethod) Close() error {
m.lock.Lock()
defer m.lock.Unlock()
list := errors.ErrorList{}
if m.blob != nil {
list.Add(m.blob.Close())
}
m.blob = nil
m.art = nil
m.ref = nil
list.Add(m.finalizer.Finalize())
return list.Result()
}
func (m *accessMethod) eval(relto oci.Repository) error {
var (
err error
ref oci.RefSpec
)
if relto == nil {
ref, err = oci.ParseRef(m.reference)
if err != nil {
return err
}
ocictx := m.ctx.OCIContext()
spec := ocictx.GetAlias(ref.Host)
if spec == nil {
spec = ocireg.NewRepositorySpec(ref.Host)
}
repo, err := ocictx.RepositoryForSpec(spec)
if err != nil {
return err
}
m.finalizer.Close(repo, "repository for accessing %s", m.reference)
m.repo = repo
} else {
repo, err := relto.Dup()
if err != nil {
return err
}
m.finalizer.Close(repo)
art, err := oci.ParseArt(m.reference)
if err != nil {
return err
}
ref = oci.RefSpec{
UniformRepositorySpec: *repo.GetSpecification().UniformRepositorySpec(),
ArtSpec: art,
}
m.repo = repo
}
m.ref = &ref
m.id = credentials.GetProvidedConsumerId(m.repo, credentials.StringUsageContext(ref.Repository))
return nil
}
func (m *accessMethod) GetArtifact() (oci.ArtifactAccess, *oci.RefSpec, error) {
m.lock.Lock()
defer m.lock.Unlock()
err := m.getArtifact()
if err != nil {
return nil, nil, m.err
}
art := m.art
if art != nil {
art, err = art.Dup()
if err != nil {
return nil, nil, err
}
}
return art, m.ref, err
}
func (m *accessMethod) getArtifact() error {
if m.art == nil && m.err == nil && m.ref != nil {
art, err := m.repo.LookupArtifact(m.ref.Repository, m.ref.Version())
m.finalizer.Close(art, "artifact for accessing %s", m.reference)
m.art, m.err = art, err
if art != nil {
m.mime = artdesc.ToContentMediaType(m.art.GetDescriptor().MimeType()) + artifactset.SynthesizedBlobFormat
m.digest = art.Digest()
}
}
return m.err
}
func (m *accessMethod) GetConsumerId(uctx ...credentials.UsageContext) credentials.ConsumerIdentity {
m.lock.Lock()
defer m.lock.Unlock()
return m.id
}
func (m *accessMethod) GetIdentityMatcher() string {
return ociidentity.CONSUMER_TYPE
}
func (m *accessMethod) Digest() digest.Digest {
d, _ := m.GetDigest()
return d
}
func (m *accessMethod) GetDigest() (digest.Digest, error) {
m.lock.Lock()
defer m.lock.Unlock()
err := m.getArtifact()
return m.digest, err
}
func (m *accessMethod) Get() ([]byte, error) {
blob, err := m.getBlob()
if err != nil {
return nil, err
}
return blob.Get()
}
func (m *accessMethod) Reader() (io.ReadCloser, error) {
b, err := m.getBlob()
if err != nil {
return nil, err
}
r, err := b.Reader()
if err != nil {
return nil, err
}
return r, nil
}
func (m *accessMethod) MimeType() string {
if m.mime == "" {
m.lock.Lock()
defer m.lock.Unlock()
m.getArtifact()
}
return m.mime
}
func (m *accessMethod) getBlob() (artifactset.ArtifactBlob, error) {
m.lock.Lock()
defer m.lock.Unlock()
if m.blob != nil || m.err != nil {
return m.blob, m.err
}
err := m.getArtifact()
if err != nil {
return nil, err
}
logger := Logger(WrapContextProvider(m.ctx))
logger.Info("synthesize artifact blob", "ref", m.reference)
m.blob, err = artifactset.SynthesizeArtifactBlobForArtifact(m.art, m.ref.Version())
logger.Info("synthesize artifact blob done", "ref", m.reference, "error", logging.ErrorMessage(err))
if err != nil {
m.err = err
return nil, err
}
return m.blob, nil
}