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 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
|
package gha
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"os"
"sync"
"time"
"github.com/containerd/containerd/content"
"github.com/containerd/containerd/labels"
"github.com/moby/buildkit/cache/remotecache"
v1 "github.com/moby/buildkit/cache/remotecache/v1"
"github.com/moby/buildkit/session"
"github.com/moby/buildkit/solver"
"github.com/moby/buildkit/util/bklog"
"github.com/moby/buildkit/util/compression"
"github.com/moby/buildkit/util/progress"
"github.com/moby/buildkit/util/tracing"
"github.com/moby/buildkit/worker"
digest "github.com/opencontainers/go-digest"
ocispecs "github.com/opencontainers/image-spec/specs-go/v1"
"github.com/pkg/errors"
actionscache "github.com/tonistiigi/go-actions-cache"
"golang.org/x/sync/errgroup"
)
func init() {
actionscache.Log = bklog.L.Debugf
}
const (
attrScope = "scope"
attrTimeout = "timeout"
attrToken = "token"
attrURL = "url"
version = "1"
defaultTimeout = 10 * time.Minute
)
type Config struct {
Scope string
URL string
Token string
Timeout time.Duration
}
func getConfig(attrs map[string]string) (*Config, error) {
scope, ok := attrs[attrScope]
if !ok {
scope = "buildkit"
}
url, ok := attrs[attrURL]
if !ok {
return nil, errors.Errorf("url not set for github actions cache")
}
token, ok := attrs[attrToken]
if !ok {
return nil, errors.Errorf("token not set for github actions cache")
}
timeout := defaultTimeout
if v, ok := attrs[attrTimeout]; ok {
var err error
timeout, err = time.ParseDuration(v)
if err != nil {
return nil, errors.Wrap(err, "failed to parse timeout for github actions cache")
}
}
return &Config{
Scope: scope,
URL: url,
Token: token,
Timeout: timeout,
}, nil
}
// ResolveCacheExporterFunc for Github actions cache exporter.
func ResolveCacheExporterFunc() remotecache.ResolveCacheExporterFunc {
return func(ctx context.Context, g session.Group, attrs map[string]string) (remotecache.Exporter, error) {
cfg, err := getConfig(attrs)
if err != nil {
return nil, err
}
return NewExporter(cfg)
}
}
type exporter struct {
solver.CacheExporterTarget
chains *v1.CacheChains
cache *actionscache.Cache
config *Config
}
func NewExporter(c *Config) (remotecache.Exporter, error) {
cc := v1.NewCacheChains()
cache, err := actionscache.New(c.Token, c.URL, actionscache.Opt{
Client: tracing.DefaultClient,
Timeout: c.Timeout,
})
if err != nil {
return nil, err
}
return &exporter{CacheExporterTarget: cc, chains: cc, cache: cache, config: c}, nil
}
func (*exporter) Name() string {
return "exporting to GitHub Actions Cache"
}
func (ce *exporter) Config() remotecache.Config {
return remotecache.Config{
Compression: compression.New(compression.Default),
}
}
func (ce *exporter) blobKey(dgst digest.Digest) string {
return "buildkit-blob-" + version + "-" + dgst.String()
}
func (ce *exporter) indexKey() string {
scope := ""
for _, s := range ce.cache.Scopes() {
if s.Permission&actionscache.PermissionWrite != 0 {
scope = s.Scope
}
}
scope = digest.FromBytes([]byte(scope)).Hex()[:8]
return "index-" + ce.config.Scope + "-" + version + "-" + scope
}
func (ce *exporter) Finalize(ctx context.Context) (map[string]string, error) {
// res := make(map[string]string)
config, descs, err := ce.chains.Marshal(ctx)
if err != nil {
return nil, err
}
// TODO: push parallel
for i, l := range config.Layers {
dgstPair, ok := descs[l.Blob]
if !ok {
return nil, errors.Errorf("missing blob %s", l.Blob)
}
if dgstPair.Descriptor.Annotations == nil {
return nil, errors.Errorf("invalid descriptor without annotations")
}
var diffID digest.Digest
v, ok := dgstPair.Descriptor.Annotations[labels.LabelUncompressed]
if !ok {
return nil, errors.Errorf("invalid descriptor without uncompressed annotation")
}
dgst, err := digest.Parse(v)
if err != nil {
return nil, errors.Wrapf(err, "failed to parse uncompressed annotation")
}
diffID = dgst
key := ce.blobKey(dgstPair.Descriptor.Digest)
b, err := ce.cache.Load(ctx, key)
if err != nil {
return nil, err
}
if b == nil {
layerDone := progress.OneOff(ctx, fmt.Sprintf("writing layer %s", l.Blob))
ra, err := dgstPair.Provider.ReaderAt(ctx, dgstPair.Descriptor)
if err != nil {
return nil, layerDone(err)
}
if err := ce.cache.Save(ctx, key, ra); err != nil {
if !errors.Is(err, os.ErrExist) {
return nil, layerDone(errors.Wrap(err, "error writing layer blob"))
}
}
layerDone(nil)
}
la := &v1.LayerAnnotations{
DiffID: diffID,
Size: dgstPair.Descriptor.Size,
MediaType: dgstPair.Descriptor.MediaType,
}
if v, ok := dgstPair.Descriptor.Annotations["buildkit/createdat"]; ok {
var t time.Time
if err := (&t).UnmarshalText([]byte(v)); err != nil {
return nil, err
}
la.CreatedAt = t.UTC()
}
config.Layers[i].Annotations = la
}
dt, err := json.Marshal(config)
if err != nil {
return nil, err
}
if err := ce.cache.SaveMutable(ctx, ce.indexKey(), 15*time.Second, func(old *actionscache.Entry) (actionscache.Blob, error) {
return actionscache.NewBlob(dt), nil
}); err != nil {
return nil, err
}
return nil, nil
}
// ResolveCacheImporterFunc for Github actions cache importer.
func ResolveCacheImporterFunc() remotecache.ResolveCacheImporterFunc {
return func(ctx context.Context, g session.Group, attrs map[string]string) (remotecache.Importer, ocispecs.Descriptor, error) {
cfg, err := getConfig(attrs)
if err != nil {
return nil, ocispecs.Descriptor{}, err
}
i, err := NewImporter(cfg)
if err != nil {
return nil, ocispecs.Descriptor{}, err
}
return i, ocispecs.Descriptor{}, nil
}
}
type importer struct {
cache *actionscache.Cache
config *Config
}
func NewImporter(c *Config) (remotecache.Importer, error) {
cache, err := actionscache.New(c.Token, c.URL, actionscache.Opt{
Client: tracing.DefaultClient,
Timeout: c.Timeout,
})
if err != nil {
return nil, err
}
return &importer{cache: cache, config: c}, nil
}
func (ci *importer) makeDescriptorProviderPair(l v1.CacheLayer) (*v1.DescriptorProviderPair, error) {
if l.Annotations == nil {
return nil, errors.Errorf("cache layer with missing annotations")
}
annotations := map[string]string{}
if l.Annotations.DiffID == "" {
return nil, errors.Errorf("cache layer with missing diffid")
}
annotations[labels.LabelUncompressed] = l.Annotations.DiffID.String()
if !l.Annotations.CreatedAt.IsZero() {
txt, err := l.Annotations.CreatedAt.MarshalText()
if err != nil {
return nil, err
}
annotations["buildkit/createdat"] = string(txt)
}
desc := ocispecs.Descriptor{
MediaType: l.Annotations.MediaType,
Digest: l.Blob,
Size: l.Annotations.Size,
Annotations: annotations,
}
return &v1.DescriptorProviderPair{
Descriptor: desc,
Provider: &ciProvider{desc: desc, ci: ci},
}, nil
}
func (ci *importer) loadScope(ctx context.Context, scope string) (*v1.CacheChains, error) {
scope = digest.FromBytes([]byte(scope)).Hex()[:8]
key := "index-" + ci.config.Scope + "-" + version + "-" + scope
entry, err := ci.cache.Load(ctx, key)
if err != nil {
return nil, err
}
if entry == nil {
return v1.NewCacheChains(), nil
}
// TODO: this buffer can be removed
buf := &bytes.Buffer{}
if err := entry.WriteTo(ctx, buf); err != nil {
return nil, err
}
var config v1.CacheConfig
if err := json.Unmarshal(buf.Bytes(), &config); err != nil {
return nil, errors.WithStack(err)
}
allLayers := v1.DescriptorProvider{}
for _, l := range config.Layers {
dpp, err := ci.makeDescriptorProviderPair(l)
if err != nil {
return nil, err
}
allLayers[l.Blob] = *dpp
}
cc := v1.NewCacheChains()
if err := v1.ParseConfig(config, allLayers, cc); err != nil {
return nil, err
}
return cc, nil
}
func (ci *importer) Resolve(ctx context.Context, _ ocispecs.Descriptor, id string, w worker.Worker) (solver.CacheManager, error) {
eg, ctx := errgroup.WithContext(ctx)
ccs := make([]*v1.CacheChains, len(ci.cache.Scopes()))
for i, s := range ci.cache.Scopes() {
func(i int, scope string) {
eg.Go(func() error {
cc, err := ci.loadScope(ctx, scope)
if err != nil {
return err
}
ccs[i] = cc
return nil
})
}(i, s.Scope)
}
if err := eg.Wait(); err != nil {
return nil, err
}
cms := make([]solver.CacheManager, 0, len(ccs))
for _, cc := range ccs {
keysStorage, resultStorage, err := v1.NewCacheKeyStorage(cc, w)
if err != nil {
return nil, err
}
cms = append(cms, solver.NewCacheManager(ctx, id, keysStorage, resultStorage))
}
return solver.NewCombinedCacheManager(cms, nil), nil
}
type ciProvider struct {
ci *importer
desc ocispecs.Descriptor
mu sync.Mutex
entries map[digest.Digest]*actionscache.Entry
}
func (p *ciProvider) CheckDescriptor(ctx context.Context, desc ocispecs.Descriptor) error {
if desc.Digest != p.desc.Digest {
return nil
}
_, err := p.loadEntry(ctx, desc)
return err
}
func (p *ciProvider) loadEntry(ctx context.Context, desc ocispecs.Descriptor) (*actionscache.Entry, error) {
p.mu.Lock()
defer p.mu.Unlock()
if ce, ok := p.entries[desc.Digest]; ok {
return ce, nil
}
key := "buildkit-blob-" + version + "-" + desc.Digest.String()
ce, err := p.ci.cache.Load(ctx, key)
if err != nil {
return nil, err
}
if ce == nil {
return nil, errors.Errorf("blob %s not found", desc.Digest)
}
if p.entries == nil {
p.entries = make(map[digest.Digest]*actionscache.Entry)
}
p.entries[desc.Digest] = ce
return ce, nil
}
func (p *ciProvider) ReaderAt(ctx context.Context, desc ocispecs.Descriptor) (content.ReaderAt, error) {
ce, err := p.loadEntry(ctx, desc)
if err != nil {
return nil, err
}
rac := ce.Download(context.TODO())
return &readerAt{ReaderAtCloser: rac, desc: desc}, nil
}
type readerAt struct {
actionscache.ReaderAtCloser
desc ocispecs.Descriptor
}
func (r *readerAt) ReadAt(p []byte, off int64) (int, error) {
if off >= r.desc.Size {
return 0, io.EOF
}
return r.ReaderAtCloser.ReadAt(p, off)
}
func (r *readerAt) Size() int64 {
return r.desc.Size
}
|