Merge pull request #780 from tonistiigi/deterministic-cache

Make exported build cache deterministic
docker-19.03
Akihiro Suda 2019-01-19 12:45:50 +09:00 committed by GitHub
commit 9c638c446a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 63 additions and 34 deletions

View File

@ -2,6 +2,7 @@ package cacheimport
import (
"context"
"time"
"github.com/moby/buildkit/identity"
"github.com/moby/buildkit/solver"
@ -191,7 +192,7 @@ type cacheResultStorage struct {
byResult map[string]map[string]struct{}
}
func (cs *cacheResultStorage) Save(res solver.Result) (solver.CacheResult, error) {
func (cs *cacheResultStorage) Save(res solver.Result, createdAt time.Time) (solver.CacheResult, error) {
return solver.CacheResult{}, errors.Errorf("importer is immutable")
}

View File

@ -1,6 +1,7 @@
package cacheimport
import (
"strings"
"time"
"github.com/containerd/containerd/content"
@ -19,6 +20,9 @@ type CacheChains struct {
}
func (c *CacheChains) Add(dgst digest.Digest) solver.CacheExporterRecord {
if strings.HasPrefix(dgst.String(), "random:") {
return &nopRecord{}
}
it := &item{c: c, dgst: dgst}
c.items = append(c.items, it)
return it
@ -124,4 +128,13 @@ func (c *item) LinkFrom(rec solver.CacheExporterRecord, index int, selector stri
c.links[index][link{src: src, selector: selector}] = struct{}{}
}
type nopRecord struct {
}
func (c *nopRecord) AddResult(createdAt time.Time, result *solver.Remote) {
}
func (c *nopRecord) LinkFrom(rec solver.CacheExporterRecord, index int, selector string) {
}
var _ solver.CacheExporterTarget = &CacheChains{}

View File

@ -3,6 +3,7 @@ package solver
import (
"context"
"testing"
"time"
"github.com/moby/buildkit/identity"
digest "github.com/opencontainers/go-digest"
@ -41,7 +42,7 @@ func TestInMemoryCache(t *testing.T) {
m := NewInMemoryCacheManager()
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), testResult("result0"))
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), testResult("result0"), time.Now())
require.NoError(t, err)
keys, err := m.Query(nil, 0, dgst("foo"), 0)
@ -57,7 +58,7 @@ func TestInMemoryCache(t *testing.T) {
require.Equal(t, "result0", unwrap(res))
// another record
cacheBar, err := m.Save(NewCacheKey(dgst("bar"), 0), testResult("result1"))
cacheBar, err := m.Save(NewCacheKey(dgst("bar"), 0), testResult("result1"), time.Now())
require.NoError(t, err)
keys, err = m.Query(nil, 0, dgst("bar"), 0)
@ -79,7 +80,7 @@ func TestInMemoryCache(t *testing.T) {
// second level
k := testCacheKey(dgst("baz"), Index(1), *cacheFoo, *cacheBar)
cacheBaz, err := m.Save(k, testResult("result2"))
cacheBaz, err := m.Save(k, testResult("result2"), time.Now())
require.NoError(t, err)
keys, err = m.Query(nil, 0, dgst("baz"), 0)
@ -113,7 +114,7 @@ func TestInMemoryCache(t *testing.T) {
require.Equal(t, keys[0].ID, keys2[0].ID)
k = testCacheKey(dgst("baz"), Index(1), *cacheFoo)
_, err = m.Save(k, testResult("result3"))
_, err = m.Save(k, testResult("result3"), time.Now())
require.NoError(t, err)
keys, err = m.Query(depKeys(*cacheFoo), 0, dgst("baz"), Index(1))
@ -128,7 +129,7 @@ func TestInMemoryCache(t *testing.T) {
{{CacheKey: *cacheFoo}, {CacheKey: *cacheBaz}},
{{CacheKey: *cacheBar}},
})
_, err = m.Save(k, testResult("result4"))
_, err = m.Save(k, testResult("result4"), time.Now())
require.NoError(t, err)
// foo, bar, baz should all point to result4
@ -154,12 +155,12 @@ func TestInMemoryCacheSelector(t *testing.T) {
m := NewInMemoryCacheManager()
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), testResult("result0"))
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), testResult("result0"), time.Now())
require.NoError(t, err)
_, err = m.Save(testCacheKeyWithDeps(dgst("bar"), 0, [][]CacheKeyWithSelector{
{{CacheKey: *cacheFoo, Selector: dgst("sel0")}},
}), testResult("result1"))
}), testResult("result1"), time.Now())
require.NoError(t, err)
keys, err := m.Query(depKeys(*cacheFoo), 0, dgst("bar"), 0)
@ -188,12 +189,12 @@ func TestInMemoryCacheSelectorNested(t *testing.T) {
m := NewInMemoryCacheManager()
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), testResult("result0"))
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), testResult("result0"), time.Now())
require.NoError(t, err)
_, err = m.Save(testCacheKeyWithDeps(dgst("bar"), 0, [][]CacheKeyWithSelector{
{{CacheKey: *cacheFoo, Selector: dgst("sel0")}, {CacheKey: expKey(NewCacheKey(dgst("second"), 0))}},
}), testResult("result1"))
}), testResult("result1"), time.Now())
require.NoError(t, err)
keys, err := m.Query(
@ -241,11 +242,11 @@ func TestInMemoryCacheReleaseParent(t *testing.T) {
m := NewCacheManager(identity.NewID(), storage, results)
res0 := testResult("result0")
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), res0)
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), res0, time.Now())
require.NoError(t, err)
res1 := testResult("result1")
_, err = m.Save(testCacheKey(dgst("bar"), 0, *cacheFoo), res1)
_, err = m.Save(testCacheKey(dgst("bar"), 0, *cacheFoo), res1, time.Now())
require.NoError(t, err)
keys, err := m.Query(nil, 0, dgst("foo"), 0)
@ -293,15 +294,15 @@ func TestInMemoryCacheRestoreOfflineDeletion(t *testing.T) {
m := NewCacheManager(identity.NewID(), storage, results)
res0 := testResult("result0")
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), res0)
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), res0, time.Now())
require.NoError(t, err)
res1 := testResult("result1")
_, err = m.Save(testCacheKey(dgst("bar"), 0, *cacheFoo), res1)
_, err = m.Save(testCacheKey(dgst("bar"), 0, *cacheFoo), res1, time.Now())
require.NoError(t, err)
results2 := NewInMemoryResultStorage()
_, err = results2.Save(res1) // only add bar
_, err = results2.Save(res1, time.Now()) // only add bar
require.NoError(t, err)
m = NewCacheManager(identity.NewID(), storage, results2)
@ -328,15 +329,15 @@ func TestCarryOverFromSublink(t *testing.T) {
results := NewInMemoryResultStorage()
m := NewCacheManager(identity.NewID(), storage, results)
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), testResult("resultFoo"))
cacheFoo, err := m.Save(NewCacheKey(dgst("foo"), 0), testResult("resultFoo"), time.Now())
require.NoError(t, err)
_, err = m.Save(testCacheKeyWithDeps(dgst("res"), 0, [][]CacheKeyWithSelector{
{{CacheKey: *cacheFoo, Selector: dgst("sel0")}, {CacheKey: expKey(NewCacheKey(dgst("content0"), 0))}},
}), testResult("result0"))
}), testResult("result0"), time.Now())
require.NoError(t, err)
cacheBar, err := m.Save(NewCacheKey(dgst("bar"), 0), testResult("resultBar"))
cacheBar, err := m.Save(NewCacheKey(dgst("bar"), 0), testResult("resultBar"), time.Now())
require.NoError(t, err)
keys, err := m.Query([]CacheKeyWithSelector{

View File

@ -3,7 +3,9 @@ package solver
import (
"context"
"fmt"
"strings"
"sync"
"time"
"github.com/moby/buildkit/identity"
digest "github.com/opencontainers/go-digest"
@ -142,15 +144,14 @@ func (c *cacheManager) Load(ctx context.Context, rec *CacheRecord) (Result, erro
return c.results.Load(ctx, res)
}
func (c *cacheManager) Save(k *CacheKey, r Result) (*ExportableCacheKey, error) {
func (c *cacheManager) Save(k *CacheKey, r Result, createdAt time.Time) (*ExportableCacheKey, error) {
c.mu.Lock()
defer c.mu.Unlock()
res, err := c.results.Save(r)
res, err := c.results.Save(r, createdAt)
if err != nil {
return nil, err
}
if err := c.backend.AddResult(c.getID(k), res); err != nil {
return nil, err
}
@ -273,5 +274,8 @@ func (c *cacheManager) getIDFromDeps(k *CacheKey) string {
}
func rootKey(dgst digest.Digest, output Index) digest.Digest {
if strings.HasPrefix(dgst.String(), "random:") {
return digest.Digest("random:" + strings.TrimPrefix(digest.FromBytes([]byte(fmt.Sprintf("%s@%d", dgst, output))).String(), digest.Canonical.String()+":"))
}
return digest.FromBytes([]byte(fmt.Sprintf("%s@%d", dgst, output)))
}

View File

@ -44,7 +44,7 @@ type CacheInfoLink struct {
// CacheResultStorage is interface for converting cache metadata result to
// actual solve result
type CacheResultStorage interface {
Save(Result) (CacheResult, error)
Save(Result, time.Time) (CacheResult, error)
Load(ctx context.Context, res CacheResult) (Result, error)
LoadRemote(ctx context.Context, res CacheResult) (*Remote, error)
Exists(id string) bool

View File

@ -4,6 +4,7 @@ import (
"context"
"strings"
"sync"
"time"
digest "github.com/opencontainers/go-digest"
"github.com/pkg/errors"
@ -71,14 +72,14 @@ func (cm *combinedCacheManager) Load(ctx context.Context, rec *CacheRecord) (Res
if err != nil {
return nil, err
}
if _, err := cm.main.Save(rec.key, res); err != nil {
if _, err := cm.main.Save(rec.key, res, rec.CreatedAt); err != nil {
return nil, err
}
return res, nil
}
func (cm *combinedCacheManager) Save(key *CacheKey, s Result) (*ExportableCacheKey, error) {
return cm.main.Save(key, s)
func (cm *combinedCacheManager) Save(key *CacheKey, s Result, createdAt time.Time) (*ExportableCacheKey, error) {
return cm.main.Save(key, s, createdAt)
}
func (cm *combinedCacheManager) Records(ck *CacheKey) ([]*CacheRecord, error) {

View File

@ -3,6 +3,7 @@ package solver
import (
"context"
"sync"
"time"
"github.com/moby/buildkit/solver/internal/pipe"
digest "github.com/opencontainers/go-digest"
@ -845,7 +846,7 @@ func (e *edge) execOp(ctx context.Context) (interface{}, error) {
var exporters []CacheExporter
for _, cacheKey := range cacheKeys {
ck, err := e.op.Cache().Save(cacheKey, res)
ck, err := e.op.Cache().Save(cacheKey, res, time.Now())
if err != nil {
return nil, err
}

View File

@ -6,6 +6,7 @@ import (
"io"
"strings"
"sync"
"time"
"github.com/containerd/containerd/platforms"
"github.com/moby/buildkit/cache"
@ -190,11 +191,11 @@ func (lcm *lazyCacheManager) Load(ctx context.Context, rec *solver.CacheRecord)
}
return lcm.main.Load(ctx, rec)
}
func (lcm *lazyCacheManager) Save(key *solver.CacheKey, s solver.Result) (*solver.ExportableCacheKey, error) {
func (lcm *lazyCacheManager) Save(key *solver.CacheKey, s solver.Result, createdAt time.Time) (*solver.ExportableCacheKey, error) {
if err := lcm.wait(); err != nil {
return nil, err
}
return lcm.main.Save(key, s)
return lcm.main.Save(key, s, createdAt)
}
func (lcm *lazyCacheManager) wait() error {

View File

@ -2,6 +2,7 @@ package ops
import (
"context"
"strings"
"sync"
"github.com/moby/buildkit/solver"
@ -59,9 +60,15 @@ func (s *sourceOp) CacheMap(ctx context.Context, index int) (*solver.CacheMap, b
return nil, false, err
}
dgst := digest.FromBytes([]byte(sourceCacheType + ":" + k))
if strings.HasPrefix(k, "session:") {
dgst = digest.Digest("random:" + strings.TrimPrefix(dgst.String(), dgst.Algorithm().String()+":"))
}
return &solver.CacheMap{
// TODO: add os/arch
Digest: digest.FromBytes([]byte(sourceCacheType + ":" + k)),
Digest: dgst,
}, done, nil
}

View File

@ -284,9 +284,9 @@ type inMemoryResultStore struct {
m *sync.Map
}
func (s *inMemoryResultStore) Save(r Result) (CacheResult, error) {
func (s *inMemoryResultStore) Save(r Result, createdAt time.Time) (CacheResult, error) {
s.m.Store(r.ID(), r)
return CacheResult{ID: r.ID(), CreatedAt: time.Now()}, nil
return CacheResult{ID: r.ID(), CreatedAt: createdAt}, nil
}
func (s *inMemoryResultStore) Load(ctx context.Context, res CacheResult) (Result, error) {

View File

@ -164,5 +164,5 @@ type CacheManager interface {
// Load pulls and returns the cached result
Load(ctx context.Context, rec *CacheRecord) (Result, error)
// Save saves a result based on a cache key
Save(key *CacheKey, s Result) (*ExportableCacheKey, error)
Save(key *CacheKey, s Result, createdAt time.Time) (*ExportableCacheKey, error)
}

View File

@ -20,7 +20,7 @@ type cacheResultStorage struct {
wc *Controller
}
func (s *cacheResultStorage) Save(res solver.Result) (solver.CacheResult, error) {
func (s *cacheResultStorage) Save(res solver.Result, createdAt time.Time) (solver.CacheResult, error) {
ref, ok := res.Sys().(*WorkerRef)
if !ok {
return solver.CacheResult{}, errors.Errorf("invalid result: %T", res.Sys())
@ -33,7 +33,7 @@ func (s *cacheResultStorage) Save(res solver.Result) (solver.CacheResult, error)
ref.ImmutableRef.Metadata().Commit()
}
}
return solver.CacheResult{ID: ref.ID(), CreatedAt: time.Now()}, nil
return solver.CacheResult{ID: ref.ID(), CreatedAt: createdAt}, nil
}
func (s *cacheResultStorage) Load(ctx context.Context, res solver.CacheResult) (solver.Result, error) {
return s.load(res.ID, false)