Add envs create command

fuskovic · fuskovic · commit 5c51b63d602a · 2020-10-21T15:50:05.000-05:00
diff --git a/ci/integration/envs_test.go b/ci/integration/envs_test.go
@@ -0,0 +1,70 @@
+package integration
+
+import (
+	"context"
+	"regexp"
+	"testing"
+
+	"cdr.dev/coder-cli/ci/tcli"
+)
+
+// From Coder organization images
+const ubuntuImgID = "5f443b16-30652892427b955601330fa5"
+
+func TestEnvsCLI(t *testing.T) {
+	t.Parallel()
+
+	run(t, "coder-cli-env-tests", func(t *testing.T, ctx context.Context, c *tcli.ContainerRunner) {
+		headlessLogin(ctx, t, c)
+
+		// Ensure binary is present.
+		c.Run(ctx, "which coder").Assert(t,
+			tcli.Success(),
+			tcli.StdoutMatches("/usr/sbin/coder"),
+			tcli.StderrEmpty(),
+		)
+
+		// Minimum args not received.
+		c.Run(ctx, "coder envs create").Assert(t,
+			tcli.StderrMatches(regexp.QuoteMeta("Error: accepts 1 arg(s), received 0")),
+			tcli.Error(),
+		)
+
+		// Successfully output help.
+		c.Run(ctx, "coder envs create --help").Assert(t,
+			tcli.Success(),
+			tcli.StdoutMatches(regexp.QuoteMeta("Create a new environment under the active user.")),
+			tcli.StderrEmpty(),
+		)
+
+		// TODO(Faris) : uncomment this when we can safely purge the environments
+		// the integrations tests would create in the sidecar
+		// Successfully create environment.
+		// c.Run(ctx, "coder envs create --image "+ubuntuImgID+" test-ubuntu").Assert(t,
+		// 	tcli.Success(),
+		// 	// why does flog.Success write to stderr?
+		// 	tcli.StderrMatches(regexp.QuoteMeta("Successfully created environment \"test-ubuntu\"")),
+		// )
+
+		// Invalid environment name should fail.
+		c.Run(ctx, "coder envs create --image "+ubuntuImgID+" this-IS-an-invalid-EnvironmentName").Assert(t,
+			tcli.Error(),
+			tcli.StderrMatches(regexp.QuoteMeta("HTTP/2.0 400 Bad Request")),
+			tcli.StderrMatches(regexp.QuoteMeta("environment name must conform to regex ^[a-z0-9]([a-z0-9-]+)?")),
+		)
+
+		// TODO(Faris) : uncomment this when we can safely purge the environments
+		// the integrations tests would create in the sidecar
+		// Successfully provision environment with fractional resource amounts
+		// c.Run(ctx, fmt.Sprintf(`coder envs create -i %s -c 1.2 -m 1.4 non-whole-resource-amounts`, ubuntuImgID)).Assert(t,
+		// 	tcli.Success(),
+		// 	tcli.StderrMatches(regexp.QuoteMeta("Successfully created environment \"non-whole-resource-amounts\"")),
+		// )
+
+		// Image does not exist should fail.
+		c.Run(ctx, "coder envs create --image does-not-exist env-will-not-be-created").Assert(t,
+			tcli.Error(),
+			tcli.StderrMatches(regexp.QuoteMeta("does not exist")),
+		)
+	})
+}
diff --git a/ci/steps/gendocs.sh b/ci/steps/gendocs.sh
@@ -13,7 +13,7 @@ go run ./cmd/coder gen-docs ./docs
 
 # remove cobra footer from each file
 for filename in ./docs/*.md; do
-  trimmed=$(head -n -1 "$filename")
+  trimmed=$(head -n $(( $(wc -l "$filename" | awk '{print $1}') - 1 )) "$filename")
   echo "$trimmed" >$filename
 done
 
diff --git a/coder-sdk/env.go b/coder-sdk/env.go
@@ -78,7 +78,7 @@ type CreateEnvironmentRequest struct {
 	ImageID  string   `json:"image_id"`
 	ImageTag string   `json:"image_tag"`
 	CPUCores float32  `json:"cpu_cores"`
-	MemoryGB int      `json:"memory_gb"`
+	MemoryGB float32  `json:"memory_gb"`
 	DiskGB   int      `json:"disk_gb"`
 	GPUs     int      `json:"gpus"`
 	Services []string `json:"services"`
diff --git a/internal/cmd/envs.go b/internal/cmd/envs.go
@@ -13,6 +13,15 @@ import (
 	"go.coder.com/flog"
 )
 
+const (
+	defaultOrg              = "default"
+	defaultImgTag           = "latest"
+	defaultCPUCores float32 = 1
+	defaultMemGB    float32 = 1
+	defaultDiskGB           = 10
+	defaultGPUs             = 0
+)
+
 func envsCommand() *cobra.Command {
 	var outputFmt string
 	var user string
@@ -63,9 +72,9 @@ func envsCommand() *cobra.Command {
 	lsCmd.Flags().StringVarP(&outputFmt, "output", "o", "human", "human | json")
 	cmd.AddCommand(lsCmd)
 	cmd.AddCommand(stopEnvCommand(&user))
-
 	cmd.AddCommand(watchBuildLogCommand())
 	cmd.AddCommand(rebuildEnvCommand())
+	cmd.AddCommand(createEnvCommand())
 	return cmd
 }
 
@@ -117,3 +126,85 @@ coder envs --user charlie@coder.com ls -o json \
 		},
 	}
 }
+
+func createEnvCommand() *cobra.Command {
+	var (
+		org      string
+		img      string
+		tag      string
+		services []string
+	)
+
+	cmd := &cobra.Command{
+		Use:    "create [flags] [environment-name]",
+		Short:  "create a new environment.",
+		Args:   cobra.ExactArgs(1),
+		Hidden: true,
+		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 {
+			if img == "" {
+				return xerrors.New("image id unset")
+			}
+			// 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(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(&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("gpus", "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
+}
