Add context to content commit

Content commit is updated to take in a context, allowing
content to be committed within the same context the writer
was in. This is useful when commit may be able to use more
context to complete the action rather than creating its own.
An example of this being useful is for the metadata implementation
of content, having a context allows tests to fully create
content in one database transaction by making use of the context.

Signed-off-by: Derek McGowan <derek@mcgstyle.net>
This commit is contained in:
Derek McGowan 2017-09-06 10:19:12 -07:00
parent e4a77fcc0a
commit 9613acb2ed
No known key found for this signature in database
GPG Key ID: F58C5D0A4405ACDB
16 changed files with 28 additions and 26 deletions

View File

@ -332,7 +332,7 @@ var (
return err return err
} }
if err := wr.Commit(0, wr.Digest()); err != nil { if err := wr.Commit(ctx, 0, wr.Digest()); err != nil {
return err return err
} }

View File

@ -70,7 +70,7 @@ var pushObjectCommand = cli.Command{
} }
// TODO: Progress reader // TODO: Progress reader
if err := content.Copy(cw, content.NewReader(ra), desc.Size, desc.Digest); err != nil { if err := content.Copy(ctx, cw, content.NewReader(ra), desc.Size, desc.Digest); err != nil {
return err return err
} }

View File

@ -90,7 +90,7 @@ type Writer interface {
// Commit commits the blob (but no roll-back is guaranteed on an error). // Commit commits the blob (but no roll-back is guaranteed on an error).
// size and expected can be zero-value when unknown. // size and expected can be zero-value when unknown.
Commit(size int64, expected digest.Digest, opts ...Opt) error Commit(ctx context.Context, size int64, expected digest.Digest, opts ...Opt) error
// Status returns the current state of write // Status returns the current state of write
Status() (Status, error) Status() (Status, error)

View File

@ -58,7 +58,7 @@ func WriteBlob(ctx context.Context, cs Ingester, ref string, r io.Reader, size i
} }
defer cw.Close() defer cw.Close()
return Copy(cw, r, size, expected) return Copy(ctx, cw, r, size, expected)
} }
// Copy copies data with the expected digest from the reader into the // Copy copies data with the expected digest from the reader into the
@ -68,7 +68,7 @@ func WriteBlob(ctx context.Context, cs Ingester, ref string, r io.Reader, size i
// the size or digest is unknown, these values may be empty. // the size or digest is unknown, these values may be empty.
// //
// Copy is buffered, so no need to wrap reader in buffered io. // Copy is buffered, so no need to wrap reader in buffered io.
func Copy(cw Writer, r io.Reader, size int64, expected digest.Digest) error { func Copy(ctx context.Context, cw Writer, r io.Reader, size int64, expected digest.Digest) error {
ws, err := cw.Status() ws, err := cw.Status()
if err != nil { if err != nil {
return err return err
@ -95,7 +95,7 @@ func Copy(cw Writer, r io.Reader, size int64, expected digest.Digest) error {
return err return err
} }
if err := cw.Commit(size, expected); err != nil { if err := cw.Commit(ctx, size, expected); err != nil {
if !errdefs.IsAlreadyExists(err) { if !errdefs.IsAlreadyExists(err) {
return errors.Wrapf(err, "failed commit on ref %q", ws.Ref) return errors.Wrapf(err, "failed commit on ref %q", ws.Ref)
} }

View File

@ -94,7 +94,7 @@ func TestContentWriter(t *testing.T) {
checkCopy(t, int64(len(p)), cw, bufio.NewReader(ioutil.NopCloser(bytes.NewReader(p)))) checkCopy(t, int64(len(p)), cw, bufio.NewReader(ioutil.NopCloser(bytes.NewReader(p))))
if err := cw.Commit(int64(len(p)), expected); err != nil { if err := cw.Commit(ctx, int64(len(p)), expected); err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -109,7 +109,7 @@ func TestContentWriter(t *testing.T) {
// now, attempt to write the same data again // now, attempt to write the same data again
checkCopy(t, int64(len(p)), cw, bufio.NewReader(ioutil.NopCloser(bytes.NewReader(p)))) checkCopy(t, int64(len(p)), cw, bufio.NewReader(ioutil.NopCloser(bytes.NewReader(p))))
if err := cw.Commit(int64(len(p)), expected); err != nil { if err := cw.Commit(ctx, int64(len(p)), expected); err != nil {
t.Fatal(err) t.Fatal(err)
} }

View File

@ -1,6 +1,7 @@
package local package local
import ( import (
"context"
"os" "os"
"path/filepath" "path/filepath"
"runtime" "runtime"
@ -54,7 +55,7 @@ func (w *writer) Write(p []byte) (n int, err error) {
return n, err return n, err
} }
func (w *writer) Commit(size int64, expected digest.Digest, opts ...content.Opt) error { func (w *writer) Commit(ctx context.Context, size int64, expected digest.Digest, opts ...content.Opt) error {
if w.fp == nil { if w.fp == nil {
return errors.Wrap(errdefs.ErrFailedPrecondition, "cannot commit on closed writer") return errors.Wrap(errdefs.ErrFailedPrecondition, "cannot commit on closed writer")
} }

View File

@ -121,7 +121,7 @@ func checkContentStoreWriter(ctx context.Context, t *testing.T, cs content.Store
} }
preCommit := time.Now() preCommit := time.Now()
if err := s.writer.Commit(0, ""); err != nil { if err := s.writer.Commit(ctx, 0, ""); err != nil {
t.Fatal(err) t.Fatal(err)
} }
postCommit := time.Now() postCommit := time.Now()
@ -201,7 +201,7 @@ func checkUploadStatus(ctx context.Context, t *testing.T, cs content.Store) {
} }
preCommit := time.Now() preCommit := time.Now()
if err := w1.Commit(0, ""); err != nil { if err := w1.Commit(ctx, 0, ""); err != nil {
t.Fatalf("Commit failed: %+v", err) t.Fatalf("Commit failed: %+v", err)
} }
postCommit := time.Now() postCommit := time.Now()
@ -235,7 +235,7 @@ func checkLabels(ctx context.Context, t *testing.T, cs content.Store) {
} }
preCommit := time.Now() preCommit := time.Now()
if err := w1.Commit(0, "", content.WithLabels(labels)); err != nil { if err := w1.Commit(ctx, 0, "", content.WithLabels(labels)); err != nil {
t.Fatalf("Commit failed: %+v", err) t.Fatalf("Commit failed: %+v", err)
} }
postCommit := time.Now() postCommit := time.Now()

View File

@ -179,7 +179,7 @@ func (s *walkingDiff) DiffMounts(ctx context.Context, lower, upper []mount.Mount
} }
dgst := cw.Digest() dgst := cw.Digest()
if err := cw.Commit(0, dgst, opts...); err != nil { if err := cw.Commit(ctx, 0, dgst, opts...); err != nil {
return emptyDesc, errors.Wrap(err, "failed to commit") return emptyDesc, errors.Wrap(err, "failed to commit")
} }

View File

@ -352,19 +352,19 @@ type namespacedWriter struct {
db *bolt.DB db *bolt.DB
} }
func (nw *namespacedWriter) Commit(size int64, expected digest.Digest, opts ...content.Opt) error { func (nw *namespacedWriter) Commit(ctx context.Context, size int64, expected digest.Digest, opts ...content.Opt) error {
return nw.db.Update(func(tx *bolt.Tx) error { return update(ctx, nw.db, func(tx *bolt.Tx) error {
bkt := getIngestBucket(tx, nw.namespace) bkt := getIngestBucket(tx, nw.namespace)
if bkt != nil { if bkt != nil {
if err := bkt.Delete([]byte(nw.ref)); err != nil { if err := bkt.Delete([]byte(nw.ref)); err != nil {
return err return err
} }
} }
return nw.commit(tx, size, expected, opts...) return nw.commit(ctx, tx, size, expected, opts...)
}) })
} }
func (nw *namespacedWriter) commit(tx *bolt.Tx, size int64, expected digest.Digest, opts ...content.Opt) error { func (nw *namespacedWriter) commit(ctx context.Context, tx *bolt.Tx, size int64, expected digest.Digest, opts ...content.Opt) error {
var base content.Info var base content.Info
for _, opt := range opts { for _, opt := range opts {
if err := opt(&base); err != nil { if err := opt(&base); err != nil {
@ -382,7 +382,7 @@ func (nw *namespacedWriter) commit(tx *bolt.Tx, size int64, expected digest.Dige
actual := nw.Writer.Digest() actual := nw.Writer.Digest()
if err := nw.Writer.Commit(size, expected); err != nil { if err := nw.Writer.Commit(ctx, size, expected); err != nil {
if !errdefs.IsAlreadyExists(err) { if !errdefs.IsAlreadyExists(err) {
return err return err
} }

View File

@ -215,7 +215,7 @@ func (pw *pushWriter) Digest() digest.Digest {
return pw.expected return pw.expected
} }
func (pw *pushWriter) Commit(size int64, expected digest.Digest, opts ...content.Opt) error { func (pw *pushWriter) Commit(ctx context.Context, size int64, expected digest.Digest, opts ...content.Opt) error {
// Check whether read has already thrown an error // Check whether read has already thrown an error
if _, err := pw.pipe.Write([]byte{}); err != nil && err != io.ErrClosedPipe { if _, err := pw.pipe.Write([]byte{}); err != nil && err != io.ErrClosedPipe {
return errors.Wrap(err, "pipe error before commit") return errors.Wrap(err, "pipe error before commit")

View File

@ -252,7 +252,7 @@ func (c *Converter) fetchBlob(ctx context.Context, desc ocispec.Descriptor) erro
eg.Go(func() error { eg.Go(func() error {
defer pw.Close() defer pw.Close()
return content.Copy(cw, io.TeeReader(rc, pw), desc.Size, desc.Digest) return content.Copy(ctx, cw, io.TeeReader(rc, pw), desc.Size, desc.Digest)
}) })
if err := eg.Wait(); err != nil { if err := eg.Wait(); err != nil {

View File

@ -101,7 +101,7 @@ func fetch(ctx context.Context, ingester content.Ingester, fetcher Fetcher, desc
} }
defer rc.Close() defer rc.Close()
return content.Copy(cw, rc, desc.Size, desc.Digest) return content.Copy(ctx, cw, rc, desc.Size, desc.Digest)
} }
// PushHandler returns a handler that will push all content from the provider // PushHandler returns a handler that will push all content from the provider
@ -139,5 +139,5 @@ func push(ctx context.Context, provider content.Provider, pusher Pusher, desc oc
defer ra.Close() defer ra.Close()
rd := io.NewSectionReader(ra, 0, desc.Size) rd := io.NewSectionReader(ra, 0, desc.Size)
return content.Copy(cw, rd, desc.Size, desc.Digest) return content.Copy(ctx, cw, rd, desc.Size, desc.Digest)
} }

View File

@ -424,7 +424,7 @@ func (s *Service) Write(session api.Content_WriteServer) (err error) {
if req.Labels != nil { if req.Labels != nil {
opts = append(opts, content.WithLabels(req.Labels)) opts = append(opts, content.WithLabels(req.Labels))
} }
if err := wr.Commit(total, expected, opts...); err != nil { if err := wr.Commit(ctx, total, expected, opts...); err != nil {
return err return err
} }
} }

View File

@ -1,6 +1,7 @@
package content package content
import ( import (
"context"
"io" "io"
contentapi "github.com/containerd/containerd/api/services/content/v1" contentapi "github.com/containerd/containerd/api/services/content/v1"
@ -80,7 +81,7 @@ func (rw *remoteWriter) Write(p []byte) (n int, err error) {
return return
} }
func (rw *remoteWriter) Commit(size int64, expected digest.Digest, opts ...content.Opt) error { func (rw *remoteWriter) Commit(ctx context.Context, size int64, expected digest.Digest, opts ...content.Opt) error {
var base content.Info var base content.Info
for _, opt := range opts { for _, opt := range opts {
if err := opt(&base); err != nil { if err := opt(&base); err != nil {

View File

@ -465,7 +465,7 @@ func (s *Service) writeContent(ctx context.Context, mediaType, ref string, r io.
if err != nil { if err != nil {
return nil, err return nil, err
} }
if err := writer.Commit(0, ""); err != nil { if err := writer.Commit(ctx, 0, ""); err != nil {
return nil, err return nil, err
} }
return &types.Descriptor{ return &types.Descriptor{

View File

@ -528,7 +528,7 @@ func writeContent(ctx context.Context, store content.Store, mediaType, ref strin
if err != nil { if err != nil {
return d, err return d, err
} }
if err := writer.Commit(size, ""); err != nil { if err := writer.Commit(ctx, size, ""); err != nil {
return d, err return d, err
} }
return v1.Descriptor{ return v1.Descriptor{