Introduce --quiet option

Signed-off-by: Nicolas De Loof <[email protected]>

Author: ndeloof

Gopkg.lock

@@ -2,6 +2,7 @@ package e2e
 
 import (
 	"encoding/json"
+	"fmt"
 	"io/ioutil"
 	"os"
 	"path"
@@ -49,7 +50,28 @@ func TestBuild(t *testing.T) {
 		iid := string(bytes)
 		actualID, err := store.FromBundle(&bndl)
 		assert.NilError(t, err)
-		assert.Equal(t, iid, actualID.String())
+		assert.Equal(t, iid, fmt.Sprintf("sha256:%s", actualID.String()))
+	})
+}
+
+func TestQuietBuild(t *testing.T) {
+	runWithDindSwarmAndRegistry(t, func(info dindSwarmAndRegistryInfo) {
+		cmd := info.configuredCmd
+		tmp := fs.NewDir(t, "TestBuild")
+
+		testDir := path.Join("testdata", "build")
+		iidfile := tmp.Join("iidfile")
+		cmd.Command = dockerCli.Command("app", "build", "--quiet", "--iidfile", iidfile, "-f", path.Join(testDir, "single.dockerapp"), testDir)
+		out := icmd.RunCmd(cmd).Assert(t, icmd.Success).Combined()
+		out = strings.Trim(out, "\r\n")
+
+		_, err := os.Stat(iidfile)
+		assert.NilError(t, err)
+		bytes, err := ioutil.ReadFile(iidfile)
+		assert.NilError(t, err)
+		iid := string(bytes)
+		assert.NilError(t, err)
+		assert.Equal(t, iid, out)
 	})
 }
 

e2e/build_test.go

@@ -39,6 +39,7 @@ type buildOptions struct {
 	folder      string
 	imageIDFile string
 	args        []string
+	quiet       bool
 }
 
 func Cmd(dockerCli command.Cli) *cobra.Command {
@@ -60,6 +61,7 @@ func Cmd(dockerCli command.Cli) *cobra.Command {
 	flags.StringVarP(&opts.folder, "folder", "f", "", "Docker app folder containing application definition")
 	flags.BoolVar(&opts.pull, "pull", false, "Always attempt to pull a newer version of the image")
 	flags.StringArrayVar(&opts.args, "build-arg", []string{}, "Set build-time variables")
+	flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Suppress the build output and print app image ID on success")
 	flags.StringVar(&opts.imageIDFile, "iidfile", "", "Write the app image ID to the file")
 
 	return cmd
@@ -110,14 +112,18 @@ func runBuild(dockerCli command.Cli, contextPath string, opt buildOptions) error
 	}
 
 	if opt.imageIDFile != "" {
-		if err = ioutil.WriteFile(opt.imageIDFile, []byte(id.String()), 0644); err != nil {
+		if err = ioutil.WriteFile(opt.imageIDFile, []byte(id.Digest().String()), 0644); err != nil {
 			fmt.Fprintf(dockerCli.Err(), "Failed to write application image id in %s: %s", opt.imageIDFile, err)
 		}
 	}
 
-	fmt.Printf("Successfully built %s\n", id)
+	if opt.quiet {
+		fmt.Fprintln(dockerCli.Out(), id.Digest().String())
+		return err
+	}
+	fmt.Fprintf(dockerCli.Out(), "Successfully built %s\n", id.String())
 	if ref != nil {
-		fmt.Printf("Successfully tagged %s\n", ref.String())
+		fmt.Fprintf(dockerCli.Out(), "Successfully tagged %s\n", ref.String())
 	}
 	return err
 }
@@ -145,13 +151,23 @@ func buildImageUsingBuildx(app *types.App, contextPath string, opt buildOptions,
 			Driver: d,
 		},
 	}
-	pw := progress.NewPrinter(ctx, os.Stderr, opt.progress)
+
+	var out *os.File
+	if opt.quiet {
+		if out, err = os.Create(os.DevNull); err != nil {
+			return nil, err
+		}
+	} else {
+		out = os.NewFile(dockerCli.Out().FD(), "/dev/stdout")
+	}
+
+	pw := progress.NewPrinter(ctx, out, opt.progress)
+
 	// We rely on buildx "docker" builder integrated in docker engine, so don't need a DockerAPI here
 	resp, err := build.Build(ctx, driverInfo, buildopts, nil, dockerCli.ConfigFile(), pw)
 	if err != nil {
 		return nil, err
 	}
