casext: switch to NewEngine API

This is necessary in order to avoid go-vet warnings, as well as removing the ugly Engine{engine} interface. In future, the implementation of casext.Engine will be made private and casext.Engine will be an interface. Signed-off-by: Aleksa Sarai <asarai@suse.de>
opencontainers · Jul 23, 2017 · 272950d · 272950d
1 parent c2d0868
commit 272950d
Show file tree

Hide file tree

Showing 14 changed files with 31 additions and 22 deletions.
diff --git a/cmd/umoci/config.go b/cmd/umoci/config.go
@@ -135,7 +135,7 @@ func config(ctx *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "open CAS")
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	fromDescriptorPaths, err := engineExt.ResolveReference(context.Background(), fromName)

diff --git a/cmd/umoci/gc.go b/cmd/umoci/gc.go
@@ -57,7 +57,7 @@ func gc(ctx *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "open CAS")
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	// Run the GC.

diff --git a/cmd/umoci/new.go b/cmd/umoci/new.go
@@ -60,7 +60,7 @@ func newImage(ctx *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "open CAS")
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	// Create a new manifest.

diff --git a/cmd/umoci/raw-runtime-config.go b/cmd/umoci/raw-runtime-config.go
@@ -128,7 +128,7 @@ func rawConfig(ctx *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "open CAS")
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	fromDescriptorPaths, err := engineExt.ResolveReference(context.Background(), fromName)

diff --git a/cmd/umoci/repack.go b/cmd/umoci/repack.go
@@ -117,7 +117,7 @@ func repack(ctx *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "open CAS")
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	// Create the mutator.

diff --git a/cmd/umoci/stat.go b/cmd/umoci/stat.go
@@ -64,7 +64,7 @@ func stat(ctx *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "open CAS")
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	manifestDescriptorPaths, err := engineExt.ResolveReference(context.Background(), tagName)

diff --git a/cmd/umoci/tag.go b/cmd/umoci/tag.go
@@ -66,7 +66,7 @@ func tagAdd(ctx *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "open CAS")
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	// Get original descriptor.
@@ -114,7 +114,7 @@ func tagRemove(ctx *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "open CAS")
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	// Remove it.
@@ -151,7 +151,7 @@ func tagList(ctx *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "open CAS")
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	names, err := engineExt.ListReferences(context.Background())

diff --git a/cmd/umoci/unpack.go b/cmd/umoci/unpack.go
@@ -126,7 +126,7 @@ func unpack(ctx *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "open CAS")
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	fromDescriptorPaths, err := engineExt.ResolveReference(context.Background(), fromName)

diff --git a/mutate/mutate.go b/mutate/mutate.go
@@ -137,7 +137,7 @@ func New(engine cas.Engine, src casext.DescriptorPath) (*Mutator, error) {
 	}
 
 	return &Mutator{
-		engine: casext.Engine{engine},
+		engine: casext.NewEngine(engine),
 		source: src,
 	}, nil
 }

diff --git a/mutate/mutate_test.go b/mutate/mutate_test.go
@@ -57,7 +57,7 @@ func setup(t *testing.T, dir string) (cas.Engine, ispec.Descriptor) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 
 	// Write a tar layer.
 	var buffer bytes.Buffer
