Unify pull with image create

Author: sjmiller609

README.md

@@ -31,8 +31,8 @@ go run cmd/hypeman/main.go
 ## Usage
 
 ```sh
-# Pull an image
-hypeman pull nginx:alpine
+# Create an image (or use `hypeman pull` as an alias)
+hypeman image create nginx:alpine
 
 # Boot a new VM (auto-pulls image if needed)
 hypeman run --name my-app nginx:alpine

pkg/cmd/imagecmd.go

@@ -25,15 +25,10 @@ var imageCmd = cli.Command{
 }
 
 var imageCreateCmd = cli.Command{
-	Name:      "create",
-	Usage:     "Pull and convert an OCI image",
-	ArgsUsage: "<name>",
-	Flags: []cli.Flag{
-		&cli.StringSliceFlag{
-			Name:  "tag",
-			Usage: "Set image tag key-value pair (KEY=VALUE, can be repeated)",
-		},
-	},
+	Name:            "create",
+	Usage:           "Pull and convert an OCI image",
+	ArgsUsage:       "<name>",
+	Flags:           imageCreateFlags(),
 	Action:          handleImageCreate,
 	HideHelpCommand: true,
 }
@@ -149,24 +144,21 @@ func handleImageList(ctx context.Context, cmd *cli.Command) error {
 }
 
 func handleImageCreate(ctx context.Context, cmd *cli.Command) error {
+	return handleImageCreateLike(ctx, cmd, "hypeman image create <name>", "image create")
+}
+
+func handleImageCreateLike(ctx context.Context, cmd *cli.Command, usageLine, outputLabel string) error {
 	args := cmd.Args().Slice()
 	if len(args) < 1 {
-		return fmt.Errorf("image name required\nUsage: hypeman image create <name>")
+		return fmt.Errorf("image name required\nUsage: %s", usageLine)
 	}
 
 	client := hypeman.NewClient(getDefaultRequestOptions(cmd)...)
 
-	params := hypeman.ImageNewParams{
-		Name: args[0],
-	}
-
-	tags, malformedTags := parseKeyValueSpecs(cmd.StringSlice("tag"))
+	params, malformedTags := buildImageNewParams(args[0], cmd.StringSlice("tag"))
 	for _, malformed := range malformedTags {
 		fmt.Fprintf(os.Stderr, "Warning: ignoring malformed tag: %s\n", malformed)
 	}
-	if len(tags) > 0 {
-		params.Tags = tags
-	}
 
 	var opts []option.RequestOption
 	if cmd.Root().Bool("debug") {
@@ -184,7 +176,7 @@ func handleImageCreate(ctx context.Context, cmd *cli.Command) error {
 			return err
 		}
 		obj := gjson.ParseBytes(res)
-		return ShowJSON(os.Stdout, "image create", obj, format, transform)
+		return ShowJSON(os.Stdout, outputLabel, obj, format, transform)
 	}
 
 	result, err := client.Images.New(ctx, params, opts...)
@@ -195,6 +187,26 @@ func handleImageCreate(ctx context.Context, cmd *cli.Command) error {
 	return nil
 }
 
+func imageCreateFlags() []cli.Flag {
+	return []cli.Flag{
+		&cli.StringSliceFlag{
+			Name:  "tag",
+			Usage: "Set image tag key-value pair (KEY=VALUE, can be repeated)",
+		},
+	}
+}
+
+func buildImageNewParams(name string, tagSpecs []string) (hypeman.ImageNewParams, []string) {
+	params := hypeman.ImageNewParams{Name: name}
+
+	tags, malformedTags := parseKeyValueSpecs(tagSpecs)
+	if len(tags) > 0 {
+		params.Tags = tags
+	}
+
+	return params, malformedTags
+}
+
 func handleImageGet(ctx context.Context, cmd *cli.Command) error {
 	args := cmd.Args().Slice()
 	if len(args) < 1 {

pkg/cmd/imagecmd_test.go

@@ -0,0 +1,23 @@
+package cmd
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestBuildImageNewParams(t *testing.T) {
+	params, malformed := buildImageNewParams("docker.io/library/alpine:latest", []string{
+		"env=staging",
+		"team=cli",
+		"missing-delimiter",
+	})
+
+	require.Equal(t, "docker.io/library/alpine:latest", params.Name)
+	assert.Equal(t, map[string]string{
+		"env":  "staging",
+		"team": "cli",
+	}, params.Tags)
+	assert.Equal(t, []string{"missing-delimiter"}, malformed)
+}

pkg/cmd/pull.go

@@ -2,57 +2,19 @@ package cmd
 
 import (
 	"context"
-	"fmt"
-	"os"
 
-	"github.com/kernel/hypeman-go"
-	"github.com/kernel/hypeman-go/option"
 	"github.com/urfave/cli/v3"
 )
 
 var pullCmd = cli.Command{
 	Name:            "pull",
-	Usage:           "Pull an image from a registry",
+	Usage:           "Alias for `image create`",
 	ArgsUsage:       "<image>",
+	Flags:           imageCreateFlags(),
 	Action:          handlePull,
 	HideHelpCommand: true,
 }
 
 func handlePull(ctx context.Context, cmd *cli.Command) error {
-	args := cmd.Args().Slice()
-	if len(args) < 1 {
-		return fmt.Errorf("image reference required\nUsage: hypeman pull <image>")
-	}
-
-	image := args[0]
-
-	fmt.Fprintf(os.Stderr, "Pulling %s...\n", image)
-
-	client := hypeman.NewClient(getDefaultRequestOptions(cmd)...)
-
-	params := hypeman.ImageNewParams{
-		Name: image,
-	}
-
-	var opts []option.RequestOption
-	if cmd.Root().Bool("debug") {
-		opts = append(opts, debugMiddlewareOption)
-	}
-
-	result, err := client.Images.New(
-		ctx,
-		params,
-		opts...,
-	)
-	if err != nil {
-		return err
-	}
-
-	fmt.Fprintf(os.Stderr, "Status: %s\n", result.Status)
-	if result.Digest != "" {
-		fmt.Fprintf(os.Stderr, "Digest: %s\n", result.Digest)
-	}
-	fmt.Fprintf(os.Stderr, "Image: %s\n", result.Name)
-
-	return nil
+	return handleImageCreateLike(ctx, cmd, "hypeman pull <image>", "pull")
 }