govc: Add import.vmdk '-i' flag to output vmdk info only

Signed-off-by: Doug MacEachern <[email protected]>

Author: dougm

cli/importx/vmdk.go

@@ -23,6 +23,7 @@ type disk struct {
 	*flags.OutputFlag
 
 	force bool
+	info  bool
 }
 
 func init() {
@@ -40,6 +41,7 @@ func (cmd *disk) Register(ctx context.Context, f *flag.FlagSet) {
 	cmd.OutputFlag.Register(ctx, f)
 
 	f.BoolVar(&cmd.force, "force", false, "Overwrite existing disk")
+	f.BoolVar(&cmd.info, "i", false, "Output vmdk info only")
 }
 
 func (cmd *disk) Process(ctx context.Context) error {
@@ -62,6 +64,17 @@ func (cmd *disk) Usage() string {
 	return "PATH_TO_VMDK [REMOTE_DIRECTORY]"
 }
 
+func (cmd *disk) Description() string {
+	return `Import vmdk to datastore.
+
+The local vmdk must be in streamOptimized format.
+
+Examples:
+  govc import.vmdk my.vmdk
+  govc import.vmdk -i my.vmdk # output vmdk info only
+  govc import.vmdk -json -i my.vmdk | jq .capacity | xargs numfmt --to=iec --suffix=B --format="%.1f"`
+}
+
 func (cmd *disk) Run(ctx context.Context, f *flag.FlagSet) error {
 	args := f.Args()
 	if len(args) < 1 {
@@ -70,6 +83,17 @@ func (cmd *disk) Run(ctx context.Context, f *flag.FlagSet) error {
 
 	src := f.Arg(0)
 
+	if cmd.info {
+		info, err := vmdk.Stat(src)
+		if err != nil {
+			if err == vmdk.ErrInvalidFormat {
+				return formatError(src, err)
+			}
+			return err
+		}
+		return cmd.WriteResult(info)
+	}
+
 	c, err := cmd.DatastoreFlag.Client()
 	if err != nil {
 		return err
@@ -110,11 +134,15 @@ func (cmd *disk) Run(ctx context.Context, f *flag.FlagSet) error {
 
 	err = vmdk.Import(ctx, c, src, ds, p)
 	if err != nil && err == vmdk.ErrInvalidFormat {
-		return fmt.Errorf(`%s
-The vmdk can be converted using one of:
-  vmware-vdiskmanager -t 5 -r '%s' new.vmdk
-  qemu-img convert -O vmdk -o subformat=streamOptimized '%s' new.vmdk`, err, src, src)
+		return formatError(src, err)
 	}
 
 	return err
 }
+
+func formatError(src string, err error) error {
+	return fmt.Errorf(`%s
+The vmdk can be converted using one of:
+  vmware-vdiskmanager -t 5 -r '%s' new.vmdk
+  qemu-img convert -O vmdk -o subformat=streamOptimized '%s' new.vmdk`, err, src, src)
+}

govc/USAGE.md

@@ -3809,10 +3809,20 @@ Options:
 ```
 Usage: govc import.vmdk [OPTIONS] PATH_TO_VMDK [REMOTE_DIRECTORY]
 
+Import vmdk to datastore.
+
+The local vmdk must be in streamOptimized format.
+
+Examples:
+  govc import.vmdk my.vmdk
+  govc import.vmdk -i my.vmdk # output vmdk info only
+  govc import.vmdk -json -i my.vmdk | jq .capacity | xargs numfmt --to=iec --suffix=B --format="%.1f"
+
 Options:
   -ds=                   Datastore [GOVC_DATASTORE]
   -folder=               Inventory folder [GOVC_FOLDER]
   -force=false           Overwrite existing disk
+  -i=false               Output vmdk info only
   -pool=                 Resource pool [GOVC_RESOURCE_POOL]
 ```
 

govc/test/import.bats

@@ -168,6 +168,23 @@ load test_helper
   assert_success # exists, but -force was used
 }
 
+@test "import.vmdk -i" {
+  # ClientFlag.Process errors otherwise, but not using client with -i flag
+  export GOVC_URL="unused"
+
+  run govc import.vmdk -i "$GOVC_IMAGES/${TTYLINUX_NAME}.ovf"
+  assert_failure
+
+  run govc import.vmdk -i "$GOVC_TEST_VMDK_SRC"
+  assert_success
+
+  run govc import.vmdk -json -i "$GOVC_TEST_VMDK_SRC"
+  assert_success
+
+  run jq . <<<"$output"
+  assert_success
+}
+
 @test "import duplicate dvpg names" {
   vcsim_env