github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Merge pull request #10187 from dmcgowan/metadata-add-lease-on-prepare

Browse Source 
Update metadata snapshotter to lease on already exists
This commit is contained in:
Maksym Pavlenko 2024-05-08 22:25:11 +00:00 committed by GitHub
commit f690928709
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 120 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
core/metadata/snapshot.go
View File

@ -323,6 +323,7 @@ func (s *snapshotter) createSnapshot(ctx context.Context, key, parent string, re
bopts = []snapshots.Opt{
snapshots.WithLabels(snapshots.FilterInheritedLabels(base.Labels)),
}
rerr error
)
if err := update(ctx, s.db, func(tx *bolt.Tx) error {
@ -334,12 +335,20 @@ func (s *snapshotter) createSnapshot(ctx context.Context, key, parent string, re
// Check if target exists, if so, return already exists
if target != "" {
if tbkt := bkt.Bucket([]byte(target)); tbkt != nil {
return fmt.Errorf("target snapshot %q: %w", target, errdefs.ErrAlreadyExists)
rerr = fmt.Errorf("target snapshot %q: %w", target, errdefs.ErrAlreadyExists)
if err := addSnapshotLease(ctx, tx, s.name, target); err != nil {
return err
}
return nil
}
}
if bbkt := bkt.Bucket([]byte(key)); bbkt != nil {
return fmt.Errorf("snapshot %q: %w", key, errdefs.ErrAlreadyExists)
rerr = fmt.Errorf("snapshot %q: %w", key, errdefs.ErrAlreadyExists)
if err := addSnapshotLease(ctx, tx, s.name, key); err != nil {
return err
}
return nil
}
if parent != "" {
@ -360,11 +369,14 @@ func (s *snapshotter) createSnapshot(ctx context.Context, key, parent string, re
}); err != nil {
return nil, err
}
// Already exists and lease successfully added in transaction
if rerr != nil {
return nil, rerr
}
var (
m []mount.Mount
created string
rerr error
)
if readonly {
m, err = s.Snapshotter.View(ctx, bkey, bparent, bopts...)
@ -527,7 +539,10 @@ func (s *snapshotter) Commit(ctx context.Context, name, key string, opts ...snap
return err
}
var bname string
var (
bname string
rerr error
)
if err := update(ctx, s.db, func(tx *bolt.Tx) error {
bkt := getSnapshotterBucket(tx, ns, s.name)
if bkt == nil {
@ -535,16 +550,17 @@ func (s *snapshotter) Commit(ctx context.Context, name, key string, opts ...snap
s.name, errdefs.ErrNotFound)
}
if err := addSnapshotLease(ctx, tx, s.name, name); err != nil {
return err
}
bbkt, err := bkt.CreateBucket([]byte(name))
if err != nil {
if err == bolt.ErrBucketExists {
err = fmt.Errorf("snapshot %q: %w", name, errdefs.ErrAlreadyExists)
rerr = fmt.Errorf("snapshot %q: %w", name, errdefs.ErrAlreadyExists)
return nil
}
return err
}
if err := addSnapshotLease(ctx, tx, s.name, name); err != nil {
return err
}
obkt := bkt.Bucket([]byte(key))
if obkt == nil {
@ -634,17 +650,19 @@ func (s *snapshotter) Commit(ctx context.Context, name, key string, opts ...snap
return err
}
if publisher := s.db.Publisher(ctx); publisher != nil {
if err := publisher.Publish(ctx, "/snapshot/commit", &eventstypes.SnapshotCommit{
Key: key,
Name: name,
Snapshotter: s.name,
}); err != nil {
return err
if rerr == nil {
if publisher := s.db.Publisher(ctx); publisher != nil {
if err := publisher.Publish(ctx, "/snapshot/commit", &eventstypes.SnapshotCommit{
Key: key,
Name: name,
Snapshotter: s.name,
}); err != nil {
return err
}
}
}
return nil
return rerr
}

103
core/metadata/snapshot_test.go
View File

@ -27,6 +27,7 @@ import (
"testing"
"time"
"github.com/containerd/containerd/v2/core/leases"
"github.com/containerd/containerd/v2/core/mount"
"github.com/containerd/containerd/v2/core/snapshots"
"github.com/containerd/containerd/v2/core/snapshots/testsuite"
@ -63,6 +64,32 @@ func newTestSnapshotter(ctx context.Context, root string) (snapshots.Snapshotter
}, nil
}
func snapshotLease(ctx context.Context, t *testing.T, db *DB, sn string) (context.Context, func(string) bool) {
lm := NewLeaseManager(db)
l, err := lm.Create(ctx, leases.WithRandomID())
if err != nil {
t.Fatal(err)
}
ltype := fmt.Sprintf("%s/%s", bucketKeyObjectSnapshots, sn)
t.Cleanup(func() {
lm.Delete(ctx, l)
})
return leases.WithLease(ctx, l.ID), func(id string) bool {
resources, err := lm.ListResources(ctx, l)
if err != nil {
t.Error(err)
}
for _, r := range resources {
if r.Type == ltype && r.ID == id {
return true
}
}
return false
}
}
func TestMetadata(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("snapshotter not implemented on windows")
@ -76,27 +103,40 @@ func TestSnapshotterWithRef(t *testing.T) {
ctx, db := testDB(t, withSnapshotter("tmp", func(string) (snapshots.Snapshotter, error) {
return NewTmpSnapshotter(), nil
}))
sn := db.Snapshotter("tmp")
snapshotter := "tmp"
ctx1, leased1 := snapshotLease(ctx, t, db, snapshotter)
sn := db.Snapshotter(snapshotter)
key1 := "test1"
test1opt := snapshots.WithLabels(
map[string]string{
labelSnapshotRef: "test1",
labelSnapshotRef: key1,
},
)
_, err := sn.Prepare(ctx, "test1-tmp", "", test1opt)
key1t := "test1-tmp"
_, err := sn.Prepare(ctx1, key1t, "", test1opt)
if err != nil {
t.Fatal(err)
}
if !leased1(key1t) {
t.Errorf("no lease for %q", key1t)
}
err = sn.Commit(ctx, "test1", "test1-tmp", test1opt)
err = sn.Commit(ctx1, key1, key1t, test1opt)
if err != nil {
t.Fatal(err)
}
if !leased1(key1) {
t.Errorf("no lease for %q", key1)
}
if leased1(key1t) {
t.Errorf("lease should be removed for %q", key1t)
}
ctx2 := namespaces.WithNamespace(ctx, "testing2")
_, err = sn.Prepare(ctx2, "test1-tmp", "", test1opt)
_, err = sn.Prepare(ctx2, key1t, "", test1opt)
if err == nil {
t.Fatal("expected already exists error")
} else if !errdefs.IsAlreadyExists(err) {
@ -104,86 +144,112 @@ func TestSnapshotterWithRef(t *testing.T) {
}
// test1 should now be in the namespace
_, err = sn.Stat(ctx2, "test1")
_, err = sn.Stat(ctx2, key1)
if err != nil {
t.Fatal(err)
}
key2t := "test2-tmp"
key2 := "test2"
test2opt := snapshots.WithLabels(
map[string]string{
labelSnapshotRef: "test2",
labelSnapshotRef: key2,
},
)
_, err = sn.Prepare(ctx2, "test2-tmp", "test1", test2opt)
_, err = sn.Prepare(ctx2, key2t, key1, test2opt)
if err != nil {
t.Fatal(err)
}
// In original namespace, but not committed
_, err = sn.Prepare(ctx, "test2-tmp", "test1", test2opt)
_, err = sn.Prepare(ctx1, key2t, key1, test2opt)
if err != nil {
t.Fatal(err)
}
if !leased1(key2t) {
t.Errorf("no lease for %q", key2t)
}
if leased1(key2) {
t.Errorf("lease for %q should not exist yet", key2)
}
err = sn.Commit(ctx2, "test2", "test2-tmp", test2opt)
err = sn.Commit(ctx2, key2, key2t, test2opt)
if err != nil {
t.Fatal(err)
}
// See note in Commit function for why
// this does not return ErrAlreadyExists
err = sn.Commit(ctx, "test2", "test2-tmp", test2opt)
err = sn.Commit(ctx1, key2, key2t, test2opt)
if err != nil {
t.Fatal(err)
}
ctx2, leased2 := snapshotLease(ctx2, t, db, snapshotter)
if leased2(key2) {
t.Errorf("new lease should not have previously created snapshots")
}
// This should error out, already exists in namespace
// despite mismatched parent
_, err = sn.Prepare(ctx2, "test2-tmp-again", "", test2opt)
key2ta := "test2-tmp-again"
_, err = sn.Prepare(ctx2, key2ta, "", test2opt)
if err == nil {
t.Fatal("expected already exists error")
} else if !errdefs.IsAlreadyExists(err) {
t.Fatal(err)
}
if !leased2(key2) {
t.Errorf("no lease for %q", key2)
}
// In original namespace, but already exists
_, err = sn.Prepare(ctx, "test2-tmp-again", "test1", test2opt)
_, err = sn.Prepare(ctx, key2ta, key1, test2opt)
if err == nil {
t.Fatal("expected already exists error")
} else if !errdefs.IsAlreadyExists(err) {
t.Fatal(err)
}
if leased1(key2ta) {
t.Errorf("should not have lease for non-existent snapshot %q", key2ta)
}
// Now try a third namespace
ctx3 := namespaces.WithNamespace(ctx, "testing3")
ctx3, leased3 := snapshotLease(ctx3, t, db, snapshotter)
// This should error out, matching parent not found
_, err = sn.Prepare(ctx3, "test2-tmp", "", test2opt)
_, err = sn.Prepare(ctx3, key2t, "", test2opt)
if err != nil {
t.Fatal(err)
}
// Remove, not going to use yet
err = sn.Remove(ctx3, "test2-tmp")
err = sn.Remove(ctx3, key2t)
if err != nil {
t.Fatal(err)
}
_, err = sn.Prepare(ctx3, "test2-tmp", "test1", test2opt)
_, err = sn.Prepare(ctx3, key2t, key1, test2opt)
if err == nil {
t.Fatal("expected not error")
} else if !errdefs.IsNotFound(err) {
t.Fatal(err)
}
if leased3(key1) {
t.Errorf("lease for %q should not have been created", key1)
}
_, err = sn.Prepare(ctx3, "test1-tmp", "", test1opt)
_, err = sn.Prepare(ctx3, key1t, "", test1opt)
if err == nil {
t.Fatal("expected already exists error")
} else if !errdefs.IsAlreadyExists(err) {
t.Fatal(err)
}
if !leased3(key1) {
t.Errorf("no lease for %q", key1)
}
_, err = sn.Prepare(ctx3, "test2-tmp", "test1", test2opt)
if err == nil {
@ -191,6 +257,9 @@ func TestSnapshotterWithRef(t *testing.T) {
} else if !errdefs.IsAlreadyExists(err) {
t.Fatal(err)
}
if !leased3(key2) {
t.Errorf("no lease for %q", key2)
}
}
func TestFilterInheritedLabels(t *testing.T) {