@@ -458,7 +458,7 @@ func TestMutatePath(t *testing.T) {
 	defer os.RemoveAll(dir)
 
 	engine, manifestDescriptor := setup(t, dir)
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 	defer engine.Close()
 
 	// Create some additional structure.

diff --git a/oci/casext/casext.go b/oci/casext/casext.go
@@ -22,8 +22,17 @@ package casext
 
 import "github.com/openSUSE/umoci/oci/cas"
 
+// TODO: Convert this to an interface and make Engine private.
+
 // Engine is a wrapper around cas.Engine that provides additional, generic
 // extensions to the transport-dependent cas.Engine implementation.
 type Engine struct {
 	cas.Engine
 }
+
+// NewEngine returns a new Engine which acts as a wrapper around the given
+// cas.Engine and provides additional, generic extensions to the
+// transport-dependent cas.Engine implementation.
+func NewEngine(engine cas.Engine) Engine {
+	return Engine{Engine: engine}
+}
diff --git a/oci/casext/json_dir_test.go b/oci/casext/json_dir_test.go
@@ -49,7 +49,7 @@ func TestEngineBlobJSON(t *testing.T) {
 	if err != nil {
 		t.Fatalf("unexpected error opening image: %+v", err)
 	}
-	engineExt := Engine{engine}
+	engineExt := NewEngine(engine)
 	defer engine.Close()
 
 	type object struct {
@@ -145,7 +145,7 @@ func TestEngineBlobJSONReadonly(t *testing.T) {
 		if err != nil {
 			t.Fatalf("unexpected error opening image: %+v", err)
 		}
-		engineExt := Engine{engine}
+		engineExt := NewEngine(engine)
 
 		digest, _, err := engineExt.PutBlobJSON(ctx, test.object)
 		if err != nil {
@@ -163,7 +163,7 @@ func TestEngineBlobJSONReadonly(t *testing.T) {
 		if err != nil {
 			t.Errorf("unexpected error opening ro image: %+v", err)
 		}
-		newEngineExt := Engine{newEngine}
+		newEngineExt := NewEngine(newEngine)
 
 		blobReader, err := newEngineExt.GetBlob(ctx, digest)
 		if err != nil {

diff --git a/oci/casext/refname_dir_test.go b/oci/casext/refname_dir_test.go
@@ -254,7 +254,7 @@ func TestEngineReference(t *testing.T) {
 	if err != nil {
 		t.Fatalf("unexpected error opening image: %+v", err)
 	}
-	engineExt := Engine{engine}
+	engineExt := NewEngine(engine)
 	defer engine.Close()
 
 	descMap, err := fakeSetupEngine(t, engineExt)
@@ -318,7 +318,7 @@ func TestEngineReferenceReadonly(t *testing.T) {
 	if err != nil {
 		t.Fatalf("unexpected error opening image: %+v", err)
 	}
-	engineExt := Engine{engine}
+	engineExt := NewEngine(engine)
 
 	descMap, err := fakeSetupEngine(t, engineExt)
 	if err != nil {
@@ -336,7 +336,7 @@ func TestEngineReferenceReadonly(t *testing.T) {
 		if err != nil {
 			t.Fatalf("unexpected error opening image: %+v", err)
 		}
-		engineExt := Engine{engine}
+		engineExt := NewEngine(engine)
 
 		if err := engineExt.UpdateReference(ctx, name, test.index); err != nil {
 			t.Errorf("UpdateReference: unexpected error: %+v", err)
@@ -353,7 +353,7 @@ func TestEngineReferenceReadonly(t *testing.T) {
 		if err != nil {
 			t.Errorf("unexpected error opening ro image: %+v", err)
 		}
-		newEngineExt := Engine{newEngine}
+		newEngineExt := NewEngine(newEngine)
 
 		gotDescriptorPaths, err := newEngineExt.ResolveReference(ctx, name)
 		if err != nil {

diff --git a/oci/layer/unpack.go b/oci/layer/unpack.go
@@ -87,7 +87,7 @@ func isLayerType(mediaType string) bool {
 //
 // FIXME: This interface is ugly.
 func UnpackManifest(ctx context.Context, engine cas.Engine, bundle string, manifest ispec.Manifest, opt *MapOptions) error {
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 
 	// Create the bundle directory. We only error out if config.json or rootfs/
 	// already exists, because we cannot be sure that the user intended us to
@@ -227,7 +227,7 @@ func UnpackManifest(ctx context.Context, engine cas.Engine, bundle string, manif
 //
 // XXX: I don't like this API. It has way too many arguments.
 func UnpackRuntimeJSON(ctx context.Context, engine cas.Engine, configFile io.Writer, rootfs string, manifest ispec.Manifest, opt *MapOptions) error {
-	engineExt := casext.Engine{engine}
+	engineExt := casext.NewEngine(engine)
 
 	var mapOptions MapOptions
 	if opt != nil {