-	fmt.Fprintln(dockerCli.Out(), "Successfully built service images") //nolint:errcheck
 
 	bundle, err := packager.MakeBundleFromApp(dockerCli, app, nil)
 	if err != nil {

internal/commands/build/build.go

@@ -26,10 +26,10 @@ type bundleStoreStubForListCmd struct {
 	refList []reference.Reference
 }
 
-func (b *bundleStoreStubForListCmd) Store(ref reference.Reference, bndle *bundle.Bundle) (reference.Reference, error) {
+func (b *bundleStoreStubForListCmd) Store(ref reference.Reference, bndle *bundle.Bundle) (reference.Digested, error) {
 	b.refMap[ref] = bndle
 	b.refList = append(b.refList, ref)
-	return ref, nil
+	return store.FromBundle(bndle)
 }
 
 func (b *bundleStoreStubForListCmd) Read(ref reference.Reference) (*bundle.Bundle, error) {

internal/commands/image/list_test.go

@@ -15,16 +15,17 @@ type bundleStoreStub struct {
 	ReadError    error
 	StoredBundle string
 	StoredError  error
+	StoredID     reference.Digested
 }
 
-func (b *bundleStoreStub) Store(ref reference.Reference, bndle *bundle.Bundle) (reference.Reference, error) {
+func (b *bundleStoreStub) Store(ref reference.Reference, bndle *bundle.Bundle) (reference.Digested, error) {
 	defer func() {
 		b.StoredError = nil
 	}()
 
 	b.StoredBundle = ref.String()
 
-	return ref, b.StoredError
+	return b.StoredID, b.StoredError
 }
 
 func (b *bundleStoreStub) Read(ref reference.Reference) (*bundle.Bundle, error) {

internal/commands/image/tag_test.go

@@ -71,7 +71,7 @@ func MakeCNABImageName(appName, appVersion, suffix string) (string, error) {
 }
 
 // PersistInBundleStore do store a bundle with optional reference and return it's ID
-func PersistInBundleStore(ref reference.Reference, bndle *bundle.Bundle) (reference.Reference, error) {
+func PersistInBundleStore(ref reference.Reference, bndle *bundle.Bundle) (reference.Digested, error) {
 	appstore, err := store.NewApplicationStore(config.Dir())
 	if err != nil {
 		return nil, err

internal/packager/bundle.go

@@ -11,13 +11,14 @@ import (
 
 	"github.com/deislabs/cnab-go/bundle"
 	"github.com/docker/distribution/reference"
+	"github.com/opencontainers/go-digest"
 	"github.com/pkg/errors"
 )
 
 //
 type BundleStore interface {
 	// Store do store the bundle with optional reference, and return it's unique ID
-	Store(ref reference.Reference, bndle *bundle.Bundle) (reference.Reference, error)
+	Store(ref reference.Reference, bndle *bundle.Bundle) (reference.Digested, error)
 	Read(ref reference.Reference) (*bundle.Bundle, error)
 	List() ([]reference.Reference, error)
 	Remove(ref reference.Reference) error
@@ -46,12 +47,12 @@ type bundleStore struct {
 //      \_ bundle.json
 //
 
-func (b *bundleStore) Store(ref reference.Reference, bndle *bundle.Bundle) (reference.Reference, error) {
+func (b *bundleStore) Store(ref reference.Reference, bndle *bundle.Bundle) (reference.Digested, error) {
 	digest, err := ComputeDigest(bndle)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to store bundle %q", ref)
 	}
-	id := ID{digest.Encoded()}
+	id := ID{digest}
 
 	if ref == nil {
 		ref = id
@@ -107,7 +108,7 @@ func (b *bundleStore) List() ([]reference.Reference, error) {
 		if strings.HasPrefix(path, digests) {
 			rel := path[len(digests)+1:]
 			dg := strings.Split(filepath.ToSlash(rel), "/")[0]
-			references = append(references, ID{dg})
+			references = append(references, ID{digest.NewDigestFromEncoded(digest.SHA256, dg)})
 			return nil
 		}
 

internal/store/bundle.go

@@ -32,21 +32,26 @@ func FromString(s string) (ID, error) {
 	if ok, _ := regexp.MatchString("[a-z0-9]{64}", s); !ok {
 		return ID{}, fmt.Errorf("could not parse '%s' as a valid reference", s)
 	}
-	return ID{s}, nil
+	digest := digest.NewDigestFromEncoded(digest.SHA256, s)
+	return ID{digest}, nil
 }
 
 func FromBundle(bndle *bundle.Bundle) (ID, error) {
 	digest, err := ComputeDigest(bndle)
-	return ID{digest.Encoded()}, err
+	return ID{digest}, err
 }
 
 // ID is an unique identifier for docker app image bundle, implementing reference.Reference
 type ID struct {
-	digest string
+	digest digest.Digest
 }
 
 var _ reference.Reference = ID{}
 
 func (id ID) String() string {
+	return id.digest.Encoded()
+}
+
+func (id ID) Digest() digest.Digest {
 	return id.digest
 }