clean up

fuskovic · fuskovic · commit 9fc7f8a0f2d0 · 2020-10-21T10:42:40.000-05:00
diff --git a/internal/cmd/envs.go b/internal/cmd/envs.go
@@ -1,7 +1,6 @@
 package cmd
 
 import (
-	"context"
 	"encoding/json"
 	"os"
 
@@ -14,6 +13,15 @@ import (
 	"go.coder.com/flog"
 )
 
+const (
+	defaultOrg              = "default"
+	defaultImgTag           = "latest"
+	defaultCPUCores float32 = 1
+	defaultMemGB    float32 = 1
+	defaultDiskGB           = 10
+	defaultGPUs             = 1
+)
+
 func envsCommand() *cobra.Command {
 	var outputFmt string
 	var user string
@@ -120,61 +128,80 @@ coder envs --user charlie@coder.com ls -o json \
 }
 
 func createEnvCommand() *cobra.Command {
-	var orgID string
-	createReq := new(coder.CreateEnvironmentRequest)
+	var (
+		org      string
+		img      string
+		tag      string
+		services []string
+	)
 
 	cmd := &cobra.Command{
 		Use:   "create",
 		Short: "create a new environment.",
+		Args:  cobra.ExactArgs(1),
 		Long:  "Create a new environment under the active user.",
+		Example: `
+# create a new environment using default resource amounts
+coder envs create \
+	--image id-of-imported-image \
+	my-env-name
+
+See Flags section for default values.
+
+# create a new environment using custom resource amounts
+coder envs create \
+	--cores 4 \
+	--disk 100 \
+	--memory 8 \
+	--image id-of-imported-image \
+	--org id-of-existing-organization \
+	my-env-name
+
+# same command this time using short-hand flags for a more succinct command experience.
+coder envs create \
+	-c 4 \
+	-d 100 \
+	-m 8 \
+	-i id-of-imported-image my-env-name \
+	-o id-of-existing-organization \
+	my-env-name
+`,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			ctx, cancel := context.WithCancel(context.Background())
-			defer cancel()
-
-			if createReq.ImageTag == "" {
-				createReq.ImageTag = "latest"
-			}
-
-			if createReq.CPUCores == 0 {
-				createReq.CPUCores = 1
-			}
-
-			if createReq.MemoryGB == 0 {
-				createReq.MemoryGB = 1
-			}
-
-			if createReq.DiskGB == 0 {
-				createReq.DiskGB = 10
-			}
-
-			if createReq.GPUs == 0 {
-				createReq.GPUs = 1
+			// We don't need an empty-ness check on img because its value is propogated by a required flag.
+			// cobra.ExactArgs(1) ensures our name value can't panic on an out of bounds.
+			createReq := &coder.CreateEnvironmentRequest{
+				Name:     args[0],
+				ImageID:  img,
+				ImageTag: tag,
 			}
+			// We're explicitly ignoring errors for these because all of these flags
+			// have a non-zero-value default value set already.
+			createReq.CPUCores, _ = cmd.Flags().GetFloat32("cores")
+			createReq.MemoryGB, _ = cmd.Flags().GetFloat32("memory")
+			createReq.DiskGB, _ = cmd.Flags().GetInt("disk")
+			createReq.GPUs, _ = cmd.Flags().GetInt("gpus")
 
 			client, err := newClient()
 			if err != nil {
 				return err
 			}
 
-			env, err := client.CreateEnvironment(ctx, orgID, *createReq)
+			env, err := client.CreateEnvironment(cmd.Context(), org, *createReq)
 			if err != nil {
 				return xerrors.Errorf("create environment: %w", err)
 			}
 			flog.Success("Successfully created environment %q", env.Name)
 			return nil
 		},
 	}
-	cmd.Flags().StringVarP(&orgID, "org", "o", "", "ID of the organization the environment should be created under. (optional: false)")
-	cmd.Flags().StringVarP(&createReq.Name, "name", "n", "", "The name to assign to the environment. (optional: false)")
-	cmd.Flags().StringVarP(&createReq.ImageID, "img", "i", "", "ID of the image to base the environment off of. (optional: false)")
-	cmd.Flags().StringVarP(&createReq.ImageTag, "tag", "t", "", "The particular tag of the image the environment will be based off of. (default: latest, optional: true)")
-	cmd.Flags().Float32P("cores", "c", createReq.CPUCores, "The number of cpu cores the environment should be provisioned with. (default: 1, optional: true, supports fractional amounts)")
-	cmd.Flags().Float32P("memory", "m", createReq.MemoryGB, "The amount of RAM an environment should be provisioned with. (default: 1, optional: true, supports fractional amounts)")
-	cmd.Flags().IntP("disk", "d", createReq.DiskGB, "The amount of disk storage an environment should be provisioned with. (default:10, optional: true, supports whole numbers only)")
-	cmd.Flags().IntP("gpu", "g", createReq.GPUs, "The amount of disk storage to provision the environment with. (default:1, optional: true, supports whole numbers only)")
-	cmd.Flags().StringSliceP("services", "s", createReq.Services, "The services that the environment should be initialized with. (optional: true)")
-	cmd.MarkFlagRequired("org")
-	cmd.MarkFlagRequired("name")
-	cmd.MarkFlagRequired("img")
+	cmd.Flags().StringVarP(&org, "org", "o", defaultOrg, "ID of the organization the environment should be created under.")
+	cmd.Flags().StringVarP(&tag, "tag", "t", defaultImgTag, "The particular tag of the image the environment will be based off of.")
+	cmd.Flags().Float32P("cores", "c", defaultCPUCores, "The number of cpu cores the environment should be provisioned with.")
+	cmd.Flags().Float32P("memory", "m", defaultMemGB, "GB of RAM an environment should be provisioned with.")
+	cmd.Flags().IntP("disk", "d", defaultDiskGB, "GB of disk storage an environment should be provisioned with.")
+	cmd.Flags().IntP("gpu", "g", defaultGPUs, "The number GPUs an environment should be provisioned with.")
+	cmd.Flags().StringSliceP("services", "s", services, "The services that the environment should be initialized with.")
+	cmd.Flags().StringVarP(&img, "image", "i", "", "ID of the image to base the environment off of.")
+	cmd.MarkFlagRequired("image")
 	return cmd
 }
